Skip to main content

Push an image

To upload a container image to the Katapult Container Registry (KCR), use a container management tool such as Docker.

This guide focuses on Docker, but the same principles apply to other container management tools like Buildah and Podman.

Prerequisites​

  • Docker on your machine
  • A Katapult user (or organization) API token with the appropriate permissions
  • Your email address (this is the username when you log in)
info

This guide uses Docker, but the same steps work with other container management tools such as Buildah and Podman.

Create an API token​

You'll need an API token to authenticate with KCR. We recommend using a user token from Krystal Identity for most use cases.

For detailed instructions on creating both user and organization API tokens, see our Authentication guide.

Log in to KCR​

On your local machine or VM, authenticate with KCR by running the following command:

docker login kcr.io \
  --username <your-email-address> \
  --password <your-user-api-token>

For organization tokens, use your organization subdomain as the username:

docker login kcr.io \
  --username <katapult-org-subdomain> \
  --password <your-org-api-token>

Once logged in, you can proceed to the next step.

Tag the image​

For this guide, let's use the classic hello-world Docker image:

docker pull hello-world
docker tag hello-world \
  kcr.io/<org-sub-domain>/hello-world:v1

The path structure is always kcr.io/<org-sub-domain>/<image>:<tag>. KCR will create the repository the first time you push.

Push to KCR​

Now, push the Docker image to KCR:

docker push kcr.io/<org-sub-domain>/hello-world:v1

The upload and data transfer happen internally within Katapult's network, so it's fast and as internal traffic, you won't incur bandwidth charges.

After a successful push, the image will be visible on the Container Registry page within the Katapult UI.

Container Registry - Dashboard

tip

If you pull container images to a Katapult VM from KCR in the same location (currently available in London only), the pull stays inside the data-centre, completes almost instantly, and incurs zero bandwidth charges.