openstack/openstack-ansible-os_heat
Code Issues Proposed changes

docs: add link to OSA deployment guide for adding a role

Browse Source 
Provide a direct reference to the OpenStack-Ansible deploy guide, helping users understand how to integrate a new role into their deployment.

Change-Id: I386f99321e56453670e6941435572a84f826d3ff
Signed-off-by: Dmitriy Chubinidze <dcu995@gmail.com>
This commit is contained in:
Dmitriy Chubinidze
2025-08-18 17:33:15 +00:00
parent ca074bf6b2
commit 1a2ca7391b
1 changed files with 36 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
doc/source/index.rst
View File

@@ -2,12 +2,9 @@
Heat role for OpenStack-Ansible
===============================
Dependencies
~~~~~~~~~~~~
This role needs pip >= 7.1 installed on the target host.
To use this role, define the following variables:
.. code-block:: yaml
@@ -30,7 +27,7 @@ To use this role, define the following variables:
keystone_auth_admin_password: "secrete"
To clone or view the source code for this repository, visit the role repository
for `os_heat <https://github.com/openstack/openstack-ansible-os_heat>`_.
for `os_heat <https://opendev.org/openstack/openstack-ansible-os_heat>`_.
Default variables
~~~~~~~~~~~~~~~~~
@@ -39,6 +36,41 @@ Default variables
:language: yaml
:start-after: under the License.
Adding The Service to Your OpenStack-Ansible Deployment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To add a new service to your OpenStack-Ansible (OSA) deployment:
* Define ``orchestration_hosts`` in your ``conf.d`` or
``openstack_user_config.yml``. For example:
.. code-block:: yaml
orchestration_hosts:
infra1:
ip: 172.20.236.111
infra2:
ip: 172.20.236.112
infra3:
ip: 172.20.236.113
* Create respective LXC containers (skip this step for metal deployments):
.. code-block:: console
openstack-ansible openstack.osa.containers_lxc_create --limit heat_all,orchestration_hosts
* Run service deployment playbook:
.. code-block:: console
openstack-ansible openstack.osa.heat
For more information, please refer to the `OpenStack-Ansible project documentation <https://docs.openstack.org/project-deploy-guide/openstack-ansible/latest/>`_.
Always verify that the integration is successful and that the service behaves
correctly before using it in a production environment.
Example playbook
~~~~~~~~~~~~~~~~