The CGC Image Registry

Store images containing tools

STORE IMAGES CONTAINING TOOLS

The CGC image registry is a secure storage facility in the same data center as the CGC compute nodes. It is used to store Docker images containing tools. Images there can be accessed by the CGC, in order to run the tools in the containers that the images are snapshots of.

Alternatively, Docker's own image registry, Docker Hub, can be used to store images. Images stored in Docker Hub can also be accessed from the CGC.

To make your tools available on the CGC, you should upload Docker images containing them to Docker Hub or to the CGC Image Registry.

The CGC image registry is cgc-images.sbgenomics.com.

Note that the image registry cgc-images.sbgenomics.com is the location of your Docker images on the CGC. This doesn't point to a webpage, so you can't open cgc-images.sbgenomics.com in your browser.

Repositories in the CGC Image Registry

Images in the Seven Bridges registry are arranged in repositories.

Repository paths

In order to upload an image to the the CGC Image Registry, or run a tool from an image contained there, you will need to refer to the repository in which the image is housed. Each image is uniquely identified using its full repository path:

cgc-images.sbgenomics.com/<username>/<repository_name>[:tag]

This path consists of the following parts:

  • cgc-images.sbgenomics.com: URL of the CGC image registry.
  • <username>: Your CGC username.
  • <repository_name>: Repository name.
  • [:tag]: Optional, commonly used to label the version of the image.

You will need to do this on the Tool Editor in order to refer to the image containing your tool, if the image is stored in the CGC image registry. If the image is stored in Docker Hub, you can enter just the Docker Hub repository instead.

Repository names

Repository names are user-defined, must be at least 3 characters long and can only contain lowercase letters, numbers, ., - and _.

Image tags

A repository can house multiple images. To identify images, each image can be given a unique tag. You can use a numerical tagging system, or use words or phrases as tags. If you do not specify a tag, the default tag is latest.

❗️

Please be aware that new repositories that are pushed to the CGC image registry have their privacy set to Public by default. Images in a public repository can be read by anybody who knows or can guess the name of the repository. For this reason, we recommend that you set the repository privacy to Private or don't put sensitive data into containers whose images are stored in the CGC image registry.


Did this page help you?