New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
remove registry docs #15888
remove registry docs #15888
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
7820cd3
to
8bcb318
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Changes itself LGTM (pending the discussion if we need to preserve some bits or replace them with something)
So; progressive insight (could use input from @milosgajdos on this);
As a result, various projects refer to docs.docker.com as canonical location for the specs, e.g. https://github.com/containerd/containerd/blob/72177ca663a2b63c6d9c87a7d6e2e8d5a32ad446/remotes/docker/authorizer.go#L276 Question is; will distribution/distribution continue to maintain the docs for an obsolete spec that they no longer implement? And if not, then where should those docs live (if Docker Hub implements them)? (Basically, who "owns" the Auth spec?) |
Auth spec seems to be in a bit of a limbo that has been driving people in the community pretty crazy as demonstrated in both upstream issues and discussions. I think we need to find a way how to shift the spec to the open -- should CNCF own it as part of the distribution? Or should it be standardised by OCI? I tend to lean towards the latter, but not sure how to go about shifting that responsibility to them |
Ah forgot I had this branch main...crazy-max:docker.github.io:registry-remote when I was working on the new |
504be63
to
bfaa9ae
Compare
bf7657c
to
826aaf8
Compare
826aaf8
to
ec34fe0
Compare
011a248
to
c9c01cb
Compare
Would need to change: https://github.com/docker/docs/blame/main/docker-hub/service-accounts.md#L54 To |
c9c01cb
to
56f7784
Compare
Signed-off-by: David Karlsson <david.karlsson@docker.com>
56f7784
to
401642c
Compare
Authentication (and "search") were deliberately left out of the specification when the OCI distribution spec was initiated. Some reasons for that;
Which left us with;
There was a discussion during KubeCon where people wanted to add authentication to the OCI spec. There was still debate about "to what extend", so one option was to document "known implementations" (not a strict requirement). I think in the meantime we can;
|
The first option is what this PR is currently doing: pulling the auth spec from distribution/distribution upstream. This is no different to how we currently do it (for auth). For the API spec we will just refer to upstream (not Docker Registry V2, but OCI spec). Registry storage drivers were purged completely from our site. I agree that it would be ideal to have a dedicated description for the Hub implementation of auth, with an external reference for more information. Outside the scope for this PR but we should have a followup for this. Related, at some point we might want to revisit where we describe the v2 image manifest schema 2. That is ALSO currently in distribution upstream. Works for now 🤷🏻 |
to be revisited |
This removes the documentation for registry (a CNCF project) from
docs.docker.com
and adds corresponding redirects to thedistribution/distribution
GitHub, e.g. https://deploy-preview-15888--docsdocker.netlify.app/registry/deploying/Do not merge: awaiting confirmation on Docker Hub conformance to OCI spec
Todo: use the new_redirects.yml
and remove stubs