Quickstart

The Katapult Container Registry (KCR) is a secure and private container image repository service. It lets you store, manage, and distribute Docker container images for your applications.

KCR is Open Container Initiative (OCI) compliant.

Getting Started

Before pushing or pulling images, you'll need to authenticate with the registry.

Authentication

You can authenticate with the Katapult Container Registry using your Katapult org subdomain or user email and API token.

• When prompted for your username, use your Katapult org subdomain or user email.
• For the password, use your API token.

You can create an API token in the Katapult UI or in Krystal Identity. You will need to assign it the relevant scopes. See Authentication

Docker

Log in to Container Registry using the Docker CLI:

docker login kcr.io

Buildah

Log in to Container Registry using the Buildah CLI:

buildah login kcr.io

Helm

Log in to Container Registry using the Helm CLI:

helm login kcr.io

Podman

Log in to Container Registry using the Podman CLI:

podman login kcr.io

Skopeo

Log in to Container Registry using the Skopeo CLI:

skopeo login kcr.io

Pushing Artifacts

Docker

Tag your local image with the registry path:

docker tag my-application:latest kcr.io/my-organization/my-application:latest

Push the image:

docker push kcr.io/my-organization/my-application:latest

Buildah

Tag your local image with the registry path:

buildah tag my-application:latest kcr.io/my-organization/my-application:latest

Push the image:

buildah push kcr.io/my-organization/my-application:latest

Helm

Package your Helm chart:

helm package ./my-chart

Push the packaged chart to the registry:

helm push my-chart-1.0.0.tgz oci://kcr.io/my-organization/helm-charts

Or push directly without packaging first:

helm push ./my-chart oci://kcr.io/my-organization/helm-charts

Pulling Artifacts

Docker

Pull an image from the registry:

docker pull kcr.io/my-organization/my-application:latest

Buildah

Pull an image from the registry:

If your image is formatted as a docker image.

buildah pull docker://kcr.io/my-organization/my-application:latest

If your image is formatted as an OCI image.

buildah pull oci://kcr.io/my-organization/my-application:latest

Helm

Pull a Helm chart

helm pull oci://kcr.io/my-organization/helm-charts/my-chart --version 1.0.0