operations.docker: add extra parameters (#1593)

Author: wowi42

src/pyinfra/operations/docker.py

@@ -35,6 +35,14 @@ def container(
     start: bool = True,
     restart_policy: str | None = None,
     auto_remove: bool = False,
+    mounts: list[str] | None = None,
+    privileged: bool = False,
+    hostname: str | None = None,
+    entrypoint: str | None = None,
+    user: str | None = None,
+    cpus: float | None = None,
+    memory: str | None = None,
+    extra_args: list[str] | None = None,
     dns: list[str] | None = None,
 ):
     """
@@ -54,6 +62,14 @@ def container(
     + start: start or stop the container
     + restart_policy: restart policy to apply when a container exits
     + auto_remove: automatically remove the container and its associated anonymous volumes when it exits
+    + mounts: list of ``--mount`` specifications (e.g. ``type=bind,source=/src,target=/app``)
+    + privileged: give extended privileges to the container
+    + hostname: container hostname
+    + entrypoint: override the default entrypoint
+    + user: username or UID to run as
+    + cpus: number of CPUs (e.g. ``1.5``)
+    + memory: memory limit (e.g. ``512m``, ``1g``)
+    + extra_args: list of additional raw arguments passed to ``docker container create``
     + dns: list of dns servers to be used by the container
 
     **Examples:**
@@ -76,6 +92,21 @@ def container(
             auto_remove=True,
         )
 
+        # Run a container with mounts and resource limits
+        docker.container(
+            name="Deploy app container",
+            container="myapp",
+            image="myapp:latest",
+            mounts=["type=bind,source=/host/data,target=/app/data"],
+            privileged=True,
+            hostname="myapp-host",
+            entrypoint="/bin/sh",
+            user="1000:1000",
+            cpus=2.0,
+            memory="512m",
+            extra_args=["--cap-add", "NET_ADMIN"],
+        )
+
         # Stop a container
         docker.container(
             name="Stop Nginx container",
@@ -102,6 +133,14 @@ def container(
         pull_always,
         restart_policy,
         auto_remove,
+        mounts or list(),
+        privileged,
+        hostname,
+        entrypoint,
+        user,
+        cpus,
+        memory,
+        extra_args or list(),
         dns or list(),
     )
     existent_container = host.get_fact(DockerContainer, object_id=container)

src/pyinfra/operations/util/docker.py

@@ -168,6 +168,14 @@ class ContainerSpec:
     pull_always: bool = False
     restart_policy: str | None = None
     auto_remove: bool = False
+    mounts: list[str] = field(default_factory=list)
+    privileged: bool = False
+    hostname: str | None = None
+    entrypoint: str | None = None
+    user: str | None = None
+    cpus: float | None = None
+    memory: str | None = None
+    extra_args: list[str] = field(default_factory=list)
     dns: list[str] = field(default_factory=list)
 
     def container_create_args(self):
@@ -181,6 +189,9 @@ def container_create_args(self):
         for volume in self.volumes:
             args.append("-v {0}".format(volume))
 
+        for mount in self.mounts:
+            args.append("--mount {0}".format(mount))
+
         for env_var in self.env_vars:
             args.append("-e {0}".format(env_var))
 
@@ -199,6 +210,27 @@ def container_create_args(self):
         if self.auto_remove:
             args.append("--rm")
 
+        if self.privileged:
+            args.append("--privileged")
+
+        if self.hostname is not None:
+            args.append("--hostname {0}".format(self.hostname))
+
+        if self.entrypoint is not None:
+            args.append("--entrypoint {0}".format(self.entrypoint))
+
+        if self.user is not None:
+            args.append("--user {0}".format(self.user))
+
+        if self.cpus is not None:
+            args.append("--cpus {0}".format(self.cpus))
+
+        if self.memory is not None:
+            args.append("--memory {0}".format(self.memory))
+
+        for extra_arg in self.extra_args:
+            args.append(extra_arg)
+
         for dns in self.dns:
             args.append("--dns {0}".format(dns))
 

tests/operations/docker.container/add_container_with_all_new_options.json

@@ -0,0 +1,25 @@
+{
+    "kwargs": {
+        "container": "myapp",
+        "image": "myapp:latest",
+        "ports": ["8080:80"],
+        "mounts": ["type=bind,source=/host/data,target=/app/data"],
+        "privileged": true,
+        "hostname": "myapp-host",
+        "entrypoint": "/bin/sh",
+        "user": "1000:1000",
+        "cpus": 1.5,
+        "memory": "1g",
+        "extra_args": ["--cap-add", "SYS_PTRACE"],
+        "present": "true",
+        "start": false
+    },
+    "facts": {
+        "docker.DockerContainer": {
+            "object_id=myapp": []
+        }
+    },
+    "commands": [
+        "docker container create --name myapp -p 8080:80 --mount type=bind,source=/host/data,target=/app/data --privileged --hostname myapp-host --entrypoint /bin/sh --user 1000:1000 --cpus 1.5 --memory 1g --cap-add SYS_PTRACE myapp:latest"
+    ]
+}

tests/operations/docker.container/add_container_with_cpus_and_memory.json

@@ -0,0 +1,18 @@
+{
+    "kwargs": {
+        "container": "myapp",
+        "image": "myapp:latest",
+        "cpus": 2.0,
+        "memory": "512m",
+        "present": "true",
+        "start": false
+    },
+    "facts": {
+        "docker.DockerContainer": {
+            "object_id=myapp": []
+        }
+    },
+    "commands": [
+        "docker container create --name myapp --cpus 2.0 --memory 512m myapp:latest"
+    ]
+}

tests/operations/docker.container/add_container_with_entrypoint.json

@@ -0,0 +1,17 @@
+{
+    "kwargs": {
+        "container": "myapp",
+        "image": "myapp:latest",
+        "entrypoint": "/bin/sh",
+        "present": "true",
+        "start": false
+    },
+    "facts": {
+        "docker.DockerContainer": {
+            "object_id=myapp": []
+        }
+    },
+    "commands": [
+        "docker container create --name myapp --entrypoint /bin/sh myapp:latest"
+    ]
+}

tests/operations/docker.container/add_container_with_extra_args.json

@@ -0,0 +1,17 @@
+{
+    "kwargs": {
+        "container": "myapp",
+        "image": "myapp:latest",
+        "extra_args": ["--cap-add", "NET_ADMIN", "--device", "/dev/net/tun"],
+        "present": "true",
+        "start": false
+    },
+    "facts": {
+        "docker.DockerContainer": {
+            "object_id=myapp": []
+        }
+    },
+    "commands": [
+        "docker container create --name myapp --cap-add NET_ADMIN --device /dev/net/tun myapp:latest"
+    ]
+}

tests/operations/docker.container/add_container_with_hostname.json

@@ -0,0 +1,17 @@
+{
+    "kwargs": {
+        "container": "myapp",
+        "image": "myapp:latest",
+        "hostname": "myapp-host",
+        "present": "true",
+        "start": false
+    },
+    "facts": {
+        "docker.DockerContainer": {
+            "object_id=myapp": []
+        }
+    },
+    "commands": [
+        "docker container create --name myapp --hostname myapp-host myapp:latest"
+    ]
+}

tests/operations/docker.container/add_container_with_mounts.json

@@ -0,0 +1,20 @@
+{
+    "kwargs": {
+        "container": "myapp",
+        "image": "myapp:latest",
+        "mounts": [
+            "type=bind,source=/host/data,target=/app/data",
+            "type=tmpfs,target=/tmp"
+        ],
+        "present": "true",
+        "start": false
+    },
+    "facts": {
+        "docker.DockerContainer": {
+            "object_id=myapp": []
+        }
+    },
+    "commands": [
+        "docker container create --name myapp --mount type=bind,source=/host/data,target=/app/data --mount type=tmpfs,target=/tmp myapp:latest"
+    ]
+}

tests/operations/docker.container/add_container_with_privileged.json

@@ -0,0 +1,17 @@
+{
+    "kwargs": {
+        "container": "myapp",
+        "image": "myapp:latest",
+        "privileged": true,
+        "present": "true",
+        "start": false
+    },
+    "facts": {
+        "docker.DockerContainer": {
+            "object_id=myapp": []
+        }
+    },
+    "commands": [
+        "docker container create --name myapp --privileged myapp:latest"
+    ]
+}

tests/operations/docker.container/add_container_with_user.json

@@ -0,0 +1,17 @@
+{
+    "kwargs": {
+        "container": "myapp",
+        "image": "myapp:latest",
+        "user": "1000:1000",
+        "present": "true",
+        "start": false
+    },
+    "facts": {
+        "docker.DockerContainer": {
+            "object_id=myapp": []
+        }
+    },
+    "commands": [
+        "docker container create --name myapp --user 1000:1000 myapp:latest"
+    ]
+}