docs/doc/source/index.rst
Ron Stone ec42ebdda0 TOC reorg
Implemented review comments on patchset 2
Resolved index.rst merge conflict
Incorporated review comments from Greg W.
Some master index.rst reorg and renaming.

•	Introduction
•	Deployment Configurations
•	Planning
•	Installation Guides
•	Security
•	System Configuration
•	Data Networks
•	Node Management
•	Storage
•	Fault Management
•	Backup and Restore
•	Administrator Tasks
•	User Tasks
•	Guest Integration
•	Container integration
•	REST API Reference
•	CLI Reference
•	Deprecated guides
•	Contributor guides
•	Release Notes
•	Developer Resources

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-28 16:39:46 -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 R4.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/r4_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

vnf_integration/index container_integration/kubernetes/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.