The image registry

Overview

The CAVATICA Image Registry stores Docker images containing tools you can use to execute analyses on CAVATICA. The images are organized into repositories and contain tools as well as their dependencies.

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

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

Repositories in the CAVATICA Image Registry

Images in the CAVATICA registry are arranged in repositories.

Repository paths

In order to upload an image to the the CAVATICA 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:

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

This path consists of the following parts:

  • pgc-images.sbgenomics.com: URL of the CAVATICA Image Registry.
  • <username>: Your CAVATICA 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 CAVATICA registry.

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.


Did this page help you?