Use container setup role from plugins repo

This patch converts the container setup from a task include
to a role in the plugins repo so that the container setup
code can be re-used when extending openstack-ansible through
further use of ansible collections.

Depends-On: https://review.opendev.org/c/openstack/openstack-ansible-plugins/+/900529
Change-Id: Idc8ece17ca334a6b46fa18446218a38b2c85c32b

playbooks/common-playbooks/cinder.yml

@@ -46,7 +46,8 @@
         - always
 
     - name: Configure container (cinder-volume) when lvm is in-use
-      include_tasks: "../common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       vars:
         extra_container_config:
           - "lxc.autodev=0"
@@ -60,7 +61,8 @@
         - "cinder_backend_lvm_inuse | bool"
 
     - name: Configure container (other services)
-      include_tasks: "../common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when:
         - "not is_metal"
         - "not ( 'cinder_volume' in group_names and cinder_backend_lvm_inuse | bool )"

playbooks/common-playbooks/neutron.yml

@@ -46,7 +46,8 @@
         - always
 
     - name: Configure container (neutron-agent)
-      include_tasks: "../common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       vars:
         list_of_bind_mounts:
           - bind_dir_path: "{{ (ansible_facts['pkg_mgr'] == 'apt') | ternary('/lib/modules', '/usr/lib/modules') }}"
@@ -60,7 +61,8 @@
         - "'neutron_agent' in group_names"
 
     - name: Configure container (other services)
-      include_tasks: "../common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when:
         - "not is_metal"
         - "'neutron_agent' not in group_names"

playbooks/common-tasks/ceph-server.yml

@@ -13,7 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-- include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+- name: Including container setup role
+  include_role:
+    name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
   when: not is_metal
   vars:
     list_of_bind_mounts: "{{ ceph_container_bind_mounts }}"

playbooks/common-tasks/os-lxc-container-setup.yml

@@ -1,156 +0,0 @@
----
-# Copyright 2016, Rackspace US, Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Usage:
-#  This common task will update lxc containers to use the lxc-openstack
-#  app-armor profile by default however this profile can be changed as needed.
-
-#  This will also load in a list of bind mounts for a given container. To load
-#  in a list of bind mounts the variable, "list_of_bind_mounts" must be used
-#  containing at least one dictionary with the keys "bind_dir_path",
-#  "relative_bind_dir_path", and "mount_path".
-#    * bind_dir_path = Container path used in a bind mount
-#    * mount_path = Local path on the physical host used for a bind mount
-
-#  If extra container configurations are desirable set the
-#  "extra_container_config" list to strings containing the options needed.
-
-- name: Set default bind mounts (bind var/log)
-  set_fact:
-    lxc_default_bind_mounts: '{{ lxc_default_bind_mounts | default([{"bind_dir_path": "/var/log", "mount_path": "/openstack/log/" ~ inventory_hostname}]) }}'
-  when:
-    - default_bind_mount_logs | bool
-  tags:
-    - common-lxc
-
-- name: Ensure mount directories exists
-  file:
-    path: "{{ item['mount_path'] }}"
-    state: "directory"
-  with_items:
-    - "{{ lxc_default_bind_mounts | default([]) }}"
-    - "{{ list_of_bind_mounts | default([]) }}"
-  when:
-    - item.create | default('dir') == 'dir'
-  delegate_to: "{{ physical_host }}"
-  tags:
-    - common-lxc
-
-- name: Add bind mount configuration to container
-  lineinfile:
-    dest: "/var/lib/lxc/{{ inventory_hostname }}/config"
-    line: "lxc.mount.entry = {{ item['mount_path'] }} {{ item['bind_dir_path'].lstrip('/') }} none bind,create={{ item.create | default('dir') }} 0 0"
-    insertbefore: "^lxc.mount.entry = .*\\s{{ item['bind_dir_path'].lstrip('/') | regex_replace('/', '\/') }}.*"
-    backup: "true"
-  with_items:
-    - "{{ lxc_default_bind_mounts | default([]) }}"
-    - "{{ list_of_bind_mounts | default([]) }}"
-  delegate_to: "{{ physical_host }}"
-  register: _mc
-  tags:
-    - common-lxc
-
-- name: Extra lxc config
-  lineinfile:
-    path: "/var/lib/lxc/{{ inventory_hostname }}/config"
-    regexp: "^{{ item.split('=')[0] }} ="
-    line: "{{ item.split('=')[0] }} = {{ item.split('=', 1)[1] }}"
-    backup: "true"
-  with_items: "{{ extra_container_config | default([]) }}"
-  delegate_to: "{{ physical_host }}"
-  register: _ec
-  tags:
-    - common-lxc
-
-- name: Extra lxc config no restart
-  lineinfile:
-    path: "/var/lib/lxc/{{ inventory_hostname }}/config"
-    regexp: "^{{ item.split('=')[0] }} ="
-    line: "{{ item.split('=')[0] }} = {{ item.split('=', 1)[1] }}"
-    backup: "true"
-  with_items: "{{ extra_container_config_no_restart | default(['lxc.start.order=100']) }}"
-  delegate_to: "{{ physical_host }}"
-  tags:
-    - common-lxc
-
-- name: Check container state
-  command: "lxc-info -n {{ inventory_hostname }} --state"
-  changed_when: false
-  delegate_to: "{{ physical_host }}"
-  register: _lxc_container_state
-  until: _lxc_container_state is success
-  retries: 3
-  delay: 5
-  when:
-    - (_mc is defined and _mc is changed) or (_ec is defined and _ec is changed)
-
-# Due to https://github.com/ansible/ansible-modules-extras/issues/2691
-# this uses the LXC CLI tools to ensure that we get logging.
-# TODO(odyssey4me): revisit this once the bug is fixed and released
-# NOTE(cloudnull): The `lxc-stop` command will have an RC of 2 if the command
-#                  fails due to a container already being in a stopped state.
-- name: Lxc container restart
-  command: >
-    lxc-stop --name {{ inventory_hostname }}
-    --logfile {{ lxc_container_log_path }}/lxc-{{ inventory_hostname }}.log
-    --logpriority {{ (debug | bool) | ternary('DEBUG', 'INFO') }}
-  delegate_to: "{{ physical_host }}"
-  register: container_stop
-  until: container_stop is success
-  retries: 3
-  failed_when:
-    - container_stop.rc not in [0, 2]
-  when:
-    - lxc_container_allow_restarts | default(True) | bool
-    - (_mc is defined and _mc is changed) or (_ec is defined and _ec is changed)
-    - _lxc_container_state.stdout.find('RUNNING') != -1
-  tags:
-    - common-lxc
-
-# Due to https://github.com/ansible/ansible-modules-extras/issues/2691
-# this uses the LXC CLI tools to ensure that we get logging.
-# TODO(odyssey4me): revisit this once the bug is fixed and released
-- name: Start Container
-  command: >
-    lxc-start --daemon --name {{ inventory_hostname }}
-    --logfile {{ lxc_container_log_path }}/lxc-{{ inventory_hostname }}.log
-    --logpriority {{ (debug | bool) | ternary('DEBUG', 'INFO') }}
-  delegate_to: "{{ physical_host }}"
-  register: container_start
-  until: container_start is success
-  retries: 3
-  when:
-    - (_mc is defined and _mc is changed) or (_ec is defined and _ec is changed)
-  tags:
-    - common-lxc
-
-- name: Wait for container tmpfiles-setup finish
-  raw: systemctl list-units systemd-tmpfiles-setup.service --no-legend | grep 'exited' >/dev/null
-  register: systemd_tmpfiles
-  until: systemd_tmpfiles.rc == 0
-  retries: 20
-  delay: 2
-  changed_when: false
-
-- name: Wait for container connectivity
-  wait_for_connection:
-    connect_timeout: "{{ lxc_container_wait_params.connect_timeout | default(omit) }}"
-    delay: "{{ lxc_container_wait_params.delay | default(omit) }}"
-    sleep: "{{ lxc_container_wait_params.sleep | default(omit) }}"
-    timeout: "{{ lxc_container_wait_params.timeout | default(omit) }}"
-  when:
-    - (_mc is defined and _mc is changed) or (_ec is defined and _ec is changed)
-  tags:
-    - common-lxc

playbooks/galera-install.yml

@@ -39,7 +39,8 @@
   user: root
   pre_tasks:
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
       vars:
         list_of_bind_mounts: "{{ galera_container_bind_mounts }}"

playbooks/haproxy-install.yml

@@ -38,7 +38,8 @@
   user: root
   pre_tasks:
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
     - name: Including unbound-clients tasks
       include_tasks: common-tasks/unbound-clients.yml

playbooks/memcached-install.yml

@@ -26,7 +26,8 @@
   user: root
   pre_tasks:
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
     - name: Including unbound-clients tasks
       include_tasks: common-tasks/unbound-clients.yml

playbooks/os-aodh-install.yml

@@ -57,7 +57,8 @@
         - "groups['aodh_api'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including unbound-clients tasks

playbooks/os-barbican-install.yml

@@ -57,7 +57,8 @@
         - "groups['barbican_api'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including unbound-clients tasks

playbooks/os-blazar-install.yml

@@ -57,7 +57,8 @@
         - "groups['blazar_api'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including unbound-clients tasks

playbooks/os-ceilometer-install.yml

@@ -32,7 +32,8 @@
     - "defaults/{{ install_method }}_install.yml"
   pre_tasks:
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including unbound-clients tasks

playbooks/os-designate-install.yml

@@ -60,7 +60,8 @@
         - "groups['designate_api'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including unbound-clients tasks

playbooks/os-glance-install.yml

