You are viewing documentation for version 1.19.x. The most current version is 1.20.x.  This documentation is available for 1.20.x.

container-registry

Settings related to container image registries (settings.container-registry.*)

Setting list for settings.container-registry


Full Reference

settings.container-registry.credentials

An array of tables that represent image registry credentials. The fields (all strings) in the table specify the registry and credential information such as username, password, auth, identitytoken. The credential fields map to containerd’s registry credential fields, which in turn map to fields in .docker/config.json.

[[settings.container-registry.credentials]]
registry = "docker.io"
username = "foo"
password = "bar"

[[settings.container-registry.credentials]]
registry = "gcr.io"
auth = "example_base64_encoded_auth_string"
apiclient set --json '{
  "container-registry": {
    "credentials": [
      {
        "registry": "docker.io",
        "username": "foo",
        "password": "bar"
      },
      {
        "registry": "gcr.io",
        "auth": "example_base64_encoded_auth_string"
      }
    ]
  }
}'

settings.container-registry.mirrors

An array of tables that represent container image registry mirrors. Each table must contain the registry (a string) and endpoints (an array of strings). When pulling an image from a registry, the container runtime will try the endpoints one-by-one and use the first working registry. The runtime will still try the default registry URL if the mirrors fail.

The Docker container runtime can only provide pull-through caches for images from Docker Hub (docker.io) and ignores mirrors for other registries. Consequently, Bottlerocket variants that use the Docker container runtime (e.g. aws-ecs-1 or aws-ecs-2) have the same limitation.

[[settings.container-registry.mirrors]]
registry = "*"
endpoint = ["https://<example-mirror>","https://<example-mirror-2>"]

[[settings.container-registry.mirrors]]
registry = "docker.io"
endpoint = [ "https://<my-docker-hub-mirror-host>", "https://<my-docker-hub-mirror-host-2>"]