Deprecate kolla-tags and kolla-limit

Deprecates the options ``--kolla-tags``, ``--kolla-skip-tags``, and
``kolla-limit``. Regular ``--tags``, ``--skip-tags``, and ``--limit``
will now be passed directly to the Kolla-Ansible invocations. The
``kayobe-generate-config`` tag is added to ``kolla-ansible.yml`` and
``kolla-openstack.yml``. It is always called, to allow for limiting to
OpenStack services with just one tag, e.g. ``kayobe overcloud service
deploy -t nova`. You can still skip this with
``--skip-tags kayobe-generate-config``.

Also adds the ``bifrost`` tag to ``kolla-bifrost.yml``, so that we can
easily limit to bifrost in the seed service deploy.

As there is no clean way to handle some of Ansible's "special" tags
like ``none``, using both regular and kolla tags/limits together is no
longer allowed.

Change-Id: I6f466305d49031da4d048f8fa7d2625b261a6fa0
Signed-off-by: Matt Crees <mattc@stackhpc.com>
Co-Authored-By: Will Szumski <will@stackhpc.com>

Author: 2 people

ansible/kayobe-target-venv.yml

@@ -26,7 +26,9 @@
         filter: "{{ kayobe_ansible_setup_filter }}"
         gather_subset: "{{ kayobe_ansible_setup_gather_subset }}"
       when:
-        - ansible_facts is undefined or ansible_facts is falsy
+        #TODO(mattcrees): Enable this check once this bug is fixed:
+        # https://bugs.launchpad.net/kayobe/+bug/2144548
+        # - ansible_facts is undefined or ansible_facts is falsy
         - kayobe_virtualenv is defined
       register: gather_facts_result
       # Before any facts are gathered, ansible doesn't know about

ansible/kolla-ansible.yml

@@ -9,6 +9,7 @@
   tags:
     - kolla-ansible
     - config-validation
+    - kayobe-generate-config
   tasks:
     - name: Validate serial console configuration
       block:
@@ -26,6 +27,7 @@
   hosts: localhost
   tags:
     - kolla-ansible
+    - kayobe-generate-config
   gather_facts: false
   pre_tasks:
     - block:
@@ -113,6 +115,7 @@
     - config
     - config-validation
     - kolla-ansible
+    - kayobe-generate-config
   gather_facts: False
   tasks:
     - name: Set Kolla Ansible host variables
@@ -142,6 +145,7 @@
     - config
     - config-validation
     - kolla-ansible
+    - kayobe-generate-config
   gather_facts: False
   tasks:
     - name: Set Kolla Ansible host variables

ansible/kolla-bifrost.yml

@@ -3,6 +3,7 @@
   hosts: localhost
   tags:
     - kolla-bifrost
+    - bifrost
   roles:
     - role: kolla-bifrost
 

ansible/kolla-openstack.yml

@@ -7,6 +7,7 @@
     - config-validation
     - kolla-ansible
     - kolla-openstack
+    - kayobe-generate-config
   tasks:
     - name: Create controllers group with ironic enabled
       group_by:
@@ -19,6 +20,7 @@
   tags:
     - kolla-ansible
     - kolla-openstack
+    - kayobe-generate-config
   vars:
     # These are the filenames generated by overcloud-ipa-build.yml.
     ipa_image_name: "ipa"
@@ -57,6 +59,7 @@
   tags:
     - kolla-ansible
     - kolla-openstack
+    - kayobe-generate-config
   vars:
     switch_type_to_device_type:
       arista: netmiko_arista_eos

doc/source/administration/overcloud.rst

@@ -15,7 +15,7 @@ necessary to update these prior to running a package update. To do this, update
 the configuration in ``${KAYOBE_CONFIG_PATH}/dnf.yml`` and run the following
 command::
 
-    (kayobe) $ kayobe overcloud host configure --tags dnf --kolla-tags none
+    (kayobe) $ kayobe overcloud host configure --tags dnf
 
 Package Update
 --------------
@@ -80,10 +80,9 @@ improved by specifying Ansible tags to limit the tasks run in kayobe and/or
 kolla-ansible's playbooks.  This may require knowledge of the inner workings of
 these tools but in general, kolla-ansible tags the play used to configure each
 service by the name of that service.  For example: ``nova``, ``neutron`` or
-``ironic``.  Use ``-t`` or ``--tags`` to specify kayobe tags and ``-kt`` or
-``--kolla-tags`` to specify kolla-ansible tags.  For example::
+``ironic``.  Use ``-t`` or ``--tags`` to specify tags.  For example::
 
-    (kayobe) $ kayobe overcloud service reconfigure --tags config --kolla-tags nova,ironic
+    (kayobe) $ kayobe overcloud service reconfigure --tags nova,ironic
 
 Deploying Updated Container Images
 ==================================
@@ -105,10 +104,9 @@ improved by specifying Ansible tags to limit the tasks run in kayobe and/or
 kolla-ansible's playbooks.  This may require knowledge of the inner workings of
 these tools but in general, kolla-ansible tags the play used to configure each
 service by the name of that service.  For example: ``nova``, ``neutron`` or
-``ironic``.  Use ``-t`` or ``--tags`` to specify kayobe tags and ``-kt`` or
-``--kolla-tags`` to specify kolla-ansible tags.  For example::
+``ironic``.  Use ``-t`` or ``--tags`` to specify tags.  For example::
 
-    (kayobe) $ kayobe overcloud service deploy containers --kolla-tags nova,ironic
+    (kayobe) $ kayobe overcloud service deploy containers --tags nova,ironic
 
 Upgrading Containerised Services
 ================================
@@ -126,9 +124,9 @@ To upgrade the containerised control plane services::
     (kayobe) $ kayobe overcloud service upgrade
 
 As for the reconfiguration command, it is possible to specify tags for Kayobe
-and/or kolla-ansible::
+and kolla-ansible::
 
-    (kayobe) $ kayobe overcloud service upgrade --tags config --kolla-tags keystone
+    (kayobe) $ kayobe overcloud service upgrade --tags keystone
 
 Running Prechecks
 =================
@@ -137,10 +135,10 @@ Sometimes it may be useful to run prechecks without deploying services::
 
     (kayobe) $ kayobe overcloud service prechecks
 
-As for other similar commands, it is possible to specify tags for Kayobe and/or
+As for other similar commands, it is possible to specify tags for Kayobe and
 kolla-ansible::
 
-    (kayobe) $ kayobe overcloud service upgrade --tags config --kolla-tags keystone
+    (kayobe) $ kayobe overcloud service upgrade --tags keystone
 
 Stopping the Overcloud Services
 ===============================
@@ -156,12 +154,11 @@ To stop the overcloud services::
 It should be noted that this state is persistent - containers will remain
 stopped after a reboot of the host on which they are running.
 
-It is possible to limit the operation to particular hosts via
-``--kolla-limit``, or to particular services via ``--kolla-tags``.  It is also
-possible to avoid stopping the common containers via ``--kolla-skip-tags
-common``. For example:
+It is possible to limit the operation to particular hosts via ``--limit``, or
+to particular services via ``--tags``.  It is also possible to avoid stopping
+the common containers via ``--skip-tags common``. For example:
 
-    (kayobe) $ kayobe overcloud service stop --kolla-tags glance,nova --kolla-skip-tags common
+    (kayobe) $ kayobe overcloud service stop --tags glance,nova --skip-tags common
 
 Destroying the Overcloud Services
 =================================

doc/source/administration/seed.rst

@@ -31,10 +31,7 @@ To destroy the seed services::
 
 This can optionally be used with a tag::
 
-    (kayobe) $ kayobe seed service destroy --yes-i-really-really-mean-it -kt none -t docker-registry
-
-Care must be taken to set both kayobe and kolla tags to avoid accidentally
-destroying other services.
+    (kayobe) $ kayobe seed service destroy --yes-i-really-really-mean-it -t docker-registry
 
 Updating Packages
 =================
@@ -49,7 +46,7 @@ necessary to update these prior to running a package update. To do this, update
 the configuration in ``${KAYOBE_CONFIG_PATH}/dnf.yml`` and run the following
 command::
 
-    (kayobe) $ kayobe seed host configure --tags dnf --kolla-tags none
+    (kayobe) $ kayobe seed host configure --tags dnf
 
 Package Update
 --------------

doc/source/configuration/reference/vgpu.rst

@@ -226,7 +226,7 @@ To apply the configuration to Nova:
 
 .. code:: shell
 
-   (kayobe) $ kayobe overcloud service deploy -kt nova
+   (kayobe) $ kayobe overcloud service deploy -t nova
 
 OpenStack flavors
 =================
@@ -307,4 +307,4 @@ Reconfigure nova to match the change:
 
 .. code:: shell
 
-   (kayobe) $ kayobe overcloud service reconfigure -kt nova --kolla-limit computegpu000 --skip-prechecks
+   (kayobe) $ kayobe overcloud service reconfigure -t nova --limit computegpu000 --skip-prechecks

doc/source/deployment.rst

@@ -217,9 +217,10 @@ After this command has completed the seed services will be active.
 
 .. note::
 
-    Bifrost deployment behaviour is split between Kayobe and Kolla-Ansible. As
-    such, you should use both ``--tags kolla-bifrost`` and ``--kolla-tags
-    bifrost`` if you want to limit to Bifrost deployment.
+    You can use ``--tags bifrost`` if you want to limit to just the Bifrost
+    deployment. Note however that using tags is not tested in either Kayobe or
+    Kolla-Ansible CI, and as such should only be used if you know what you're
+    doing. Proceed with caution.
 
 .. seealso::
 

doc/source/upgrading.rst

@@ -450,7 +450,13 @@ To upgrade the containerised control plane services::
 
     (kayobe) $ kayobe overcloud service upgrade
 
-It is possible to specify tags for Kayobe and/or kolla-ansible to restrict the
+It is possible to specify tags for Kayobe and kolla-ansible to restrict the
 scope of the upgrade::
 
-    (kayobe) $ kayobe overcloud service upgrade --tags config --kolla-tags keystone
+    (kayobe) $ kayobe overcloud service upgrade --tags keystone
+
+.. note::
+
+    Using tags is not tested in either Kayobe or Kolla-Ansible CI, and as such
+    should only be used if you know what you're doing. Proceed with caution.
+

doc/source/usage.rst

@@ -63,12 +63,11 @@ Limiting Hosts
 
 Sometimes it may be necessary to limit execution of kayobe or kolla-ansible
 plays to a subset of the hosts.  The ``--limit <SUBSET>`` argument allows the
-kayobe ansible hosts to be limited.  The ``--kolla-limit <SUBSET>`` argument
-allows the kolla-ansible hosts to be limited.  These two options may be
-combined in a single command.  In both cases, the argument provided should be
+kayobe and kolla-ansible hosts to be limited.  The argument provided should be
 an `Ansible host pattern
 <http://docs.ansible.com/ansible/latest/intro_patterns.html>`_, and will
