The Seven Bridges Knowledge Center

The Seven Bridges Platform is a simple solution for doing bioinformatics at industrial scale. But sometimes, everyone needs a little help.

Get Started

About the Seven Bridges Image Registry

Store images containing tools

Overview

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

The Seven Bridges Image Registry is images.sbgenomics.com. Note that this doesn’t point to a webpage and cannot be opened in a browser.

If you are using the Seven Bridges Platform on AWS EU, please use eu-images.sbgenomics.com as the image registry instead of images.sbgenomics.com.

Learn more about the Seven Bridges Image Registry below.

This feature depends on your cloud infrastructure provider

To use this feature, you should know which cloud infrastructure provider you run the Seven Bridges Platform on: Amazon Web Services in the US (AWS US East); Amazon Web Services in Frankfurt, Germany (AWS EU) or Google Cloud Platform.

If you didn't chose a cloud provider when you signed up for the Platform, you will be using AWS US East.

If you signed up from early 2016, you will have had the option to select your cloud provider from AWS and Google Cloud Platform. If you signed up from early 2017, you will have had the additional option to select AWS EU as your cloud provider.

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 Platform.

If you signed up for the Seven Bridges Platform by selecting Google Cloud Platform (GCP) as the cloud service provider, you will need to use Docker Hub to store your images, instead of the Seven Bridges image registry.

For detailed instructions on how to push your image(s) to Docker Hub, please refer to the official Docker Hub documentation.

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

Repositories in the Seven Bridges Image Registry

Images in the Seven Bridges registry are arranged in repositories, which correspond to projects on the Seven Bridges Platform.

Repository names

In order to upload an image to the the Seven Bridges 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. Repository names have the format <user_name>/<project_name>.

<project_name> is the short name of a project on the Seven Bridges Platform. The default short name of a project is obtained from the name chosen when creating the project, by converting it to lowercase, replacing any spaces with hyphens, and omitting any characters except alpha-numeric characters, hyphens and underscores. You have the option to override the default short name and enter your own when you create a project.

If you give your project the same name as another project you own, then a number will automatically be appended to <project_name>. This guarantees that <user_name>/<project_name> is unique.

For example, if you have a project called 'My Project' and you create another project with this name, the second will have the <project_name> 'My-Project-1'.

Caution

Please be aware that all newly created repositories in the Seven Bridges image registry are set as public by default and your images in such repository can be read by anybody who knows (or can guess) the name of the repository. See how to manage your Docker repositories by setting them as private and further managing their members and permissions.

Project short names

You can also find your project short name by clicking on the project in the browser, and checking its URL.

<user_name> is the Seven Bridges user name of that project's creator. When you want to access your own images, <user_name> will just be your own user name. However, if you want to access an image from a project created by a colleague, you will need to know his or her user name and the name of their project in which the image is stored. You can check this information by looking at the projects that you can access listed on your dashboard on the Platform.

Usernames and Docker

Docker does not allow any non-alphanumerics in the repository name except for underscores. If your username or project name contains such characters, you'll need to replace them with underscores when setting the repository on the image.

For example, "john.smith/my-repo" should be referred to as "john_smith/my_repo".

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.

To fully specify an image in the Seven Bridges registry, enter its repository, followed by a colon, followed by the image tag: <repository>:<tag>

Repository paths

To refer to the location of images stored in the Seven Bridges images registry, use the full path: images.sbgenomics.com/<repository>[:<tag>].

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 Seven Bridges registry. If the image is stored in Docker Hub, you can enter just the Docker Hub repository instead.

About the Seven Bridges Image Registry


Store images containing tools

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.