docs/doc/source/index.rst
MCamp859 d235b95056 R5 updates to landing page and installation
Patch set 5: Updated R5 RN.

Patch set 4: Resolved merge confict.

Patch set 3: Removed R5 install guides.
Local docs build is successful.

Patch set 2: Added R6 install guides.
Removed R1-R4 install guides.
R5 will be removed next patch set.

Updated main docs landing page with R5 links.
Installation index page: promoted R5 to supported, moved R4 to
archive section, created R6 (latest) section.

Change-Id: Ic0e0409f2385a9a6f29b83a2eda12753ea4ac1a3
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-05-31 11:46:08 -04:00

3.9 KiB
Executable File

Welcome to the StarlingX Documentation

StarlingX is a fully integrated edge cloud software stack that provides everything needed to deploy an edge cloud on one, two, or up to 100 servers.

The most recent supported release of StarlingX is StarlingX R5.0.

For more information about the StarlingX project, refer to the StarlingX wiki.

Note

Community contributions to the documentation are welcome! If you see an empty topic and want to contribute, refer to the linked story in the topic for details.

See our Contributor guide </contributor/index> for more information.

Introduction

To get started fast with StarlingX, try the Virtual All-in-one Simplex installation </deploy_install_guides/r6_release/virtual/aio_simplex>, which requires a minimum of hardware and configuration.

Learn more about StarlingX:

introduction/index

Deployment configurations

deploy/index

Planning

planning/index

Installation guides

deploy_install_guides/index

Security

security/index

System configuration

system_configuration/index

Data networks

datanet/index

Node management

node_management/index

Storage

storage/index

Fault management

fault-mgmt/index

Backup and restore

backup/index

Updates

updates/index

Admin tasks

admintasks/index

User tasks

usertasks/index

Guest integration

guest_integration/index

Reference

api-ref/index cli_ref/index

Distributed Cloud

dist_cloud/index

Deprecated guides

The guides listed here have been replaced by new guides that provide more details.

Configuration

configuration/index

Operation guides

operations/index

General information

contributor/index releasenotes/index developer_resources/index Project Specifications <https://docs.starlingx.io/specs/>

Governance

StarlingX is a top-level OpenStack Foundation pilot project that is governed by two separate bodies: The OpenStack Foundation Board of Directors and the StarlingX Technical Steering Committee.

See StarlingX Governance for additional information about StarlingX project governance.