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

    Interface DockerCredentialsRequestBuilder

    Builds and executes requests for operations under /v2/registry/docker-credentials

    interface DockerCredentialsRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<
                DockerCredentialsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | Docker_credentials>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                DockerCredentialsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        withUrl(rawUrl: string): DockerCredentialsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    • In order to access your container registry with the Docker client or from aKubernetes cluster, you will need to configure authentication. The necessaryJSON configuration can be retrieved by sending a GET request to/v2/registry/docker-credentials.The response will be in the format of a Docker config.json file. To use theconfig in your Kubernetes cluster, create a Secret with: kubectl create secret generic docr / --from-file=.dockerconfigjson=config.json / --type=kubernetes.io/dockerconfigjsonBy default, the returned credentials have read-only access to your registryand cannot be used to push images. This is appropriate for most Kubernetesclusters. To retrieve read/write credentials, suitable for use with the Dockerclient or in a CI system, read_write may be provided as query parameter. Forexample: /v2/registry/docker-credentials?read_write=trueBy default, the returned credentials will not expire. To retrieve credentialswith an expiry set, expiry_seconds may be provided as a query parameter. Forexample: /v2/registry/docker-credentials?expiry_seconds=3600 will returncredentials that expire after one hour.

      Parameters

      Returns Promise<undefined | Docker_credentials>

      error when the service returns a 401 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

    • In order to access your container registry with the Docker client or from aKubernetes cluster, you will need to configure authentication. The necessaryJSON configuration can be retrieved by sending a GET request to/v2/registry/docker-credentials.The response will be in the format of a Docker config.json file. To use theconfig in your Kubernetes cluster, create a Secret with: kubectl create secret generic docr / --from-file=.dockerconfigjson=config.json / --type=kubernetes.io/dockerconfigjsonBy default, the returned credentials have read-only access to your registryand cannot be used to push images. This is appropriate for most Kubernetesclusters. To retrieve read/write credentials, suitable for use with the Dockerclient or in a CI system, read_write may be provided as query parameter. Forexample: /v2/registry/docker-credentials?read_write=trueBy default, the returned credentials will not expire. To retrieve credentialswith an expiry set, expiry_seconds may be provided as a query parameter. Forexample: /v2/registry/docker-credentials?expiry_seconds=3600 will returncredentials that expire after one hour.

      Parameters

      Returns RequestInformation