openstack/devstack
Code Issues Proposed changes
f41479f370
devstack/doc/source/overview.rst

78 lines
2.0 KiB
ReStructuredText
Raw Normal View History

Remove old HTML headers Change-Id: I39107df88aeb89d3364ad479d8c313b7a79b9440
2014-10-29 22:08:13 -05:00
========
Overview
========
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
DevStack has evolved to support a large number of configuration options
and alternative platforms and support services. That evolution has grown
well beyond what was originally intended and the majority of
configuration combinations are rarely, if ever, tested. DevStack is not
a general OpenStack installer and was never meant to be everything to
doc changes to devstack overview.rst changed to comply with doc conventions When referring to services, use "Compute," "Image service" and "Identity" instead of "nova," "glance," and "keystone." Use the project names like "nova" and "keystone" glance is officially Image service not storage removed extra . Change-Id: I39457c20dc2ede775fe3f3c63077133fbb6c917b
2015-04-16 13:58:56 -04:00
everyone.
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
Below is a list of what is specifically is supported (read that as
"tested") going forward.
Supported Components
use a more common rst header hiearchy While rst doesn't actually care about the order of headers, reviewers sometimes do. And the build in emacs mode has a certain order specified that it can easily rotate between. Standardize on == h1, = h2, - h3, ~ h4 in the code. Change-Id: I80ff6df6ef0703a3c3005809069428018bb355d4
2014-11-18 06:51:16 -05:00
====================
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
Base OS
use a more common rst header hiearchy While rst doesn't actually care about the order of headers, reviewers sometimes do. And the build in emacs mode has a certain order specified that it can easily rotate between. Standardize on == h1, = h2, - h3, ~ h4 in the code. Change-Id: I80ff6df6ef0703a3c3005809069428018bb355d4
2014-11-18 06:51:16 -05:00
-------
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
*The OpenStack Technical Committee (TC) has defined the current CI
strategy to include the latest Ubuntu release and the latest RHEL
Correct various inaccuracies in overview.rst This still was referencing nova-network Change-Id: Id584d3fd26482330f42319aee4cb36981066db55
2017-05-02 08:49:17 -04:00
release.*
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
- Ubuntu: current LTS release plus current development release
Drop Fedora support Fedora 36 is EOL, also opendev is dropping support for Fedora images completely since interest in running jobs on that platform is no longer existing. CentOS 9 Stream has evolved as replacement platform for new features. Only drop the Zuul configuration and the tag in stack.sh for now plus update some docs. Cleanup of the deployment code will be done in a second step. Change-Id: Ica483fde27346e3939b5fc0d7e0a6dfeae0e8d1e
2023-06-07 15:19:37 +02:00
- RHEL/CentOS/RockyLinux: current major release
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
- Other OS platforms may continue to be included but the maintenance of
those platforms shall not be assumed simply due to their presence.
Having a listed point-of-contact for each additional OS will greatly
increase its chance of being well-maintained.
Drop Fedora support Fedora 36 is EOL, also opendev is dropping support for Fedora images completely since interest in running jobs on that platform is no longer existing. CentOS 9 Stream has evolved as replacement platform for new features. Only drop the Zuul configuration and the tag in stack.sh for now plus update some docs. Cleanup of the deployment code will be done in a second step. Change-Id: Ica483fde27346e3939b5fc0d7e0a6dfeae0e8d1e
2023-06-07 15:19:37 +02:00
- Patches for Ubuntu and/or RockyLinux will not be held up due to
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
side-effects on other OS platforms.
Databases
use a more common rst header hiearchy While rst doesn't actually care about the order of headers, reviewers sometimes do. And the build in emacs mode has a certain order specified that it can easily rotate between. Standardize on == h1, = h2, - h3, ~ h4 in the code. Change-Id: I80ff6df6ef0703a3c3005809069428018bb355d4
2014-11-18 06:51:16 -05:00
---------
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
*As packaged by the host OS*
- MySQL
Queues
use a more common rst header hiearchy While rst doesn't actually care about the order of headers, reviewers sometimes do. And the build in emacs mode has a certain order specified that it can easily rotate between. Standardize on == h1, = h2, - h3, ~ h4 in the code. Change-Id: I80ff6df6ef0703a3c3005809069428018bb355d4
2014-11-18 06:51:16 -05:00
------
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
*As packaged by the host OS*
- Rabbit
Web Server
use a more common rst header hiearchy While rst doesn't actually care about the order of headers, reviewers sometimes do. And the build in emacs mode has a certain order specified that it can easily rotate between. Standardize on == h1, = h2, - h3, ~ h4 in the code. Change-Id: I80ff6df6ef0703a3c3005809069428018bb355d4
2014-11-18 06:51:16 -05:00
----------
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
*As packaged by the host OS*
- Apache
OpenStack Network
use a more common rst header hiearchy While rst doesn't actually care about the order of headers, reviewers sometimes do. And the build in emacs mode has a certain order specified that it can easily rotate between. Standardize on == h1, = h2, - h3, ~ h4 in the code. Change-Id: I80ff6df6ef0703a3c3005809069428018bb355d4
2014-11-18 06:51:16 -05:00
-----------------
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
- Neutron: A basic configuration approximating the original FlatDHCP
mode using linuxbridge or OpenVSwitch.
Services
use a more common rst header hiearchy While rst doesn't actually care about the order of headers, reviewers sometimes do. And the build in emacs mode has a certain order specified that it can easily rotate between. Standardize on == h1, = h2, - h3, ~ h4 in the code. Change-Id: I80ff6df6ef0703a3c3005809069428018bb355d4
2014-11-18 06:51:16 -05:00
--------
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
doc changes to devstack overview.rst changed to comply with doc conventions When referring to services, use "Compute," "Image service" and "Identity" instead of "nova," "glance," and "keystone." Use the project names like "nova" and "keystone" glance is officially Image service not storage removed extra . Change-Id: I39457c20dc2ede775fe3f3c63077133fbb6c917b
2015-04-16 13:58:56 -04:00
The default services configured by DevStack are Identity (keystone),
Correct various inaccuracies in overview.rst This still was referencing nova-network Change-Id: Id584d3fd26482330f42319aee4cb36981066db55
2017-05-02 08:49:17 -04:00
Object Storage (swift), Image Service (glance), Block Storage
Add placement as default project in index webpage Change-Id: I101ade5368fbdf108906e89e1c3ba03a46cd6f35
2019-02-13 15:04:02 +09:00
(cinder), Compute (nova), Placement (placement),
Networking (neutron), Dashboard (horizon).
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
Additional services not included directly in DevStack can be tied in to
Pass through the rest of the docs Do the link cleanups and update a handful of things that were out of date. Change-Id: I758027bf3577c66cfb13df963516823a5c247080
2014-11-08 08:29:16 -06:00
``stack.sh`` using the :doc:`plugin mechanism <plugins>` to call
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
scripts that perform the configuration and startup of the service.
Node Configurations
use a more common rst header hiearchy While rst doesn't actually care about the order of headers, reviewers sometimes do. And the build in emacs mode has a certain order specified that it can easily rotate between. Standardize on == h1, = h2, - h3, ~ h4 in the code. Change-Id: I80ff6df6ef0703a3c3005809069428018bb355d4
2014-11-18 06:51:16 -05:00
-------------------
Convert all HTML doc to RST The motivation for this conversion is to have DevStack's docs be generated using a more familair workflow for OpenStack projects, using Sphinx. Changing from raw HTML to RST will also make it easier to contribute more documentation, as well as making edits less of a hassle. The majority of the work was done by using Pandoc to convert from HTML to RST, with minor edits to the output to remove errors in Sphinx. Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-21 11:40:08 -04:00
- single node
Correct various inaccuracies in overview.rst This still was referencing nova-network Change-Id: Id584d3fd26482330f42319aee4cb36981066db55
2017-05-02 08:49:17 -04:00
- multi-node configurations as are tested by the gate
Copy Permalink