Update a Kubernetes Cluster | DigitalOcean API (unofficial showcase)

1 parameter · 20 body fields

cluster_idstringrequired

A unique ID that can be used to reference a Kubernetes cluster.

namestringrequired

A human-readable name for a Kubernetes cluster.

tagsarray<string>optional

An array of tags applied to the Kubernetes cluster. All clusters are automatically tagged `k8s` and `k8s:$K8S_CLUSTER_ID`.

maintenance_policyobjectoptional

An object specifying the maintenance window policy for the Kubernetes cluster.

auto_upgradebooleanoptional

A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window.

Default:false

surge_upgradebooleanoptional

A boolean value indicating whether surge upgrade is enabled/disabled for the cluster. Surge upgrade makes cluster upgrades fast and reliable by bringing up new nodes before destroying the outdated nodes.

Default:false

habooleanoptional

A boolean value indicating whether the control plane is run in a highly available configuration in the cluster. Highly available control planes incur less downtime. The property cannot be disabled. When omitted on create, the default is version-dependent; for DOKS 1.36.0 and later, the default is true; for earlier versions, the default is false.

gpu_operator_readybooleanoptional

A boolean value indicating whether GPU nodes in the cluster are launched with images that do not include pre-installed GPU drivers, allowing GPU drivers to be managed by a GPU operator instead. Mutually exclusive with other GPU-related cluster options, such as `nvidia_gpu_dra_driver` and `amd_gpu_dra_driver`. When omitted, the current value is left unchanged.

control_plane_firewallobjectoptional

An object specifying the control plane firewall for the Kubernetes cluster. Control plane firewall is in early availability (invite only).

cluster_autoscaler_configurationobjectoptional

An object specifying custom cluster autoscaler configuration.

ssoobjectoptional

An object specifying Single Sign-On (SSO) configuration for the Kubernetes cluster.

routing_agentobjectoptional

An object specifying whether the routing-agent component should be enabled for the Kubernetes cluster.

p2p_oci_registry_pluginobjectoptional

An object specifying whether the Peer-to-peer OCI registry component should be enabled for the Kubernetes cluster.

nfs_csi_pluginobjectoptional

An object specifying whether the NFS CSI plugin should be enabled for the Kubernetes cluster.

amd_gpu_device_pluginobjectoptional

An object specifying whether the AMD GPU Device Plugin should be enabled in the Kubernetes cluster. It's enabled by default for clusters with an AMD GPU node pool.

amd_gpu_device_metrics_exporter_pluginobjectoptional

An object specifying whether the AMD Device Metrics Exporter should be enabled in the Kubernetes cluster.

nvidia_gpu_device_pluginobjectoptional

An object specifying whether the Nvidia GPU Device Plugin should be enabled in the Kubernetes cluster. It's enabled by default for clusters with an Nvidia GPU node pool.

nvidia_gpu_dra_driverobjectoptional

An object specifying whether the NVIDIA GPU DRA Driver should be enabled in the Kubernetes cluster. Mutually exclusive with `nvidia_gpu_device_plugin`.

amd_gpu_dra_driverobjectoptional

An object specifying whether the AMD GPU DRA Driver should be enabled in the Kubernetes cluster. Mutually exclusive with `amd_gpu_device_plugin`.

rdma_shared_dev_pluginobjectoptional

An object specifying whether the RDMA shared device plugin should be enabled in the Kubernetes cluster.

coredns_autoscalerobjectoptional

An object specifying whether the Cluster Proportional Autoscaler (CPA) add-on for CoreDNS should be enabled for the Kubernetes cluster.

6 status codes

202The response will be a JSON object with a key called `kubernetes_cluster`. The value of this will be an object containing the standard attributes of a Kubernetes cluster.

kubernetes_clusterobjectoptional

401Authentication failed due to invalid credentials.

idstringrequired

A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."

messagestringrequired

A message providing additional information about the error, including details to help resolve it when possible.

request_idstringoptional

Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

404The resource was not found.

idstringrequired

A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."

messagestringrequired

A message providing additional information about the error, including details to help resolve it when possible.

request_idstringoptional

Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

429The API rate limit has been exceeded.

idstringrequired

A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."

messagestringrequired

A message providing additional information about the error, including details to help resolve it when possible.

request_idstringoptional

Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

500There was a server error.

idstringrequired

A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."

messagestringrequired

A message providing additional information about the error, including details to help resolve it when possible.

request_idstringoptional

Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

defaultThere was an unexpected error.

idstringrequired

A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."

messagestringrequired

A message providing additional information about the error, including details to help resolve it when possible.

request_idstringoptional

Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

Error handling

A 401 is returned: Authentication failed due to invalid credentials. A 404 is returned: The resource was not found. A 429 is returned: The API rate limit has been exceeded. A 500 is returned: There was a server error. Any other status is an error: There was an unexpected error.

import { Client } from "@octridev/digitalocean";

