Intial authfile man page #821
Conversation
|
Will clean up white space errors that gitvalidate is not happy about after the first round of comments. |
|
@QiWang19 PTAL |
docs/containers-authfile.5.md
Outdated
|
|
||
| ## FORMAT | ||
|
|
||
| The auth.json file is stores encrypted authentication information for the |
There was a problem hiding this comment.
You is correct! Thanks!
|
LGTM |
docs/containers-authfile.5.md
Outdated
| "auths": { | ||
| "localhost:5001": {} | ||
| }, | ||
| "credsStore": "secretservice" |
There was a problem hiding this comment.
No. I see the code can only parse "credHelpers":{}
There was a problem hiding this comment.
So we should not document it here, until we get containers/image to support credStore.
|
A very weak suggestion: do we want to commit to the format, or just to say “use an API”? Given that we have decided to be compatible, documenting the format as implemented is I suppose good and the downside of inability to change the format is negligible; still, throwing this out here to consider. |
|
I would just document what we have now. Would be difficult to remove support now, but we could extend it in the future. |
|
OK as there's a number of questions on how credential-helpers/cred-stores are working with the auth file ATM, I've removed the info from that. We need to take a look at that and then update this file after it's sorted out. Unless there are strong objections, I'd like to at least get this in for now. |
|
LGTM, will merge once the tests pass. |
|
I needed to rebase and have repushed without changes to the file. |
|
@vrothberg PTAL |
docs/containers-authfile.5.md
Outdated
| The auth.json file stores encrypted authentication information for the | ||
| user to container image registries. The file can have zero to many entries and | ||
| is created by a `login` command from a container tool such as `podman login` or | ||
| `buildah login`. Each entry includes the name of the registry and then an auth |
There was a problem hiding this comment.
Somehow related: I'd love there to be a skopeo login :)
There was a problem hiding this comment.
@QiWang19 Could you add this to your list of Things to Do. Add skopoe login/logout.
There was a problem hiding this comment.
The initial man page for the authfile used by the container tools. Fixes: containers/podman#4359 Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
|
I've renamed the file inside and out (thx @vrothberg !) and have repushed. |
|
LGTM |
The initial man page for the authfile used by
the container tools.
Fixes: containers/podman#4359
Signed-off-by: TomSweeneyRedHat tsweeney@redhat.com