common: Rename role to kolla_toolbox

Renaming it to kolla_toolbox to comply with Ansible Galaxy role naming standard

Change-Id: I5e3cbcd5e8028574eeab148f1e2222378f121a22
Signed-off-by: Michal Nasiadka <mnasiadka@gmail.com>

27 files changed, 61 insertions, 61 deletions

diff --git a/ansible/inventory/all-in-one b/ansible/inventory/all-in-one
index 1eccb5310..79704c8de 100644
--- a/ansible/inventory/all-in-one
+++ b/ansible/inventory/all-in-one
@@ -175,10 +175,10 @@ common
 [fluentd:children]
 common
 
-[kolla-toolbox:children]
+[kolla_logs:children]
 common
 
-[kolla_logs:children]
+[kolla_toolbox:children]
 common
 
 [opensearch:children]
diff --git a/ansible/inventory/multinode b/ansible/inventory/multinode
index 9c87a2015..cbb0db70c 100644
--- a/ansible/inventory/multinode
+++ b/ansible/inventory/multinode
@@ -193,15 +193,11 @@ common
 [fluentd:children]
 common
 
-[kolla-toolbox:children]
+[kolla_logs:children]
 common
 
-[kolla_logs:children]
-control
-network
-compute
-storage
-monitoring
+[kolla_toolbox:children]
+common
 
 [opensearch:children]
 control
diff --git a/ansible/roles/common/vars/main.yml b/ansible/roles/common/vars/main.yml
deleted file mode 100644
index df0a76fc2..000000000
--- a/ansible/roles/common/vars/main.yml
+++ /dev/null
@@ -1,2 +0,0 @@
----
-project_name: "common"
diff --git a/ansible/roles/common/defaults/main.yml b/ansible/roles/kolla_toolbox/defaults/main.yml
index cf1a1485e..534377b1f 100644
--- a/ansible/roles/common/defaults/main.yml
+++ b/ansible/roles/kolla_toolbox/defaults/main.yml
@@ -1,8 +1,8 @@
 ---
-common_services:
+kolla_toolbox_services:
   kolla-toolbox:
     container_name: kolla_toolbox
-    group: kolla-toolbox
+    group: kolla_toolbox
     enabled: true
     image: "{{ kolla_toolbox_image_full }}"
     environment:
@@ -16,12 +16,10 @@ common_services:
 ####################
 # Docker
 ####################
-common_tag: "{{ openstack_tag }}"
-
 kolla_toolbox_dimensions: "{{ default_container_dimensions }}"
 
 kolla_toolbox_image: "{{ docker_image_url }}kolla-toolbox"
-kolla_toolbox_tag: "{{ common_tag }}"
+kolla_toolbox_tag: "{{ openstack_tag }}"
 kolla_toolbox_image_full: "{{ kolla_toolbox_image }}:{{ kolla_toolbox_tag }}"
 
 kolla_toolbox_default_volumes:
@@ -35,4 +33,4 @@ kolla_toolbox_extra_volumes: "{{ default_extra_volumes }}"
 ###################
 # Copy certificates
 ###################
-common_copy_certs: "{{ kolla_copy_ca_into_containers | bool }}"
+kolla_toolbox_copy_certs: "{{ kolla_copy_ca_into_containers | bool }}"
diff --git a/ansible/roles/common/handlers/main.yml b/ansible/roles/kolla_toolbox/handlers/main.yml
index c0d148d5f..73db9be9d 100644
--- a/ansible/roles/common/handlers/main.yml
+++ b/ansible/roles/kolla_toolbox/handlers/main.yml
@@ -2,7 +2,7 @@
 - name: Restart kolla-toolbox container
   vars:
     service_name: "kolla-toolbox"
-    service: "{{ common_services[service_name] }}"
+    service: "{{ kolla_toolbox_services[service_name] }}"
   become: true
   kolla_container:
     action: "recreate_or_restart_container"
@@ -17,6 +17,9 @@
     - Initializing toolbox container using normal user
 
 - name: Initializing toolbox container using normal user
+  vars:
+    service_name: "kolla-toolbox"
+    service: "{{ kolla_toolbox_services[service_name] }}"
   become: true
-  ansible.builtin.command: "{{ kolla_container_engine }} exec -t {{ common_services['kolla-toolbox']['container_name'] }} ansible --version"
+  ansible.builtin.command: "{{ kolla_container_engine }} exec -t {{ service['container_name'] }} ansible --version"
   changed_when: false
diff --git a/ansible/roles/common/tasks/bootstrap.yml b/ansible/roles/kolla_toolbox/tasks/bootstrap.yml
index ed97d539c..ed97d539c 100644
--- a/ansible/roles/common/tasks/bootstrap.yml
+++ b/ansible/roles/kolla_toolbox/tasks/bootstrap.yml
diff --git a/ansible/roles/common/tasks/check-containers.yml b/ansible/roles/kolla_toolbox/tasks/check-containers.yml
index b450a891d..3f08716d8 100644
--- a/ansible/roles/common/tasks/check-containers.yml
+++ b/ansible/roles/kolla_toolbox/tasks/check-containers.yml
@@ -1,4 +1,4 @@
 ---
-- name: Check common containers
+- name: Check kolla_toolbox containers
   ansible.builtin.import_role:
     name: service-check-containers
diff --git a/ansible/roles/common/tasks/check.yml b/ansible/roles/kolla_toolbox/tasks/check.yml
index ea907300a..9e77943a3 100644
--- a/ansible/roles/common/tasks/check.yml
+++ b/ansible/roles/kolla_toolbox/tasks/check.yml
@@ -1,4 +1,4 @@
 ---
-- name: Checking Common containers
+- name: Checking kolla_toolbox containers
   ansible.builtin.import_role:
     role: service-check
diff --git a/ansible/roles/common/tasks/config.yml b/ansible/roles/kolla_toolbox/tasks/config.yml
index aa962fc66..899799a94 100644
--- a/ansible/roles/common/tasks/config.yml
+++ b/ansible/roles/kolla_toolbox/tasks/config.yml
@@ -1,26 +1,21 @@
 ---
 - name: Ensuring config directories exist
   vars:
-    service_name: "{{ item.0.service_name }}"
-    service: "{{ common_services[service_name] }}"
+    service_name: "kolla-toolbox"
+    service: "{{ kolla_toolbox_services[service_name] }}"
   ansible.builtin.file:
-    path: "{{ node_config_directory }}/{{ item.1 }}"
+    path: "{{ node_config_directory }}/{{ service_name }}"
     state: "directory"
     owner: "{{ config_owner_user }}"
     group: "{{ config_owner_group }}"
     mode: "0770"
   become: true
-  with_subelements:
-    - - service_name: "kolla-toolbox"
-        paths:
-          - "kolla-toolbox"
-    - paths
   when: service | service_enabled_and_mapped_to_host
 
 - name: Copying over TLS certificates
   ansible.builtin.include_tasks: copy-certs.yml
   when:
-    - common_copy_certs | bool
+    - kolla_toolbox_copy_certs | bool
 
 - name: Copying over config.json files for services
   ansible.builtin.template:
@@ -28,7 +23,7 @@
     dest: "{{ node_config_directory }}/{{ item.key }}/config.json"
     mode: "0660"
   become: true
-  with_dict: "{{ common_services | select_services_enabled_and_mapped_to_host }}"
+  with_dict: "{{ kolla_toolbox_services | select_services_enabled_and_mapped_to_host }}"
 
 - name: Ensure RabbitMQ Erlang cookie exists
   become: true
@@ -37,7 +32,7 @@
     dest: "{{ node_config_directory }}/kolla-toolbox/rabbitmq-erlang.cookie"
     mode: "0660"
   when:
