From f552eb7ae08c7c1ed827df847c905abf5c3b2f82 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Mon, 11 Dec 2023 22:07:48 +0100 Subject: [PATCH] update cli docs to latest of 24.0 branch Signed-off-by: Sebastiaan van Stijn --- _vendor/github.com/docker/cli/docs/deprecated.md | 2 -- .../github.com/docker/cli/docs/extend/legacy_plugins.md | 2 +- .../docker/cli/docs/extend/plugins_authorization.md | 2 +- .../docker/cli/docs/extend/plugins_graphdriver.md | 4 ---- .../github.com/docker/cli/docs/extend/plugins_logging.md | 2 +- .../github.com/docker/cli/docs/extend/plugins_services.md | 2 -- .../docker/cli/docs/reference/commandline/cli.md | 6 ++---- .../docker/cli/docs/reference/commandline/dockerd.md | 4 ++-- _vendor/github.com/docker/cli/docs/reference/run.md | 8 +------- _vendor/modules.txt | 2 +- go.mod | 2 +- go.sum | 4 ++++ 12 files changed, 14 insertions(+), 26 deletions(-) diff --git a/_vendor/github.com/docker/cli/docs/deprecated.md b/_vendor/github.com/docker/cli/docs/deprecated.md index b0d50165ac..bf653dec3d 100644 --- a/_vendor/github.com/docker/cli/docs/deprecated.md +++ b/_vendor/github.com/docker/cli/docs/deprecated.md @@ -821,9 +821,7 @@ Because of which, the driver specific log tag options `syslog-tag`, `gelf-tag` a `fluentd-tag` have been deprecated in favor of the generic `tag` option. ```console -{% raw %} $ docker --log-driver=syslog --log-opt tag="{{.ImageName}}/{{.Name}}/{{.ID}}" -{% endraw %} ``` diff --git a/_vendor/github.com/docker/cli/docs/extend/legacy_plugins.md b/_vendor/github.com/docker/cli/docs/extend/legacy_plugins.md index d3981bd076..6c842ac473 100644 --- a/_vendor/github.com/docker/cli/docs/extend/legacy_plugins.md +++ b/_vendor/github.com/docker/cli/docs/extend/legacy_plugins.md @@ -1,5 +1,5 @@ --- -redirect_from: +aliases: - "/engine/extend/plugins/" description: "How to add additional functionality to Docker with plugins extensions" keywords: "Examples, Usage, plugins, docker, documentation, user guide" diff --git a/_vendor/github.com/docker/cli/docs/extend/plugins_authorization.md b/_vendor/github.com/docker/cli/docs/extend/plugins_authorization.md index 2fc444e101..203c1bf2e2 100644 --- a/_vendor/github.com/docker/cli/docs/extend/plugins_authorization.md +++ b/_vendor/github.com/docker/cli/docs/extend/plugins_authorization.md @@ -1,7 +1,7 @@ --- description: "How to create authorization plugins to manage access control to your Docker daemon." keywords: "security, authorization, authentication, docker, documentation, plugin, extend" -redirect_from: +aliases: - "/engine/extend/authorization/" --- diff --git a/_vendor/github.com/docker/cli/docs/extend/plugins_graphdriver.md b/_vendor/github.com/docker/cli/docs/extend/plugins_graphdriver.md index f0c88f734f..f6558d7f1e 100644 --- a/_vendor/github.com/docker/cli/docs/extend/plugins_graphdriver.md +++ b/_vendor/github.com/docker/cli/docs/extend/plugins_graphdriver.md @@ -311,9 +311,7 @@ and `Parent`. `Parent` may be an empty string, in which case there is no parent. **Response**: ``` -{% raw %} {{ TAR STREAM }} -{% endraw %} ``` ### /GraphDriver.Changes @@ -357,9 +355,7 @@ Respond with a non-empty string error if an error occurred. **Request**: ``` -{% raw %} {{ TAR STREAM }} -{% endraw %} ``` Extract the changeset from the given diff into the layer with the specified `ID` diff --git a/_vendor/github.com/docker/cli/docs/extend/plugins_logging.md b/_vendor/github.com/docker/cli/docs/extend/plugins_logging.md index 6405dd26cf..d6ce96cfb3 100644 --- a/_vendor/github.com/docker/cli/docs/extend/plugins_logging.md +++ b/_vendor/github.com/docker/cli/docs/extend/plugins_logging.md @@ -213,7 +213,7 @@ to determine what set of logs to read. **Response**: ``` -{% raw %}{{ log stream }}{% endraw %} +{{ log stream }} ``` The response should be the encoded log message using the same format as the diff --git a/_vendor/github.com/docker/cli/docs/extend/plugins_services.md b/_vendor/github.com/docker/cli/docs/extend/plugins_services.md index 20889dd976..f0c2dc503d 100644 --- a/_vendor/github.com/docker/cli/docs/extend/plugins_services.md +++ b/_vendor/github.com/docker/cli/docs/extend/plugins_services.md @@ -69,10 +69,8 @@ node1 is the manager and node2 is the worker. 4. Observe the task getting scheduled in node 2: ```console - {% raw %} $ docker ps --format '{{.ID}}\t {{.Status}} {{.Names}} {{.Command}}' 83fc1e842599 Up 2 days my-service.1.9jn59qzn7nbc3m0zt1hij12xs "top" - {% endraw %} ``` ### Network plugins diff --git a/_vendor/github.com/docker/cli/docs/reference/commandline/cli.md b/_vendor/github.com/docker/cli/docs/reference/commandline/cli.md index 92f4f39074..8714cd6b70 100644 --- a/_vendor/github.com/docker/cli/docs/reference/commandline/cli.md +++ b/_vendor/github.com/docker/cli/docs/reference/commandline/cli.md @@ -2,7 +2,7 @@ title: "Use the Docker command line" description: "Docker's CLI command description and usage" keywords: "Docker, Docker documentation, CLI, command line, config.json, CLI configuration file" -redirect_from: +aliases: - /reference/commandline/cli/ - /engine/reference/commandline/engine/ - /engine/reference/commandline/engine_activate/ @@ -156,7 +156,7 @@ By default, the Docker command line stores its configuration files in a directory called `.docker` within your `$HOME` directory. Docker manages most of the files in the configuration directory -and you should not modify them. However, you *can* modify the +and you should not modify them. However, you can modify the `config.json` file to control certain aspects of how the `docker` command behaves. @@ -313,7 +313,6 @@ Following is a sample `config.json` file to illustrate the format used for various fields: ```json -{% raw %} { "HttpHeaders": { "MyHeader": "MyValue" @@ -356,7 +355,6 @@ various fields: } } } -{% endraw %} ``` ### Experimental features diff --git a/_vendor/github.com/docker/cli/docs/reference/commandline/dockerd.md b/_vendor/github.com/docker/cli/docs/reference/commandline/dockerd.md index 9a62bbf97d..1c9f8e1837 100644 --- a/_vendor/github.com/docker/cli/docs/reference/commandline/dockerd.md +++ b/_vendor/github.com/docker/cli/docs/reference/commandline/dockerd.md @@ -2,7 +2,7 @@ title: "dockerd" description: "The daemon command description and usage" keywords: "container, daemon, runtime" -redirect_from: +aliases: - /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 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: ```console diff --git a/_vendor/github.com/docker/cli/docs/reference/run.md b/_vendor/github.com/docker/cli/docs/reference/run.md index 5737bb3dc5..200ef75f24 100644 --- a/_vendor/github.com/docker/cli/docs/reference/run.md +++ b/_vendor/github.com/docker/cli/docs/reference/run.md @@ -1,7 +1,7 @@ --- description: "Configure containers at runtime" keywords: "docker, run, configure, runtime" -redirect_from: +aliases: - /reference/run/ --- @@ -570,19 +570,15 @@ for a container can be obtained via [`docker inspect`](commandline/inspect.md). for container "my-container"; ```console -{% raw %} $ docker inspect -f "{{ .RestartCount }}" my-container # 2 -{% endraw %} ``` Or, to get the last time the container was (re)started; ```console -{% raw %} $ docker inspect -f "{{ .State.StartedAt }}" my-container # 2015-03-04T23:47:07.691840179Z -{% endraw %} ``` Combining `--restart` (restart policy) with the `--rm` (clean up) flag results @@ -1646,7 +1642,6 @@ Similarly the operator can set the **HOSTNAME** (Linux) or **COMPUTERNAME** (Win Example: ```console -{% raw %} $ docker run --name=test -d \ --health-cmd='stat /etc/passwd || exit 1' \ --health-interval=2s \ @@ -1691,7 +1686,6 @@ $ sleep 2; docker inspect --format='{{json .State.Health}}' test } ] } -{% endraw %} ``` The health status is also displayed in the `docker ps` output. diff --git a/_vendor/modules.txt b/_vendor/modules.txt index a1d22561e6..d36ff2fd99 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -2,6 +2,6 @@ # github.com/moby/buildkit v0.13.0-beta1.0.20231113205014-1efcd30d9dd6 # github.com/docker/buildx v0.12.0 # github.com/docker/scout-cli v1.2.0 -# github.com/docker/cli v24.0.8-0.20231106123152-48ec4f339e2b+incompatible +# github.com/docker/cli v24.0.8-0.20231211210310-fb2f337bc1b1+incompatible # github.com/compose-spec/compose-spec v0.0.0-20231121152139-478928e7c9f8 # github.com/docker/compose/v2 v2.23.3 diff --git a/go.mod b/go.mod index a3238d0539..c7bd5a621c 100644 --- a/go.mod +++ b/go.mod @@ -7,7 +7,7 @@ toolchain go1.21.1 require ( github.com/compose-spec/compose-spec v0.0.0-20231121152139-478928e7c9f8 // indirect github.com/docker/buildx v0.12.0 // indirect - github.com/docker/cli v24.0.8-0.20231106123152-48ec4f339e2b+incompatible // indirect + github.com/docker/cli v24.0.8-0.20231211210310-fb2f337bc1b1+incompatible // indirect github.com/docker/compose/v2 v2.23.3 // indirect github.com/docker/scout-cli v1.2.0 // indirect github.com/moby/buildkit v0.13.0-beta1.0.20231113205014-1efcd30d9dd6 // indirect diff --git a/go.sum b/go.sum index ffa67d4ec1..3331d5e85d 100644 --- a/go.sum +++ b/go.sum @@ -62,6 +62,10 @@ github.com/docker/cli v24.0.6+incompatible h1:fF+XCQCgJjjQNIMjzaSmiKJSCcfcXb3TWT github.com/docker/cli v24.0.6+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= github.com/docker/cli v24.0.8-0.20231106123152-48ec4f339e2b+incompatible h1:tXZk7C97vINae9YYzPtqoClal32VoMl8gz6gLjJ6Kdg= github.com/docker/cli v24.0.8-0.20231106123152-48ec4f339e2b+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= +github.com/docker/cli v24.0.8-0.20231211210310-fb2f337bc1b1+incompatible h1:3hcKPFXxdqoVzoIrjNF1NNb36kzFiEimwUegOhw0pC0= +github.com/docker/cli v24.0.8-0.20231211210310-fb2f337bc1b1+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= +github.com/docker/cli v25.0.0-beta.1+incompatible h1:bJzIgR4mKNpceAwwi19SqZK0AbztMc3nQTgnvxxyY/A= +github.com/docker/cli v25.0.0-beta.1+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= github.com/docker/compose-cli v1.0.35 h1:uZyEHLalfqBS2PiTpA1LAULyJmuQ+YtZg7nG4Xl3/Cc= github.com/docker/compose-cli v1.0.35/go.mod h1:mSXI4hFLpRU3EtI8NTo32bNwI0UXSr8jnq+/rYjGAUU= github.com/docker/compose/v2 v2.22.0 h1:3rRz4L7tPU75wRsV8JZh2/aTgerQvPa1cpzZN+tHqUY=