Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4706 from thaJeztah/24.0_backport_docs 

[24.0 backport] assorted documentation updates
This commit is contained in:
Sebastiaan van Stijn 2023-12-11 22:03:10 +01:00 committed by GitHub
parent f5a9aabe74 a976e5084a
commit fb2f337bc1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 29 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/extend/legacy_plugins.md
View File

@ -1,5 +1,5 @@
--- ---
redirect_from: aliases:
- "/engine/extend/plugins/" - "/engine/extend/plugins/"
description: "How to add additional functionality to Docker with plugins extensions" description: "How to add additional functionality to Docker with plugins extensions"
keywords: "Examples, Usage, plugins, docker, documentation, user guide" keywords: "Examples, Usage, plugins, docker, documentation, user guide"

2
docs/extend/plugins_authorization.md
View File

@ -1,7 +1,7 @@
--- ---
description: "How to create authorization plugins to manage access control to your Docker daemon." description: "How to create authorization plugins to manage access control to your Docker daemon."
keywords: "security, authorization, authentication, docker, documentation, plugin, extend" keywords: "security, authorization, authentication, docker, documentation, plugin, extend"
redirect_from: aliases:
- "/engine/extend/authorization/" - "/engine/extend/authorization/"
--- ---

2
docs/reference/commandline/cli.md
View File

@ -2,7 +2,7 @@
title: "Use the Docker command line" title: "Use the Docker command line"
description: "Docker's CLI command description and usage" description: "Docker's CLI command description and usage"
keywords: "Docker, Docker documentation, CLI, command line, config.json, CLI configuration file" keywords: "Docker, Docker documentation, CLI, command line, config.json, CLI configuration file"
redirect_from: aliases:
- /reference/commandline/cli/ - /reference/commandline/cli/
- /engine/reference/commandline/engine/ - /engine/reference/commandline/engine/
- /engine/reference/commandline/engine_activate/ - /engine/reference/commandline/engine_activate/

4
docs/reference/commandline/dockerd.md
View File

@ -2,7 +2,7 @@
title: "dockerd" title: "dockerd"
description: "The daemon command description and usage" description: "The daemon command description and usage"
keywords: "container, daemon, runtime" keywords: "container, daemon, runtime"
redirect_from: aliases:
- /engine/reference/commandline/daemon/ - /engine/reference/commandline/daemon/
--- ---
@ -205,7 +205,7 @@ find examples of using Systemd socket activation with Docker and Systemd in the
You can configure the Docker daemon to listen to multiple sockets at the same You can configure the Docker daemon to listen to multiple sockets at the same
time using multiple `-H` options: time using multiple `-H` options:
The example below runs the daemon listenin on the default unix socket, and The example below runs the daemon listening on the default unix socket, and
on 2 specific IP addresses on this host: on 2 specific IP addresses on this host:
```console ```console

8
docs/reference/commandline/exec.md
View File

@ -77,10 +77,10 @@ This starts a new shell session in the container `mycontainer`.
Next, set environment variables in the current bash session. Next, set environment variables in the current bash session.
By default, the `docker exec` command, inherits the environment variables that The `docker exec` command inherits the environment variables that are set at the
are set at the time the container is created. Use the `--env` (or the `-e` shorthand) time the container is created. Use the `--env` (or the `-e` shorthand) to
to override global environment variables, or to set additional environment variables override global environment variables, or to set additional environment
for the process started by `docker exec`. variables for the process started by `docker exec`.
The example below creates a new shell session in the container `mycontainer` with The example below creates a new shell session in the container `mycontainer` with
environment variables `$VAR_A` and `$VAR_B` set to "1" and "2" respectively. environment variables `$VAR_A` and `$VAR_B` set to "1" and "2" respectively.

2
docs/reference/commandline/load.md
View File

@ -20,7 +20,7 @@ Load an image from a tar archive or STDIN
## Description ## Description
Load an image or repository from a tar archive (even if compressed with gzip, Load an image or repository from a tar archive (even if compressed with gzip,
bzip2, or xz) from a file or STDIN. It restores both images and tags. bzip2, xz or zstd) from a file or STDIN. It restores both images and tags.
## Examples ## Examples

16
docs/reference/commandline/pull.md
View File

