Skip to content

Registry

The registry key in .buildtools.yaml defines the docker registry used for the project. This will primarily be used for CI pipelines to push built docker images, i.e the push command.

Locally it can be used to build images with correct tags, making it possible to deploy locally built images.

Each supported registry has their own configuration keys, typically the setup looks like this:

registry:
  <registry name>:
    <specific config>

Supported registries

The following registries are supported:

Config key Container registry
dockerhub Docker hub
ecr AWS Elastic Container Registry
github Github package registry
gitlab Gitlab container registry
quay Quay docker registry
gcr Google Container registry

dockerhub

Parameter Description Env variable
namespace The namespace to publish to DOCKERHUB_NAMESPACE
username User to authenticate DOCKERHUB_USERNAME
password Password for user authentication DOCKERHUB_PASSWORD

ecr

AWS Credentials must be supplied as ENV variables, read more here.

Parameter Description Env variable
url The ECR registry URL ECR_URL
region Specify a region (if it's possible to derive from the url parameter it can be omitted) ECR_REGION

github

To authenticate token or a combination of username and password must be provided.

Parameter Description Env variable
repository The repository part of the docker image name GITHUB_REPOSITORY
username User to authenticate GITHUB_USERNAME
password Password for user authentication GITHUB_PASSWORD
token A personal access token to use for authentication GITHUB_TOKEN

gitlab

Parameter Description Env variable
registry The registry part of the docker image name CI_REGISTRY
repository The repository part of the docker image name CI_REGISTRY_IMAGE
user User to authenticate CI_REGISTRY_USER
token A personal access token to use for authentication CI_JOB_TOKEN

quay

Parameter Description Env variable
repository The repository part of the docker image name QUAY_REPOSITORY
username User to authenticate QUAY_USERNAME
password Password for user authentication QUAY_PASSWORD

gcr

GCP Credentials must be supplied as service account json key (Base64 encoded)

Parameter Description Env variable
url The GCR registry URL GCR_URL
keyfileContent ServiceAccount keyfile content GCR_KEYFILE_CONTENT