From f443e9316e0e897c56dbc5dfb8c03d9c9073a883 Mon Sep 17 00:00:00 2001 From: Dmitriy Rabotyagov Date: Tue, 19 Sep 2023 11:55:29 +0200 Subject: [PATCH] [doc] Update deploy guide with relevant roles Change-Id: Iaf650e7f8895b0c6f8e3c551586048a438fd02b9 --- deploy-guide/source/conf.py | 5 ++++- deploy-guide/source/configure.rst | 34 +++++++++++++++++++++++++++---- 2 files changed, 34 insertions(+), 5 deletions(-) diff --git a/deploy-guide/source/conf.py b/deploy-guide/source/conf.py index f2d472517d..ebe37186f6 100644 --- a/deploy-guide/source/conf.py +++ b/deploy-guide/source/conf.py @@ -60,6 +60,8 @@ dev_docs_prefix = ("https://docs.openstack.org/openstack-ansible/" "{}/%s".format(current_series)) role_docs_prefix = ("https://docs.openstack.org/openstack-ansible-" "%s/{}".format(current_series)) +ansible_role_docs_prefix = ("https://docs.openstack.org/ansible-role-" + "%s/{}".format(current_series)) # Substitutions loader rst_epilog = """ @@ -73,7 +75,8 @@ rst_epilog = """ # Format: Reference name: (string containing %s for substitution, linkname) extlinks = {'deploy_guide': (deploy_guide_prefix, ''), 'dev_docs': (dev_docs_prefix, ''), - 'role_docs': (role_docs_prefix, '') + 'role_docs': (role_docs_prefix, ''), + 'ansible_role_docs': (ansible_role_docs_prefix, '') } # If extensions (or modules to document with autodoc) are in another directory, diff --git a/deploy-guide/source/configure.rst b/deploy-guide/source/configure.rst index be9ec5b1f9..dfdd5a3a0f 100644 --- a/deploy-guide/source/configure.rst +++ b/deploy-guide/source/configure.rst @@ -110,6 +110,8 @@ about the available options. Infrastructure service roles ---------------------------- +- :ansible_role_docs:`PKI ` + - :role_docs:`galera_server ` - :role_docs:`haproxy_server ` @@ -120,6 +122,8 @@ Infrastructure service roles - :role_docs:`repo_server ` +- :ansible_role_docs:`Zookeeper ` + OpenStack service roles ----------------------- @@ -134,6 +138,8 @@ OpenStack service roles - :role_docs:`os_cinder ` +- :role_docs:`os_cloudkitty ` + - :role_docs:`os_designate ` - :role_docs:`os_glance ` @@ -154,12 +160,18 @@ OpenStack service roles - :role_docs:`os_masakari ` +- :role_docs:`os_mistral ` + +- :role_docs:`os_murano ` + - :role_docs:`os_neutron ` - :role_docs:`os_nova ` - :role_docs:`os_octavia ` +- :role_docs:`os_placement ` + - :role_docs:`os_rally ` - :role_docs:`os_sahara ` @@ -168,10 +180,14 @@ OpenStack service roles - :role_docs:`os_swift ` +- :role_docs:`os_tacker ` + - :role_docs:`os_tempest ` - :role_docs:`os_trove ` +- :role_docs:`os_zun ` + Other roles ----------- @@ -180,18 +196,28 @@ Other roles - :role_docs:`ceph_client ` -- :role_docs:`galera_client ` - - :role_docs:`lxc_container_create ` - :role_docs:`lxc_hosts ` -- :role_docs:`plugins ` - - :role_docs:`openstack_hosts ` - :role_docs:`openstack_openrc ` +- :role_docs:`plugins ` + +- :ansible_role_docs:`python_venv_build ` + +- :ansible_role_docs:`systemd_service ` + +- :ansible_role_docs:`systemd_mount ` + +- :ansible_role_docs:`systemd_networkd ` + +- :ansible_role_docs:`unbound ` + +- :ansible_role_docs:`uWSGI ` + Configuring service credentials ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~