Merge pull request #2268 from thaJeztah/19.03_backport_docs_changes

[19.03 backport] assorted documentation changes
This commit is contained in:
Silvin Lubecki 2020-01-17 14:44:41 +01:00 committed by GitHub
commit 66905dcff8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
34 changed files with 200 additions and 58 deletions

View File

@ -28,7 +28,7 @@ Practices](https://docs.docker.com/engine/userguide/eng-image/dockerfile_best-pr
## Usage ## Usage
The [`docker build`](commandline/build.md) command builds an image from The [docker build](commandline/build.md) command builds an image from
a `Dockerfile` and a *context*. The build's context is the set of files at a a `Dockerfile` and a *context*. The build's context is the set of files at a
specified location `PATH` or `URL`. The `PATH` is a directory on your local specified location `PATH` or `URL`. The `PATH` is a directory on your local
filesystem. The `URL` is a Git repository location. filesystem. The `URL` is a Git repository location.
@ -93,8 +93,7 @@ instructions.
Whenever possible, Docker will re-use the intermediate images (cache), Whenever possible, Docker will re-use the intermediate images (cache),
to accelerate the `docker build` process significantly. This is indicated by to accelerate the `docker build` process significantly. This is indicated by
the `Using cache` message in the console output. the `Using cache` message in the console output.
(For more information, see the [Build cache section](https://docs.docker.com/engine/userguide/eng-image/dockerfile_best-practices/#build-cache) in the (For more information, see the [`Dockerfile` best practices guide](https://docs.docker.com/engine/userguide/eng-image/dockerfile_best-practices/):
`Dockerfile` best practices guide):
$ docker build -t svendowideit/ambassador . $ docker build -t svendowideit/ambassador .
Sending build context to Docker daemon 15.36 kB Sending build context to Docker daemon 15.36 kB
@ -137,7 +136,7 @@ implementation. For example, BuildKit can:
* Avoid side-effects with rest of the API (intermediate images and containers) * Avoid side-effects with rest of the API (intermediate images and containers)
* Prioritize your build cache for automatic pruning * Prioritize your build cache for automatic pruning
To use the BuildKit backend, you need to set an environment variable To use the BuildKit backend, you need to set an environment variable
`DOCKER_BUILDKIT=1` on the CLI before invoking `docker build`. `DOCKER_BUILDKIT=1` on the CLI before invoking `docker build`.
To learn about the experimental Dockerfile syntax available to BuildKit-based To learn about the experimental Dockerfile syntax available to BuildKit-based
@ -269,7 +268,7 @@ This feature is only enabled if the [BuildKit](#buildkit) backend is used.
The syntax directive defines the location of the Dockerfile builder that is used for The syntax directive defines the location of the Dockerfile builder that is used for
building the current Dockerfile. The BuildKit backend allows to seamlessly use building the current Dockerfile. The BuildKit backend allows to seamlessly use
external implementations of builders that are distributed as Docker images and external implementations of builders that are distributed as Docker images and
execute inside a container sandbox environment. execute inside a container sandbox environment.
Custom Dockerfile implementation allows you to: Custom Dockerfile implementation allows you to:
@ -280,9 +279,9 @@ Custom Dockerfile implementation allows you to:
### Official releases ### Official releases
Docker distributes official versions of the images that can be used for building Docker distributes official versions of the images that can be used for building
Dockerfiles under `docker/dockerfile` repository on Docker Hub. There are two Dockerfiles under `docker/dockerfile` repository on Docker Hub. There are two
channels where new images are released: stable and experimental. channels where new images are released: stable and experimental.
Stable channel follows semantic versioning. For example: Stable channel follows semantic versioning. For example:
@ -298,9 +297,9 @@ component from the stable channel on the time of the release. For example:
- docker/dockerfile:1.0-experimental - latest experimental releases after 1.0 - docker/dockerfile:1.0-experimental - latest experimental releases after 1.0
- docker/dockerfile:experimental - latest release on experimental channel - docker/dockerfile:experimental - latest release on experimental channel
You should choose a channel that best fits your needs. If you only want You should choose a channel that best fits your needs. If you only want
bugfixes, you should use `docker/dockerfile:1.0`. If you want to benefit from bugfixes, you should use `docker/dockerfile:1.0`. If you want to benefit from
experimental features, you should use the experimental channel. If you are using experimental features, you should use the experimental channel. If you are using
the experimental channel, newer releases may not be backwards compatible, so it the experimental channel, newer releases may not be backwards compatible, so it
is recommended to use an immutable full version variant. is recommended to use an immutable full version variant.
@ -571,7 +570,7 @@ Or
FROM [--platform=<platform>] <image>[@<digest>] [AS <name>] FROM [--platform=<platform>] <image>[@<digest>] [AS <name>]
The `FROM` instruction initializes a new build stage and sets the The `FROM` instruction initializes a new build stage and sets the
[*Base Image*](glossary.md#base-image) for subsequent instructions. As such, a [*Base Image*](../../glossary/#base-image) for subsequent instructions. As such, a
valid `Dockerfile` must start with a `FROM` instruction. The image can be valid `Dockerfile` must start with a `FROM` instruction. The image can be
any valid image it is especially easy to start by **pulling an image** from any valid image it is especially easy to start by **pulling an image** from
the [*Public Repositories*](https://docs.docker.com/engine/tutorials/dockerrepos/). the [*Public Repositories*](https://docs.docker.com/engine/tutorials/dockerrepos/).
@ -694,7 +693,7 @@ cache for `RUN` instructions can be invalidated by using the `--no-cache`
flag, for example `docker build --no-cache`. flag, for example `docker build --no-cache`.
See the [`Dockerfile` Best Practices See the [`Dockerfile` Best Practices
guide](https://docs.docker.com/engine/userguide/eng-image/dockerfile_best-practices/#/build-cache) for more information. guide](https://docs.docker.com/engine/userguide/eng-image/dockerfile_best-practices/) for more information.
The cache for `RUN` instructions can be invalidated by `ADD` instructions. See The cache for `RUN` instructions can be invalidated by `ADD` instructions. See
[below](#add) for details. [below](#add) for details.
@ -1015,7 +1014,7 @@ of whether or not the file has changed and the cache should be updated.
> following instructions from the Dockerfile if the contents of `<src>` have > following instructions from the Dockerfile if the contents of `<src>` have
> changed. This includes invalidating the cache for `RUN` instructions. > changed. This includes invalidating the cache for `RUN` instructions.
> See the [`Dockerfile` Best Practices > See the [`Dockerfile` Best Practices
guide](https://docs.docker.com/engine/userguide/eng-image/dockerfile_best-practices/#/build-cache) for more information. guide](https://docs.docker.com/engine/userguide/eng-image/dockerfile_best-practices/) for more information.
`ADD` obeys the following rules: `ADD` obeys the following rules:
@ -1436,7 +1435,7 @@ containers. The value can be a JSON array, `VOLUME ["/var/log/"]`, or a plain
string with multiple arguments, such as `VOLUME /var/log` or `VOLUME /var/log string with multiple arguments, such as `VOLUME /var/log` or `VOLUME /var/log
/var/db`. For more information/examples and mounting instructions via the /var/db`. For more information/examples and mounting instructions via the
Docker client, refer to Docker client, refer to
[*Share Directories via Volumes*](https://docs.docker.com/engine/tutorials/dockervolumes/#/mount-a-host-directory-as-a-data-volume) [*Share Directories via Volumes*](https://docs.docker.com/engine/tutorials/dockervolumes/)
documentation. documentation.
The `docker run` command initializes the newly created volume with any data The `docker run` command initializes the newly created volume with any data
@ -2055,13 +2054,12 @@ The `SHELL` feature was added in Docker 1.12.
This feature is only available when using the [BuildKit](#buildkit) backend. This feature is only available when using the [BuildKit](#buildkit) backend.
Docker build supports experimental features like cache mounts, build secrets and Docker build supports experimental features like cache mounts, build secrets and
ssh forwarding that are enabled by using an external implementation of the ssh forwarding that are enabled by using an external implementation of the
builder with a syntax directive. To learn about these features, [refer to the documentation in BuildKit repository](https://github.com/moby/buildkit/blob/master/frontend/dockerfile/docs/experimental.md). builder with a syntax directive. To learn about these features, [refer to the documentation in BuildKit repository](https://github.com/moby/buildkit/blob/master/frontend/dockerfile/docs/experimental.md).
## Dockerfile examples ## Dockerfile examples
Below you can see some examples of Dockerfile syntax. If you're interested in Below you can see some examples of Dockerfile syntax.
something more realistic, take a look at the list of [Dockerization examples](https://docs.docker.com/engine/examples/).
``` ```
# Nginx # Nginx

View File

@ -221,6 +221,23 @@ running `docker stack` management commands. Valid values are `"swarm"`,
`"kubernetes"`, and `"all"`. This property can be overridden with the `"kubernetes"`, and `"all"`. This property can be overridden with the
`DOCKER_STACK_ORCHESTRATOR` environment variable, or the `--orchestrator` flag. `DOCKER_STACK_ORCHESTRATOR` environment variable, or the `--orchestrator` flag.
The property `proxies` specifies proxy environment variables to be automatically
set on containers, and set as `--build-arg` on containers used during `docker build`.
A `"default"` set of proxies can be configured, and will be used for any docker
daemon that the client connects to, or a configuration per host (docker daemon),
for example, "https://docker-daemon1.example.com". The following properties can
be set for each environment:
* `httpProxy` (sets the value of `HTTP_PROXY` and `http_proxy`)
* `httpsProxy` (sets the value of `HTTPS_PROXY` and `https_proxy`)
* `ftpProxy` (sets the value of `FTP_PROXY` and `ftp_proxy`)
* `noProxy` (sets the value of `NO_PROXY` and `no_proxy`)
> **Warning**: Proxy settings may contain sensitive information (for example,
> if the proxy requires authentication). Environment variables are stored as
> plain text in the container's configuration, and as such can be inspected
> through the remote API or committed to an image when using `docker commit`.
Once attached to a container, users detach from it and leave it running using Once attached to a container, users detach from it and leave it running using
the using `CTRL-p CTRL-q` key sequence. This detach key sequence is customizable the using `CTRL-p CTRL-q` key sequence. This detach key sequence is customizable
using the `detachKeys` property. Specify a `<sequence>` value for the using the `detachKeys` property. Specify a `<sequence>` value for the
@ -275,6 +292,18 @@ Following is a sample `config.json` file:
"anotheroption": "anothervalue", "anotheroption": "anothervalue",
"athirdoption": "athirdvalue" "athirdoption": "athirdvalue"
} }
},
"proxies": {
"default": {
"httpProxy": "http://user:pass@example.com:3128",
"httpsProxy": "http://user:pass@example.com:3128",
"noProxy": "http://user:pass@example.com:3128",
"ftpProxy": "http://user:pass@example.com:3128"
},
"https://manager1.mycorp.example.com:2377": {
"httpProxy": "http://user:pass@example.com:3128",
"httpsProxy": "http://user:pass@example.com:3128"
},
} }
} }
{% endraw %} {% endraw %}

View File

@ -159,12 +159,12 @@ a single overlay network. Each of the subnetworks has 126 usable addresses.
```bash ```bash
$ docker network create -d overlay \ $ docker network create -d overlay \
--subnet=192.168.1.0/25 \ --subnet=192.168.10.0/25 \
--subnet=192.170.2.0/25 \ --subnet=192.168.20.0/25 \
--gateway=192.168.1.100 \ --gateway=192.168.10.100 \
--gateway=192.170.2.100 \ --gateway=192.168.20.100 \
--aux-address="my-router=192.168.1.5" --aux-address="my-switch=192.168.1.6" \ --aux-address="my-router=192.168.10.5" --aux-address="my-switch=192.168.10.6" \
--aux-address="my-printer=192.170.1.5" --aux-address="my-nas=192.170.1.6" \ --aux-address="my-printer=192.168.20.5" --aux-address="my-nas=192.168.20.6" \
my-multihost-network my-multihost-network
``` ```

View File

@ -27,9 +27,11 @@ Options:
## Description ## Description
Demotes an existing manager so that it is no longer a manager. This command Demotes an existing manager so that it is no longer a manager.
targets a docker engine that is a manager in the swarm.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples

View File

@ -34,6 +34,10 @@ given template for each result. Go's
[text/template](http://golang.org/pkg/text/template/) package describes all the [text/template](http://golang.org/pkg/text/template/) package describes all the
details of the format. details of the format.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples
### Inspect a node ### Inspect a node

View File

@ -36,6 +36,10 @@ Lists all the nodes that the Docker Swarm manager knows about. You can filter
using the `-f` or `--filter` flag. Refer to the [filtering](#filtering) section using the `-f` or `--filter` flag. Refer to the [filtering](#filtering) section
for more information about available filter options. for more information about available filter options.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples
```bash ```bash

View File

@ -28,6 +28,10 @@ Options:
Promotes a node to manager. This command can only be executed on a manager node. Promotes a node to manager. This command can only be executed on a manager node.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples
```bash ```bash

View File

@ -32,7 +32,13 @@ Options:
## Description ## Description
Lists all the tasks on a Node that Docker knows about. You can filter using the `-f` or `--filter` flag. Refer to the [filtering](#filtering) section for more information about available filter options. Lists all the tasks on a Node that Docker knows about. You can filter using the
`-f` or `--filter` flag. Refer to the [filtering](#filtering) section for more
information about available filter options.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples

View File

@ -30,8 +30,11 @@ Options:
## Description ## Description
When run from a manager node, removes the specified nodes from a swarm. Removes the specified nodes from a swarm.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples

View File

@ -32,6 +32,10 @@ Options:
Update metadata about a node, such as its availability, labels, or roles. Update metadata about a node, such as its availability, labels, or roles.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples
### Add label metadata to a node ### Add label metadata to a node

View File

@ -27,10 +27,14 @@ Options:
## Description ## Description
Creates a secret using standard input or from a file for the secret content. You must run this command on a manager node. Creates a secret using standard input or from a file for the secret content.
For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/). For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/).
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples
### Create a secret ### Create a secret

View File

@ -27,8 +27,7 @@ Options:
## Description ## Description
Inspects the specified secret. This command has to be run targeting a manager Inspects the specified secret.
node.
By default, this renders all results in a JSON array. If a format is specified, By default, this renders all results in a JSON array. If a format is specified,
the given template will be executed for each result. the given template will be executed for each result.
@ -38,6 +37,10 @@ describes all the details of the format.
For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/). For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/).
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples
### Inspect a secret by name or ID ### Inspect a secret by name or ID

View File

@ -36,6 +36,10 @@ Run this command on a manager node to list the secrets in the swarm.
For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/). For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/).
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples
```bash ```bash

View File

@ -29,11 +29,14 @@ Options:
## Description ## Description
Removes the specified secrets from the swarm. This command has to be run Removes the specified secrets from the swarm.
targeting a manager node.
For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/). For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/).
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples
This example removes a secret: This example removes a secret:

View File

@ -40,3 +40,6 @@ Run 'docker service COMMAND --help' for more information on a command.
Manage services. Manage services.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.

View File

@ -92,8 +92,11 @@ Options:
## Description ## Description
Creates a service as described by the specified parameters. You must run this Creates a service as described by the specified parameters.
command on a manager node.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples
@ -425,7 +428,7 @@ The following options can only be used for bind mounts (`type=bind`):
Bind propagation refers to whether or not mounts created within a given Bind propagation refers to whether or not mounts created within a given
bind mount or named volume can be propagated to replicas of that mount. Consider bind mount or named volume can be propagated to replicas of that mount. Consider
a mount point `/mnt`, which is also mounted on `/tmp`. The propation settings a mount point `/mnt`, which is also mounted on `/tmp`. The propagation settings
control whether a mount on `/tmp/a` would also be available on `/mnt/a`. Each control whether a mount on `/tmp/a` would also be available on `/mnt/a`. Each
propagation setting has a recursive counterpoint. In the case of recursion, propagation setting has a recursive counterpoint. In the case of recursion,
consider that `/tmp/a` is also mounted as `/foo`. The propagation settings consider that `/tmp/a` is also mounted as `/foo`. The propagation settings

View File

@ -28,8 +28,7 @@ Options:
## Description ## Description
Inspects the specified service. This command has to be run targeting a manager Inspects the specified service.
node.
By default, this renders all results in a JSON array. If a format is specified, By default, this renders all results in a JSON array. If a format is specified,
the given template will be executed for each result. the given template will be executed for each result.
@ -37,6 +36,10 @@ the given template will be executed for each result.
Go's [text/template](http://golang.org/pkg/text/template/) package Go's [text/template](http://golang.org/pkg/text/template/) package
describes all the details of the format. describes all the details of the format.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples
### Inspect a service by name or ID ### Inspect a service by name or ID

View File

@ -35,6 +35,10 @@ Options:
The `docker service logs` command batch-retrieves logs present at the time of execution. The `docker service logs` command batch-retrieves logs present at the time of execution.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
The `docker service logs` command can be used with either the name or ID of a The `docker service logs` command can be used with either the name or ID of a
service, or with the ID of a task. If a service is passed, it will display logs service, or with the ID of a task. If a service is passed, it will display logs
for all of the containers in that service. If a task is passed, it will only for all of the containers in that service. If a task is passed, it will only

View File

@ -32,8 +32,11 @@ Options:
## Description ## Description
This command when run targeting a manager, lists services are running in the This command lists services are running in the swarm.
swarm.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples

View File

@ -32,8 +32,11 @@ Options:
## Description ## Description
Lists the tasks that are running as part of the specified services. This command Lists the tasks that are running as part of the specified services.
has to be run targeting a manager node.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples

View File

@ -29,8 +29,11 @@ Options:
## Description ## Description
Removes the specified services from the swarm. This command has to be run Removes the specified services from the swarm.
targeting a manager node.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples

View File

@ -28,8 +28,11 @@ Options:
## Description ## Description
Roll back a specified service to its previous version from the swarm. This command must be run Roll back a specified service to its previous version from the swarm.
targeting a manager node.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples

View File

@ -33,6 +33,10 @@ services which are global mode. The command will return immediately, but the
actual scaling of the service may take some time. To stop all replicas of a actual scaling of the service may take some time. To stop all replicas of a
service while keeping the service active in the swarm you can set the scale to 0. service while keeping the service active in the swarm you can set the scale to 0.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples
### Scale a single service ### Scale a single service

View File

@ -109,9 +109,9 @@ Options:
## Description ## Description
Updates a service as described by the specified parameters. This command has to be run targeting a manager node. Updates a service as described by the specified parameters. The parameters are
The parameters are the same as [`docker service create`](service_create.md). Please look at the description there the same as [`docker service create`](service_create.md). Refer to the description
for further information. there for further information.
Normally, updating a service will only cause the service's tasks to be replaced with new ones if a change to the Normally, updating a service will only cause the service's tasks to be replaced with new ones if a change to the
service requires recreating the tasks for it to take effect. For example, only changing the service requires recreating the tasks for it to take effect. For example, only changing the
@ -119,6 +119,10 @@ service requires recreating the tasks for it to take effect. For example, only c
setting. However, the `--force` flag will cause the tasks to be recreated anyway. This can be used to perform a setting. However, the `--force` flag will cause the tasks to be recreated anyway. This can be used to perform a
rolling restart without any changes to the service parameters. rolling restart without any changes to the service parameters.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples
### Update a service ### Update a service

View File

@ -38,8 +38,12 @@ Options:
## Description ## Description
Create and update a stack from a `compose` or a `dab` file on the swarm. This command Create and update a stack from a `compose` file on the swarm.
has to be run targeting a manager node.
> **Note**: This is a cluster management command. When using swarm as an orchestrator,
> this command must be executed on a swarm manager node. To learn about managers
> and workers, refer to the [Swarm mode section](https://docs.docker.com/engine/swarm/)
> in the documentation.
## Examples ## Examples

View File

@ -35,6 +35,11 @@ Options:
Lists the stacks. Lists the stacks.
> **Note**: This is a cluster management command. When using swarm as an orchestrator,
> this command must be executed on a swarm manager node. To learn about managers
> and workers, refer to the [Swarm mode section](https://docs.docker.com/engine/swarm/)
> in the documentation.
## Examples ## Examples
The following command shows all stacks and some additional information: The following command shows all stacks and some additional information:

View File

@ -34,8 +34,12 @@ Options:
## Description ## Description
Lists the tasks that are running as part of the specified stack. This Lists the tasks that are running as part of the specified stack.
command has to be run targeting a manager node.
> **Note**: This is a cluster management command. When using swarm as an orchestrator,
> this command must be executed on a swarm manager node. To learn about managers
> and workers, refer to the [Swarm mode section](https://docs.docker.com/engine/swarm/)
> in the documentation.
## Examples ## Examples

View File

@ -32,8 +32,12 @@ Options:
## Description ## Description
Remove the stack from the swarm. This command has to be run targeting Remove the stack from the swarm.
a manager node.
> **Note**: This is a cluster management command. When using swarm as an orchestrator,
> this command must be executed on a swarm manager node. To learn about managers
> and workers, refer to the [Swarm mode section](https://docs.docker.com/engine/swarm/)
> in the documentation.
## Examples ## Examples

View File

@ -32,8 +32,12 @@ Options:
## Description ## Description
Lists the services that are running as part of the specified stack. This Lists the services that are running as part of the specified stack.
command has to be run targeting a manager node.
> **Note**: This is a cluster management command. When using swarm as an orchestrator,
> this command must be executed on a swarm manager node. To learn about managers
> and workers, refer to the [Swarm mode section](https://docs.docker.com/engine/swarm/)
> in the documentation.
## Examples ## Examples

View File

@ -33,7 +33,11 @@ Options:
## Description ## Description
View or rotate the current swarm CA certificate. This command must target a manager node. View or rotate the current swarm CA certificate.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples

View File

@ -34,6 +34,10 @@ role. You pass the token using the `--token` flag when you run
[swarm join](swarm_join.md). Nodes use the join token only when they join the [swarm join](swarm_join.md). Nodes use the join token only when they join the
swarm. swarm.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples
You can view or rotate the join tokens using `swarm join-token`. You can view or rotate the join tokens using `swarm join-token`.

View File

@ -31,6 +31,10 @@ used to reactivate a manager after its Docker daemon restarts if the autolock
setting is turned on. The unlock key is printed at the time when autolock is setting is turned on. The unlock key is printed at the time when autolock is
enabled, and is also available from the `docker swarm unlock-key` command. enabled, and is also available from the `docker swarm unlock-key` command.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples
```bash ```bash

View File

@ -35,6 +35,10 @@ swarm.
You can view or rotate the unlock key using `swarm unlock-key`. To view the key, You can view or rotate the unlock key using `swarm unlock-key`. To view the key,
run the `docker swarm unlock-key` command without any arguments: run the `docker swarm unlock-key` command without any arguments:
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples
```bash ```bash

View File

@ -33,7 +33,11 @@ Options:
## Description ## Description
Updates a swarm with new parameter values. This command must target a manager node. Updates a swarm with new parameter values.
> **Note**: This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the [Swarm mode
> section](https://docs.docker.com/engine/swarm/) in the documentation.
## Examples ## Examples