stx-docs refactoring for new doc structure
Changes included updating the StarlingX docs landing page to conform to a new list of available documents as follows: * StarlingX Introduction * Deployment Guides * Installation Guides * Developer resources * Operation Guides * Project Specifications * REST API Reference * Release Notes * Contribute So-called "dead-end" links have an explanation of content coming. Any destination associated with an existing story ID have the link to the story for reference. The existence of a "current" and "latest" Developer Guides resulted in the top-level list of doc resources including both the "Developer Guides" and "Developer Resources" bullets. Ideally, the Developer Guides would be included as part of the "Developer Resources" area. For "latest" they are. However, for "current" I left them alone since the 2018.10 release is out there. This organization can settle out as more releases launch. Finally, I did not focus on the writing aspect for this PR. That part can be cleaned up going forward. Change-Id: I0442e948d5d9a41add9eb3bdde8882c157a8f752 Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
This commit is contained in:
Scott Rifenbark
parent
822399f26e
commit
3b0b2b0199
|
|
@ -1,5 +1,5 @@
|
|||
=====================
|
||||
API Contributor Guide
|
||||
API contributor guide
|
||||
=====================
|
||||
|
||||
---------
|
||||
|
|
|
|||
|
|
@ -1,12 +1,9 @@
|
|||
===========================
|
||||
Developer guide stx.2018.10
|
||||
===========================
|
||||
=======================
|
||||
Build guide stx.2018.10
|
||||
=======================
|
||||
|
||||
This section contains the steps for building a StarlingX ISO from
|
||||
the "current" StarlingX software (i.e. the most recently released version).
|
||||
If this is not the software you want to use, see the
|
||||
:doc:`available developer guides </developer_guide/index>` for
|
||||
StarlingX.
|
||||
|
||||
------------
|
||||
Requirements
|
||||
|
|
@ -1,12 +1,9 @@
|
|||
===========================
|
||||
Developer guide stx.2019.05
|
||||
===========================
|
||||
=======================
|
||||
Build guide stx.2019.05
|
||||
=======================
|
||||
|
||||
This section contains the steps for building a StarlingX ISO from
|
||||
the "latest" StarlingX software (i.e. the "under development" branch).
|
||||
If this is not the software you want to use, see the
|
||||
:doc:`available developer guides </developer_guide/index>` for
|
||||
StarlingX.
|
||||
|
||||
------------
|
||||
Requirements
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
=============================
|
||||
StarlingX development process
|
||||
=============================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
.. Linked Story does not yet exist.
|
||||
|
||||
`Linked Story <https://storyboard.openstack.org/#!/story/2005173>`__
|
||||
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
===============================
|
||||
Documentation Contributor Guide
|
||||
Documentation contributor guide
|
||||
===============================
|
||||
|
||||
This guide provides information that allows you to contribute to the
|
||||
|
|
|
|||
|
|
@ -18,3 +18,40 @@ OpenStack documentation can be found in the
|
|||
api_contribute_guide
|
||||
release_note_contribute_guide
|
||||
doc_contribute_guide
|
||||
|
||||
For information on the StarlingX development process, see the following:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
development_process
|
||||
|
||||
Build guides for StarlingX are release-specific.
|
||||
The following list provides help on choosing the correct
|
||||
build guide based on a release:
|
||||
|
||||
- The "current" release is the most recent offically released version of StarlingX.
|
||||
Following is the current build guide:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
build_guides/current/index
|
||||
|
||||
- The "latest" release is the forthcoming version under development.
|
||||
Following is the latest build guide:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
build_guides/latest/index
|
||||
|
||||
- The "archived" build guides are as follows:
|
||||
|
||||
* Currently, no archived build guides exist.
|
||||
|
||||
|
||||
|
||||
.. When a new release of developer guides occurs, follow the steps in the
|
||||
commented block of the /installation_guide/index.rst file.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
===============================
|
||||
Release Notes Contributor Guide
|
||||
Release notes contributor guide
|
||||
===============================
|
||||
|
||||
Release notes for StarlingX projects are managed using Reno allowing release
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
===============================================
|
||||
Controller storage deployment guide stx.2019.05
|
||||
===============================================
|
||||
==============================
|
||||
Controller storage stx.2018.10
|
||||
==============================
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
==============================================
|
||||
Dedicated storage deployment guide stx.2018.10
|
||||
==============================================
|
||||
=============================
|
||||
Dedicated storage stx.2018.10
|
||||
=============================
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
==============================================
|
||||
All-In-One Duplex deployment guide stx.2019.05
|
||||
==============================================
|
||||
=============================
|
||||
All-in-one duplex stx.2018.10
|
||||
=============================
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
Before Width: | Height: | Size: 100 KiB After Width: | Height: | Size: 100 KiB |
|
Before Width: | Height: | Size: 107 KiB After Width: | Height: | Size: 107 KiB |
|
Before Width: | Height: | Size: 104 KiB After Width: | Height: | Size: 104 KiB |
|
Before Width: | Height: | Size: 89 KiB After Width: | Height: | Size: 89 KiB |
|
Before Width: | Height: | Size: 79 KiB After Width: | Height: | Size: 79 KiB |
|
|
@ -1,6 +1,6 @@
|
|||
===============================================
|
||||
All-In-One Simplex deployment guide stx.2019.05
|
||||
===============================================
|
||||
==============================
|
||||
All-in-one simplex stx.2018.10
|
||||
==============================
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
|
@ -0,0 +1,95 @@
|
|||
=================
|
||||
Deployment Guides
|
||||
=================
|
||||
|
||||
Deployment guides for StarlingX are release-specific.
|
||||
The following list provides help on choosing the correct deployment guide:
|
||||
|
||||
- The "current" release is the most recent offically released version of StarlingX.
|
||||
Following are the current deployment guides:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
../deployment_guides/current/simplex
|
||||
../deployment_guides/current/duplex
|
||||
../deployment_guides/current/controller_storage
|
||||
../deployment_guides/current/dedicated_storage
|
||||
|
||||
- The "latest" release is the forthcoming version under development.
|
||||
Following are the latest deployment guides:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
latest/planning/index
|
||||
latest/options/index
|
||||
latest/aio_simplex/index
|
||||
latest/aio_duplex/index
|
||||
latest/aio_duplex_computes/index
|
||||
latest/controller_storage/index
|
||||
latest/dedicated_storage/index
|
||||
latest/ironic/index
|
||||
latest/multi_region/index
|
||||
latest/dist_cloud/index
|
||||
|
||||
- Following are deployment guides for past StartlingX releases that have
|
||||
been archived:
|
||||
|
||||
* Currently, no archived deployment guides exist.
|
||||
|
||||
|
||||
.. Steps you must take when a new release of the installer and developer guides occurs:
|
||||
|
||||
.. 1. Archive the "current" release:
|
||||
1. Rename the "current" folder to the release name using the <Year_Month> convention (e.g. 2018_10).
|
||||
2. Get inside your new folder (i.e. the old "current" folder) and update all links in the *.rst
|
||||
files to use the new path (e.g. :doc:`Libvirt/QEMU </installation_guide/current/installation_libvirt_qemu>`
|
||||
becomes
|
||||
:doc:`Libvirt/QEMU </installation_guide/<Year_Month>/installation_libvirt_qemu>`
|
||||
3. You might want to change your working directory to /<Year_Month> and use Git to grep for
|
||||
the "current" string (i.e. 'git grep "current" *'). For each applicable occurence, make
|
||||
the call whether or not to convert the string to the actual archived string "<Year_Month>".
|
||||
Be sure to scrub all files for the "current" string in both the "installation_guide"
|
||||
and "developer_guide" folders downward.
|
||||
2. Add the new "current" release:
|
||||
1. Rename the existing "latest" folders to "current". This assumes that "latest" represented
|
||||
the under-development release that just officially released.
|
||||
2. Get inside your new folder (i.e. the old "latest" folder) and update all links in the *.rst
|
||||
files to use the new path (e.g. :doc:`Libvirt/QEMU </installation_guide/latest/installation_libvirt_qemu>`
|
||||
becomes
|
||||
:doc:`Libvirt/QEMU </installation_guide/current/installation_libvirt_qemu>`
|
||||
3. You might want to change your working directory to the "current" directory and use Git to grep for
|
||||
the "latest" string (i.e. 'git grep "latest" *'). For each applicable occurence, make
|
||||
the call whether or not to convert the string to "current".
|
||||
Be sure to scrub all files for the "latest" string in both the "installation_guide"
|
||||
and "developer_guide" folders downward.
|
||||
4. Because the "current" release is now available, make sure to update these pages:
|
||||
- index
|
||||
- installation guide
|
||||
- developer guide
|
||||
- release notes
|
||||
3. Create a new "latest" release, which are the installation and developer guides under development:
|
||||
1. Copy your "current" folders and rename them "latest".
|
||||
2. Make sure the new files have the correct version in the page title and intro
|
||||
sentence (e.g. '2019.10.rc1 Installation Guide').
|
||||
3. Make sure all files in new "latest" link to the correct versions of supporting
|
||||
docs. You do this through the doc link, so that it resolves to the top of the page
|
||||
(e.g. :doc:`/installation_guide/latest/index`)
|
||||
4. Make sure the new release index is labeled with the correct version name
|
||||
(e.g .. _index-2019-05:)
|
||||
5. Add the archived version to the toctree on this page. You want all possible versions
|
||||
to build.
|
||||
6. Since you are adding a new version ("latest") *before* it is available
|
||||
(e.g. to begin work on new docs), make sure page text still directs user to the
|
||||
"current" release and not to the under development version of the manuals.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
==============================================
|
||||
All-In-One Duplex deployment guide stx.2018.10
|
||||
==============================================
|
||||
=============================
|
||||
All-in-one duplex stx.2019.05
|
||||
=============================
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
|
@ -31,7 +31,7 @@ consolidated onto a protected pair of physical servers. For example:
|
|||
or different distributions of operating systems by using multiple virtual
|
||||
machines.
|
||||
|
||||
.. figure:: figures/starlingx-deployment-options-duplex.png
|
||||
.. figure:: ../figures/starlingx-deployment-options-duplex.png
|
||||
:scale: 50%
|
||||
:alt: All-In-One Duplex deployment configuration
|
||||
|
||||
|
|
@ -70,7 +70,7 @@ someone starting with an All-In-One Duplex deployment.
|
|||
With this option, virtual machines can be scheduled on either of the
|
||||
all-in-one controller nodes and/or the compute nodes.
|
||||
|
||||
.. figure:: figures/starlingx-deployment-options-duplex-extended.png
|
||||
.. figure:: ../figures/starlingx-deployment-options-duplex-extended.png
|
||||
:scale: 50%
|
||||
:alt: All-In-One Duplex Extended Deployment Configuration
|
||||
|
||||
|
|
@ -1507,14 +1507,14 @@ machines.
|
|||
Deployment terminology
|
||||
----------------------
|
||||
|
||||
.. include:: deployment_terminology.rst
|
||||
.. include:: ../deployment_terminology.rst
|
||||
:start-after: incl-simplex-deployment-terminology:
|
||||
:end-before: incl-simplex-deployment-terminology-end:
|
||||
|
||||
.. include:: deployment_terminology.rst
|
||||
.. include:: ../deployment_terminology.rst
|
||||
:start-after: incl-standard-controller-deployment-terminology:
|
||||
:end-before: incl-standard-controller-deployment-terminology-end:
|
||||
|
||||
.. include:: deployment_terminology.rst
|
||||
.. include:: ../deployment_terminology.rst
|
||||
:start-after: incl-common-deployment-terminology:
|
||||
:end-before: incl-common-deployment-terminology-end:
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
==========================================
|
||||
All-in-one duplex with up to four computes
|
||||
==========================================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
.. Linked Story does not yet exist.
|
||||
|
||||
`Linked Story <https://storyboard.openstack.org/#!/story/2005009>`__
|
||||
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
===============================================
|
||||
All-In-One Simplex deployment guide stx.2018.10
|
||||
===============================================
|
||||
==============================
|
||||
All-in-one simplex stx.2019.05
|
||||
==============================
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
|
@ -31,7 +31,7 @@ deployment you can:
|
|||
Only a small amount of cloud processing / storage power is required with an
|
||||
All-In-One Simplex deployment.
|
||||
|
||||
.. figure:: figures/starlingx-deployment-options-simplex.png
|
||||
.. figure:: ../figures/starlingx-deployment-options-simplex.png
|
||||
:scale: 50%
|
||||
:alt: All-In-One Simplex deployment configuration
|
||||
|
||||
|
|
@ -716,14 +716,14 @@ Nova Flavors, configure Neutron networks and launch Nova virtual machines.
|
|||
Deployment terminology
|
||||
----------------------
|
||||
|
||||
.. include:: deployment_terminology.rst
|
||||
.. include:: ../deployment_terminology.rst
|
||||
:start-after: incl-simplex-deployment-terminology:
|
||||
:end-before: incl-simplex-deployment-terminology-end:
|
||||
|
||||
.. include:: deployment_terminology.rst
|
||||
.. include:: ../deployment_terminology.rst
|
||||
:start-after: incl-standard-controller-deployment-terminology:
|
||||
:end-before: incl-standard-controller-deployment-terminology-end:
|
||||
|
||||
.. include:: deployment_terminology.rst
|
||||
.. include:: ../deployment_terminology.rst
|
||||
:start-after: incl-common-deployment-terminology:
|
||||
:end-before: incl-common-deployment-terminology-end:
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
===============================================
|
||||
Controller storage deployment guide stx.2018.10
|
||||
===============================================
|
||||
==============================
|
||||
Controller storage stx.2019.05
|
||||
==============================
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
|
@ -28,7 +28,7 @@ controller / storage cluster with:
|
|||
- Storage function running on top of LVM on single second disk, DRBD-sync'd
|
||||
between the controller nodes.
|
||||
|
||||
.. figure:: figures/starlingx-deployment-options-controller-storage.png
|
||||
.. figure:: ../figures/starlingx-deployment-options-controller-storage.png
|
||||
:scale: 50%
|
||||
:alt: Controller Storage deployment configuration
|
||||
|
||||
|
|
@ -965,10 +965,10 @@ virtual machines.
|
|||
Deployment terminology
|
||||
----------------------
|
||||
|
||||
.. include:: deployment_terminology.rst
|
||||
.. include:: ../deployment_terminology.rst
|
||||
:start-after: incl-standard-controller-deployment-terminology:
|
||||
:end-before: incl-standard-controller-deployment-terminology-end:
|
||||
|
||||
.. include:: deployment_terminology.rst
|
||||
.. include:: ../deployment_terminology.rst
|
||||
:start-after: incl-common-deployment-terminology:
|
||||
:end-before: incl-common-deployment-terminology-end:
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
==============================================
|
||||
Dedicated storage deployment guide stx.2019.05
|
||||
==============================================
|
||||
=============================
|
||||
Dedicated storage stx.2019.05
|
||||
=============================
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
|
@ -23,7 +23,7 @@ This deployment option provides the maximum capacity for a single region
|
|||
deployment, with a supported growth path to a multi-region deployment option by
|
||||
adding a secondary region.
|
||||
|
||||
.. figure:: figures/starlingx-deployment-options-dedicated-storage.png
|
||||
.. figure:: ../figures/starlingx-deployment-options-dedicated-storage.png
|
||||
:scale: 50%
|
||||
:alt: Dedicated Storage deployment configuration
|
||||
|
||||
|
|
@ -905,14 +905,14 @@ launch Nova virtual machines.
|
|||
Deployment terminology
|
||||
----------------------
|
||||
|
||||
.. include:: deployment_terminology.rst
|
||||
.. include:: ../deployment_terminology.rst
|
||||
:start-after: incl-standard-controller-deployment-terminology:
|
||||
:end-before: incl-standard-controller-deployment-terminology-end:
|
||||
|
||||
.. include:: deployment_terminology.rst
|
||||
.. include:: ../deployment_terminology.rst
|
||||
:start-after: incl-dedicated-storage-deployment-terminology:
|
||||
:end-before: incl-dedicated-storage-deployment-terminology-end:
|
||||
|
||||
.. include:: deployment_terminology.rst
|
||||
.. include:: ../deployment_terminology.rst
|
||||
:start-after: incl-common-deployment-terminology:
|
||||
:end-before: incl-common-deployment-terminology-end:
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
=================
|
||||
Distributed cloud
|
||||
=================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
.. Linked Story does not yet exist.
|
||||
|
||||
`Linked Story <https://storyboard.openstack.org/#!/story/2005013>`__
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 100 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 107 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 104 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 89 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 79 KiB |
|
|
@ -0,0 +1,10 @@
|
|||
====================
|
||||
Standard with Ironic
|
||||
====================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
.. Linked Story does not yet exist.
|
||||
|
||||
`Linked Story <https://storyboard.openstack.org/#!/story/2004795>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
============
|
||||
Multi-region
|
||||
============
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
.. Linked Story does not yet exist.
|
||||
|
||||
`Linked Story <https://storyboard.openstack.org/#!/story/2005012>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
==================
|
||||
Deployment options
|
||||
==================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
.. Linked Story does not yet exist.
|
||||
|
||||
`Linked Story <https://storyboard.openstack.org/#!/story/2005006>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
===================
|
||||
Deployment planning
|
||||
===================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
.. Linked Story does not yet exist.
|
||||
|
||||
`Linked Story <https://storyboard.openstack.org/#!/story/2005005>`__
|
||||
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
================
|
||||
Developer guides
|
||||
================
|
||||
|
||||
Developer guides for StarlingX are release-specific.
|
||||
The following list provides help on choosing the correct
|
||||
developer guide based on a release:
|
||||
|
||||
- The "current" release is the most recent offically released version of StarlingX.
|
||||
To build a StarlingX ISO from the current release, use the :doc:`/developer_guide/current/index`.
|
||||
|
||||
- The "latest" release is the forthcoming version under development.
|
||||
To build a StarlingX ISO using the latest release, use the :doc:`/developer_guide/latest/index`.
|
||||
|
||||
- Following are all available developer guides for StarlingX:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
/developer_guide/current/index
|
||||
/developer_guide/latest/index
|
||||
|
||||
.. When a new release of developer guides occurs, follow the steps in the
|
||||
commented block of the /installation_guide/index.rst file.
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
================================
|
||||
StarlingX architecture documents
|
||||
================================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2005184>`__
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
.. _developer_resources:
|
||||
|
||||
===================
|
||||
Developer Resources
|
||||
===================
|
||||
|
||||
StarlingX developer resources exist that help you understand the
|
||||
architecture of the documentation, how to navigate the StarlingX
|
||||
source code, and understand the development process.
|
||||
|
||||
The developer guide is release-specific.
|
||||
The following list provides help on choosing the correct
|
||||
developer guide based on a release:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
navigate_source_code
|
||||
architecture_docs
|
||||
Project Specifications <https://docs.starlingx.io/specs/>
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
=========================================
|
||||
How to navigate the StarlingX source code
|
||||
=========================================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2005184>`__
|
||||
|
||||
|
|
@ -16,12 +16,13 @@ Sections
|
|||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
introduction/index
|
||||
deployment_guides/index
|
||||
installation_guide/index
|
||||
developer_guide/index
|
||||
Project Specifications <https://docs.starlingx.io/specs/>
|
||||
api-ref/index
|
||||
releasenotes/index
|
||||
operation_guides/index
|
||||
contributor/index
|
||||
releasenotes/index
|
||||
developer_resources/index
|
||||
|
||||
--------
|
||||
Projects
|
||||
|
|
|
|||
|
|
@ -243,7 +243,7 @@ Unload firewall and disable firewall on boot:
|
|||
Getting the StarlingX ISO image
|
||||
-------------------------------
|
||||
|
||||
Follow the instructions from the :doc:`/developer_guide/current/index` to build a
|
||||
Follow the instructions from the :doc:`/contributor/build_guides/current/index` to build a
|
||||
StarlingX ISO image.
|
||||
|
||||
**********
|
||||
|
|
@ -271,19 +271,16 @@ Deployment options
|
|||
|
||||
- Standard controller
|
||||
|
||||
- :doc:`StarlingX Cloud with Dedicated Storage </installation_guide/current/dedicated_storage>`
|
||||
- :doc:`StarlingX Cloud with Controller Storage </installation_guide/current/controller_storage>`
|
||||
- :doc:`StarlingX Cloud with Dedicated Storage </deployment_guides/current/dedicated_storage>`
|
||||
- :doc:`StarlingX Cloud with Controller Storage </deployment_guides/current/controller_storage>`
|
||||
|
||||
- All-in-one
|
||||
|
||||
- :doc:`StarlingX Cloud Duplex </installation_guide/current/duplex>`
|
||||
- :doc:`StarlingX Cloud Simplex </installation_guide/current/simplex>`
|
||||
- :doc:`StarlingX Cloud Duplex </deployment_guides/current/duplex>`
|
||||
- :doc:`StarlingX Cloud Simplex </deployment_guides/current/simplex>`
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
installation_libvirt_qemu
|
||||
controller_storage
|
||||
dedicated_storage
|
||||
duplex
|
||||
simplex
|
||||
|
||||
|
|
|
|||
|
|
@ -195,10 +195,10 @@ controller-0 step.
|
|||
|
||||
- Standard controller
|
||||
|
||||
- :doc:`StarlingX Cloud with Dedicated Storage Virtual Environment </installation_guide/current/dedicated_storage>`
|
||||
- :doc:`StarlingX Cloud with Controller Storage Virtual Environment </installation_guide/current/controller_storage>`
|
||||
- :doc:`StarlingX Cloud with Dedicated Storage Virtual Environment </deployment_guides/current/dedicated_storage>`
|
||||
- :doc:`StarlingX Cloud with Controller Storage Virtual Environment </deployment_guides/current/controller_storage>`
|
||||
|
||||
- All-in-one
|
||||
|
||||
- :doc:`StarlingX Cloud Duplex Virtual Environment </installation_guide/current/duplex>`
|
||||
- :doc:`StarlingX Cloud Simplex Virtual Environment </installation_guide/current/simplex>`
|
||||
- :doc:`StarlingX Cloud Duplex Virtual Environment </deployment_guides/current/duplex>`
|
||||
- :doc:`StarlingX Cloud Simplex Virtual Environment </deployment_guides/current/simplex>`
|
||||
|
|
|
|||
|
|
@ -1,24 +1,31 @@
|
|||
===================
|
||||
Installation guides
|
||||
Installation Guides
|
||||
===================
|
||||
|
||||
Installation steps for StarlingX are release-specific.
|
||||
The following list provides help on choosing the correct installation steps:
|
||||
|
||||
- The "current" release is the most recent offically released version of StarlingX.
|
||||
To install the current release of StarlingX, use the :doc:`/installation_guide/current/index`.
|
||||
|
||||
- The "latest" release is the forthcoming version under development.
|
||||
To install the latest release of StarlingX, use the :doc:`/installation_guide/latest/index`.
|
||||
|
||||
- Following are all available installation steps for StarlingX:
|
||||
- The "current" release is the most recent offically released version of StarlingX:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
/installation_guide/current/index
|
||||
|
||||
- The "latest" release is the forthcoming version under development:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
/installation_guide/latest/index
|
||||
|
||||
- The "archived" installation documents are as follows:
|
||||
|
||||
* Currently, no archived installation documents exist.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
.. Steps you must take when a new release of the installer and developer guides occurs:
|
||||
|
||||
|
|
@ -67,3 +74,7 @@ The following list provides help on choosing the correct installation steps:
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,10 @@
|
|||
================================================
|
||||
Additional OpenStack Services Installation Guide
|
||||
================================================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2005181>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
==================================================
|
||||
All-in-one Duplex with Computes Installation Guide
|
||||
==================================================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
.. Linked Story does not yet exist.
|
||||
|
||||
`Linked Story <https://storyboard.openstack.org/#!/story/2005177>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
====================================
|
||||
Distributed Cloud Installation Guide
|
||||
====================================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
.. Linked Story does not yet exist.
|
||||
|
||||
`Linked Story <https://storyboard.openstack.org/#!/story/2005181>`__
|
||||
|
||||
|
|
@ -2,10 +2,9 @@
|
|||
Installation guide stx.2019.05
|
||||
==============================
|
||||
|
||||
This is the installation guide for the "latest" StarlingX software
|
||||
(i.e. the "under development" branch).
|
||||
If this is not the the installation guide you want to use,
|
||||
see the
|
||||
This is the installation guide for the "current" StarlingX software
|
||||
(i.e. the most recently released version).
|
||||
If this is not the installation guide you want to use, see the
|
||||
:doc:`available installation guides </installation_guide/index>`.
|
||||
|
||||
------------
|
||||
|
|
@ -244,7 +243,7 @@ Unload firewall and disable firewall on boot:
|
|||
Getting the StarlingX ISO image
|
||||
-------------------------------
|
||||
|
||||
Follow the instructions from the :doc:`/developer_guide/latest/index` to build a
|
||||
Follow the instructions from the :doc:`/contributor/build_guides/latest/index` to build a
|
||||
StarlingX ISO image.
|
||||
|
||||
**********
|
||||
|
|
@ -265,26 +264,34 @@ directory:
|
|||
|
||||
$ cp <starlingx iso image> $HOME/stx-tools/deployment/libvirt/
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
aio_duplex_computes
|
||||
additional_os_services
|
||||
multi_region
|
||||
dist_cloud
|
||||
installation_libvirt_qemu
|
||||
|
||||
------------------
|
||||
Deployment options
|
||||
------------------
|
||||
|
||||
- Standard controller
|
||||
|
||||
- :doc:`StarlingX Cloud with Dedicated Storage </installation_guide/latest/dedicated_storage>`
|
||||
- :doc:`StarlingX Cloud with Controller Storage </installation_guide/latest/controller_storage>`
|
||||
|
||||
- All-in-one
|
||||
|
||||
- :doc:`StarlingX Cloud Duplex </installation_guide/latest/duplex>`
|
||||
- :doc:`StarlingX Cloud Simplex </installation_guide/latest/simplex>`
|
||||
- :doc:`StarlingX Cloud Simplex </deployment_guides/latest/aio_simplex/index>`
|
||||
- :doc:`StarlingX Cloud Duplex </deployment_guides/latest/aio_duplex/index>`
|
||||
- :doc:`StarlingX Cloud Duplex with Computes </deployment_guides/latest/aio_duplex_computes/index>`
|
||||
|
||||
- Standard controller
|
||||
|
||||
- :doc:`StarlingX Cloud with Controller Storage </deployment_guides/latest/controller_storage/index>`
|
||||
- :doc:`StarlingX Cloud with Dedicated Storage </deployment_guides/latest/dedicated_storage/index>`
|
||||
|
||||
- Others
|
||||
|
||||
- :doc:`Multi-region </deployment_guides/latest/multi_region/index>`
|
||||
- :doc:`Distributed cloud </deployment_guides/latest/dist_cloud/index>`
|
||||
- :doc:`Additional OpenStack services <additional_os_services>`
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
installation_libvirt_qemu
|
||||
controller_storage
|
||||
dedicated_storage
|
||||
duplex
|
||||
simplex
|
||||
|
|
|
|||
|
|
@ -195,10 +195,10 @@ controller-0 step.
|
|||
|
||||
- Standard controller
|
||||
|
||||
- :doc:`StarlingX Cloud with Dedicated Storage Virtual Environment </installation_guide/latest/dedicated_storage>`
|
||||
- :doc:`StarlingX Cloud with Controller Storage Virtual Environment </installation_guide/latest/controller_storage>`
|
||||
- :doc:`StarlingX Cloud with Dedicated Storage Virtual Environment </deployment_guides/latest/dedicated_storage/index>`
|
||||
- :doc:`StarlingX Cloud with Controller Storage Virtual Environment </deployment_guides/latest/controller_storage/index>`
|
||||
|
||||
- All-in-one
|
||||
|
||||
- :doc:`StarlingX Cloud Duplex Virtual Environment </installation_guide/latest/duplex>`
|
||||
- :doc:`StarlingX Cloud Simplex Virtual Environment </installation_guide/latest/simplex>`
|
||||
- :doc:`StarlingX Cloud Duplex Virtual Environment </deployment_guides/latest/aio_duplex/index>`
|
||||
- :doc:`StarlingX Cloud Simplex Virtual Environment </deployment_guides/latest/aio_simplex/index>`
|
||||
|
|
|
|||
|
|
@ -0,0 +1,10 @@
|
|||
===============================
|
||||
Multi-Region Installation Guide
|
||||
===============================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
.. Linked Story does not yet exist.
|
||||
|
||||
`Linked Story <https://storyboard.openstack.org/#!/story/2005180>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
==================
|
||||
StarlingX in a box
|
||||
==================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
.. Linked Story does not yet exist.
|
||||
|
||||
`Linked Story <https://storyboard.openstack.org/#!/story/2005003>`__
|
||||
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
======================
|
||||
StarlingX Introduction
|
||||
======================
|
||||
|
||||
StarlingX encompasses many areas.
|
||||
The information in this section introduces you to StarlingX,
|
||||
describes how various users use StarlingX, how StarlingX
|
||||
behaves "out of the box", how software evaluation occurs, and
|
||||
a roadmap of the documentation.
|
||||
|
||||
Following are the introductory topics available for StarlingX:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
/introduction/intro
|
||||
/introduction/kubernetes
|
||||
/introduction/openstack
|
||||
/introduction/box
|
||||
/introduction/software_evaluation
|
||||
/introduction/roadmap
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
====================
|
||||
Project introduction
|
||||
====================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
`Linked Story <https://storyboard.openstack.org/#!/story/2005002>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
================
|
||||
Kubernetes users
|
||||
================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2005002>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
===============
|
||||
OpenStack users
|
||||
===============
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2005002>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
=====================
|
||||
Documentation roadmap
|
||||
=====================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2005003>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
=========================
|
||||
Software evaluation guide
|
||||
=========================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2005003>`__
|
||||
|
||||
|
|
@ -0,0 +1,92 @@
|
|||
================
|
||||
Operation Guides
|
||||
================
|
||||
|
||||
Operation guides for StarlingX are release-specific.
|
||||
The following list provides help on choosing the correct operations guide:
|
||||
|
||||
- The "current" release is the most recent offically released version of StarlingX.
|
||||
Following are the current operation guides:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
../api-ref/index
|
||||
|
||||
- The "latest" release is the forthcoming version under development.
|
||||
Following are the latest operation guides:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
../api-ref/index
|
||||
latest/cli_reference/index
|
||||
latest/data_network_config/index
|
||||
latest/ceph_storage_config/index
|
||||
latest/sdn_networking/index
|
||||
latest/kubernetes_cluster_guide/index
|
||||
latest/swift_config_management/index
|
||||
latest/fault_management/index
|
||||
latest/patching_guide/index
|
||||
latest/upgrade_guide/index
|
||||
|
||||
- Following are operation guides for past StartlingX releases that have
|
||||
been archived:
|
||||
|
||||
* Currently, no archived operation guides exist.
|
||||
|
||||
|
||||
.. Steps you must take when a new release of the installer and developer guides occurs:
|
||||
|
||||
.. 1. Archive the "current" release:
|
||||
1. Rename the "current" folder to the release name using the <Year_Month> convention (e.g. 2018_10).
|
||||
2. Get inside your new folder (i.e. the old "current" folder) and update all links in the *.rst
|
||||
files to use the new path (e.g. :doc:`Libvirt/QEMU </installation_guide/current/installation_libvirt_qemu>`
|
||||
becomes
|
||||
:doc:`Libvirt/QEMU </installation_guide/<Year_Month>/installation_libvirt_qemu>`
|
||||
3. You might want to change your working directory to /<Year_Month> and use Git to grep for
|
||||
the "current" string (i.e. 'git grep "current" *'). For each applicable occurence, make
|
||||
the call whether or not to convert the string to the actual archived string "<Year_Month>".
|
||||
Be sure to scrub all files for the "current" string in both the "installation_guide"
|
||||
and "developer_guide" folders downward.
|
||||
2. Add the new "current" release:
|
||||
1. Rename the existing "latest" folders to "current". This assumes that "latest" represented
|
||||
the under-development release that just officially released.
|
||||
2. Get inside your new folder (i.e. the old "latest" folder) and update all links in the *.rst
|
||||
files to use the new path (e.g. :doc:`Libvirt/QEMU </installation_guide/latest/installation_libvirt_qemu>`
|
||||
becomes
|
||||
:doc:`Libvirt/QEMU </installation_guide/current/installation_libvirt_qemu>`
|
||||
3. You might want to change your working directory to the "current" directory and use Git to grep for
|
||||
the "latest" string (i.e. 'git grep "latest" *'). For each applicable occurence, make
|
||||
the call whether or not to convert the string to "current".
|
||||
Be sure to scrub all files for the "latest" string in both the "installation_guide"
|
||||
and "developer_guide" folders downward.
|
||||
4. Because the "current" release is now available, make sure to update these pages:
|
||||
- index
|
||||
- installation guide
|
||||
- developer guide
|
||||
- release notes
|
||||
3. Create a new "latest" release, which are the installation and developer guides under development:
|
||||
1. Copy your "current" folders and rename them "latest".
|
||||
2. Make sure the new files have the correct version in the page title and intro
|
||||
sentence (e.g. '2019.10.rc1 Installation Guide').
|
||||
3. Make sure all files in new "latest" link to the correct versions of supporting
|
||||
docs. You do this through the doc link, so that it resolves to the top of the page
|
||||
(e.g. :doc:`/installation_guide/latest/index`)
|
||||
4. Make sure the new release index is labeled with the correct version name
|
||||
(e.g .. _index-2019-05:)
|
||||
5. Add the archived version to the toctree on this page. You want all possible versions
|
||||
to build.
|
||||
6. Since you are adding a new version ("latest") *before* it is available
|
||||
(e.g. to begin work on new docs), make sure page text still directs user to the
|
||||
"current" release and not to the under development version of the manuals.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
==========================
|
||||
CEPH storage configuration
|
||||
==========================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2004877>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
=============
|
||||
CLI reference
|
||||
=============
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2004877>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
==========================
|
||||
Data network configuration
|
||||
==========================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2004877>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
================
|
||||
Fault management
|
||||
================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2004877>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
==================
|
||||
Kubernetes cluster
|
||||
==================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2004877>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
========
|
||||
Patching
|
||||
========
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2004877>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
==============
|
||||
SDN networking
|
||||
==============
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2004877>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
==================================
|
||||
SWIFT configuration and management
|
||||
==================================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2004877>`__
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
=======
|
||||
Upgrade
|
||||
=======
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2004877>`__
|
||||
|
||||
Loading…
Reference in New Issue