@ -67,18 +67,18 @@ docker.io/library/debian:latest
Docker images can consist of multiple layers. In the example above, the image Docker images can consist of multiple layers. In the example above, the image
consists of a single layer; `e756f3fdd6a3`. consists of a single layer; `e756f3fdd6a3`.
Layers can be reused by images. For example, the `debian:bullseye` image shares Layers can be reused by images. For example, the `debian:bookworm` image shares
its layer with the `debian:latest`. Pulling the `debian:bullseye` image therefore its layer with the `debian:latest`. Pulling the `debian:bookworm` image therefore
only pulls its metadata, but not its layers, because the layer is already present only pulls its metadata, but not its layers, because the layer is already present
locally: locally:
```console ```console
$ docker image pull debian:bullseye $ docker image pull debian:bookworm
bullseye: Pulling from library/debian bookworm: Pulling from library/debian
Digest: sha256:3f1d6c17773a45c97bd8f158d665c9709d7b29ed7917ac934086ad96f92e4510 Digest: sha256:3f1d6c17773a45c97bd8f158d665c9709d7b29ed7917ac934086ad96f92e4510
Status: Downloaded newer image for debian:bullseye Status: Downloaded newer image for debian:bookworm
docker.io/library/debian:bullseye docker.io/library/debian:bookworm
``` ```
To see which images are present locally, use the [`docker images`](images.md) To see which images are present locally, use the [`docker images`](images.md)
@ -88,13 +88,13 @@ command:
$ docker images $ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE REPOSITORY TAG IMAGE ID CREATED SIZE
debian bullseye 4eacea30377a 8 days ago 124MB debian bookworm 4eacea30377a 8 days ago 124MB
debian latest 4eacea30377a 8 days ago 124MB debian latest 4eacea30377a 8 days ago 124MB
``` ```
Docker uses a content-addressable image store, and the image ID is a SHA256 Docker uses a content-addressable image store, and the image ID is a SHA256
digest covering the image's configuration and layers. In the example above, digest covering the image's configuration and layers. In the example above,
`debian:bullseye` and `debian:latest` have the same image ID because they are `debian:bookworm` and `debian:latest` have the same image ID because they are
the *same* image tagged with different names. Because they are the same image, the *same* image tagged with different names. Because they are the same image,
their layers are stored only once and do not consume extra disk space. their layers are stored only once and do not consume extra disk space.

2
docs/reference/commandline/run.md
View File

@ -416,6 +416,8 @@ environment, the variable isn't set in the container.
You can also load the environment variables from a file. This file should use You can also load the environment variables from a file. This file should use
the syntax `<variable>=value` (which sets the variable to the given value) or the syntax `<variable>=value` (which sets the variable to the given value) or
`<variable>` (which takes the value from the local environment), and `#` for comments. `<variable>` (which takes the value from the local environment), and `#` for comments.
Additionally, it's important to note that lines beginning with `#` are treated as line comments
and are ignored, whereas a `#` appearing anywhere else in a line is treated as part of the variable value.
```console ```console
$ cat env.list $ cat env.list

2
docs/reference/run.md
View File

@ -1,7 +1,7 @@
--- ---
description: "Configure containers at runtime" description: "Configure containers at runtime"
keywords: "docker, run, configure, runtime" keywords: "docker, run, configure, runtime"
redirect_from: aliases:
- /reference/run/ - /reference/run/
--- ---

16
man/src/image/pull.md
View File

@ -27,17 +27,17 @@ Docker Engine uses the `:latest` tag as a default. This example pulls the
Docker images can consist of multiple layers. In the example above, the image Docker images can consist of multiple layers. In the example above, the image
consists of a single layer; `e756f3fdd6a3`. consists of a single layer; `e756f3fdd6a3`.
Layers can be reused by images. For example, the `debian:bullseye` image shares Layers can be reused by images. For example, the `debian:bookworm` image shares
its layer with the `debian:latest`. Pulling the `debian:bullseye` image therefore its layer with the `debian:latest`. Pulling the `debian:bookworm` image therefore
only pulls its metadata, but not its layers, because the layer is already present only pulls its metadata, but not its layers, because the layer is already present
locally: locally:
$ docker image pull debian:bullseye $ docker image pull debian:bookworm
bullseye: Pulling from library/debian bookworm: Pulling from library/debian
Digest: sha256:3f1d6c17773a45c97bd8f158d665c9709d7b29ed7917ac934086ad96f92e4510 Digest: sha256:3f1d6c17773a45c97bd8f158d665c9709d7b29ed7917ac934086ad96f92e4510
Status: Downloaded newer image for debian:bullseye Status: Downloaded newer image for debian:bookworm
docker.io/library/debian:bullseye docker.io/library/debian:bookworm
To see which images are present locally, use the **docker-images(1)** To see which images are present locally, use the **docker-images(1)**
command: command:
@ -45,12 +45,12 @@ command:
$ docker images $ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE REPOSITORY TAG IMAGE ID CREATED SIZE
debian bullseye 4eacea30377a 8 days ago 124MB debian bookworm 4eacea30377a 8 days ago 124MB
debian latest 4eacea30377a 8 days ago 124MB debian latest 4eacea30377a 8 days ago 124MB
Docker uses a content-addressable image store, and the image ID is a SHA256 Docker uses a content-addressable image store, and the image ID is a SHA256
digest covering the image's configuration and layers. In the example above, digest covering the image's configuration and layers. In the example above,
`debian:bullseye` and `debian:latest` have the same image ID because they are `debian:bookworm` and `debian:latest` have the same image ID because they are
the *same* image tagged with different names. Because they are the same image, the *same* image tagged with different names. Because they are the same image,
their layers are stored only once and do not consume extra disk space. their layers are stored only once and do not consume extra disk space.