fix: clamp desiredNodes within [minNodes, maxNodes] range

Co-authored-by: fredleger <2778741+fredleger@users.noreply.github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>

Author: 2 people

.devcontainer/devcontainer.json

@@ -1,9 +1,11 @@
 {
-  "name": "Debian",
-  "image": "mcr.microsoft.com/devcontainers/base:bullseye",
+  "name": "github-action-ovh-mks-scaling",
+  "image": "mcr.microsoft.com/devcontainers/base:debian",
   "features": {
     "ghcr.io/devcontainers/features/node:1": {},
-    "ghcr.io/devcontainers/features/docker-in-docker:2": {},
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {
+      "moby": false
+    },
     "ghcr.io/devcontainers/features/github-cli:1": {}
   },
   "remoteEnv": {

Makefile

@@ -18,7 +18,7 @@ lint-fix: ## Execute linting and fix
 
 ci: ## Execute all formats and checks
 	@npm install
-	@npm audit fix
+	@npm audit fix || true
 	@npm run all
 	$(MAKE) lint-fix
 

action.yml

@@ -44,24 +44,31 @@ inputs:
   nodepool-id:
     required: true
     description: "The ID of the OVH MKS nodepool"
-  number-of-nodes:
-    required: true
-    description: "The desired number of nodes to scale to"
-    default: "1"
   autoscale:
     required: false
     description: "Whether to enable autoscaling for the nodepool"
     default: "true"
+  number-of-nodes:
+    required: true
+    description: |
+      The desired number of nodes to scale to.
+      This value sets the `desiredNodes` property on the OVH API.
+      It is also used as the default for `min-nodes` and `max-nodes` when they are not provided.
+      The effective `desiredNodes` sent to the API is clamped between `min-nodes` and `max-nodes`
+      (i.e. `max(number-of-nodes, min-nodes)` then `min(result, max-nodes)`).
+    default: "1"
   min-nodes:
     required: false
     description: |
-      The minimum number of nodes for autoscaling.
-      Defaults to the value of number-of-nodes if not provided.
+      The minimum number of nodes for autoscaling (sets `minNodes` on the OVH API).
+      Defaults to `number-of-nodes` if not provided.
+      When autoscaling is enabled, the cluster will never scale below this value.
   max-nodes:
     required: false
     description: |
-      The maximum number of nodes for autoscaling.
-      Defaults to the value of number-of-nodes if not provided.
+      The maximum number of nodes for autoscaling (sets `maxNodes` on the OVH API).
+      Defaults to `number-of-nodes` if not provided.
+      When autoscaling is enabled, the cluster will never scale above this value.
 
 outputs:
   response:

dist/index.js

@@ -87,4 +87,4 @@
   "tsDevTools": {
     "version": "20250623095600-remove-prettier-oxc"
   }
-}
+}

package-lock.json

@@ -337,6 +337,58 @@ describe("OvhService", () => {
       );
     });
 
+    it("should clamp desiredNodes to minNodes when numberOfNodes is below minNodes", async () => {
+      mockRequestPromised.mockResolvedValue({} as NodepoolUpdateResponse);
+
+      await service.scaleNodepool({
+        projectId: "project-123",
+        clusterId: "cluster-456",
+        nodepoolId: "nodepool-789",
+        numberOfNodes: 1,
+        autoscale: true,
+        minNodes: 3,
+        maxNodes: 10,
+      });
+
+      expect(mockRequestPromised).toHaveBeenCalledWith(
+        "PUT",
+        "/cloud/project/project-123/kube/cluster-456/nodepool/nodepool-789",
+        {
+          autoscale: true,
+          autoscaling: {},
+          minNodes: 3,
+          maxNodes: 10,
+          desiredNodes: 3,
+        }
+      );
+    });
+
+    it("should clamp desiredNodes to maxNodes when numberOfNodes is above maxNodes", async () => {
+      mockRequestPromised.mockResolvedValue({} as NodepoolUpdateResponse);
+
+      await service.scaleNodepool({
+        projectId: "project-123",
+        clusterId: "cluster-456",
+        nodepoolId: "nodepool-789",
+        numberOfNodes: 15,
+        autoscale: true,
+        minNodes: 3,
+        maxNodes: 10,
+      });
+
+      expect(mockRequestPromised).toHaveBeenCalledWith(
+        "PUT",
+        "/cloud/project/project-123/kube/cluster-456/nodepool/nodepool-789",
+        {
+          autoscale: true,
+          autoscaling: {},
+          minNodes: 3,
+          maxNodes: 10,
+          desiredNodes: 10,
+        }
+      );
+    });
+
     it("should disable autoscale and use numberOfNodes for min/max when autoscale is false and no overrides", async () => {
       const mockResponse: NodepoolUpdateResponse = {
         autoscale: false,

package.json

@@ -164,6 +164,10 @@ export class OvhService {
   }) {
     const effectiveMinNodes = minNodes ?? numberOfNodes;
     const effectiveMaxNodes = maxNodes ?? numberOfNodes;
+    const effectiveDesiredNodes = Math.min(
+      Math.max(numberOfNodes, effectiveMinNodes),
+      effectiveMaxNodes
+    );
 
     return this.client.requestPromised(
       "PUT",
@@ -173,7 +177,7 @@ export class OvhService {
         autoscaling: {},
         minNodes: effectiveMinNodes,
         maxNodes: effectiveMaxNodes,
-        desiredNodes: numberOfNodes,
+        desiredNodes: effectiveDesiredNodes,
       }
     );
   }