Add a private or custom image registry to a new container

Overview

You can use this document to learn how to add a private or custom image registry to a new container.

You cannot add a private or custom image registry with an existing container. 

Credentials are required to access a private or custom registry. If you do not provide access pull credentials for a private or custom registry, the service will search the following public registries:

• registry.centos.org
• registry.access.redhat.com
• docker.io
• quay.io

To push your containers, there are several online container registries, such as GitHub, GitLab, Amazon ECR, Azure Container Registry, Docker Hub, Google Container Registry, Quay, etc.

Add a private or custom registry to a new container

At high level, to add a private or custom registry to a new container: 

1. When you create a container-based workload, mark Add Image Pull Credentials.
2. In the fields that appear (Username, Password, Server, Email), enter the same information that you would use in the following docker login command: docker login $server -u $username -p $password
   • In Server, enter the full path to the image.
     • For example, if you use Google Container Registry, you would enter: gcr.io/$project/$path/$to/$image:$version
   • Additionally, in Server, ensure that the domain you enter for the full path to the image matches the server you would enter for $server.

For detailed information on how to create a generic, container-based workload, see Create and Manage Virtual Machines, Containers, and Workloads.

Troubleshooting tips

Each image registry may have a different authentication method. If you have issues pulling images, StackPath recommends that you verify that you can successfully run authentication commands. 

Review the following common authentication instructions: 

• Amazon ECS
• Azure
• GitLab
• Google Container Registry