add renew_anon_volumes parameter to docker compose up (#977)

* add `renew_anon_volumes` parameter to `docker compose up` * Apply suggestions from code review Apply suggested changes to Documentation Co-authored-by: Felix Fontein <[email protected]> * Fix sanity check error apply suggestion from code review Co-authored-by: Felix Fontein <[email protected]> * add changelog fragment for PR #977 * apply suggested changes to changelog fragment Co-authored-by: Felix Fontein <[email protected]> --------- Co-authored-by: Christoph Sieber <[email protected]> Co-authored-by: Felix Fontein <[email protected]>
ansible-collections · Oct 19, 2024 · be5564d · be5564d
1 parent 309a30e
commit be5564d
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/changelogs/fragments/977-renew_anon_volumes.yaml b/changelogs/fragments/977-renew_anon_volumes.yaml
@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - docker_compose_v2 - add ``renew_anon_volumes`` parameter for ``docker compose up`` (https://github.com/ansible-collections/community.docker/pull/977).
diff --git a/plugins/modules/docker_compose_v2.py b/plugins/modules/docker_compose_v2.py
@@ -93,6 +93,13 @@
       - always
       - never
       - auto
+  renew_anon_volumes:
+    description:
+      - Whether to recreate instead of reuse anonymous volumes from previous containers.
+      - V(true) is equivalent to the C(--renew-anon-volumes) option of C(docker compose up).
+    type: bool
+    default: false
+    version_added: 4.0.0
   remove_images:
     description:
       - Use with O(state=absent) to remove all images or only local images.
@@ -436,6 +443,7 @@ def __init__(self, client):
         self.remove_images = parameters['remove_images']
         self.remove_volumes = parameters['remove_volumes']
         self.remove_orphans = parameters['remove_orphans']
+        self.renew_anon_volumes = parameters['renew_anon_volumes']
         self.timeout = parameters['timeout']
         self.services = parameters['services'] or []
         self.scale = parameters['scale'] or {}
@@ -478,6 +486,8 @@ def get_up_cmd(self, dry_run, no_start=False):
             args.append('--force-recreate')
         if self.recreate == 'never':
             args.append('--no-recreate')
+        if self.renew_anon_volumes:
+            args.append('--renew-anon-volumes')
         if not self.dependencies:
             args.append('--no-deps')
         if self.timeout is not None:
@@ -620,6 +630,7 @@ def main():
         pull=dict(type='str', choices=['always', 'missing', 'never', 'policy'], default='policy'),
         build=dict(type='str', choices=['always', 'never', 'policy'], default='policy'),
         recreate=dict(type='str', default='auto', choices=['always', 'never', 'auto']),
+        renew_anon_volumes=dict(type='bool', default=False),
         remove_images=dict(type='str', choices=['all', 'local']),
         remove_volumes=dict(type='bool', default=False),
         remove_orphans=dict(type='bool', default=False),