Add service cleanup automation

This PR implements the service cleanup functionality with an
edpm_cleanup role.

- edpm_container_standalone creates a state file to keep track of
deployed services on the nodes
- Containers for services not in service list of nodeset would be
cleaned by adding cleanup service to the nodeset services list or
a new deployment with cleanup in 'servicesOverride'
- If a service drops a container it would be automatically cleaned
up
- Service cleanup will also remove containers, startup_config and other
config files along with running the specific cleanup tasks provided in
cleanup.yaml of a role

jira: https://issues.redhat.com/browse/OSPRH-19243

Assisted-by: claude-4-sonnet

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

Author: rabi

docs/source/roles/role-edpm_container_manage.rst

@@ -143,7 +143,6 @@ overrides the image setting in one-off.
                 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_clean_orphans: false
                 edpm_container_manage_config_overrides:
                   haproxy:
                     image: quay.io/edpmmastercentos9/centos-binary-haproxy:hotfix
@@ -164,10 +163,11 @@ containers by Ansible.
 
     $ ansible-playbook haproxy.yaml --check --diff
 
-The ``edpm_container_manage_clean_orphans`` parameter is optional
-and can be set to `false` to not clean orphaned containers for a
-config_id. It can be used to manage a single container without
-impacting other running containers with same config_id.
+.. warning::
+
+    The ``edpm_container_manage_clean_orphans`` parameter is **deprecated** and will be removed in a future release.
+    While it still functions, users should migrate to using ``edpm_cleanup_orphaned_containers`` in the
+    ``edpm_container_standalone`` role instead, which provides better state-file aware orphan cleanup.
 
 The ``edpm_container_manage_config_overrides`` parameter is optional
 and can be used to override a specific container attribute like the image

playbooks/cleanup.yml

@@ -0,0 +1,41 @@
+---
+# Copyright 2025 Red Hat, Inc.
+# All Rights Reserved.
+#
+# 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.
+
+- name: Cleanup EDPM Services
+  hosts: "{{ edpm_override_hosts | default('all', true) }}"
+  strategy: linear
+  gather_facts: "{{ gather_facts | default(false) }}"
+  any_errors_fatal: "{{ edpm_any_errors_fatal | default(true) }}"
+  max_fail_percentage: "{{ edpm_max_fail_percentage | default(0) }}"
+  environment: "{{ edpm_playbook_environment | default({}) }}"
+  tasks:
+    - name: Display cleanup information
+      ansible.builtin.debug:
+        msg:
+          - "=========================================="
+          - "Services to keep (from edpm_service_types):"
+          - "{{ edpm_service_types | default([]) | join(', ') }}"
+          - "=========================================="
+          - "This will clean up all services NOT in edpm_service_types:"
+          - "  - Stop and disable systemd services"
+          - "  - Remove containers"
+          - "  - Remove configuration directories"
+          - "  - Update state file"
+          - "=========================================="
+
+    - name: Cleanup services
+      ansible.builtin.include_role:
+        name: osp.edpm.edpm_cleanup

playbooks/nova.yml

@@ -2,6 +2,9 @@
 
 - name: Deploy EDPM Nova storage infrastructure
   ansible.builtin.import_playbook: nova_storage.yml
+  vars:
+    edpm_service_name: nova
+
 - name: Deploy EDPM Nova
   hosts: "{{ edpm_override_hosts | default('all', true) }}"
   strategy: linear

plugins/filter/helpers.py

@@ -41,7 +41,7 @@ def needs_delete(self, container_infos, config, config_id,
         :param container_infos: list
         :param config: dict
         :param config_id: string
-        :param clean_orphans: bool
+        :param clean_orphans: bool (DEPRECATED - use edpm_cleanup_orphaned_containers instead)
         :param check_config: bool to whether or not check if config changed
         :returns: list
         """

plugins/filter/needs_delete.yml

@@ -81,6 +81,13 @@
       - Number of podman actions to run at the same time
     type: int
     default: 1
+  containers:
+    description:
+      - List of specific container names to manage
+      - If empty, all containers matching the pattern will be managed
+    type: list
+    elements: str
+    default: []
   debug:
     description:
       - Enable debug
@@ -127,6 +134,7 @@ def __init__(self, module, results):
         self.config_dir = args.get('config_dir')
         self.config_patterns = args.get('config_patterns')
         self.config_overrides = args['config_overrides']
+        self.containers = args.get('containers', [])
         self.log_base_path = args.get('log_base_path')
         self.debug = args.get('debug')
 
@@ -155,6 +163,11 @@ def _get_configs(self):
                                          self.config_patterns))
         for match in matches:
             name = os.path.splitext(os.path.basename(match))[0]
+            # Skip if specific containers list provided and this isn't in it
+            if self.containers and name not in self.containers:
+                if self.debug:
+                    self.module.debug(f'Skipping {name} - not in containers list')
+                continue
             with open(match, 'r') as data:
                 config = json.loads(data.read())
             if self.debug: