ea352faeaa
Patchset 4: removed ref to downstream doc. Patchset 3: fixed errors, removed limitation, added changes to main landing page/index. Patchset 2: added reviewer feedback, fixed table Change-Id: I9f11478c85444c6feccfde0a298355c5e19c37b6 Signed-off-by: MCamp859 <maryx.camp@intel.com>
251 lines
3.9 KiB
ReStructuredText
Executable File
251 lines
3.9 KiB
ReStructuredText
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 is StarlingX R6.0.**
|
|
|
|
* See the :ref:`release-notes`.
|
|
* Download the `R6.0 StarlingX ISO image
|
|
<http://mirror.starlingx.cengn.ca/mirror/starlingx/release/6.0/centos/flock/outputs/>`_
|
|
from the CENGN StarlingX mirror.
|
|
|
|
For more information about the StarlingX project, refer to the
|
|
`StarlingX wiki <https://wiki.openstack.org/wiki/StarlingX>`_.
|
|
|
|
.. 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 :doc:`Contributor guide </contributor/index>` for more information.
|
|
|
|
------------
|
|
Introduction
|
|
------------
|
|
|
|
To get started fast with StarlingX, try the
|
|
:doc:`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:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
introduction/index
|
|
|
|
-------------------------
|
|
Deployment configurations
|
|
-------------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
deploy/index
|
|
|
|
--------
|
|
Planning
|
|
--------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
planning/index
|
|
|
|
-------------------
|
|
Installation guides
|
|
-------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
deploy_install_guides/index
|
|
|
|
--------
|
|
Security
|
|
--------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
security/index
|
|
|
|
|
|
--------------------
|
|
System configuration
|
|
--------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
system_configuration/index
|
|
|
|
|
|
-------------
|
|
Data networks
|
|
-------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
datanet/index
|
|
|
|
---------------
|
|
Node management
|
|
---------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
node_management/index
|
|
|
|
-------
|
|
Storage
|
|
-------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
storage/index
|
|
|
|
|
|
----------------
|
|
Fault management
|
|
----------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
fault-mgmt/index
|
|
|
|
|
|
------------------
|
|
Backup and restore
|
|
------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
backup/index
|
|
|
|
|
|
-------
|
|
Updates
|
|
-------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
updates/index
|
|
|
|
|
|
-----------
|
|
Admin tasks
|
|
-----------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
admintasks/index
|
|
|
|
|
|
----------
|
|
User tasks
|
|
----------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
usertasks/index
|
|
|
|
|
|
-----------------
|
|
Guest integration
|
|
-----------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
guest_integration/index
|
|
|
|
|
|
---------
|
|
Reference
|
|
---------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
api-ref/index
|
|
cli_ref/index
|
|
|
|
-----------------
|
|
Distributed Cloud
|
|
-----------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
dist_cloud/index
|
|
|
|
-----------------
|
|
Deprecated guides
|
|
-----------------
|
|
|
|
The guides listed here have been replaced by new guides that provide more
|
|
details.
|
|
|
|
*************
|
|
Configuration
|
|
*************
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
configuration/index
|
|
|
|
|
|
****************
|
|
Operation guides
|
|
****************
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
operations/index
|
|
|
|
|
|
-------------------
|
|
General information
|
|
-------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
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.
|
|
|
|
.. _`OpenStack Foundation Board of Directors`: https://wiki.openstack.org/wiki/Governance/Foundation
|
|
.. _`StarlingX Technical Steering Committee`: https://docs.starlingx.io/governance/reference/tsc/
|
|
.. _`StarlingX Governance`: https://docs.starlingx.io/governance/
|
|
|
|
|