Class KubernetesService

Hierarchy

  • KubernetesService

Constructors

Methods

  • Create a new kubernetes cluster

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const request = {
    "name": "prod-cluster-01",
    "region": "nyc1",
    "version": "1.14.1-do.4",
    "tags": [
    "production",
    "web-team"
    ],
    "node_pools": [
    {
    "size": "s-1vcpu-2gb",
    "count": 3,
    "name": "frontend-pool",
    "tags": [
    "frontend"
    ]
    },
    {
    "size": "c-4",
    "count": 2,
    "name": "backend-pool"
    }
    ]
    };
    const cluster = await client.kubernetes.createCluster(request);

    Parameters

    Returns Promise<KubernetesCluster>

  • Delete an existing kubernetes cluster

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    await client.kubernetes.deleteCluster('cluster-id');

    Parameters

    • clusterId: string

    Returns Promise<void>

  • Delete an existing node from a node pool in a kubernetes cluster. Optionally specify to skip node draining or to replace with a new node after deletion.

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    await client.kubernetes.deleteNodeFromNodePoolForCluster('cluster-id', 'pool-id', 'node-id', false, false);

    Parameters

    • clusterId: string
    • nodePoolId: string
    • nodeId: string
    • Optional skipDrain: boolean
    • Optional replace: boolean

    Returns Promise<void>

  • Delete an existing node pool from a kubernetes cluster

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    await client.kubernetes.deleteNodePoolFromCluster('cluster-id', 'pool-id');

    Parameters

    • clusterId: string
    • nodePoolId: string

    Returns Promise<void>

  • Get the contents of the kubeconfig yaml file for use with a Kubernetes cluster

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    const kubeconfig = await client.kubernetes.getClusterKubeconfig('cluster-id');

    Parameters

    • clusterId: string

    Returns Promise<string>

  • Upgrade the version of an existing kubernetes cluster

    Example

    import { DigitalOcean } from 'digitalocean-js';

    const client = new DigitalOcean('your-api-key');
    await client.kubernetes.upgradeExistingCluster('cluster-id', "1.12.3-do.1");

    Parameters

    • clusterId: string
    • version: string

    Returns Promise<void>

Generated using TypeDoc