@@ -57,7 +57,8 @@
         - "groups['glance_api'] | length > 1"
 
     - name: Configure container (local storage bind mount from host)
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       vars:
         list_of_bind_mounts: "{{ glance_container_bind_mounts }}"
       when:
@@ -66,7 +67,8 @@
         - (glance_remote_client is not defined) or (glance_remote_client | length == 0)
 
     - name: Configure container (remote storage)
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when:
         - not is_metal
         - (glance_default_store != "file") or (glance_remote_client is defined)

playbooks/os-gnocchi-install.yml

@@ -57,7 +57,8 @@
         - "groups['gnocchi_all'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       vars:
         list_of_bind_mounts: "{{ gnocchi_container_bind_mounts }}"
       when:

playbooks/os-heat-install.yml

@@ -57,7 +57,8 @@
         - "groups['heat_api'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including unbound-clients tasks

playbooks/os-horizon-install.yml

@@ -57,7 +57,8 @@
         - "groups['horizon_all'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
     - name: Including unbound-clients tasks
       include_tasks: common-tasks/unbound-clients.yml

playbooks/os-ironic-install.yml

@@ -57,7 +57,8 @@
         - "groups['ironic_api'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including unbound-clients tasks

playbooks/os-keystone-install.yml

@@ -86,7 +86,8 @@
         - "groups['keystone_all'] | length > 1"
 
     - name: Configure container
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       vars:
         extra_container_config_no_restart:
           - "lxc.start.order=19"

playbooks/os-magnum-install.yml

@@ -60,7 +60,8 @@
         - "groups['magnum_all'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including unbound-clients tasks

playbooks/os-masakari-install.yml

@@ -84,7 +84,8 @@
         - "groups['masakari_api'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including unbound-clients tasks

playbooks/os-mistral-install.yml

@@ -57,7 +57,8 @@
         - "groups['mistral_all'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including unbound-clients tasks

playbooks/os-murano-install.yml

@@ -57,7 +57,8 @@
         - "groups['murano_all'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including unbound-clients tasks

playbooks/os-nova-install.yml

@@ -90,7 +90,8 @@
         - "nova_console"
 
     - name: Configure container
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
       vars:
         extra_container_config_no_restart:
@@ -157,7 +158,8 @@
         - always
 
     - name: Configure container
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
       vars:
         extra_container_config_no_restart:

playbooks/os-octavia-install.yml

@@ -57,7 +57,8 @@
         - "groups['octavia_all'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including unbound-clients tasks

playbooks/os-placement-install.yml

@@ -57,7 +57,8 @@
         - "groups['placement_all'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including unbound-clients tasks

playbooks/os-sahara-install.yml

@@ -55,7 +55,8 @@
         - "groups['sahara_api'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including unbound-clients tasks

playbooks/os-swift-install.yml

@@ -40,7 +40,8 @@
     - "defaults/{{ install_method }}_install.yml"
   pre_tasks:
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       vars:
         extra_container_config_no_restart:
           - "lxc.start.order=39"

playbooks/os-tacker-install.yml

@@ -57,7 +57,8 @@
         - "groups['tacker_all'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
   roles:

playbooks/os-trove-install.yml

@@ -60,7 +60,8 @@
         - "groups['trove_api'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including unbound-clients tasks

playbooks/os-zun-install.yml

@@ -71,7 +71,8 @@
         - "groups['zun_api'] | length > 1"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including unbound-clients tasks

playbooks/qdrouterd-install.yml

@@ -29,7 +29,8 @@
     - qdrouterd
   pre_tasks:
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       vars:
         extra_container_config_no_restart:
           - "lxc.start.order=19"

playbooks/rabbitmq-install.yml

@@ -26,7 +26,8 @@
   user: root
   pre_tasks:
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       vars:
         extra_container_config_no_restart:
           - "lxc.start.order=19"

playbooks/repo-install.yml

@@ -31,7 +31,8 @@
         - (install_method | default('source')) != "source"
 
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       vars:
         list_of_bind_mounts: "{{ repo_container_bind_mounts }}"
       when: not is_metal

playbooks/unbound-install.yml

@@ -28,7 +28,8 @@
     - name: Including os-log-dir-setup tasks
       include_tasks: common-tasks/os-log-dir-setup.yml
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
   roles:
     - role: "unbound"

playbooks/utility-install.yml

@@ -49,7 +49,8 @@
         - "venv changed"
   pre_tasks:
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
 
     - name: Including os-log-dir-setup tasks

playbooks/zookeeper-install.yml

@@ -29,7 +29,8 @@
     - name: Including os-log-dir-setup tasks
       include_tasks: common-tasks/os-log-dir-setup.yml
     - name: Including container-setup tasks
-      include_tasks: "common-tasks/os-{{ container_tech | default('lxc') }}-container-setup.yml"
+      include_role:
+        name: "openstack.osa.{{ container_tech | default('lxc') }}_container_setup"
       when: not is_metal
       vars:
         list_of_bind_mounts: "{{ zookeeper_container_bind_mounts }}"