add support for deploy.resources

aksiksi · Mar 16, 2024 · 4df31ab · 4df31ab
1 parent e02a4eb
commit 4df31ab
Show file tree

Hide file tree

Showing 16 changed files with 77 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -233,6 +233,7 @@ If a feature is missing, please feel free to [create an issue](https://github.co
 | [`depends_on`](https://docs.docker.com/compose/compose-file/05-services/#depends_on) | ⚠️ | Only short syntax is supported. |
 | [`restart`](https://docs.docker.com/compose/compose-file/05-services/#restart) | ✅ | |
 | [`deploy.restart_policy`](https://docs.docker.com/compose/compose-file/deploy/#restart_policy) | ✅ | |
+| [`deploy.resources`](https://docs.docker.com/compose/compose-file/deploy/#resources) | ✅ | |
 | [`devices`](https://docs.docker.com/compose/compose-file/05-services/#devices) | ✅ | |
 | [`networks.aliases`](https://docs.docker.com/compose/compose-file/05-services/#aliases) | ✅ | |
 | [`network_mode`](https://docs.docker.com/compose/compose-file/05-services/#network_mode) | ✅ | |

diff --git a/compose.go b/compose.go
@@ -462,6 +462,29 @@ func (g *Generator) buildNixContainer(service types.ServiceConfig) (*NixContaine
 		}
 	}
 
+	// Deploy resources configuration.
+	// https://docs.docker.com/compose/compose-file/deploy/#resources
+	if deploy := service.Deploy; deploy != nil {
+		if limits := deploy.Resources.Limits; limits != nil {
+			if limits.MemoryBytes != 0 {
+				c.ExtraOptions = append(c.ExtraOptions, fmt.Sprintf("--memory=%db", limits.MemoryBytes))
+			}
+			// Name is misleading - this actually is the exact number passed in with "cpus".
+			if limits.NanoCPUs != "" {
+				c.ExtraOptions = append(c.ExtraOptions, "--cpu-quota="+limits.NanoCPUs)
+			}
+		}
+		if reservations := deploy.Resources.Reservations; reservations != nil {
+			if reservations.MemoryBytes != 0 {
+				c.ExtraOptions = append(c.ExtraOptions, fmt.Sprintf("--memory-reservation=%db", reservations.MemoryBytes))
+			}
+			// Name is misleading - this actually is the exact number passed in with "cpus".
+			if reservations.NanoCPUs != "" {
+				c.ExtraOptions = append(c.ExtraOptions, "--cpus="+reservations.NanoCPUs)
+			}
+		}
+	}
+
 	// Restart policy.
 	if err := c.SystemdConfig.ParseRestartPolicy(&service, g.Runtime); err != nil {
 		return nil, err

diff --git a/nixos-test/docker-compose.nix b/nixos-test/docker-compose.nix
@@ -21,6 +21,7 @@
     ];
     log-driver = "journald";
     extraOptions = [
+      "--cpus=1.0"
       "--network-alias=sabnzbd"
       "--network=myproject-default"
     ];

diff --git a/nixos-test/docker-compose.yml b/nixos-test/docker-compose.yml
@@ -8,6 +8,10 @@ services:
     volumes:
       - /var/volumes/sabnzbd:/config
       - storage:/storage
+    deploy:
+      resources:
+        reservations:
+          cpus: "1.0"
     labels:
       - 'compose2nix.systemd.service.Restart="no"'
       - "compose2nix.systemd.service.RuntimeMaxSec=360"

diff --git a/nixos-test/podman-compose.nix b/nixos-test/podman-compose.nix
@@ -26,6 +26,7 @@
     ];
     log-driver = "journald";
     extraOptions = [
+      "--cpus=1.0"
       "--network-alias=sabnzbd"
       "--network=myproject-default"
     ];

diff --git a/testdata/TestDocker_EnvFilesOnly_out.nix b/testdata/TestDocker_EnvFilesOnly_out.nix
@@ -31,11 +31,15 @@
     log-driver = "journald";
     autoStart = false;
     extraOptions = [
+      "--cpu-quota=1.5"
+      "--cpus=1.0"
       "--dns=1.1.1.1"
       "--health-cmd='curl -f http://localhost/\${POTATO}'"
       "--log-opt=compress=true"
       "--log-opt=max-file=3"
       "--log-opt=max-size=10m"
+      "--memory-reservation=524288000b"
+      "--memory=1048576000b"
       "--network=container:myproject-sabnzbd"
     ];
   };

diff --git a/testdata/TestDocker_NoWriteNixSetup_out.nix b/testdata/TestDocker_NoWriteNixSetup_out.nix
@@ -27,11 +27,15 @@
     log-driver = "journald";
     autoStart = false;
     extraOptions = [
+      "--cpu-quota=1.5"
+      "--cpus=1.0"
       "--dns=1.1.1.1"
       "--health-cmd='curl -f http://localhost/\${POTATO}'"
       "--log-opt=compress=true"
       "--log-opt=max-file=3"
       "--log-opt=max-size=10m"
+      "--memory-reservation=524288000b"
+      "--memory=1048576000b"
       "--network=container:myproject-sabnzbd"
     ];
   };

diff --git a/testdata/TestDocker_OverrideSystemdStopTimeout_out.nix b/testdata/TestDocker_OverrideSystemdStopTimeout_out.nix
@@ -33,11 +33,15 @@
     log-driver = "journald";
     autoStart = false;
     extraOptions = [
+      "--cpu-quota=1.5"
+      "--cpus=1.0"
       "--dns=1.1.1.1"
       "--health-cmd='curl -f http://localhost/\${POTATO}'"
       "--log-opt=compress=true"
       "--log-opt=max-file=3"
       "--log-opt=max-size=10m"
+      "--memory-reservation=524288000b"
+      "--memory=1048576000b"
       "--network=container:myproject-sabnzbd"
     ];
   };

diff --git a/testdata/TestDocker_RemoveVolumes_out.nix b/testdata/TestDocker_RemoveVolumes_out.nix
@@ -33,11 +33,15 @@
     log-driver = "journald";
     autoStart = false;
     extraOptions = [
+      "--cpu-quota=1.5"
+      "--cpus=1.0"
       "--dns=1.1.1.1"
       "--health-cmd='curl -f http://localhost/\${POTATO}'"
       "--log-opt=compress=true"
       "--log-opt=max-file=3"
       "--log-opt=max-size=10m"
+      "--memory-reservation=524288000b"
+      "--memory=1048576000b"
       "--network=container:myproject-sabnzbd"
     ];
   };

diff --git a/testdata/TestDocker_SystemdMount_out.nix b/testdata/TestDocker_SystemdMount_out.nix
@@ -33,11 +33,15 @@
     log-driver = "journald";
     autoStart = false;
     extraOptions = [
+      "--cpu-quota=1.5"
+      "--cpus=1.0"
       "--dns=1.1.1.1"
       "--health-cmd='curl -f http://localhost/\${POTATO}'"
       "--log-opt=compress=true"
       "--log-opt=max-file=3"
       "--log-opt=max-size=10m"
+      "--memory-reservation=524288000b"
+      "--memory=1048576000b"
       "--network=container:myproject-sabnzbd"
     ];
   };

diff --git a/testdata/TestDocker_WithProject_out.nix b/testdata/TestDocker_WithProject_out.nix
@@ -33,11 +33,15 @@
     log-driver = "journald";
     autoStart = false;
     extraOptions = [
+      "--cpu-quota=1.5"
+      "--cpus=1.0"
       "--dns=1.1.1.1"
       "--health-cmd='curl -f http://localhost/\${POTATO}'"
       "--log-opt=compress=true"
       "--log-opt=max-file=3"
       "--log-opt=max-size=10m"
+      "--memory-reservation=524288000b"
+      "--memory=1048576000b"
       "--network=container:myproject-sabnzbd"
     ];
   };

diff --git a/testdata/TestDocker_out.nix b/testdata/TestDocker_out.nix
@@ -32,11 +32,15 @@
     ];
     log-driver = "journald";
     extraOptions = [
+      "--cpu-quota=1.5"
+      "--cpus=1.0"
       "--dns=1.1.1.1"
       "--health-cmd='curl -f http://localhost/\${POTATO}'"
       "--log-opt=compress=true"
       "--log-opt=max-file=3"
       "--log-opt=max-size=10m"
+      "--memory-reservation=524288000b"
+      "--memory=1048576000b"
       "--network=container:myproject-sabnzbd"
     ];
   };

diff --git a/testdata/TestPodman_SystemdMount_out.nix b/testdata/TestPodman_SystemdMount_out.nix
@@ -38,11 +38,15 @@
     log-driver = "journald";
     autoStart = false;
     extraOptions = [
+      "--cpu-quota=1.5"
+      "--cpus=1.0"
       "--dns=1.1.1.1"
       "--health-cmd='curl -f http://localhost/\${POTATO}'"
       "--log-opt=compress=true"
       "--log-opt=max-file=3"
       "--log-opt=max-size=10m"
+      "--memory-reservation=524288000b"
+      "--memory=1048576000b"
       "--network=container:myproject-sabnzbd"
     ];
   };

diff --git a/testdata/TestPodman_WithProject_out.nix b/testdata/TestPodman_WithProject_out.nix
@@ -38,11 +38,15 @@
     log-driver = "journald";
     autoStart = false;
     extraOptions = [
+      "--cpu-quota=1.5"
+      "--cpus=1.0"
       "--dns=1.1.1.1"
       "--health-cmd='curl -f http://localhost/\${POTATO}'"
       "--log-opt=compress=true"
       "--log-opt=max-file=3"
       "--log-opt=max-size=10m"
+      "--memory-reservation=524288000b"
+      "--memory=1048576000b"
       "--network=container:myproject-sabnzbd"
     ];
   };

diff --git a/testdata/TestPodman_out.nix b/testdata/TestPodman_out.nix
@@ -37,11 +37,15 @@
     ];
     log-driver = "journald";
     extraOptions = [
+      "--cpu-quota=1.5"
+      "--cpus=1.0"
       "--dns=1.1.1.1"
       "--health-cmd='curl -f http://localhost/\${POTATO}'"
       "--log-opt=compress=true"
       "--log-opt=max-file=3"
       "--log-opt=max-size=10m"
+      "--memory-reservation=524288000b"
+      "--memory=1048576000b"
       "--network=container:myproject-sabnzbd"
     ];
   };

diff --git a/testdata/docker-compose.yml b/testdata/docker-compose.yml
@@ -120,6 +120,13 @@ services:
         delay: 5s
         max_attempts: 3
         window: 120s
+      resources:
+        limits:
+          cpus: "1.5"
+          memory: 1000M
+        reservations:
+          cpus: "1.0"
+          memory: 500M
     logging:
       driver: "json-file"
       options: