From dc8d6256ceede391952375ffd896f4420e1f1937 Mon Sep 17 00:00:00 2001 From: Jean-Philippe Evrard Date: Tue, 20 Feb 2018 13:42:41 +0000 Subject: [PATCH] [Docs] Move AIO to first scenario With the ability to now have scenarii as first class citizens, we can move the AIO. Change-Id: I7d21bc49128b49bd6b2e6cf1b31938f1b81706d6 --- README.rst | 2 +- deploy-guide/source/index.rst | 2 +- doc/source/conf.py | 2 +- doc/source/contributor/index.rst | 1 - doc/source/contributor/scripts.rst | 7 +++---- .../quickstart-aio.rst => user/aio/quickstart.rst} | 10 +++++++--- .../{contributor => user/aio}/scenario-table-gen.html | 2 +- doc/source/user/index.rst | 5 +++++ 8 files changed, 19 insertions(+), 12 deletions(-) rename doc/source/{contributor/quickstart-aio.rst => user/aio/quickstart.rst} (99%) rename doc/source/{contributor => user/aio}/scenario-table-gen.html (89%) diff --git a/README.rst b/README.rst index eccb27120e..27567756a8 100644 --- a/README.rst +++ b/README.rst @@ -49,7 +49,7 @@ https://git.openstack.org/cgit/openstack/openstack-ansible-. .. _official OpenStack project: https://governance.openstack.org/reference/projects/index.html .. _Home Page: https://governance.openstack.org/reference/projects/openstackansible.html .. _Deployment Guide: https://docs.openstack.org/project-deploy-guide/openstack-ansible/latest -.. _Quick Start: https://docs.openstack.org/openstack-ansible/latest/contributor/quickstart-aio.html +.. _Quick Start: https://docs.openstack.org/openstack-ansible/latest/user/aio/quickstart.html .. _Developer Documentation: https://docs.openstack.org/openstack-ansible/latest/contributor/index.html .. _Source: https://git.openstack.org/cgit/openstack/openstack-ansible .. _OpenStack Mailing Lists: http://lists.openstack.org/ diff --git a/deploy-guide/source/index.rst b/deploy-guide/source/index.rst index 06bd4ab628..628f5e4443 100644 --- a/deploy-guide/source/index.rst +++ b/deploy-guide/source/index.rst @@ -9,7 +9,7 @@ intended for deployers. .. note:: If you want to do a quick proof of concept of OpenStack, read the - `All-In-One quickstart Guide `_ + `All-In-One quickstart Guide `_ instead of this document. This document is a walkthrough of a deploy using OpenStack-Ansible, with all its configurability. diff --git a/doc/source/conf.py b/doc/source/conf.py index a5020c4608..bf52d93195 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -29,7 +29,7 @@ import sys # Create dynamic table file. CONF_PATH = os.path.dirname(os.path.realpath(__file__)) -SCENARIO_TABLE = 'contributor/scenario-table-gen.html' +SCENARIO_TABLE = 'user/aio/scenario-table-gen.html' TABLE_FILE = os.path.join(CONF_PATH, SCENARIO_TABLE) stg = imp.load_source( 'scenario_table_gen', diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index d2078581be..7ad558c3df 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -24,7 +24,6 @@ Contents: .. toctree:: :maxdepth: 2 - quickstart-aio inventory-and-vars scripts contribute diff --git a/doc/source/contributor/scripts.rst b/doc/source/contributor/scripts.rst index 843e9035a4..95e53af2c4 100644 --- a/doc/source/contributor/scripts.rst +++ b/doc/source/contributor/scripts.rst @@ -51,13 +51,12 @@ arguments to ``ansible-playbook`` as a convenience. bootstrap-aio.sh ---------------- -The ``bootstrap-aio.sh`` script prepares a host for an `All-In-One`_ (AIO) +The ``bootstrap-aio.sh`` script prepares a host for an +:ref:`All-In-One ` (AIO) deployment for the purposes of development and gating. The script creates the necessary partitions, directories, and configurations. The script can be configured using environment variables - more details are provided on the -`All-In-One`_ page. - -.. _All-In-One: quickstart-aio.html +:ref:`All-In-One ` page. Development and Testing ^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/source/contributor/quickstart-aio.rst b/doc/source/user/aio/quickstart.rst similarity index 99% rename from doc/source/contributor/quickstart-aio.rst rename to doc/source/user/aio/quickstart.rst index 5894ebc2f1..fbcac8f6b0 100644 --- a/doc/source/contributor/quickstart-aio.rst +++ b/doc/source/user/aio/quickstart.rst @@ -1,6 +1,8 @@ -=========== -Quick Start -=========== +.. _quickstart-aio: + +=============== +Quickstart: AIO +=============== All-in-one (AIO) builds are a great way to perform an OpenStack-Ansible build for: @@ -234,6 +236,7 @@ Keystone service, execute: Rebooting an AIO ---------------- + As the AIO includes all three cluster members of MariaDB/Galera, the cluster has to be re-initialized after the host is rebooted. @@ -251,6 +254,7 @@ section in the operations guide. Rebuilding an AIO ----------------- + Sometimes it may be useful to destroy all the containers and rebuild the AIO. While it is preferred that the AIO is entirely destroyed and rebuilt, this isn't always practical. As such the following may be executed instead: diff --git a/doc/source/contributor/scenario-table-gen.html b/doc/source/user/aio/scenario-table-gen.html similarity index 89% rename from doc/source/contributor/scenario-table-gen.html rename to doc/source/user/aio/scenario-table-gen.html index d9ba1e6a2e..225fcfc0e5 100644 --- a/doc/source/contributor/scenario-table-gen.html +++ b/doc/source/user/aio/scenario-table-gen.html @@ -1 +1 @@ -
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
magnum      X
trove      X
octavia    X X
tacker     X 
novaXXXXX X
haproxyX XXXXX
sahara      X
cinderXXXX  X
glanceXXXXX X
swiftXXX   X
designateX X   X
neutronXXXXX X
ceph   X   
heatXXX  XX
keystoneXXXXXXX
horizonX X   X
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
designateX X   X
tacker     X 
horizonX X   X
ceph   X   
swiftXXX   X
neutronXXXXX X
glanceXXXXX X
haproxyX XXXXX
heatXXX  XX
octavia    X X
sahara      X
cinderXXXX  X
keystoneXXXXXXX
magnum      X
novaXXXXX X
trove      X
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
sahara      X
neutronXXXXX X
haproxyX XXXXX
glanceXXXXX X
novaXXXXX X
designateX X   X
heatXXX  XX
trove      X
keystoneXXXXXXX
magnum      X
octavia    X X
cinderXXXX  X
swiftXXX   X
ceph   X   
tacker     X 
horizonX X   X
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
cinderXXXX  X
tacker     X 
sahara      X
swiftXXX   X
neutronXXXXX X
horizonX X   X
designateX X   X
octavia    X X
magnum      X
keystoneXXXXXXX
ceph   X   
glanceXXXXX X
haproxyX XXXXX
heatXXX  XX
trove      X
novaXXXXX X
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
keystoneXXXXXXX
horizonX X   X
ceph   X   
heatXXX  XX
swiftXXX   X
designateX X   X
neutronXXXXX X
cinderXXXX  X
tacker     X 
glanceXXXXX X
magnum      X
haproxyX XXXXX
octavia    X X
novaXXXXX X
sahara      X
trove      X
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
ceph   X   
novaXXXXX X
cinderXXXX  X
swiftXXX   X
heatXXX  XX
sahara      X
trove      X
octavia    X X
tacker     X 
keystoneXXXXXXX
designateX X   X
neutronXXXXX X
magnum      X
haproxyX XXXXX
horizonX X   X
glanceXXXXX X
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
sahara      X
octavia    X X
cinderXXXX  X
tacker     X 
haproxyX XXXXX
swiftXXX   X
trove      X
novaXXXXX X
designateX X   X
magnum      X
keystoneXXXXXXX
neutronXXXXX X
horizonX X   X
ceph   X   
glanceXXXXX X
heatXXX  XX
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
swiftXXX   X
designateX X   X
neutronXXXXX X
cinderXXXX  X
glanceXXXXX X
keystoneXXXXXXX
horizonX X   X
ceph   X   
tacker     X 
heatXXX  XX
novaXXXXX X
magnum      X
trove      X
sahara      X
octavia    X X
haproxyX XXXXX
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
magnum      X
haproxyX XXXXX
sahara      X
trove      X
tacker     X 
octavia    X X
novaXXXXX X
ceph   X   
heatXXX  XX
keystoneXXXXXXX
horizonX X   X
cinderXXXX  X
glanceXXXXX X
swiftXXX   X
designateX X   X
neutronXXXXX X
\ No newline at end of file +
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
magnum      X
trove      X
octavia    X X
tacker     X 
novaXXXXX X
haproxyX XXXXX
sahara      X
cinderXXXX  X
glanceXXXXX X
swiftXXX   X
designateX X   X
neutronXXXXX X
ceph   X   
heatXXX  XX
keystoneXXXXXXX
horizonX X   X
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
designateX X   X
tacker     X 
horizonX X   X
ceph   X   
swiftXXX   X
neutronXXXXX X
glanceXXXXX X
haproxyX XXXXX
heatXXX  XX
octavia    X X
sahara      X
cinderXXXX  X
keystoneXXXXXXX
magnum      X
novaXXXXX X
trove      X
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
sahara      X
neutronXXXXX X
haproxyX XXXXX
glanceXXXXX X
novaXXXXX X
designateX X   X
heatXXX  XX
trove      X
keystoneXXXXXXX
magnum      X
octavia    X X
cinderXXXX  X
swiftXXX   X
ceph   X   
tacker     X 
horizonX X   X
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
cinderXXXX  X
tacker     X 
sahara      X
swiftXXX   X
neutronXXXXX X
horizonX X   X
designateX X   X
octavia    X X
magnum      X
keystoneXXXXXXX
ceph   X   
glanceXXXXX X
haproxyX XXXXX
heatXXX  XX
trove      X
novaXXXXX X
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
keystoneXXXXXXX
horizonX X   X
ceph   X   
heatXXX  XX
swiftXXX   X
designateX X   X
neutronXXXXX X
cinderXXXX  X
tacker     X 
glanceXXXXX X
magnum      X
haproxyX XXXXX
octavia    X X
novaXXXXX X
sahara      X
trove      X
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
ceph   X   
novaXXXXX X
cinderXXXX  X
swiftXXX   X
heatXXX  XX
sahara      X
trove      X
octavia    X X
tacker     X 
keystoneXXXXXXX
designateX X   X
neutronXXXXX X
magnum      X
haproxyX XXXXX
horizonX X   X
glanceXXXXX X
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
sahara      X
octavia    X X
cinderXXXX  X
tacker     X 
haproxyX XXXXX
swiftXXX   X
trove      X
novaXXXXX X
designateX X   X
magnum      X
keystoneXXXXXXX
neutronXXXXX X
horizonX X   X
ceph   X   
glanceXXXXX X
heatXXX  XX
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
swiftXXX   X
designateX X   X
neutronXXXXX X
cinderXXXX  X
glanceXXXXX X
keystoneXXXXXXX
horizonX X   X
ceph   X   
tacker     X 
heatXXX  XX
novaXXXXX X
magnum      X
trove      X
sahara      X
octavia    X X
haproxyX XXXXX
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
magnum      X
haproxyX XXXXX
sahara      X
trove      X
tacker     X 
octavia    X X
novaXXXXX X
ceph   X   
heatXXX  XX
keystoneXXXXXXX
horizonX X   X
cinderXXXX  X
glanceXXXXX X
swiftXXX   X
designateX X   X
neutronXXXXX X
aio_lxcaio_metalaio_nspawncephoctaviatackertranslations
haproxyX XXXXX
heatXXX  XX
keystoneXXXXXXX
trove      X
tacker     X 
designateX X   X
novaXXXXX X
horizonX X   X
sahara      X
ceph   X   
glanceXXXXX X
swiftXXX   X
octavia    X X
magnum      X
neutronXXXXX X
cinderXXXX  X
\ No newline at end of file diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 7249523031..bad26ab7a2 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -18,3 +18,8 @@ see the :dev_docs:`Contributors Guide `. For in-depth technical information, see the :dev_docs:`OpenStack-Ansible Reference `. + +.. toctree:: + :maxdepth: 1 + + aio/quickstart.rst