2019-04-10 03:57:12 +08:00
|
|
|
# buildah-logout "1" "Apr 2019" "buildah"
|
|
|
|
|
|
|
|
## NAME
|
|
|
|
buildah\-logout - Logout of a container registry
|
|
|
|
|
|
|
|
## SYNOPSIS
|
|
|
|
**buildah logout** [*options*] *registry*
|
|
|
|
|
|
|
|
## DESCRIPTION
|
|
|
|
**buildah logout** logs out of a specified registry server by deleting the cached credentials
|
|
|
|
stored in the **auth.json** file. The path of the authentication file can be overridden by the user by setting the **authfile** flag.
|
|
|
|
The default path used is **${XDG\_RUNTIME_DIR}/containers/auth.json**.
|
|
|
|
All the cached credentials can be removed by setting the **all** flag.
|
|
|
|
|
|
|
|
**buildah [GLOBAL OPTIONS]**
|
|
|
|
|
2020-12-22 00:19:56 +08:00
|
|
|
**buildah logout [GLOBAL OPTIONS]**
|
2019-04-10 03:57:12 +08:00
|
|
|
|
|
|
|
**buildah logout [OPTIONS] REGISTRY [GLOBAL OPTIONS]**
|
|
|
|
|
|
|
|
## OPTIONS
|
|
|
|
|
|
|
|
**--authfile**
|
|
|
|
|
|
|
|
Path of the authentication file. Default is ${XDG_\RUNTIME\_DIR}/containers/auth.json
|
|
|
|
|
|
|
|
Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE
|
|
|
|
environment variable. `export REGISTRY_AUTH_FILE=path`
|
|
|
|
|
New CI check: xref --help vs man pages
Run 'buildah --help', recursively against all subcommands,
then cross-reference the results against docs/buildah*.md.
Report differences in subcommands and/or flags.
The majority of the changes in this PR are trivial (see
below) but a handful may be controversial and require
careful review:
* Making 'bud' the default output of 'buildah help',
with 'build-using-dockerfile' as an alias. This is
the inverse of the situation until now: buildah
would list build-using-dockerfile as the primary
name. The man page, OTOH, lists 'bud'. The source
file name is 'bud'. I suspect that most people
type 'bud'. So, for consistency, I choose to make
'bud' the default visible command.
* add --encryption-key and --encrypt-layer documentation
to buildah-commit.md, and --encrypt-layer to -push.md.
Please double-check the wording here.
* remove --notruncate from buildah-images.md. The option
does not exist (although there is a TODO comment in
the code). If it should exist, it is left to the
reader to implement. I would humbly suggest that this
is a good idea, for consistency with buildah containers.
* remove --shm-size from buildah-pull.md. The option
does not exist, and I suspect this was a copy-paste error.
* remove --security-opt from run.go. It was unimplemented
and undocumented.
* remove --userns-[gu]id-map from buildah-bud.md. These
are global options, not bud options, and are documented
well enough in buildah.bud.
Trivial (IMO) changes:
* split options in man pages, from '**--foo, -f**'
to '**--foo**, **-f**'. This conforms with the style
used in podman man pages.
* add missing one-letter aliases (usually "-q", "-a")
* add missing man page entries for some easy options
* sort out-of-order subcommand listings in man pages
Finally, do note that this is a copy-and-alter duplicate of the
original script in podman, and that is horrible. In an ideal
world I would've been able to refactor the podman version into
something usable on both repos (and then more). It turns out the
differences in man page format and in special-case handling are
too broad to let me do a clean refactor.
Signed-off-by: Ed Santiago <santiago@redhat.com>
2020-09-21 22:51:19 +08:00
|
|
|
**--all**, **-a**
|
2019-04-10 03:57:12 +08:00
|
|
|
|
|
|
|
Remove the cached credentials for all registries in the auth file
|
|
|
|
|
|
|
|
**--help**, **-h**
|
|
|
|
|
|
|
|
Print usage statement
|
|
|
|
|
|
|
|
## EXAMPLES
|
|
|
|
|
|
|
|
```
|
|
|
|
$ buildah logout docker.io
|
|
|
|
Removed login credentials for docker.io
|
|
|
|
```
|
|
|
|
|
|
|
|
```
|
2020-12-22 00:19:56 +08:00
|
|
|
$ buildah logout --authfile authdir/myauths.json docker.io
|
2019-04-10 03:57:12 +08:00
|
|
|
Removed login credentials for docker.io
|
|
|
|
```
|
|
|
|
|
|
|
|
```
|
|
|
|
$ buildah logout --all
|
|
|
|
Remove login credentials for all registries
|
|
|
|
```
|
|
|
|
|
|
|
|
## SEE ALSO
|
New CI check: xref --help vs man pages
Run 'buildah --help', recursively against all subcommands,
then cross-reference the results against docs/buildah*.md.
Report differences in subcommands and/or flags.
The majority of the changes in this PR are trivial (see
below) but a handful may be controversial and require
careful review:
* Making 'bud' the default output of 'buildah help',
with 'build-using-dockerfile' as an alias. This is
the inverse of the situation until now: buildah
would list build-using-dockerfile as the primary
name. The man page, OTOH, lists 'bud'. The source
file name is 'bud'. I suspect that most people
type 'bud'. So, for consistency, I choose to make
'bud' the default visible command.
* add --encryption-key and --encrypt-layer documentation
to buildah-commit.md, and --encrypt-layer to -push.md.
Please double-check the wording here.
* remove --notruncate from buildah-images.md. The option
does not exist (although there is a TODO comment in
the code). If it should exist, it is left to the
reader to implement. I would humbly suggest that this
is a good idea, for consistency with buildah containers.
* remove --shm-size from buildah-pull.md. The option
does not exist, and I suspect this was a copy-paste error.
* remove --security-opt from run.go. It was unimplemented
and undocumented.
* remove --userns-[gu]id-map from buildah-bud.md. These
are global options, not bud options, and are documented
well enough in buildah.bud.
Trivial (IMO) changes:
* split options in man pages, from '**--foo, -f**'
to '**--foo**, **-f**'. This conforms with the style
used in podman man pages.
* add missing one-letter aliases (usually "-q", "-a")
* add missing man page entries for some easy options
* sort out-of-order subcommand listings in man pages
Finally, do note that this is a copy-and-alter duplicate of the
original script in podman, and that is horrible. In an ideal
world I would've been able to refactor the podman version into
something usable on both repos (and then more). It turns out the
differences in man page format and in special-case handling are
too broad to let me do a clean refactor.
Signed-off-by: Ed Santiago <santiago@redhat.com>
2020-09-21 22:51:19 +08:00
|
|
|
buildah(1), buildah-login(1)
|