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

* See the :ref:`release-notes`.
* Download the pre-built ISO (CentOS and Debian) and Docker images for
  StarlingX latest release that are located at the ``StarlingX mirror`` repos:

  -  https://mirror.starlingx.windriver.com/mirror/starlingx/release/latest_release/debian/monolithic/outputs/iso/

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
:ref:`Virtual All-in-one Simplex Installation <virtual-aio-simplex>`, which
requires a minimum of hardware and configuration.

Learn more about StarlingX:

.. toctree::
   :maxdepth: 2

   introduction/index-intro-27197f27ad41

-------------------------
Deployment configurations
-------------------------

.. toctree::
   :maxdepth: 2

   deploy/index-deploy-da06a98b83b1

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

.. toctree::
   :maxdepth: 2

   planning/index-planning-332af0718d15

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

.. toctree::
   :maxdepth: 2

   deploy_install_guides/index-install-e083ca818006

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

.. toctree::
   :maxdepth: 2

   security/index-security-84d0d8aa401b


--------------------
System configuration
--------------------

.. toctree::
   :maxdepth: 2

   system_configuration/index-sysconf-d511820651f0


-------------
Data networks
-------------

.. toctree::
   :maxdepth: 2

   datanet/index-datanet-e316bf6c2f6a

---------------
Node management
---------------

.. toctree::
   :maxdepth: 2

   node_management/index-node-mgmt-cd0f9d8eaee6

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

.. toctree::
   :maxdepth: 2

   storage/index-storage-6cd708f1ada9


----------------
Fault management
----------------

.. toctree::
   :maxdepth: 2

   fault-mgmt/index-fault-98d5f50a9b8c


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

.. toctree::
   :maxdepth: 2

   backup/index-backup-1b466179efc3


-------
Updates
-------

.. toctree::
   :maxdepth: 2

   updates/index-updates-e3b970bb69ce


--------
KubeVirt
--------

.. toctree::
   :maxdepth: 2

   kube-virt/index-kubevirt-f1bfd2a21152


-----------
Admin tasks
-----------

.. toctree::
   :maxdepth: 2

   admintasks/index-admintasks-768a6e9aaeff


----------
User tasks
----------

.. toctree::
   :maxdepth: 2

   usertasks/index-usertasks-b18b379ab832


-----------------
Guest integration
-----------------

.. toctree::
   :maxdepth: 2

   guest_integration/index-guest-ef8c9a20bf6c


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

.. toctree::
   :maxdepth: 2

   api-ref/index
   cli_ref/index

-----------------
Distributed Cloud
-----------------

.. toctree::
   :maxdepth: 2

   dist_cloud/index-dist-cloud-f5dbeb16b976

------------------------------
Sample Application Deployments
------------------------------

.. toctree::
   :maxdepth: 2

   sample_apps/index-sample-apps-15fce86ad4bf


-----------------
Deprecated guides
-----------------

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


.. toctree::
   :maxdepth: 1

   archive/index-documentation-archive-900988dce206


.. toctree::
   :maxdepth: 1
   :hidden:

   configuration/index


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