.ansible-lint

@@ -5,4 +5,3 @@ skip_list:
 exclude_paths:
   - .forgejo/
   - "**/*.sops.yaml"
-  - "./resources/chaosknoten/zammad/docker_compose/compose.yaml"

roles/docker_compose/README.md

@@ -7,18 +7,17 @@ A use case for the deployment of the additional configuration files is Composes
 
 ## Supported Distributions
 
-Should work on Debian-based distributions.
+The following distributions are supported:
+
+- Debian 11
 
 ## Required Arguments
 
-- `docker_compose__compose_file_content`: The content to deploy to the Compose file at `/ansible_docker_compose/compose.yaml`.
+For the required arguments look at the [`argument_specs.yaml`](./meta/argument_specs.yaml).
 
-## Optional Arguments
+## `hosts`
 
-- `docker_compose__env_file_content`: The content to deploy to the `.env` file at `/ansible_docker_compose/.env`.
-- `docker_compose__configuration_files`: A list of configuration files to deploy to the `/ansible_docker_compose/configs/` directory.
-- `docker_compose__configuration_files.*.name`: The name of the configuration file.
-- `docker_compose__configuration_files.*.content`: The content to deploy to the configuration file.
+The `hosts` for this role need to be the machines, for which you want to make sure the given Compose file is deployed and all services of it are up-to-date and running.
 
 ## Links & Resources
 

roles/docker_compose/meta/argument_specs.yaml

@@ -2,20 +2,31 @@ argument_specs:
   main:
     options:
       docker_compose__compose_file_content:
+        description: >-
+          The content of the Compose file at
+          `/ansible_docker_compose/compose.yaml`.
         type: str
         required: true
       docker_compose__env_file_content:
+        description: >-
+          The content of the .env file at
+          `/ansible_docker_compose/.env`.
         type: str
         required: false
       docker_compose__configuration_files:
+        description: >-
+          A list of configuration files to be deployed in the
+          `/ansible_docker_compose/configs/` directory.
         type: list
         elements: dict
         required: false
         default: [ ]
         options:
           name:
+            description: The name of the configuration file.
             type: str
             required: true
           content:
+            description: The content of the configuration file.
             type: str
             required: true

roles/docker_compose/meta/main.yaml

@@ -1,3 +1,10 @@
 ---
 dependencies:
+  - role: distribution_check
+    vars:
+      distribution_check__distribution_support_spec:
+        - name: Debian
+          major_versions:
+            - 11
+            - 12
   - role: docker