The COmanage Project provides prebuilt container (Docker) images for released versions of Registry. Different images are available for different authentication mechanisms including Apache HTTP basic authentication, SAML using the Shibboleth Service Provider, and OIDC using the mod_auth_openidc Apache module.

Beginning with version 4.3.0 the images are multi-platform (aka multi-arch). Currently the platforms/architectures supported include

  • amd64
  • arm64v8


1.  Naming and Tagging Convention

The naming and tagging convention for the container images follows the pattern

comanage-registry:<version>-<authentication>-<build number>

where

  • <version> is the Registry version number, for example 4.1.2
  • <authentication> is the authentication mechanism the container implements, one of
    • basic-auth (Apache HTTP basic authentication)
    • shibboleth-sp-supervisor (SAML using the Shibboleth SP software with shibd and Apache httpd managed using supervisor)
    • mod_auth_openidc (OIDC using the mod_auth_openidc Apache module)
  • <build number> is an increasing integer updated each time a new image is built

Beginning with version 4.3.0, there are additional images that follow the pattern

comanage-registry-<authentication>:<version>-<build number>

These images contain the same binary details; they are just different names for the same images.

1.1. Automated Builds

The images are automatically built once each week to pick up changes in the underlying code and libraries. Each time a new image is built the <build number> increases.

1.2. Latest Tag

Beginning with version 4.3.0 the repositories (see below) for the images that follow the naming convention

comanage-registry-<authentication>:<version>-<build number>

also use the "latest" tag.


At this time the project has not implemented automated testing of each image built weekly by the automated build tooling. Deployers are strongly encouraged to not rely on the "latest" tag for production use and to implement thorough local testing of an image before putting it into production. 


2.  Repositories and Downloading Images

The prebuilt container images provided by the COmanage Project are available from public repositories hosted by

  • Docker Hub
  • Amazon ECR Public Gallery
  • GitHub Package Registry

The images available from the repositories are the same so you may choose the repository most convenient for you.

2.1.  dockerhub

The COmanage Project maintains  multiple repositories in Docker Hub for Registry images. Click here to browse the list of available repositories and images. To pull a specific image run

docker pull comanageproject/comanage-registry:<version>-<authentication>-<build number>

or


docker pull comanageproject/comanage-registry-<authentication>:<version>-<build number>


2.2.  Amazon ECR Public Gallery

The COmanage Registry Amazon ECR Public Gallery is hosted by the CILogon Project. Click here to visit the repository and browse the list of available images. To pull a specific image run

docker pull public.ecr.aws/cilogon/comanage-registry:<version>-<authentication>-<build number>

or

docker pull public.ecr.aws/cilogon/comanage-registry-<authentication>:<version>-<build number>


2.3.  GitHub Package Registry

The COmanage Registry GitHub Package Registries is hosted by the CILogon Project. Click here to browse the list of available images. To pull a specific image run

docker pull ghcr.io/cilogon/comanage-registry:<version>-<authentication>-<build number>

or

docker pull ghcr.io/cilogon/comanage-registry-<authentication>:<version>-<build number>

3. How to Use the Images

Click here for detailed instructions on how to use the images.

4. Develop and Hotfix Branches

Prebuilt container images for source from the develop and hotfix branches of the Match project are also available but only at the AWS container registry.

Images from the develop branch are built nightly. Images from the most recent hotfix branch are built weekly.

The image name follows the pattern detailed above but also includes a short version of the commit from the head of the branch.

5. Auxiliary Images

See this page for details on auxiliary images provided by the COmanage Project that may be useful when deploying Registry.

  • No labels