Core Docker commands

docker login images.sbgenomics.com

This returns a prompt for your Seven Bridges credentials, and then, if satisfied, gives you access to the Seven Bridges registry. Don't forget to add images.sbgenomics.com to this command, or else the utility will attempt to log you in to the Docker Hub registry.

You can enter your username in the following ways:

• In the same format as when logging in to the Platform (including uppercase, periods etc.).
• As the email address you used to register for the account on the Platform.

You should enter your authentication token in response to the password prompt, not your Seven Bridges password.

docker run -ti <image>

This runs a Docker container on your local machine. <image> can be any image in Docker Hub or the Seven Bridges image registry that you have uploaded or have permission to access. The -ti flag makes the container run, interactively.

If you are opening an image from Docker Hub, specify <image> using <docker_repository>[:tag], e.g. ubuntu.
If you are opening an image from the Seven Bridges registry, <image> should be specified using the format images.sbgenomics.com/<username>/<repository_name>[:tag], e.g images.sbgenomics.com/rfranklin/samtools:v1.

docker ps -a

This lists all your Docker containers.

docker commit <container ID> images.sbgenomics.com/<username>/<repository_name>[:tag]

This takes an image (snapshot) of the container with ID <container ID>, and names the image with the format recognised by the Seven Bridges registry.
You can find the container ID of an image using docker ps -a.

If you are using Enterprise, please follow the Docker for Enterprise image naming convention.

docker images

This lists all your local Docker images.

docker tag <image> images.sbgenomics.com/<username>/<repository_name>

This tags the image with a reference to
the Seven Bridges registry.

If you are using Enterprise, please follow the Docker for Enterprise image naming convention.

docker push images.sbgenomics.com/<username>/<repository_name>[:tag]

This uploads your Docker image to the Seven Bridges image registry, so that the tool in it can be used on the Platform.

If you are using Enterprise, please follow the Docker for Enterprise image naming convention.

docker rmi images.sbgenomics.com/<username>/<repository_name>[:tag]

This removes the specified Docker image from your local machine.

If you are using Enterprise, please follow the Docker for Enterprise image naming convention.

docker pull images.sbgenomics.com/<username>/<repository_name>[:tag]

This downloads the specified image from the Seven Bridges registry.

If you are using Enterprise, please follow the Docker for Enterprise image naming convention.

docker logout images.sbgenomics.com

This terminates your connection to the Seven Bridges image registry.