{"action":"created","comment":{"url":"https://api.github.com/repos/docker/distribution/pulls/comments/36022638","id":36022638,"diff_hunk":"@@ -0,0 +1,85 @@\n+# Registry as a pull through cache\n+\n+A v2 Registry can be configured as a pull through cache.  In this mode a Registry responds to all normal docker pull requests but stores all content locally.\n+\n+## Why?\n+\n+If you have multiple instances of Docker running in your environment (e.g., multiple physical or virtual machines, all running the Docker daemon), each time one of them requires an image that it doesn’t have it will go out to the internet and fetch it from the public Docker registry. By running a local registry mirror, you can keep most of the image fetch traffic on your local network.\n+\n+## How does it work?\n+\n+The first time you request an image from your local registry mirror, it pulls the image from the public Docker registry and stores it locally before handing it back to you. On subsequent requests, the local registry mirror is able to serve the image from its own storage.\n+\n+## What if the content changes on the Hub?\n+\n+When a pull is attempted with a tag, the Registry will check the remote to ensure if it has the latest version of the requested content.  If it doesn't it will fetch the latest content and cache it.\n+\n+## What about my disk?\n+\n+In environments with high churn rates, stale data can build up in the cache.  When running as a pull through cache the Registry will periodically remove old content to save disk space.  Subsequent requests for removed content will cause a remote fetch and local re-caching.\n+\n+To ensure best performance and guarantee correctness the Registry cache should be configured to use the `filesystem` driver for storage.\n+\n+## Running a Registry as a pull through cache\n+\n+The easiest way to run a registry as a pull through cache is to run the official Registry pull through cache official image.\n+\n+### Configuring the cache\n+\n+To configure a Registry to run as a pull through cache, the following additions are required to the config file.\n+\n+The `storage` subsection requires the addition of a YAML label.  In this exmple it is set to `&STORAGE`.  Note\n+\n+```\n+storage: &STORAGE\n+    cache:\n+        blobdescriptor: redis\n+    filesystem:\n+        rootdirectory: /var/lib/registry_cache\n+    maintenance:\n+        uploadpurging:\n+            enabled: false\n+```\n+\n+The `middleware` subsection requires the following additions.  In order to access private images on the Docker Hub the username and password can be supplied.\n+\n+```            \n+middleware:\n+  repository:\n+    - name: proxy\n+  registry:\n+    - name: proxy\n+      options:\n+        storage: *STORAGE\n+        remoteurl: https://registry-1.docker.io\n+        username: [username]\n+        password: [password]\n+```\n+\n+\n+### Building your own Registry pull through cache\n+\n+Power users may wish to build and run their own Registry as a pull through cache.  In order to do this the following rules must be applied\n+\n+ * The `noresumabledigest` build tag must be set to true.  The resumable digest mechanism is not used when the Registry is acting as a pull through cache and impacts performance.  \n+\n+\n+## Configuring the Docker daemon\n+\n+You will need to pass the `--registry-mirror` option to your Docker daemon on startup:\n+\n+```\n+docker --registry-mirror=http://<my-docker-mirror-host> -d\n+```\n+\n+For example, if your mirror is serving on http://10.0.0.2:5000, you would run:\n+\n+```\n+docker --registry-mirror=http://10.0.0.2:5000 -d","path":"docs/mirror.md","position":78,"original_position":78,"commit_id":"4d584725c058d0921ee9fb1d29aed6932fe6c8d7","original_commit_id":"4d584725c058d0921ee9fb1d29aed6932fe6c8d7","user":{"login":"RichardScothern","id":922018,"avatar_url":"https://avatars.githubusercontent.com/u/922018?v=3","gravatar_id":"","url":"https://api.github.com/users/RichardScothern","html_url":"https://github.com/RichardScothern","followers_url":"https://api.github.com/users/RichardScothern/followers","following_url":"https://api.github.com/users/RichardScothern/following{/other_user}","gists_url":"https://api.github.com/users/RichardScothern/gists{/gist_id}","starred_url":"https://api.github.com/users/RichardScothern/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/RichardScothern/subscriptions","organizations_url":"https://api.github.com/users/RichardScothern/orgs","repos_url":"https://api.github.com/users/RichardScothern/repos","events_url":"https://api.github.com/users/RichardScothern/events{/privacy}","received_events_url":"https://api.github.com/users/RichardScothern/received_events","type":"User","site_admin":false},"body":"It would.  I'll change the example to https (and link the certs documentation)","created_at":"2015-07-31T22:33:09Z","updated_at":"2015-07-31T22:33:09Z","html_url":"https://github.com/docker/distribution/pull/779#discussion_r36022638","pull_request_url":"https://api.github.com/repos/docker/distribution/pulls/779","_links":{"self":{"href":"https://api.github.com/repos/docker/distribution/pulls/comments/36022638"},"html":{"href":"https://github.com/docker/distribution/pull/779#discussion_r36022638"},"pull_request":{"href":"https://api.github.com/repos/docker/distribution/pulls/779"}}},"pull_request":{"url":"https://api.github.com/repos/docker/distribution/pulls/779","id":41162535,"html_url":"https://github.com/docker/distribution/pull/779","diff_url":"https://github.com/docker/distribution/pull/779.diff","patch_url":"https://github.com/docker/distribution/pull/779.patch","issue_url":"https://api.github.com/repos/docker/distribution/issues/779","number":779,"state":"open","locked":false,"title":"Add pull through cache ability to the Registry.","user":{"login":"RichardScothern","id":922018,"avatar_url":"https://avatars.githubusercontent.com/u/922018?v=3","gravatar_id":"","url":"https://api.github.com/users/RichardScothern","html_url":"https://github.com/RichardScothern","followers_url":"https://api.github.com/users/RichardScothern/followers","following_url":"https://api.github.com/users/RichardScothern/following{/other_user}","gists_url":"https://api.github.com/users/RichardScothern/gists{/gist_id}","starred_url":"https://api.github.com/users/RichardScothern/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/RichardScothern/subscriptions","organizations_url":"https://api.github.com/users/RichardScothern/orgs","repos_url":"https://api.github.com/users/RichardScothern/repos","events_url":"https://api.github.com/users/RichardScothern/events{/privacy}","received_events_url":"https://api.github.com/users/RichardScothern/received_events","type":"User","site_admin":false},"body":"Add pull through cache ability to the Registry.\r\n\r\nCreate a Repository middleware which delegates storage to a proxyBlobStore\r\nand proxyManifestStore.  These stores will pull through data if not present\r\nlocally.\r\n\r\nCreate a Registry middleware which runs a scheduler to remove\r\nexpired content.\r\n\r\nThe scheduler runs as a background goroutine.  When a blob\r\nor manifest is pulled through from the remote registry,\r\nan entry is added to the scheduler with a TTL.  When the\r\nTTL expires the scheduler calls a pre-specified function\r\nto remove the fetched resource.\r\n\r\nAdd token authentication to the registry middleware.\r\nGet a token at startup and preload the credential store\r\nwith the username and password supplied in the config file.\r\n\r\nSigned-off-by: Richard Scothern <richard.scothern@gmail.com>","created_at":"2015-07-29T19:32:19Z","updated_at":"2015-07-31T22:33:09Z","closed_at":null,"merged_at":null,"merge_commit_sha":"b8f38c85a16383e1aa2ec12c22715a0acc4a6735","assignee":{"login":"RichardScothern","id":922018,"avatar_url":"https://avatars.githubusercontent.com/u/922018?v=3","gravatar_id":"","url":"https://api.github.com/users/RichardScothern","html_url":"https://github.com/RichardScothern","followers_url":"https://api.github.com/users/RichardScothern/followers","following_url":"https://api.github.com/users/RichardScothern/following{/other_user}","gists_url":"https://api.github.com/users/RichardScothern/gists{/gist_id}","starred_url":"https://api.github.com/users/RichardScothern/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/RichardScothern/subscriptions","organizations_url":"https://api.github.com/users/RichardScothern/orgs","repos_url":"https://api.github.com/users/RichardScothern/repos","events_url":"https://api.github.com/users/RichardScothern/events{/privacy}","received_events_url":"https://api.github.com/users/RichardScothern/received_events","type":"User","site_admin":false},"milestone":{"url":"https://api.github.com/repos/docker/distribution/milestones/8","html_url":"https://github.com/docker/distribution/milestones/Registry/2.1","labels_url":"https://api.github.com/repos/docker/distribution/milestones/8/labels","id":1026598,"number":8,"title":"Registry/2.1","description":"Items in this roadmap will be part of the registry 2.1 release.","creator":{"login":"stevvooe","id":120601,"avatar_url":"https://avatars.githubusercontent.com/u/120601?v=3","gravatar_id":"","url":"https://api.github.com/users/stevvooe","html_url":"https://github.com/stevvooe","followers_url":"https://api.github.com/users/stevvooe/followers","following_url":"https://api.github.com/users/stevvooe/following{/other_user}","gists_url":"https://api.github.com/users/stevvooe/gists{/gist_id}","starred_url":"https://api.github.com/users/stevvooe/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stevvooe/subscriptions","organizations_url":"https://api.github.com/users/stevvooe/orgs","repos_url":"https://api.github.com/users/stevvooe/repos","events_url":"https://api.github.com/users/stevvooe/events{/privacy}","received_events_url":"https://api.github.com/users/stevvooe/received_events","type":"User","site_admin":false},"open_issues":22,"closed_issues":175,"state":"open","created_at":"2015-03-18T04:15:41Z","updated_at":"2015-07-31T21:20:37Z","due_on":"2015-08-04T07:00:00Z","closed_at":null},"commits_url":"https://api.github.com/repos/docker/distribution/pulls/779/commits","review_comments_url":"https://api.github.com/repos/docker/distribution/pulls/779/comments","review_comment_url":"https://api.github.com/repos/docker/distribution/pulls/comments{/number}","comments_url":"https://api.github.com/repos/docker/distribution/issues/779/comments","statuses_url":"https://api.github.com/repos/docker/distribution/statuses/4d584725c058d0921ee9fb1d29aed6932fe6c8d7","head":{"label":"RichardScothern:pull-through-cache","ref":"pull-through-cache","sha":"4d584725c058d0921ee9fb1d29aed6932fe6c8d7","user":{"login":"RichardScothern","id":922018,"avatar_url":"https://avatars.githubusercontent.com/u/922018?v=3","gravatar_id":"","url":"https://api.github.com/users/RichardScothern","html_url":"https://github.com/RichardScothern","followers_url":"https://api.github.com/users/RichardScothern/followers","following_url":"https://api.github.com/users/RichardScothern/following{/other_user}","gists_url":"https://api.github.com/users/RichardScothern/gists{/gist_id}","starred_url":"https://api.github.com/users/RichardScothern/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/RichardScothern/subscriptions","organizations_url":"https://api.github.com/users/RichardScothern/orgs","repos_url":"https://api.github.com/users/RichardScothern/repos","events_url":"https://api.github.com/users/RichardScothern/events{/privacy}","received_events_url":"https://api.github.com/users/RichardScothern/received_events","type":"User","site_admin":false},"repo":{"id":32835922,"name":"distribution","full_name":"RichardScothern/distribution","owner":{"login":"RichardScothern","id":922018,"avatar_url":"https://avatars.githubusercontent.com/u/922018?v=3","gravatar_id":"","url":"https://api.github.com/users/RichardScothern","html_url":"https://github.com/RichardScothern","followers_url":"https://api.github.com/users/RichardScothern/followers","following_url":"https://api.github.com/users/RichardScothern/following{/other_user}","gists_url":"https://api.github.com/users/RichardScothern/gists{/gist_id}","starred_url":"https://api.github.com/users/RichardScothern/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/RichardScothern/subscriptions","organizations_url":"https://api.github.com/users/RichardScothern/orgs","repos_url":"https://api.github.com/users/RichardScothern/repos","events_url":"https://api.github.com/users/RichardScothern/events{/privacy}","received_events_url":"https://api.github.com/users/RichardScothern/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/RichardScothern/distribution","description":"The Docker toolset to pack, ship, store, and deliver content","fork":true,"url":"https://api.github.com/repos/RichardScothern/distribution","forks_url":"https://api.github.com/repos/RichardScothern/distribution/forks","keys_url":"https://api.github.com/repos/RichardScothern/distribution/keys{/key_id}","collaborators_url":"https://api.github.com/repos/RichardScothern/distribution/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/RichardScothern/distribution/teams","hooks_url":"https://api.github.com/repos/RichardScothern/distribution/hooks","issue_events_url":"https://api.github.com/repos/RichardScothern/distribution/issues/events{/number}","events_url":"https://api.github.com/repos/RichardScothern/distribution/events","assignees_url":"https://api.github.com/repos/RichardScothern/distribution/assignees{/user}","branches_url":"https://api.github.com/repos/RichardScothern/distribution/branches{/branch}","tags_url":"https://api.github.com/repos/RichardScothern/distribution/tags","blobs_url":"https://api.github.com/repos/RichardScothern/distribution/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/RichardScothern/distribution/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/RichardScothern/distribution/git/refs{/sha}","trees_url":"https://api.github.com/repos/RichardScothern/distribution/git/trees{/sha}","statuses_url":"https://api.github.com/repos/RichardScothern/distribution/statuses/{sha}","languages_url":"https://api.github.com/repos/RichardScothern/distribution/languages","stargazers_url":"https://api.github.com/repos/RichardScothern/distribution/stargazers","contributors_url":"https://api.github.com/repos/RichardScothern/distribution/contributors","subscribers_url":"https://api.github.com/repos/RichardScothern/distribution/subscribers","subscription_url":"https://api.github.com/repos/RichardScothern/distribution/subscription","commits_url":"https://api.github.com/repos/RichardScothern/distribution/commits{/sha}","git_commits_url":"https://api.github.com/repos/RichardScothern/distribution/git/commits{/sha}","comments_url":"https://api.github.com/repos/RichardScothern/distribution/comments{/number}","issue_comment_url":"https://api.github.com/repos/RichardScothern/distribution/issues/comments{/number}","contents_url":"https://api.github.com/repos/RichardScothern/distribution/contents/{+path}","compare_url":"https://api.github.com/repos/RichardScothern/distribution/compare/{base}...{head}","merges_url":"https://api.github.com/repos/RichardScothern/distribution/merges","archive_url":"https://api.github.com/repos/RichardScothern/distribution/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/RichardScothern/distribution/downloads","issues_url":"https://api.github.com/repos/RichardScothern/distribution/issues{/number}","pulls_url":"https://api.github.com/repos/RichardScothern/distribution/pulls{/number}","milestones_url":"https://api.github.com/repos/RichardScothern/distribution/milestones{/number}","notifications_url":"https://api.github.com/repos/RichardScothern/distribution/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/RichardScothern/distribution/labels{/name}","releases_url":"https://api.github.com/repos/RichardScothern/distribution/releases{/id}","created_at":"2015-03-25T01:41:58Z","updated_at":"2015-05-08T16:24:12Z","pushed_at":"2015-07-31T18:10:53Z","git_url":"git://github.com/RichardScothern/distribution.git","ssh_url":"git@github.com:RichardScothern/distribution.git","clone_url":"https://github.com/RichardScothern/distribution.git","svn_url":"https://github.com/RichardScothern/distribution","homepage":null,"size":3466,"stargazers_count":0,"watchers_count":0,"language":"Go","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"docker:master","ref":"master","sha":"0b3b55e723b5362f68c449a37ac8cff1327c1478","user":{"login":"docker","id":5429470,"avatar_url":"https://avatars.githubusercontent.com/u/5429470?v=3","gravatar_id":"","url":"https://api.github.com/users/docker","html_url":"https://github.com/docker","followers_url":"https://api.github.com/users/docker/followers","following_url":"https://api.github.com/users/docker/following{/other_user}","gists_url":"https://api.github.com/users/docker/gists{/gist_id}","starred_url":"https://api.github.com/users/docker/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/docker/subscriptions","organizations_url":"https://api.github.com/users/docker/orgs","repos_url":"https://api.github.com/users/docker/repos","events_url":"https://api.github.com/users/docker/events{/privacy}","received_events_url":"https://api.github.com/users/docker/received_events","type":"Organization","site_admin":false},"repo":{"id":28366058,"name":"distribution","full_name":"docker/distribution","owner":{"login":"docker","id":5429470,"avatar_url":"https://avatars.githubusercontent.com/u/5429470?v=3","gravatar_id":"","url":"https://api.github.com/users/docker","html_url":"https://github.com/docker","followers_url":"https://api.github.com/users/docker/followers","following_url":"https://api.github.com/users/docker/following{/other_user}","gists_url":"https://api.github.com/users/docker/gists{/gist_id}","starred_url":"https://api.github.com/users/docker/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/docker/subscriptions","organizations_url":"https://api.github.com/users/docker/orgs","repos_url":"https://api.github.com/users/docker/repos","events_url":"https://api.github.com/users/docker/events{/privacy}","received_events_url":"https://api.github.com/users/docker/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/docker/distribution","description":"The Docker toolset to pack, ship, store, and deliver content","fork":false,"url":"https://api.github.com/repos/docker/distribution","forks_url":"https://api.github.com/repos/docker/distribution/forks","keys_url":"https://api.github.com/repos/docker/distribution/keys{/key_id}","collaborators_url":"https://api.github.com/repos/docker/distribution/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/docker/distribution/teams","hooks_url":"https://api.github.com/repos/docker/distribution/hooks","issue_events_url":"https://api.github.com/repos/docker/distribution/issues/events{/number}","events_url":"https://api.github.com/repos/docker/distribution/events","assignees_url":"https://api.github.com/repos/docker/distribution/assignees{/user}","branches_url":"https://api.github.com/repos/docker/distribution/branches{/branch}","tags_url":"https://api.github.com/repos/docker/distribution/tags","blobs_url":"https://api.github.com/repos/docker/distribution/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/docker/distribution/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/docker/distribution/git/refs{/sha}","trees_url":"https://api.github.com/repos/docker/distribution/git/trees{/sha}","statuses_url":"https://api.github.com/repos/docker/distribution/statuses/{sha}","languages_url":"https://api.github.com/repos/docker/distribution/languages","stargazers_url":"https://api.github.com/repos/docker/distribution/stargazers","contributors_url":"https://api.github.com/repos/docker/distribution/contributors","subscribers_url":"https://api.github.com/repos/docker/distribution/subscribers","subscription_url":"https://api.github.com/repos/docker/distribution/subscription","commits_url":"https://api.github.com/repos/docker/distribution/commits{/sha}","git_commits_url":"https://api.github.com/repos/docker/distribution/git/commits{/sha}","comments_url":"https://api.github.com/repos/docker/distribution/comments{/number}","issue_comment_url":"https://api.github.com/repos/docker/distribution/issues/comments{/number}","contents_url":"https://api.github.com/repos/docker/distribution/contents/{+path}","compare_url":"https://api.github.com/repos/docker/distribution/compare/{base}...{head}","merges_url":"https://api.github.com/repos/docker/distribution/merges","archive_url":"https://api.github.com/repos/docker/distribution/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/docker/distribution/downloads","issues_url":"https://api.github.com/repos/docker/distribution/issues{/number}","pulls_url":"https://api.github.com/repos/docker/distribution/pulls{/number}","milestones_url":"https://api.github.com/repos/docker/distribution/milestones{/number}","notifications_url":"https://api.github.com/repos/docker/distribution/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/docker/distribution/labels{/name}","releases_url":"https://api.github.com/repos/docker/distribution/releases{/id}","created_at":"2014-12-22T23:49:26Z","updated_at":"2015-07-31T20:14:37Z","pushed_at":"2015-07-31T21:53:10Z","git_url":"git://github.com/docker/distribution.git","ssh_url":"git@github.com:docker/distribution.git","clone_url":"https://github.com/docker/distribution.git","svn_url":"https://github.com/docker/distribution","homepage":null,"size":12369,"stargazers_count":797,"watchers_count":797,"language":"Go","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":308,"mirror_url":null,"open_issues_count":108,"forks":308,"open_issues":108,"watchers":797,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/docker/distribution/pulls/779"},"html":{"href":"https://github.com/docker/distribution/pull/779"},"issue":{"href":"https://api.github.com/repos/docker/distribution/issues/779"},"comments":{"href":"https://api.github.com/repos/docker/distribution/issues/779/comments"},"review_comments":{"href":"https://api.github.com/repos/docker/distribution/pulls/779/comments"},"review_comment":{"href":"https://api.github.com/repos/docker/distribution/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/docker/distribution/pulls/779/commits"},"statuses":{"href":"https://api.github.com/repos/docker/distribution/statuses/4d584725c058d0921ee9fb1d29aed6932fe6c8d7"}}}}