MENU
      Upgrade NodePool
        • PDF

        Upgrade NodePool

        • PDF

        Article summary

        Available in VPC

        Upgrade the version of the NodePool registered in the cluster. You can also set values in case nodes are added or become unavailable during the upgrade.

        Note

        Before upgrading your NodePool, check for factors that may impact the service. For a detailed description of the check factors, see the Ncloud Kubernetes Service User Guide.

        Requests

        The following describes the request format for the endpoint. The request format is as follows.

        MethodURI
        PATCH/clusters/{uuid}/node-pool/{instanceNo}/upgrade

        Request headers

        For headers common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service common headers.

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        uuidStringRequiredCluster's UUID
        instanceNoIntegerRequiredNodePool instance number

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        k8sVersionStringRequiredKubernetes version to upgrade
        • Only within the cluster's version of Kubernetes
        maxSurgeIntegerOptionalNumber of nodes that can be added during an upgrade
        • 0 to the current number of nodes (default: 1)
        maxUnavailableIntegerOptionalNumber of nodes you can afford to take out of service during an upgrade
        • 0 to the current number of nodes (default: 0)

        Request example

        The following is a sample request.

        curl --location --request PATCH 'https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/node-pool/{instanceNo}/upgrade?k8sVersion={version}&maxSurge=2&maxUnavailable=0' \
        --header 'x-ncp-apigw-timestamp: {timestamp}' \
        --header 'x-ncp-iam-access-key: {access key}' \
        --header 'x-ncp-apigw-signature-v2: {API gateway signature}'
        Curl

        Responses

        The following describes the response format.

        Response syntax

        The response syntax is as follows.

        {
            "uuid": "string",
            "instanceNo": "integer"
        }
        JSON

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        uuidString-UUID of the cluster
        instanceNoInteger-NodePool instance number

        Response status codes

        For response status codes common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service response status codes.

        Response example

        The following is a sample response.

        {
            "uuid": "1a1111a1-4d44-99b9-88c8-9e99a99e9e99",
            "instanceNo": 23323233
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.