{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"The image registry","type":"basic","slug":"the-image-registry","excerpt":"","body":"##Overview\n\nThe 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.\n\nThe 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.\n\nTo make your tools  available on Cavatica, you should upload [Docker images](doc:docker-basics) containing them to the Cavatica Image Registry. \n\n##Repositories in the Cavatica Image Registry\n\nImages in the Cavatica registry are arranged in **repositories**.\n\n## Repository paths\n\nIn 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:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"pgc-images.sbgenomics.com/<username>/<repository_name>[:tag]\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nThis path consists of the following parts:\n* `pgc-images.sbgenomics.com`: URL of the Cavatica Image Registry.\n* `<username>`: Your Cavatica username.\n* `<repository_name>`: [Repository name](#section-repository-names). \n* `[:tag]`: Optional, commonly used to label the version of the image.\n\nYou will need to do this on the [Tool Editor](doc:the-tool-editor) in order to refer to the image containing your tool, if the image is stored in the Cavatica registry.\n\n## Repository names\n\nRepository names are user-defined, must be at least 3 characters long and can only contain lowercase letters, numbers, `.`, `-` and `_`.\n\n## Image tags\n\nA 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`.","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"589dcfd7d8bd652f00b69370","__v":0,"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5773dcfc255e820e00e1cd51","5773df36904b0c0e00ef05ff","577baf92451b1e0e006075ac","577bb183b7ee4a0e007c4e8d","577ce77a1cf3cb0e0048e5ea","577d11865fd4de0e00cc3dab","578e62792c3c790e00937597","578f4fd98335ca0e006d5c84","578f5e5c3d04570e00976ebb","57bc35f7531e000e0075d118","57f801b3760f3a1700219ebb","5804d55d1642890f00803623","581c8d55c0dc651900aa9350","589dcf8ba8c63b3b00c3704f","594cebadd8a2f7001b0b53b2","59a562f46a5d8c00238e309a","5a2aa096e25025003c582b58","5a2e79566c771d003ca0acd4","5a3a5166142db90026f24007","5a3a52b5bcc254001c4bf152","5a3a574a2be213002675c6d2","5a3a66bb2be213002675cb73","5a3a6e4854faf60030b63159","5c8a68278e883901341de571","5cb9971e57bf020024523c7b","5cbf1683e2a36d01d5012ecd","5dc15666a4f788004c5fd7d7","5eaff69e844d67003642a020","5eb00899b36ba5002d35b0c1","5eb0172be179b70073dc936e","5eb01b42b36ba5002d35ebba","5eb01f202654a20136813093","5eb918ef149186021c9a76c8","5f0839d3f4b24e005ebbbc29"],"_id":"5773dcfc255e820e00e1cd50","__v":34,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"project":"5773dcfc255e820e00e1cd4d","user":"575e85ac41c8ba0e00259a44","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Docker","slug":"docker","order":7,"from_sync":false,"reference":false,"_id":"5eaff69e844d67003642a020","createdAt":"2020-05-04T11:03:58.395Z","version":"5773dcfc255e820e00e1cd50","project":"5773dcfc255e820e00e1cd4d","__v":0},"parentDoc":null,"createdAt":"2017-02-10T14:36:07.194Z","githubsync":""}

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](doc:docker-basics) 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: [block:code] { "codes": [ { "code": "pgc-images.sbgenomics.com/<username>/<repository_name>[:tag]", "language": "text" } ] } [/block] 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](#section-repository-names). * `[:tag]`: Optional, commonly used to label the version of the image. You will need to do this on the [Tool Editor](doc: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`.