tweak description of login/logout

Remove "Docker" from registry, as the registry specification is no
longer docker-specific, but part of the OCI distribution spec.

Also removed "Register" from one of the docs pages, as the login
command hasn't supported creating a new acccount on Docker Hub for
a long time.

I'm wondering if we should be more explicit about what log in / out
does (effectively; authenticate, and on success store the credentials
or token, and on log out; remove credentials/token).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2022-04-01 15:32:55 +02:00
parent a4b6fe16ae
commit bcd4101f3d
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
12 changed files with 17 additions and 17 deletions

View File

@ -80,6 +80,6 @@ End-to-end test should run the `docker` binary using
and make assertions about the exit code, stdout, stderr, and local file system. and make assertions about the exit code, stdout, stderr, and local file system.
Any Docker image or registry operations should use `registry:5000/<image name>` Any Docker image or registry operations should use `registry:5000/<image name>`
to communicate with the local instance of the Docker registry. To load to communicate with the local instance of the registry. To load
additional fixture images to the registry see additional fixture images to the registry see
[scripts/test/e2e/run](https://github.com/docker/cli/blob/master/scripts/test/e2e/run). [scripts/test/e2e/run](https://github.com/docker/cli/blob/master/scripts/test/e2e/run).

View File

@ -35,8 +35,8 @@ func NewLoginCommand(dockerCli command.Cli) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "login [OPTIONS] [SERVER]", Use: "login [OPTIONS] [SERVER]",
Short: "Log in to a Docker registry", Short: "Log in to a registry",
Long: "Log in to a Docker registry.\nIf no server is specified, the default is defined by the daemon.", Long: "Log in to a registry.\nIf no server is specified, the default is defined by the daemon.",
Args: cli.RequiresMaxArgs(1), Args: cli.RequiresMaxArgs(1),
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
if len(args) > 0 { if len(args) > 0 {

View File

@ -13,8 +13,8 @@ import (
func NewLogoutCommand(dockerCli command.Cli) *cobra.Command { func NewLogoutCommand(dockerCli command.Cli) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "logout [SERVER]", Use: "logout [SERVER]",
Short: "Log out from a Docker registry", Short: "Log out from a registry",
Long: "Log out from a Docker registry.\nIf no server is specified, the default is defined by the daemon.", Long: "Log out from a registry.\nIf no server is specified, the default is defined by the daemon.",
Args: cli.RequiresMaxArgs(1), Args: cli.RequiresMaxArgs(1),
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
var serverAddress string var serverAddress string

View File

@ -108,7 +108,7 @@ complete -c docker -f -n '__fish_docker_no_subcommand' -s l -l log-level -d 'Set
complete -c docker -f -n '__fish_docker_no_subcommand' -l label -d 'Set key=value labels to the daemon (displayed in `docker info`)' complete -c docker -f -n '__fish_docker_no_subcommand' -l label -d 'Set key=value labels to the daemon (displayed in `docker info`)'
complete -c docker -f -n '__fish_docker_no_subcommand' -l mtu -d 'Set the containers network MTU' complete -c docker -f -n '__fish_docker_no_subcommand' -l mtu -d 'Set the containers network MTU'
complete -c docker -f -n '__fish_docker_no_subcommand' -s p -l pidfile -d 'Path to use for daemon PID file' complete -c docker -f -n '__fish_docker_no_subcommand' -s p -l pidfile -d 'Path to use for daemon PID file'
complete -c docker -f -n '__fish_docker_no_subcommand' -l registry-mirror -d 'Specify a preferred Docker registry mirror' complete -c docker -f -n '__fish_docker_no_subcommand' -l registry-mirror -d 'Specify a preferred registry mirror'
complete -c docker -f -n '__fish_docker_no_subcommand' -s s -l storage-driver -d 'Force the Docker runtime to use a specific storage driver' complete -c docker -f -n '__fish_docker_no_subcommand' -s s -l storage-driver -d 'Force the Docker runtime to use a specific storage driver'
complete -c docker -f -n '__fish_docker_no_subcommand' -l selinux-enabled -d 'Enable selinux support. SELinux does not presently support the BTRFS storage driver' complete -c docker -f -n '__fish_docker_no_subcommand' -l selinux-enabled -d 'Enable selinux support. SELinux does not presently support the BTRFS storage driver'
complete -c docker -f -n '__fish_docker_no_subcommand' -l storage-opt -d 'Set storage driver options' complete -c docker -f -n '__fish_docker_no_subcommand' -l storage-opt -d 'Set storage driver options'
@ -358,14 +358,14 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from load' -s i -l input -d
complete -c docker -A -f -n '__fish_seen_subcommand_from load' -s q -l quiet -d 'Suppress the load output' complete -c docker -A -f -n '__fish_seen_subcommand_from load' -s q -l quiet -d 'Suppress the load output'
# login # login
complete -c docker -f -n '__fish_docker_no_subcommand' -a login -d 'Log in to a Docker registry server' complete -c docker -f -n '__fish_docker_no_subcommand' -a login -d 'Log in to a registry'
complete -c docker -A -f -n '__fish_seen_subcommand_from login' -l help -d 'Print usage' complete -c docker -A -f -n '__fish_seen_subcommand_from login' -l help -d 'Print usage'
complete -c docker -A -f -n '__fish_seen_subcommand_from login' -s p -l password -d 'Password' complete -c docker -A -f -n '__fish_seen_subcommand_from login' -s p -l password -d 'Password'
complete -c docker -A -f -n '__fish_seen_subcommand_from login' -l password-stdin -d 'Take the password from stdin' complete -c docker -A -f -n '__fish_seen_subcommand_from login' -l password-stdin -d 'Take the password from stdin'
complete -c docker -A -f -n '__fish_seen_subcommand_from login' -s u -l username -d 'Username' complete -c docker -A -f -n '__fish_seen_subcommand_from login' -s u -l username -d 'Username'
# logout # logout
complete -c docker -f -n '__fish_docker_no_subcommand' -a logout -d 'Log out from a Docker registry server' complete -c docker -f -n '__fish_docker_no_subcommand' -a logout -d 'Log out from a registry'
# logs # logs
complete -c docker -f -n '__fish_docker_no_subcommand' -a logs -d 'Fetch the logs of a container' complete -c docker -f -n '__fish_docker_no_subcommand' -a logs -d 'Fetch the logs of a container'

View File

@ -2779,7 +2779,7 @@ __docker_subcommand() {
"($help)--oom-score-adjust=[Set the oom_score_adj for the daemon]:oom-score:(-500)" \ "($help)--oom-score-adjust=[Set the oom_score_adj for the daemon]:oom-score:(-500)" \
"($help -p --pidfile)"{-p=,--pidfile=}"[Path to use for daemon PID file]:PID file:_files" \ "($help -p --pidfile)"{-p=,--pidfile=}"[Path to use for daemon PID file]:PID file:_files" \
"($help)--raw-logs[Full timestamps without ANSI coloring]" \ "($help)--raw-logs[Full timestamps without ANSI coloring]" \
"($help)*--registry-mirror=[Preferred Docker registry mirror]:registry mirror: " \ "($help)*--registry-mirror=[Preferred registry mirror]:registry mirror: " \
"($help)--seccomp-profile=[Path to seccomp profile]:path:_files -g \"*.json\"" \ "($help)--seccomp-profile=[Path to seccomp profile]:path:_files -g \"*.json\"" \
"($help -s --storage-driver)"{-s=,--storage-driver=}"[Storage driver to use]:driver:(aufs btrfs devicemapper overlay overlay2 vfs zfs)" \ "($help -s --storage-driver)"{-s=,--storage-driver=}"[Storage driver to use]:driver:(aufs btrfs devicemapper overlay overlay2 vfs zfs)" \
"($help)--selinux-enabled[Enable selinux support]" \ "($help)--selinux-enabled[Enable selinux support]" \

View File

@ -88,7 +88,7 @@ Options:
--oom-score-adjust int Set the oom_score_adj for the daemon (default -500) --oom-score-adjust int Set the oom_score_adj for the daemon (default -500)
-p, --pidfile string Path to use for daemon PID file (default "/var/run/docker.pid") -p, --pidfile string Path to use for daemon PID file (default "/var/run/docker.pid")
--raw-logs Full timestamps without ANSI coloring --raw-logs Full timestamps without ANSI coloring
--registry-mirror list Preferred Docker registry mirror --registry-mirror list Preferred registry mirror
--rootless Enable rootless mode; typically used with RootlessKit --rootless Enable rootless mode; typically used with RootlessKit
--seccomp-profile string Path to seccomp profile --seccomp-profile string Path to seccomp profile
--selinux-enabled Enable selinux support --selinux-enabled Enable selinux support

View File

@ -76,8 +76,8 @@ read the [`dockerd`](dockerd.md) reference page.
| Command | Description | | Command | Description |
|:--------------------|:------------------------------------------------------------------------| |:--------------------|:------------------------------------------------------------------------|
| [login](login.md) | Register or log in to a Docker registry | | [login](login.md) | Log in to a registry |
| [logout](logout.md) | Log out from a Docker registry | | [logout](logout.md) | Log out from a registry |
| [pull](pull.md) | Download an image from a registry | | [pull](pull.md) | Download an image from a registry |
| [push](push.md) | Upload an image to a registry | | [push](push.md) | Upload an image to a registry |
| [search](search.md) | Search Docker Hub for images | | [search](search.md) | Search Docker Hub for images |

View File

@ -9,7 +9,7 @@ keywords: "registry, login, image"
```markdown ```markdown
Usage: docker login [OPTIONS] [SERVER] Usage: docker login [OPTIONS] [SERVER]
Log in to a Docker registry. Log in to a registry.
If no server is specified, the default is defined by the daemon. If no server is specified, the default is defined by the daemon.
Options: Options:

View File

@ -9,7 +9,7 @@ keywords: "logout, docker, registry"
```markdown ```markdown
Usage: docker logout [SERVER] Usage: docker logout [SERVER]
Log out from a Docker registry. Log out from a registry.
If no server is specified, the default is defined by the daemon. If no server is specified, the default is defined by the daemon.
Options: Options:

View File

@ -98,7 +98,7 @@ Options:
### Working with insecure registries ### Working with insecure registries
The manifest command interacts solely with a Docker registry. Because of this, The manifest command interacts solely with a registry. Because of this,
it has no way to query the engine for the list of allowed insecure registries. it has no way to query the engine for the list of allowed insecure registries.
To allow the CLI to interact with an insecure registry, some `docker manifest` To allow the CLI to interact with an insecure registry, some `docker manifest`
commands have an `--insecure` flag. For each transaction, such as a `create`, commands have an `--insecure` flag. For each transaction, such as a `create`,

View File

@ -19,4 +19,4 @@ credentials. When you log in, the command stores encoded credentials in
# docker login localhost:8080 # docker login localhost:8080
# See also # See also
**docker-logout(1)** to log out from a Docker registry. **docker-logout(1)** to log out from a registry.

View File

@ -10,4 +10,4 @@ located at `https://registry-1.docker.io/` by default.
# docker logout localhost:8080 # docker logout localhost:8080
# See also # See also
**docker-login(1)** to log in to a Docker registry server. **docker-login(1)** to log in to a registry.