Skip to content
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

docs: correct default authfile path #5294

Closed
wants to merge 1 commit into from
Closed

docs: correct default authfile path #5294

wants to merge 1 commit into from

Conversation

wulfgarpro
Copy link
Contributor

/kind documentation

None

Signed-off-by: James Fraser <wulfgar.pro@gmail.com>
@openshift-ci openshift-ci bot added the kind/documentation Categorizes issue or PR as related to documentation. label Jan 25, 2024
@TomSweeneyRedHat
Copy link
Member

In other places I'm seeing the default is /run/containers/$UID/auth.json in the man pages. I think you might have found something that needs fixing in several places. @rhatdan thoughts?

@rhatdan
Copy link
Member

rhatdan commented Jan 26, 2024

grep "/run/containers/.*UID/auth.json" . -r
./docs/buildah-push.1.md:Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json. If XDG_RUNTIME_DIR is not set, the default is /run/containers/$UID/auth.json. This file is created using `buildah login`.
./docs/buildah-commit.1.md:Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json. If XDG_RUNTIME_DIR is not set, the default is /run/containers/$UID/auth.json. This file is created using `buildah login`.
./docs/buildah-from.1.md:  An image in a registry implementing the "Docker Registry HTTP API V2". By default, uses the authorization state in `$XDG_RUNTIME_DIR/containers/auth.json`, which is set using `(buildah login)`.  If XDG_RUNTIME_DIR is not set, the default is /run/containers/$UID/auth.json. If the authorization state is not found there, `$HOME/.docker/config.json` is checked, which is set using `(docker login)`.
./docs/buildah-from.1.md:Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json. If XDG_RUNTIME_DIR is not set, the default is /run/containers/$UID/auth.json. This file is created using `buildah login`.
./docs/buildah-login.1.md:is not set, the default is /run/containers/$UID/auth.json.
./docs/buildah-logout.1.md:The default path used is **${XDG\_RUNTIME_DIR}/containers/auth.json**.  If XDG_RUNTIME_DIR is not set, the default is /run/containers/$UID/auth.json.
./docs/buildah-manifest-add.1.md:Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json. If XDG_RUNTIME_DIR is not set, the default is /run/containers/$UID/auth.json. This file is created using `buildah login`.
./docs/buildah-pull.1.md:Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json. If XDG_RUNTIME_DIR is not set, the default is /run/containers/$UID/auth.json. This file is created using `buildah login`.
./docs/buildah-build.1.md:Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json. If XDG_RUNTIME_DIR is not set, the default is /run/containers/$UID/auth.json. This file is created using `buildah login`.

@wulfgarpro
Copy link
Contributor Author

It's also still a contradiction for root where buildah login XXX puts auth.json at /run/containers/0/auth.json. I'll fix it up when I have a spare moment. Is this documentation generated?

Copy link
Collaborator

@flouthoc flouthoc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

openshift-ci bot commented Jan 27, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: flouthoc, wulfgarpro

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@rhatdan
Copy link
Member

rhatdan commented Jan 27, 2024

Documentation (Markdown) is not generated, it is hand edited.

@rhatdan rhatdan closed this Feb 6, 2024
@stale-locking-app stale-locking-app bot locked as resolved and limited conversation to collaborators May 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants