Make config directories consistent across services

Some services used edpm_container_standalone and some services
directly use edpm_container_manage and the way we generate the
config files and use them is spread across multiple locations
which is confusing and difficult to troubleshoot. This sanitizes
the locations.

Signed-off-by: rabi <[email protected]>

Author: rabi

docs/source/roles/role-edpm_container_manage.rst

@@ -63,14 +63,14 @@ This Ansible role allows to do the following tasks:
 
 .. code-block:: YAML
 
-    - name: Manage step_1 containers using edpm-ansible
+    - name: Manage containers using edpm-ansible
       block:
-        - name: "Manage containers for step 1 with edpm-ansible"
+        - name: "Manage containers with edpm-ansible"
           include_role:
             name: edpm_container_manage
           vars:
-            edpm_container_manage_config: "/var/lib/edpm-config/container-startup-config/step_1"
-            edpm_container_manage_config_id: "edpm_step1"
+            edpm_container_manage_config: "/var/lib/openstack/config/containers"
+            edpm_container_manage_config_id: "nova"
 
 
 Healthchecks
@@ -120,29 +120,27 @@ This can be used to:
 * Output the container commands that are run to to manage containers lifecycle.
 * Output the changes that would have been made on containers by Ansible.
 
-.. note:: To manage a single container, you need to know 2 things:
-
-   * At which step the container is deployed.
+.. note:: To manage a single container, you need to know:
 
    * The name of the generated JSON file for container config.
 
-Here is an example of a playbook to manage HAproxy container at step 1 which
+Here is an example of a playbook to manage HAproxy container which
 overrides the image setting in one-off.
 
 .. code-block:: YAML
 
     - hosts: localhost
       become: true
       tasks:
-        - name: Manage step_1 containers using edpm-ansible
+        - name: Manage containers using edpm-ansible
           block:
-            - name: "Manage HAproxy container at step 1 with edpm-ansible"
+            - name: "Manage HAproxy container with edpm-ansible"
               include_role:
                 name: edpm_container_manage
               vars:
                 edpm_container_manage_config_patterns: 'haproxy.json'
-                edpm_container_manage_config: "/var/lib/edpm-config/container-startup-config/step_1"
-                edpm_container_manage_config_id: "edpm_step1"
+                edpm_container_manage_config: "/var/lib/openstack/config/containers"
+                edpm_container_manage_config_id: "haproxy"
                 edpm_container_manage_clean_orphans: false
                 edpm_container_manage_config_overrides:
                   haproxy:

plugins/filter/helpers.py

@@ -17,6 +17,7 @@
 import ast
 import binascii
 import json
+import os
 import re
 
 

plugins/modules/container_config_data.py

@@ -72,10 +72,10 @@
 EXAMPLES = """
 - name: Generate containers configs data
   container_config_data:
-    config_path: /var/lib/edpm-config/container-startup-config/step_1
+    config_path: /var/lib/openstack/config/containers/nova
 - name: Generate containers configs data for HAproxy and override image
   container_config_data:
-    config_path: /var/lib/edpm-config/container-startup-config/step_1
+    config_path: /var/lib/openstack/config/containers/haproxy
     config_pattern: 'haproxy.json'
     config_overrides:
       haproxy:

plugins/modules/container_config_hash.py

@@ -63,7 +63,7 @@
   container_config_hash:
 """
 
-CONTAINER_STARTUP_CONFIG = '/var/lib/edpm-config/container-startup-config'
+CONTAINER_STARTUP_CONFIG = '/var/lib/openstack/config/containers'
 BUF_SIZE = 65536
 
 
@@ -86,7 +86,7 @@ def __init__(self, module, results):
         # Set parameters
         self.config_vol_prefix = args['config_vol_prefix']
 
-        # Update container-startup-config with new config hashes
+        # Update containers config with new config hashes
         self._update_hashes()
 
         self.module.exit_json(**self.results)

plugins/modules/edpm_container_manage.py

@@ -50,7 +50,7 @@
 options:
   config_id:
     description:
-      - Config id for the label
+      - Service name for container labeling and isolation
     type: str
     required: True
   config_dir:
@@ -91,8 +91,8 @@
 EXAMPLES = """
 - name: Run containers
   edpm_container_manage:
-    config_id: edpm_step1
-    config_dir: /var/lib/edpm-config/container-startup-config/step_1
+    config_id: nova
+    config_dir: /var/lib/openstack/config/containers
 """
 
 
@@ -124,7 +124,9 @@ def __init__(self, module, results):
         # Set parameters
         self.concurrency = args.get('concurrency', 4)
         self.config_id = args.get('config_id')
-        self.config_dir = args.get('config_dir')
+        base_config_dir = args.get('config_dir')
+        # Create service-specific subdirectory based on config_id
+        self.config_dir = os.path.join(base_config_dir, self.config_id)
         self.config_patterns = args.get('config_patterns')
         self.config_overrides = args['config_overrides']
         self.log_base_path = args.get('log_base_path')

roles/edpm_container_manage/defaults/main.yml

@@ -23,8 +23,8 @@ edpm_container_manage_clean_orphans: true
 edpm_container_manage_update_config_hash: true
 edpm_container_manage_cli: podman
 edpm_container_manage_concurrency: 1
-edpm_container_manage_config: "/var/lib/edpm-config/"
-edpm_container_manage_config_id: edpm
+edpm_container_manage_config: "/var/lib/openstack/config/containers"
+edpm_container_manage_config_id: nova
 edpm_container_manage_config_overrides: {}
 edpm_container_manage_config_patterns: '*.json'
 edpm_container_manage_healthcheck_disabled: false

roles/edpm_container_manage/meta/argument_specs.yml

@@ -21,10 +21,10 @@ argument_specs:
         default: 1
       edpm_container_manage_config:
         type: str
-        default: "/var/lib/edpm-config/"
+        default: "/var/lib/openstack/config/containers"
       edpm_container_manage_config_id:
         type: str
-        default: edpm
+        default: nova
       edpm_container_manage_config_overrides:
         type: dict
         default: {}

roles/edpm_container_standalone/defaults/main.yml

@@ -23,8 +23,8 @@
 edpm_container_standalone_service: ""
 # Directory for kolla config files
 edpm_container_standalone_kolla_config_dir: /var/lib/kolla/config_files
-# Directory for container startup configs
-edpm_container_standalone_container_startup_config_dir: /var/lib/edpm-config/container-startup-config
+# Directory for container startup configs (service-specific subdirectory will be created)
+edpm_container_standalone_container_startup_config_dir: /var/lib/openstack/config/containers
 # Hash with keys of container name and value of YAML kolla config file.
 edpm_container_standalone_kolla_config_files: {}
 # Hash with keys of container name and value of YAML container definition
@@ -64,4 +64,4 @@ edpm_container_standalone_volumes: "{{
   }}"
 
 edpm_deploy_identifier: ''
-edpm_iscsid_config_volume: /var/lib/config-data/ansible-generated/iscsid
+edpm_iscsid_config_volume: /var/lib/config-data/iscsid

roles/edpm_container_standalone/meta/argument_specs.yml

@@ -21,8 +21,8 @@ argument_specs:
         description: Parsed container definitions.
         type: dict
       edpm_container_standalone_container_startup_config_dir:
-        default: /var/lib/edpm-config/container-startup-config
-        description: Path to configuration directory.
+        default: /var/lib/openstack/config/containers
+        description: Base path to configuration directory. Service-specific subdirectory will be created.
         type: path
       edpm_container_standalone_internal_tls_volumes:
         default:
@@ -64,6 +64,6 @@ argument_specs:
         description: Path to TLS certificate.
         type: path
       edpm_iscsid_config_volume:
-        default: /var/lib/config-data/ansible-generated/iscsid
+        default: /var/lib/config-data/iscsid
         description: Path to iscsid config directory.
         type: path

roles/edpm_container_standalone/tasks/main.yml

@@ -33,12 +33,13 @@
     mode: "0600"
   loop: "{{ edpm_container_standalone_kolla_config_files | dict2items }}"
 
-- name: "Create config file {{ edpm_container_standalone_container_startup_config_dir + '/' + edpm_container_standalone_service }}"
+- name: "Ensure container config directory exists: {{ edpm_container_standalone_container_startup_config_dir }}/{{ edpm_container_standalone_service }}"
   become: true
   ansible.builtin.file:
     path: "{{ edpm_container_standalone_container_startup_config_dir }}/{{ edpm_container_standalone_service }}"
     state: directory
     mode: "0755"
+    setype: "container_file_t"
 
 - name: "Render container definitions: [{{ edpm_container_standalone_service }} ]"
   become: true
@@ -55,6 +56,6 @@
   ansible.builtin.include_role:
     name: edpm_container_manage
   vars:
-    edpm_container_manage_config: "{{ edpm_container_standalone_container_startup_config_dir }}/{{ edpm_container_standalone_service }}"
+    edpm_container_manage_config: "{{ edpm_container_standalone_container_startup_config_dir }}"
     edpm_container_manage_config_patterns: "*.json"
     edpm_container_manage_config_id: "{{ edpm_container_standalone_service }}"