@digitalocean/dots - v1.0.1
    Preparing search index...

    Builds and executes requests for operations under /v2/kubernetes/clusters/{cluster_id}/kubeconfig

    interface KubeconfigRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<
                KubeconfigRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | ArrayBuffer>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                KubeconfigRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        withUrl(rawUrl: string): KubeconfigRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    • This endpoint returns a kubeconfig file in YAML format. It can be used toconnect to and administer the cluster using the Kubernetes command line tool,kubectl, or other programs supporting kubeconfig files (e.g., client libraries).The resulting kubeconfig file uses token-based authentication for clusterssupporting it, and certificate-based authentication otherwise. For a list ofsupported versions and more information, see "How to Connect to a DigitalOceanKubernetes Cluster".To retrieve a kubeconfig file for use with a Kubernetes cluster, send a GETrequest to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/kubeconfig.Clusters supporting token-based authentication may define an expiration bypassing a duration in seconds as a query parameter to/v2/kubernetes/clusters/$K8S_CLUSTER_ID/kubeconfig?expiry_seconds=$DURATION_IN_SECONDS.If not set or 0, then the token will have a 7 day expiry. The query parameterhas no impact in certificate-based authentication.Kubernetes Roles granted to a user with a token-based kubeconfig are derived from that user'sDigitalOcean role. Predefined roles (Owner, Member, Modifier etc.) have an automatic mappingto Kubernetes roles. Custom roles are not automatically mapped to any Kubernetes roles,and require additional configurationby a cluster administrator.

      Parameters

      Returns Promise<undefined | ArrayBuffer>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • This endpoint returns a kubeconfig file in YAML format. It can be used toconnect to and administer the cluster using the Kubernetes command line tool,kubectl, or other programs supporting kubeconfig files (e.g., client libraries).The resulting kubeconfig file uses token-based authentication for clusterssupporting it, and certificate-based authentication otherwise. For a list ofsupported versions and more information, see "How to Connect to a DigitalOceanKubernetes Cluster".To retrieve a kubeconfig file for use with a Kubernetes cluster, send a GETrequest to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/kubeconfig.Clusters supporting token-based authentication may define an expiration bypassing a duration in seconds as a query parameter to/v2/kubernetes/clusters/$K8S_CLUSTER_ID/kubeconfig?expiry_seconds=$DURATION_IN_SECONDS.If not set or 0, then the token will have a 7 day expiry. The query parameterhas no impact in certificate-based authentication.Kubernetes Roles granted to a user with a token-based kubeconfig are derived from that user'sDigitalOcean role. Predefined roles (Owner, Member, Modifier etc.) have an automatic mappingto Kubernetes roles. Custom roles are not automatically mapped to any Kubernetes roles,and require additional configurationby a cluster administrator.

      Parameters

      Returns RequestInformation