-ultimately be passed to ``ansible-playbook`` as a ``--limit`` argument.
+ultimately be passed to ``ansible-playbook`` for both kayobe and kolla-ansible
+as a ``--limit`` argument.
 
 .. _usage-tags:
 
@@ -77,12 +76,15 @@ Tags
 
 `Ansible tags <http://docs.ansible.com/ansible/latest/playbooks_tags.html>`_
 provide a useful mechanism for executing a subset of the plays or tasks in a
-playbook.  The ``--tags <TAGS>`` argument allows execution of kayobe ansible
-playbooks to be limited to matching plays and tasks.  The ``--kolla-tags
-<TAGS>`` argument allows execution of kolla-ansible ansible playbooks to be
-limited to matching plays and tasks.  The ``--skip-tags <TAGS>`` and
-``--kolla-skip-tags <TAGS>`` arguments allow for avoiding execution of matching
-plays and tasks.
+playbook.  The ``--tags <TAGS>`` argument allows execution of kayobe and
+kolla-ansible playbooks to be limited to matching plays and tasks.  The
+``--skip-tags <TAGS>`` argument allows for avoiding execution of matching plays
+and tasks.
+
+.. note::
+
+    Using tags is not tested in either Kayobe or Kolla-Ansible CI, and as such
+    should only be used if you know what you're doing. Proceed with caution.
 
 Check and diff mode
 -------------------