feat(cli): restrict rollups-node resources

now it is possible to define limits for memory and cpu used for the rollups-node (validator) container, the defaults are generous but can be redefined
cartesi · Aug 21, 2024 · ea68daa · ea68daa
1 parent 70c6c36
commit ea68daa
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 2 deletions.
diff --git a/.changeset/tidy-dolphins-serve.md b/.changeset/tidy-dolphins-serve.md
@@ -0,0 +1,5 @@
+---
+"@cartesi/cli": patch
+---
+
+add --cpus and --memory to run command
diff --git a/apps/cli/src/commands/run.ts b/apps/cli/src/commands/run.ts
@@ -54,7 +54,17 @@ export default class Run extends BaseCommand<typeof Run> {
             description: "port to listen for incoming connections",
             default: 8080,
         }),
-        "show-config": Flags.boolean({
+        cpus: Flags.integer({
+            description:
+                "Define the number of CPUs to use (eg.: 1) for the rollups-node",
+            summary: "number of cpu limits for the rollups-node",
+        }),
+        memory: Flags.integer({
+            description:
+                "Define the amount of memory to use for the rollups-node in MB (eg.: 1024)",
+            summary: "memory limit for the rollups-node in MB",
+        }),
+        "dry-run": Flags.boolean({
             description: "show the docker compose configuration",
             default: false,
             hidden: true,
@@ -104,10 +114,18 @@ export default class Run extends BaseCommand<typeof Run> {
             CARTESI_SNAPSHOT_DIR: "/usr/share/rollups-node/snapshot",
             CARTESI_BIN_PATH: binPath,
             CARTESI_LISTEN_PORT: listenPort.toString(),
+            CARTESI_VALIDATOR_CPUS: flags.cpus?.toString(),
+            CARTESI_VALIDATOR_MEMORY: flags.memory?.toString(),
         };
 
         // validator
         const composeFiles = ["docker-compose-validator.yaml"];
+        if (flags.cpus) {
+            composeFiles.push("docker-compose-validator-cpus.yaml");
+        }
+        if (flags.memory) {
+            composeFiles.push("docker-compose-validator-memory.yaml");
+        }
 
         // prompt
         composeFiles.push("docker-compose-prompt.yaml");
@@ -174,7 +192,7 @@ export default class Run extends BaseCommand<typeof Run> {
         process.on("SIGINT", () => {});
 
         try {
-            if (flags["show-config"]) {
+            if (flags["dry-run"]) {
                 // show the docker compose configuration
                 await execa("docker", [...compose_args, "config"], {
                     env,

diff --git a/apps/cli/src/node/docker-compose-validator-cpus.yaml b/apps/cli/src/node/docker-compose-validator-cpus.yaml
@@ -0,0 +1,6 @@
+services:
+    validator:
+        deploy:
+            resources:
+                limits:
+                    cpus: "${CARTESI_VALIDATOR_CPUS}"
diff --git a/apps/cli/src/node/docker-compose-validator-memory.yaml b/apps/cli/src/node/docker-compose-validator-memory.yaml
@@ -0,0 +1,6 @@
+services:
+    validator:
+        deploy:
+            resources:
+                limits:
+                    memory: "${CARTESI_VALIDATOR_MEMORY}M"