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

66 lines
2.2 KiB
ReStructuredText

============
Introduction
============
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.
Key features of StarlingX include:
* Provided as a single, easy to install package that includes an operating system,
storage and networking components, and all the cloud infrastructure needed to
run edge workloads.
* Optimized software that meets edge application requirements.
* Designed with pre-defined configurations to meet a variety of edge cloud deployment
needs.
* Tested and released as a complete stack, ensuring compatibility among open
source components.
* Included fault management and service management capabilities, which provide
high availability for user applications.
* Optimized by the community for security, ultra-low latency, extremely high
service uptime, and streamlined operation.
Download the StarlingX ISO image from the
`CENGN StarlingX mirror <http://mirror.starlingx.cengn.ca/mirror/starlingx/>`_.
Learn more about StarlingX:
.. toctree::
:maxdepth: 1
functional_overview
deploy_config_overview
deploy_options
terms
consuming
StarlingX Project Overview (PDF) <https://www.starlingx.io/collateral/StarlingX_Onboarding_Deck_for_Web.pdf>
.. _stx_projects:
--------
Projects
--------
StarlingX contains multiple sub-projects that include additional edge cloud
support services and clients. API documentation and release notes for each
project are found on the specific project page:
* `Bare Metal </metal/index.html>`__
* `Clients </clients/index.html>`__
* `Config </config/index.html>`__
* `Distributed Cloud </distcloud/index.html>`__
* `Distributed Cloud Client </distcloud-client/index.html>`__
* `Fault Management </fault/index.html>`__
* `High Availability </ha/index.html>`__
* `Horizon Plugin (GUI) </gui/index.html>`__
* `Integration </integ/index.html>`__
* `NFV </nfv/index.html>`__
* `Software Updates </update/index.html>`__
* `Upstream </upstream/index.html>`__
Supporting projects and repositories:
* `Tools </tools/index.html>`__
For additional information about project teams, refer to the
`StarlingX wiki <https://wiki.openstack.org/wiki/StarlingX>`_.