const client = new Client({
  baseUrl: "https://api.digitalocean.com",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.clusters.update({
  clusterId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  name: "Untitled",
  tags: [],
  maintenancePolicy: {},
  autoUpgrade: true,
});

{
  "kubernetes_cluster": {
    "id": "bd5f5959-5e1e-4205-a714-a914373942af",
    "name": "prod-cluster-01",
    "region": "nyc1",
    "version": "1.18.6-do.0",
    "cluster_subnet": "10.244.0.0/16",
    "service_subnet": "10.245.0.0/16",
    "vpc_uuid": "c33931f2-a26a-4e61-b85c-4e95a2ec431b",
    "ipv4": "68.183.121.157",
    "endpoint": "https://bd5f5959-5e1e-4205-a714-a914373942af.k8s.ondigitalocean.com",
    "tags": [
      "production",
      "web-team",
      "k8s",
      "k8s:bd5f5959-5e1e-4205-a714-a914373942af"
    ],
    "node_pools": [
      {
        "id": "cdda885e-7663-40c8-bc74-3a036c66545d",
        "name": "frontend-pool",
        "size": "s-1vcpu-2gb",
        "count": 3,
        "tags": [
          "production",
          "web-team",
          "k8s",
          "k8s:bd5f5959-5e1e-4205-a714-a914373942af",
          "k8s:worker"
        ],
        "labels": null,
        "taints": [],
        "auto_scale": false,
        "min_nodes": 0,
        "max_nodes": 0,
        "nodes": [
          {
            "id": "478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f",
            "name": "adoring-newton-3niq",
            "status": {
              "state": "running"
            },
            "droplet_id": "205545370",
            "created_at": "2018-11-15T16:00:11Z",
            "updated_at": "2018-11-15T16:00:11Z"
          },
          {
            "id": "ad12e744-c2a9-473d-8aa9-be5680500eb1",
            "name": "adoring-newton-3nim",
            "status": {
              "state": "running"
            },
            "droplet_id": "205545371",
            "created_at": "2018-11-15T16:00:11Z",
            "updated_at": "2018-11-15T16:00:11Z"
          },
          {
            "id": "e46e8d07-f58f-4ff1-9737-97246364400e",
            "name": "adoring-newton-3ni7",
            "status": {
              "state": "running"
            },
            "droplet_id": "205545372",
            "created_at": "2018-11-15T16:00:11Z",
            "updated_at": "2018-11-15T16:00:11Z"
          }
        ]
      },
      {
        "id": "f49f4379-7e7f-4af5-aeb6-0354bd840778",
        "name": "backend-pool",
        "size": "g-4vcpu-16gb",
        "count": 2,
        "tags": [
          "production",
          "web-team",
          "k8s",
          "k8s:bd5f5959-5e1e-4205-a714-a914373942af",
          "k8s:worker"
        ],
        "labels": {
          "service": "backend",
          "priority": "high"
        },
        "taints": [],
        "auto_scale": true,
        "min_nodes": 2,
        "max_nodes": 5,
        "nodes": [
          {
            "id": "3385619f-8ec3-42ba-bb23-8d21b8ba7518",
            "name": "affectionate-nightingale-3nif",
            "status": {
              "state": "running"
            },
            "droplet_id": "205545373",
            "created_at": "2018-11-15T16:00:11Z",
            "updated_at": "2018-11-15T16:00:11Z"
          },
          {
            "id": "4b8f60ff-ba06-4523-a6a4-b8148244c7e6",
            "name": "affectionate-nightingale-3niy",
            "status": {
              "state": "running"
            },
            "droplet_id": "205545374",
            "created_at": "2018-11-15T16:00:11Z",
            "updated_at": "2018-11-15T16:00:11Z"
          }
        ]
      }
    ],
    "maintenance_policy": {
      "start_time": "00:00",
      "duration": "4h0m0s",
      "day": "any"
    },
    "auto_upgrade": true,
    "isolated_workers": false,
    "gpu_operator_ready": false,
    "status": {
      "state": "running"
    },
    "created_at": "2018-11-15T16:00:11Z",
    "updated_at": "2018-11-15T16:00:11Z",
    "surge_upgrade": true,
    "registry_enabled": false,
    "registries": [
      "registry-a",
      "registry-b"
    ],
    "ha": false,
    "control_plane_firewall": {
      "enabled": true,
      "allowed_addresses": [
        "1.2.3.4/32",
        "1.1.0.0/16"
      ]
    },
    "cluster_autoscaler_configuration": {
      "scale_down_utilization_threshold": 0.65,
      "scale_down_unneeded_time": "1m",
      "expanders": [
        "priority",
        "random"
      ]
    },
    "sso": {
      "enabled": true,
      "required": false,
      "issuer_url": "https://sso.example.com",
      "client_id": "doks-cluster-client"
    },
    "routing_agent": {
      "enabled": false
    },
    "amd_gpu_device_plugin": {
      "enabled": false
    },
    "amd_gpu_device_metrics_exporter_plugin": {
      "enabled": false
    },
    "nvidia_gpu_device_plugin": {
      "enabled": false
    },
    "nvidia_gpu_dra_driver": {
      "enabled": false
    },
    "amd_gpu_dra_driver": {
      "enabled": false
    },
    "rdma_shared_dev_plugin": {
      "enabled": false
    },
    "coredns_autoscaler": {
      "enabled": false
    },
    "p2p_oci_registry_plugin": {
      "enabled": false
    },
    "nfs_csi_plugin": {
      "enabled": false
    }
  }
}

Request

Response

Errors