-    - common_services['kolla-toolbox'] | service_enabled_and_mapped_to_host
+    - kolla_toolbox_services['kolla-toolbox'] | service_enabled_and_mapped_to_host
     - enable_rabbitmq | bool
 
 - name: Ensuring config directories have correct owner and permission
@@ -48,9 +43,7 @@
     group: "{{ config_owner_group }}"
     mode: "0770"
   ignore_errors: "{{ ansible_check_mode }}"
-  when:
-    - item.key != "kolla-toolbox"
-  with_dict: "{{ common_services | select_services_enabled_and_mapped_to_host }}"
+  with_dict: "{{ kolla_toolbox_services | select_services_enabled_and_mapped_to_host }}"
 
 - name: Copy rabbitmq-env.conf to kolla toolbox
   ansible.builtin.template:
@@ -63,7 +56,7 @@
     - "rabbitmq-env.conf.j2"
   become: true
   when:
-    - common_services['kolla-toolbox'] | service_enabled_and_mapped_to_host
+    - kolla_toolbox_services['kolla-toolbox'] | service_enabled_and_mapped_to_host
     - enable_rabbitmq | bool
 
 - name: Copy rabbitmq erl_inetrc to kolla toolbox
@@ -77,5 +70,5 @@
     - "{{ node_custom_config }}/kolla-toolbox/erl_inetrc"
     - "erl_inetrc.j2"
   when:
-    - common_services['kolla-toolbox'] | service_enabled_and_mapped_to_host
+    - kolla_toolbox_services['kolla-toolbox'] | service_enabled_and_mapped_to_host
     - enable_rabbitmq | bool
diff --git a/ansible/roles/common/tasks/config_validate.yml b/ansible/roles/kolla_toolbox/tasks/config_validate.yml
index ed97d539c..ed97d539c 100644
--- a/ansible/roles/common/tasks/config_validate.yml
+++ b/ansible/roles/kolla_toolbox/tasks/config_validate.yml
diff --git a/ansible/roles/common/tasks/copy-certs.yml b/ansible/roles/kolla_toolbox/tasks/copy-certs.yml
index ab906e224..3da86d914 100644
--- a/ansible/roles/common/tasks/copy-certs.yml
+++ b/ansible/roles/kolla_toolbox/tasks/copy-certs.yml
@@ -3,4 +3,4 @@
   ansible.builtin.import_role:
     role: service-cert-copy
   vars:
-    project_services: "{{ common_services }}"
+    project_services: "{{ kolla_toolbox_services }}"
diff --git a/ansible/roles/common/tasks/deploy-containers.yml b/ansible/roles/kolla_toolbox/tasks/deploy-containers.yml
index a37ddafc0..dea81dcaf 100644
--- a/ansible/roles/common/tasks/deploy-containers.yml
+++ b/ansible/roles/kolla_toolbox/tasks/deploy-containers.yml
@@ -1,3 +1,3 @@
 ---
-- name: Check common containers
+- name: Check kolla_toolbox containers
   ansible.builtin.import_tasks: check-containers.yml
diff --git a/ansible/roles/common/tasks/deploy.yml b/ansible/roles/kolla_toolbox/tasks/deploy.yml
index df6770fab..a7a9bf2e1 100644
--- a/ansible/roles/common/tasks/deploy.yml
+++ b/ansible/roles/kolla_toolbox/tasks/deploy.yml
@@ -1,11 +1,11 @@
 ---
-- name: Configure common
+- name: Configure kolla_toolbox
   ansible.builtin.import_tasks: config.yml
 
-- name: Check common containers
+- name: Check kolla_toolbox containers
   ansible.builtin.import_tasks: check-containers.yml
 
-- name: Bootstrap common service
+- name: Bootstrap kolla_toolbox service
   ansible.builtin.import_tasks: bootstrap.yml
 
 - name: Flush handlers
diff --git a/ansible/roles/common/tasks/main.yml b/ansible/roles/kolla_toolbox/tasks/main.yml
index 594ad5d85..594ad5d85 100644
--- a/ansible/roles/common/tasks/main.yml
+++ b/ansible/roles/kolla_toolbox/tasks/main.yml
diff --git a/ansible/roles/common/tasks/precheck.yml b/ansible/roles/kolla_toolbox/tasks/precheck.yml
index d3b4b6440..98a02793e 100644
--- a/ansible/roles/common/tasks/precheck.yml
+++ b/ansible/roles/kolla_toolbox/tasks/precheck.yml
@@ -1,7 +1,7 @@
 ---
-- name: Precheck common configuration
+- name: Precheck kolla_toolbox configuration
   ansible.builtin.import_role:
     name: service-precheck
   vars:
-    service_precheck_services: "{{ common_services }}"
+    service_precheck_services: "{{ kolla_toolbox_services }}"
     service_name: "{{ project_name }}"
diff --git a/ansible/roles/common/tasks/pull.yml b/ansible/roles/kolla_toolbox/tasks/pull.yml
index ae366b298..12baee1a8 100644
--- a/ansible/roles/common/tasks/pull.yml
+++ b/ansible/roles/kolla_toolbox/tasks/pull.yml
@@ -1,4 +1,4 @@
 ---
-- name: Pull common images
+- name: Pull kolla_toolbox images
   ansible.builtin.import_role:
     role: service-images-pull
diff --git a/ansible/roles/common/tasks/reconfigure.yml b/ansible/roles/kolla_toolbox/tasks/reconfigure.yml
index 36714ba9f..8d3a74904 100644
--- a/ansible/roles/common/tasks/reconfigure.yml
+++ b/ansible/roles/kolla_toolbox/tasks/reconfigure.yml
@@ -1,3 +1,3 @@
 ---
-- name: Deploy common
+- name: Deploy kolla_toolbox
   ansible.builtin.import_tasks: deploy.yml
diff --git a/ansible/roles/common/tasks/stop.yml b/ansible/roles/kolla_toolbox/tasks/stop.yml
index ead296fad..336f44a01 100644
--- a/ansible/roles/common/tasks/stop.yml
+++ b/ansible/roles/kolla_toolbox/tasks/stop.yml
@@ -1,7 +1,7 @@
 ---
-- name: Stop common containers
+- name: Stop kolla_toolbox containers
   ansible.builtin.import_role:
     name: service-stop
   vars:
-    project_services: "{{ common_services }}"
+    project_services: "{{ kolla_toolbox_services }}"
     service_name: "{{ project_name }}"
diff --git a/ansible/roles/common/tasks/upgrade.yml b/ansible/roles/kolla_toolbox/tasks/upgrade.yml
index fde501e3d..56b1cdeaf 100644
--- a/ansible/roles/common/tasks/upgrade.yml
+++ b/ansible/roles/kolla_toolbox/tasks/upgrade.yml
@@ -1,8 +1,8 @@
 ---
-- name: Configure common
+- name: Configure kolla_toolbox
   ansible.builtin.import_tasks: config.yml
 
-- name: Check common containers
+- name: Check kolla_toolbox containers
   ansible.builtin.import_tasks: check-containers.yml
 
 - name: Flush handlers
diff --git a/ansible/roles/common/templates/erl_inetrc.j2 b/ansible/roles/kolla_toolbox/templates/erl_inetrc.j2
index 81755d8a3..81755d8a3 100644
--- a/ansible/roles/common/templates/erl_inetrc.j2
+++ b/ansible/roles/kolla_toolbox/templates/erl_inetrc.j2
diff --git a/ansible/roles/common/templates/kolla-toolbox.json.j2 b/ansible/roles/kolla_toolbox/templates/kolla-toolbox.json.j2
index 03c79a5cd..03c79a5cd 100644
--- a/ansible/roles/common/templates/kolla-toolbox.json.j2
+++ b/ansible/roles/kolla_toolbox/templates/kolla-toolbox.json.j2
diff --git a/ansible/roles/common/templates/rabbitmq-env.conf.j2 b/ansible/roles/kolla_toolbox/templates/rabbitmq-env.conf.j2
index b78696a20..b78696a20 100644
--- a/ansible/roles/common/templates/rabbitmq-env.conf.j2
+++ b/ansible/roles/kolla_toolbox/templates/rabbitmq-env.conf.j2
diff --git a/ansible/roles/common/templates/rabbitmq-erlang.cookie.j2 b/ansible/roles/kolla_toolbox/templates/rabbitmq-erlang.cookie.j2
index d2322468d..d2322468d 100644
--- a/ansible/roles/common/templates/rabbitmq-erlang.cookie.j2
+++ b/ansible/roles/kolla_toolbox/templates/rabbitmq-erlang.cookie.j2
diff --git a/ansible/roles/kolla_toolbox/vars/main.yml b/ansible/roles/kolla_toolbox/vars/main.yml
new file mode 100644
index 000000000..6c6d367e2
--- /dev/null
+++ b/ansible/roles/kolla_toolbox/vars/main.yml
@@ -0,0 +1,2 @@
+---
+project_name: "kolla_toolbox"
diff --git a/ansible/site.yml b/ansible/site.yml
index 08a072ccf..18d9c3c92 100644
--- a/ansible/site.yml
+++ b/ansible/site.yml
@@ -97,10 +97,10 @@
   roles:
     - logs
 
-- name: Apply role common
+- name: Apply role kolla_toolbox
   gather_facts: false
   hosts:
-    - kolla-toolbox
+    - kolla_toolbox
   serial: '{{ kolla_serial|default("0") }}'
   max_fail_percentage: >-
     {{ common_max_fail_percentage |
@@ -108,8 +108,9 @@
        default(100) }}
   tags:
     - common
+    - kolla_toolbox
   roles:
-    - role: common
+    - role: kolla_toolbox
 
 - name: Apply role cron
   gather_facts: false
@@ -556,8 +557,8 @@
   gather_facts: false
   hosts:
     # NOTE(mgoddard): This is only used to register Keystone services, and
-    # can run on any host running kolla-toolbox.
-    - kolla-toolbox
+    # can run on any host running kolla_toolbox.
+    - kolla_toolbox
     - "&enable_ceph_rgw_True"
   serial: '{{ kolla_serial|default("0") }}'
   max_fail_percentage: >-
diff --git a/releasenotes/notes/rename-kolla-toolbox-role-31e3b6c34519f68c.yaml b/releasenotes/notes/rename-kolla-toolbox-role-31e3b6c34519f68c.yaml
new file mode 100644
index 000000000..ecfcd4370
--- /dev/null
+++ b/releasenotes/notes/rename-kolla-toolbox-role-31e3b6c34519f68c.yaml
@@ -0,0 +1,10 @@
+---
+upgrade:
+  - |
+    ``common`` Ansible role has been renamed to ``kolla_toolbox``.
+    Also the ``kolla-toolbox`` Ansible inventory group has been renamed
+    to ``kolla_toolbox`` to be in line with Ansible requirements.
+    The tag for ``kolla_toolbox`` deployment task has also been
+    renamed.
+    Users should update their inventories and inventory overrides to
+    reflect this change.
diff --git a/tests/templates/inventory.j2 b/tests/templates/inventory.j2
index 1e2833298..9a7787b31 100644
--- a/tests/templates/inventory.j2
+++ b/tests/templates/inventory.j2
@@ -255,17 +255,16 @@ common
 {% if is_upgrade | bool %}
 [kolla-logs:children]
 common
-{% endif %}
 
 [kolla-toolbox:children]
 common
+{% endif %}
 
 [kolla_logs:children]
-control
-network
-compute
-storage
-monitoring
+common
+
+[kolla_toolbox:children]
+common
 
 [opensearch:children]
 control