operators/docker: add support for setting labels

Co-authored-by: Anatol Ulrich <[email protected]>

Author: spookyvision

src/pyinfra/operations/docker.py

@@ -27,6 +27,7 @@ def container(
     networks: list[str] | None = None,
     volumes: list[str] | None = None,
     env_vars: list[str] | None = None,
+    labels: list[str] | None = None,
     pull_always: bool = False,
     present: bool = True,
     force: bool = False,
@@ -41,6 +42,7 @@ def container(
     + ports: port list to expose
     + volumes: volume list to map on container
     + env_vars: environment variable list to inject on container
+    + labels: Label list to attach to the container
     + pull_always: force image pull
     + force: remove a container with same name and create a new one
     + present: whether the container should be up and running
@@ -85,6 +87,7 @@ def container(
         networks or list(),
         volumes or list(),
         env_vars or list(),
+        labels or list(),
         pull_always,
     )
     existent_container = host.get_fact(DockerContainer, object_id=container)

src/pyinfra/operations/util/docker.py

@@ -163,6 +163,7 @@ class ContainerSpec:
     networks: list[str] = field(default_factory=list)
     volumes: list[str] = field(default_factory=list)
     env_vars: list[str] = field(default_factory=list)
+    labels: list[str] = field(default_factory=list)
     pull_always: bool = False
 
     def container_create_args(self):
@@ -179,6 +180,9 @@ def container_create_args(self):
         for env_var in self.env_vars:
             args.append("-e {0}".format(env_var))
 
+        for label in self.labels:
+            args.append("--label {0}".format(label))
+
         if self.pull_always:
             args.append("--pull always")
 

tests/operations/docker.container/add_container_with_labels.json

@@ -0,0 +1,19 @@
+{
+    "kwargs": {
+        "container": "nginx",
+        "image": "nginx:alpine",
+        "labels": [
+            "eg_key=eg_val"
+        ],
+        "present": "true",
+        "start": false
+    },
+    "facts": {
+        "docker.DockerContainer": {
+            "object_id=nginx": []
+        }
+    },
+    "commands": [
+        "docker container create --name nginx --label eg_key=eg_val nginx:alpine"
+    ]
+}