GitHub Action: OVH MKS Scaling

---

Overview

Scale up or down your OVH MKS nodepool.

Rely on the OVH API through the OVH Node.js SDK to manage your Kubernetes clusters. It allows you to scale the number of nodes in a specific nodepool of an OVH Managed Kubernetes Service (MKS) cluster. This action supports both Application Key/Application Secret and OAuth2 authentication methods.

Usage

- uses: hoverkraft-tech/github-action-ovh-mks-scaling@d9f205d85554633240217794cd535ecd0f84854c # 0.3.0
  with:
    # The OVH endpoint to use.
    # See the [available endpoints](https://github.com/ovh/node-ovh/blob/master/lib/endpoints.js) list.
    endpoint: ""

    # The OVH application key
    application-key: ""

    # The OVH application secret
    application-secret: ""

    # The OVH consumer key
    consumer-key: ""

    # The OAuth2 client ID
    client-id: ""

    # The OAuth2 client secret
    client-secret: ""

    # The project ID of the OVH MKS project
    # This input is required.
    project-id: ""

    # The ID of the OVH MKS cluster
    # This input is required.
    cluster-id: ""

    # The ID of the OVH MKS nodepool
    # This input is required.
    nodepool-id: ""

    # Whether to enable autoscaling for the nodepool
    # Default: `true`
    autoscale: "true"

    # 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)`).
    #
    # This input is required.
    # Default: `1`
    number-of-nodes: "1"

    # 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.
    min-nodes: ""

    # 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.
    max-nodes: ""

Prerequisites

You need first to :

• Create an application in OVH API at : https://www.ovh.com/auth/api/createApp
• Export env vars OVH_APPLICATION_KEY and OVH_APPLICATION_SECRET
• And to run the script scripts/create-ovh-creds.sh
• note the consumer key
• click on the link for credentials validation

export OVH_APPLICATION_KEY="your_application_key"
export OVH_APPLICATION_SECRET="your_application_secret"

bash scripts/create-ovh-creds.sh

Inputs

Input	Description	Required	Default
endpoint	The OVH endpoint to use.	false	-
	See the available endpoints list.
application-key	The OVH application key	false	-
application-secret	The OVH application secret	false	-
consumer-key	The OVH consumer key	false	-
client-id	The OAuth2 client ID	false	-
client-secret	The OAuth2 client secret	false	-
project-id	The project ID of the OVH MKS project	true	-
cluster-id	The ID of the OVH MKS cluster	true	-
nodepool-id	The ID of the OVH MKS nodepool	true	-
autoscale	Whether to enable autoscaling for the nodepool	false	true
number-of-nodes	The desired number of nodes to scale to.	true	1
	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)).
min-nodes	The minimum number of nodes for autoscaling (sets minNodes on the OVH API).	false	-
	Defaults to number-of-nodes if not provided.
	When autoscaling is enabled, the cluster will never scale below this value.
max-nodes	The maximum number of nodes for autoscaling (sets maxNodes on the OVH API).	false	-
	Defaults to number-of-nodes if not provided.
	When autoscaling is enabled, the cluster will never scale above this value.

Outputs

Output	Description
response	The response of the server

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

License

This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2026 hoverkraft

For more details, see the license.

---

This documentation was automatically generated by CI Dokumentor.