======================================
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.**

* See the :ref:`release-notes`.
* Download the `R4.0 StarlingX ISO image
  <http://mirror.starlingx.cengn.ca/mirror/starlingx/release/4.0.1/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.

-----------
Get started
-----------

To get started fast with StarlingX, try the
:doc:`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:

.. toctree::
   :maxdepth: 2

   introduction/index

--------
Planning
--------

.. toctree::
   :maxdepth: 2
   
   planning/index

-----------------
Deployment guides
-----------------

.. toctree::
   :maxdepth: 2

   deploy/index

-------------------
Installation guides
-------------------

.. toctree::
   :maxdepth: 2

   deploy_install_guides/index

-------------
Configuration
-------------

.. toctree::
   :maxdepth: 2

   configuration/index

------------------------------------------------
Data Network Configuration and Management Guides
------------------------------------------------

.. toctree::
   :maxdepth: 2
   
   datanet/index

---------------
Node Management
---------------

.. toctree::
   :maxdepth: 2
   
   node_management/index

--------
Security
--------

.. toctree::
   :maxdepth: 2

   security/index

--------------------
System Configuration
--------------------

.. toctree::
   :maxdepth: 2

   system_configuration/index

----------------
Fault Management
----------------

.. toctree::
   :maxdepth: 2

   fault-mgmt/index

-----------
Admin Tasks
-----------

.. toctree::
   :maxdepth: 2

   admintasks/index

----------
User Tasks
----------

.. toctree::
   :maxdepth: 2

   usertasks/index

-------
Storage
-------

.. toctree::
   :maxdepth: 2

   storage/index

----------------
Operation guides
----------------

.. toctree::
   :maxdepth: 2

   operations/index

------------------
Backup and restore
------------------

.. toctree::
   :maxdepth: 2

   backup/index

---------
Reference
---------

.. toctree::
   :maxdepth: 2

   api-ref/index
   cli_ref/index

-------------------
General information
-------------------

.. toctree::
   :maxdepth: 1

   contributor/index
   releasenotes/index
   developer_resources/index

----------
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/