Rename and update links related to tripleo-ansible roles

During the latest cycles, role names were changed, replacing the hyphen
by underscore.

Change-Id: Ib62963bef59062ac9d81d0cf1f3972a08335af9d
This commit is contained in:
Cédric Jeanneret 2020-08-12 11:07:55 +02:00
parent f32bea5415
commit 64aee82ad8
5 changed files with 16 additions and 16 deletions

View File

@ -415,8 +415,8 @@ Load global variables
tags: always
Common roles for TripleO servers
Applies common ansible roles to all overcloud nodes. Includes
``tripleo-bootstrap`` for installing bootstrap packages and
``tripleo-ssh-known-hosts`` for configuring ssh known hosts.
``tripleo_bootstrap`` for installing bootstrap packages and
``tripleo_ssh_known_hosts`` for configuring ssh known hosts.
tags: common_roles
Overcloud deploy step tasks for step 0
@ -445,7 +445,7 @@ Overcloud deploy step tasks for [1,2,3,4,5]
Overcloud common deploy step tasks [1,2,3,4,5]
Applies the common tasks done at each step to include puppet host
configuration, ``container-puppet.py``, and ``paunch`` or
``tripleo-container-manage`` Ansible role (container configuration).
``tripleo_container_manage`` Ansible role (container configuration).
tags: overcloud, deploy_setps
Server Post Deployments

View File

@ -22,7 +22,7 @@ runtime and image components from the docker packages. The installed components
include the docker daemon system service and `OCI`_ compliant `Moby`_ and
`Containerd`_ - the building blocks for the container system.
Containers control plane includes `Paunch`_ or tripleo-container-manage_ and
Containers control plane includes `Paunch`_ or tripleo_container_manage_ and
systemd for the stateless services, and Pacemaker `Bundle`_ for the
containerized stateful services, like the messaging system or database.
@ -96,7 +96,7 @@ Paunch
------
.. note:: During Ussuri cycle, Paunch has been replaced by the
tripleo-container-manage_ Ansible role. Therefore, the following block
tripleo_container_manage_ Ansible role. Therefore, the following block
is deprecated in favor of the new role. However, the JSON input remains
backward compatible and the containers are configured the same way as it
was with Paunch.
@ -123,7 +123,7 @@ defined in the service's yaml file. Refer to the `Docker specific settings`_
section for more info on this.
.. _paunch: https://github.com/openstack/paunch
.. _tripleo-container-manage: https://docs.openstack.org/tripleo-ansible/latest/roles/role-tripleo-container-manage.html
.. _tripleo_container_manage: https://docs.openstack.org/tripleo-ansible/latest/roles/role-tripleo_container_manage.html
TripleO Heat Templates
----------------------

View File

@ -226,19 +226,19 @@ The following commands are useful for debugging containers.
$ docker run --rm $OUTPUT_FROM_PREVIOUS_COMMAND /bin/bash
Debugging with tripleo-container-manage Ansible role
Debugging with tripleo_container_manage Ansible role
----------------------------------------------------
The debugging manual for tripleo-container-manage is documented in the role_
The debugging manual for tripleo_container_manage is documented in the role_
directly.
.. _role: https://docs.openstack.org/tripleo-ansible/latest/roles/role-tripleo-container-manage.html#debug
.. _role: https://docs.openstack.org/tripleo-ansible/latest/roles/role-tripleo_container_manage.html#debug
Debugging with Paunch
---------------------
.. note:: During Ussuri cycle, Paunch has been replaced by the
tripleo-container-manage Ansible role. Therefore, the following block
tripleo_container_manage Ansible role. Therefore, the following block
is deprecated in favor of the new role which contains a Debug manual.
The ``paunch debug`` command allows you to perform specific actions on a given

View File

@ -433,7 +433,7 @@ explicitly write on which step to start which container. Steps are set as keys
with the ``step_<step number>`` format. Inside these, we should set up keys
with the specific container names. In our example, we're running only the etcd
container, so we use a key called ``etcd`` to give it such a name.
`Paunch`_ or tripleo-container-manage_ Ansible role will read these parameters,
`Paunch`_ or tripleo_container_manage_ Ansible role will read these parameters,
and start the containers with those settings.
Here's an example of the container definition::
@ -512,5 +512,5 @@ run as part of the steps (you can specify several of these, divided by the
.. _common/services.yaml: https://github.com/openstack/tripleo-heat-templates/blob/stable/queens/common/services.yaml#L44
.. _container image prepare workflow: https://docs.openstack.org/tripleo-docs/latest/install/containers_deployment/overcloud.html#preparing-overcloud-images
.. _Paunch: https://docs.openstack.org/paunch/readme.html
.. _tripleo-container-manage: https://docs.openstack.org/tripleo-ansible/latest/roles/role-tripleo-container-manage.html
.. _tripleo_container_manage: https://docs.openstack.org/tripleo-ansible/latest/roles/role-tripleo_container_manage.html
.. _privileged: https://www.linux.com/blog/learn/sysadmin/2017/5/lazy-privileged-docker-containers

View File

@ -130,9 +130,9 @@ Writing update logic for a service
Simple config/image replacement
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If the service is managed by Paunch_ or tripleo-container-manage_ Ansible role,
If the service is managed by Paunch_ or tripleo_container_manage_ Ansible role,
it may be that there's no need to write any update tasks. Paunch or
tripleo-container-manage can automatically handle simple updates: change in
tripleo_container_manage can automatically handle simple updates: change in
configuration or change of container image URL triggers automatic removal of
the old container and creation of new one with latest config and latest image.
If that's all the service needs for updates, you don't need to create any
@ -141,7 +141,7 @@ If that's all the service needs for updates, you don't need to create any
Custom tasks during updates
~~~~~~~~~~~~~~~~~~~~~~~~~~~
If the service is not managed by Paunch_ nor tripleo-container-manage, or if
If the service is not managed by Paunch_ nor tripleo_container_manage_, or if
the simple container replacement done by Paunch is not sufficient for the
service update, you will need to include custom update logic. This is done via
providing these outputs in your composable service template:
@ -153,7 +153,7 @@ providing these outputs in your composable service template:
the node being updated.
.. _Paunch: https://opendev.org/openstack/paunch/src/branch/master/README.rst
.. _tripleo-container-manage: https://docs.openstack.org/tripleo-ansible/latest/roles/role-tripleo-container-manage.html
.. _tripleo_container_manage: https://docs.openstack.org/tripleo-ansible/latest/roles/role-tripleo_container_manage.html
Update tasks are generally meant to bring the service into a stopped
state (sometimes with pre-fetched new images, this is necessary for