mirror of https://github.com/docker/cli.git
				
				
				
			reference docs: reformat notes
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
		
							parent
							
								
									8919c228bd
								
							
						
					
					
						commit
						6ae5df423a
					
				|  | @ -78,7 +78,8 @@ that succeeds, the directory is sent to the Docker daemon as the context. | |||
| Local copy gives you the ability to access private repositories using local | ||||
| user credentials, VPN's, and so forth. | ||||
| 
 | ||||
| > **Note:** | ||||
| > **Note** | ||||
| > | ||||
| > If the `URL` parameter contains a fragment the system will recursively clone | ||||
| > the repository and its submodules using a `git clone --recursive` command. | ||||
| 
 | ||||
|  | @ -577,7 +578,9 @@ $ ls ./out | |||
| vndr | ||||
| ``` | ||||
| 
 | ||||
| > **Note**: This feature requires the BuildKit backend. You can either | ||||
| > **Note** | ||||
| > | ||||
| > This feature requires the BuildKit backend. You can either | ||||
| > [enable BuildKit](../builder.md#buildkit) or use the [buildx](https://github.com/docker/buildx) | ||||
| > plugin which provides more output type options. | ||||
| 
 | ||||
|  | @ -616,7 +619,9 @@ BuildKit automatically pulls the image from the registry if needed. | |||
| $ docker build --cache-from myname/myapp . | ||||
| ``` | ||||
| 
 | ||||
| > **Note**: This feature requires the BuildKit backend. You can either | ||||
| > **Note** | ||||
| > | ||||
| > This feature requires the BuildKit backend. You can either | ||||
| > [enable BuildKit](../builder.md#buildkit) or use the [buildx](https://github.com/docker/buildx) | ||||
| > plugin. The previous builder has limited support for reusing cache from | ||||
| > pre-pulled images. | ||||
|  |  | |||
|  | @ -407,7 +407,9 @@ Sometimes, multiple options can call for a more complex value string as for | |||
| $ docker run -v /host:/container example/mysql | ||||
| ``` | ||||
| 
 | ||||
| > **Note**: Do not use the `-t` and `-a stderr` options together due to | ||||
| > **Note** | ||||
| > | ||||
| > Do not use the `-t` and `-a stderr` options together due to | ||||
| > limitations in the `pty` implementation. All `stderr` in `pty` mode | ||||
| > simply goes to `stdout`. | ||||
| 
 | ||||
|  |  | |||
|  | @ -109,10 +109,10 @@ type `dockerd`. | |||
| To run the daemon with debug output, use `dockerd -D` or add `"debug": true` to | ||||
| the `daemon.json` file. | ||||
| 
 | ||||
| > **Note**: In Docker 1.13 and higher, enable experimental features by starting | ||||
| > `dockerd` with the `--experimental` flag or adding `"experimental": true` to the | ||||
| > `daemon.json` file. In earlier Docker versions, a different build was required | ||||
| > to enable experimental features. | ||||
| > **Enabling experimental features** | ||||
| >  | ||||
| > Enable experimental features by starting `dockerd` with the `--experimental` | ||||
| > flag or adding `"experimental": true` to the `daemon.json` file. | ||||
| 
 | ||||
| ## Examples | ||||
| 
 | ||||
|  | @ -135,7 +135,9 @@ interface using its IP address: `-H tcp://192.168.59.103:2375`. It is | |||
| conventional to use port `2375` for un-encrypted, and port `2376` for encrypted | ||||
| communication with the daemon. | ||||
| 
 | ||||
| > **Note**: If you're using an HTTPS encrypted socket, keep in mind that only | ||||
| > **Note** | ||||
| > | ||||
| > If you're using an HTTPS encrypted socket, keep in mind that only | ||||
| > TLS1.0 and greater are supported. Protocols SSLv3 and under are not | ||||
| > supported anymore for security reasons. | ||||
| 
 | ||||
|  | @ -300,20 +302,24 @@ The `overlay` is a very fast union filesystem. It is now merged in the main | |||
| Linux kernel as of [3.18.0](https://lkml.org/lkml/2014/10/26/137). `overlay` | ||||
| also supports page cache sharing, this means multiple containers accessing | ||||
| the same file can share a single page cache entry (or entries), it makes | ||||
| `overlay` as efficient with memory as `aufs` driver. Call | ||||
| `dockerd -s overlay` to use it. | ||||
| 
 | ||||
| > **Note**: As promising as `overlay` is, the feature is still quite young and | ||||
| > should not be used in production. Most notably, using `overlay` can cause | ||||
| > excessive inode consumption (especially as the number of images grows), as | ||||
| > well as being incompatible with the use of RPMs. | ||||
| `overlay` as efficient with memory as `aufs` driver. Call `dockerd -s overlay` | ||||
| to use it. | ||||
| 
 | ||||
| The `overlay2` uses the same fast union filesystem but takes advantage of | ||||
| [additional features](https://lkml.org/lkml/2015/2/11/106) added in Linux | ||||
| kernel 4.0 to avoid excessive inode consumption. Call `dockerd -s overlay2` | ||||
| to use it. | ||||
| 
 | ||||
| > **Note**: Both `overlay` and `overlay2` are currently unsupported on `btrfs` | ||||
| > **Note** | ||||
| > | ||||
| > The `overlay` storage driver can cause excessive inode consumption (especially | ||||
| > as the number of images grows). We recommend using the `overlay2` storage | ||||
| > driver instead. | ||||
| 
 | ||||
| 
 | ||||
| > **Note** | ||||
| > | ||||
| > Both `overlay` and `overlay2` are currently unsupported on `btrfs` | ||||
| > or any Copy on Write filesystem and should only be used over `ext4` partitions. | ||||
| 
 | ||||
| On Windows, the Docker daemon supports a single image layer storage driver | ||||
|  | @ -460,7 +466,9 @@ $ sudo service docker start | |||
| 
 | ||||
| ##### `dm.loopdatasize` | ||||
| 
 | ||||
| > **Note**: This option configures devicemapper loopback, which should not | ||||
| > **Note** | ||||
| > | ||||
| > This option configures devicemapper loopback, which should not | ||||
| > be used in production. | ||||
| 
 | ||||
| Specifies the size to use when creating the loopback file for the | ||||
|  | @ -476,7 +484,9 @@ $ sudo dockerd --storage-opt dm.loopdatasize=200G | |||
| 
 | ||||
| ##### `dm.loopmetadatasize` | ||||
| 
 | ||||
| > **Note**: This option configures devicemapper loopback, which should not | ||||
| > **Note** | ||||
| > | ||||
| > This option configures devicemapper loopback, which should not | ||||
| > be used in production. | ||||
| 
 | ||||
| Specifies the size to use when creating the loopback file for the | ||||
|  | @ -623,7 +633,9 @@ $ sudo dockerd --storage-opt dm.override_udev_sync_check=true | |||
| When this value is `true`, the  `devicemapper` continues and simply warns | ||||
| you the errors are happening. | ||||
| 
 | ||||
| > **Note**: The ideal is to pursue a `docker` daemon and environment that does | ||||
| > **Note** | ||||
| > | ||||
| > The ideal is to pursue a `docker` daemon and environment that does | ||||
| > support synchronizing with `udev`. For further discussion on this | ||||
| > topic, see [docker#4036](https://github.com/docker/docker/issues/4036). | ||||
| > Otherwise, set this flag for migrating existing Docker daemons to | ||||
|  | @ -955,7 +967,9 @@ This is the same example via the command line: | |||
| $ sudo dockerd --add-runtime runc=runc --add-runtime custom=/usr/local/bin/my-runc-replacement | ||||
| ``` | ||||
| 
 | ||||
| > **Note**: Defining runtime arguments via the command line is not supported. | ||||
| > **Note** | ||||
| > | ||||
| > Defining runtime arguments via the command line is not supported. | ||||
| 
 | ||||
| #### Options for the runtime | ||||
| 
 | ||||
|  |  | |||
|  | @ -190,7 +190,9 @@ This example removes images which have a maintainer label not set to `john`: | |||
| $ docker image prune --filter="label!=maintainer=john" | ||||
| ``` | ||||
| 
 | ||||
| > **Note**: You are prompted for confirmation before the `prune` removes | ||||
| > **Note** | ||||
| > | ||||
| > You are prompted for confirmation before the `prune` removes | ||||
| > anything, but you are not shown a list of what will potentially be removed. | ||||
| > In addition, `docker image ls` does not support negative filtering, so it | ||||
| > difficult to predict what images will actually be removed. | ||||
|  |  | |||
|  | @ -184,8 +184,7 @@ dea752e4e117 | |||
| 511136ea3c5a | ||||
| ``` | ||||
| 
 | ||||
| > **Note**: Docker warns you if any containers exist that are using these | ||||
| > untagged images. | ||||
| Docker warns you if any containers exist that are using these untagged images. | ||||
| 
 | ||||
| 
 | ||||
| #### Show images with a given label | ||||
|  |  | |||
|  | @ -25,8 +25,10 @@ Options: | |||
| 
 | ||||
| The `docker logs` command batch-retrieves logs present at the time of execution. | ||||
| 
 | ||||
| > **Note**: this command is only functional for containers that are started with | ||||
| > the `json-file` or `journald` logging driver. | ||||
| > **Note** | ||||
| > | ||||
| > This command is only functional for containers that are started with the | ||||
| > `json-file` or `journald` logging driver. | ||||
| 
 | ||||
| For more information about selecting and configuring logging drivers, refer to | ||||
| [Configure logging drivers](https://docs.docker.com/config/containers/logging/configure/). | ||||
|  |  | |||
|  | @ -20,7 +20,9 @@ Options: | |||
| 
 | ||||
| Demotes an existing manager so that it is no longer a manager. | ||||
| 
 | ||||
| > **Note**: This is a cluster management command, and must be executed on 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. | ||||
| 
 | ||||
|  |  | |||
|  | @ -25,9 +25,12 @@ given template for each result. Go's | |||
| [text/template](http://golang.org/pkg/text/template/) package 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -27,9 +27,12 @@ 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 | ||||
| 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. | ||||
| > **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 | ||||
| 
 | ||||
|  | @ -41,10 +44,11 @@ ID                           HOSTNAME        STATUS  AVAILABILITY  MANAGER STATU | |||
| 38ciaotwjuritcdtn9npbnkuz    swarm-worker1   Ready   Active | ||||
| e216jshn25ckzbvmwlnh5jr3g *  swarm-manager1  Ready   Active        Leader | ||||
| ``` | ||||
| > **Note**: | ||||
| > In the above example output, there is a hidden column of `.Self` that indicates if the | ||||
| > node is the same node as the current docker daemon. A `*` (e.g., `e216jshn25ckzbvmwlnh5jr3g *`) | ||||
| > means this node is the current docker daemon. | ||||
| > **Note** | ||||
| > | ||||
| > In the above example output, there is a hidden column of `.Self` that indicates | ||||
| > if the node is the same node as the current docker daemon. A `*` (e.g., | ||||
| > `e216jshn25ckzbvmwlnh5jr3g *`) means this node is the current docker daemon. | ||||
| 
 | ||||
| 
 | ||||
| ### Filtering | ||||
|  |  | |||
|  | @ -19,9 +19,12 @@ Options: | |||
| 
 | ||||
| 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -27,9 +27,12 @@ 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -23,9 +23,12 @@ Options: | |||
| 
 | ||||
| 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -23,9 +23,12 @@ Options: | |||
| 
 | ||||
| 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -109,7 +109,9 @@ $ docker plugin inspect -f '{{with $mount := index .Settings.Mounts 0}}{{$mount. | |||
| /bar | ||||
| ``` | ||||
| 
 | ||||
| > **Note**: Since only `source` is settable in `mymount`, | ||||
| > **Note** | ||||
| > | ||||
| > Since only `source` is settable in `mymount`, | ||||
| > `docker plugins set mymount=/bar myplugin` would work too. | ||||
| 
 | ||||
| ### Change a device path | ||||
|  | @ -129,7 +131,8 @@ $ docker plugin inspect -f '{{with $device := index .Settings.Devices 0}}{{$devi | |||
| /dev/bar | ||||
| ``` | ||||
| 
 | ||||
| > **Note**: Since only `path` is settable in `mydevice`, | ||||
| > **Note** | ||||
| > Since only `path` is settable in `mydevice`, | ||||
| > `docker plugins set mydevice=/dev/bar myplugin` would work too. | ||||
| 
 | ||||
| ### Change the source of the arguments | ||||
|  |  | |||
|  | @ -163,7 +163,9 @@ FROM ubuntu@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5 | |||
| MAINTAINER some maintainer <maintainer@example.com> | ||||
| ``` | ||||
| 
 | ||||
| > **Note**: Using this feature "pins" an image to a specific version in time. | ||||
| > **Note** | ||||
| > | ||||
| > Using this feature "pins" an image to a specific version in time. | ||||
| > Docker will therefore not pull updated versions of an image, which may include | ||||
| > security updates. If you want to pull an updated image, you need to change the | ||||
| > digest accordingly. | ||||
|  |  | |||
|  | @ -22,9 +22,12 @@ 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/). | ||||
| 
 | ||||
| > **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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -28,9 +28,12 @@ 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/). | ||||
| 
 | ||||
| > **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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -27,9 +27,12 @@ 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/). | ||||
| 
 | ||||
| > **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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -24,9 +24,12 @@ Removes the specified secrets from the swarm. | |||
| 
 | ||||
| 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -31,6 +31,9 @@ Run 'docker service COMMAND --help' for more information on a command. | |||
| 
 | ||||
| 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. | ||||
| > **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. | ||||
|  |  | |||
|  | @ -85,9 +85,12 @@ Options: | |||
| 
 | ||||
| Creates a service as described by the specified 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -27,9 +27,12 @@ the given template will be executed for each result. | |||
| Go's [text/template](http://golang.org/pkg/text/template/) package | ||||
| 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -26,9 +26,12 @@ Options: | |||
| 
 | ||||
| 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. | ||||
| > **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 | ||||
| service, or with the ID of a task. If a service is passed, it will display logs | ||||
|  |  | |||
|  | @ -25,9 +25,12 @@ Options: | |||
| 
 | ||||
| This command lists services are running 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -25,9 +25,12 @@ Options: | |||
| 
 | ||||
| Lists the tasks that are running as part of the specified 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -22,9 +22,12 @@ Options: | |||
| 
 | ||||
| Removes the specified services from 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -21,9 +21,12 @@ Options: | |||
| 
 | ||||
| Roll back a specified service to its previous version from 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -24,9 +24,12 @@ 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 | ||||
| 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -110,9 +110,12 @@ 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 | ||||
| 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -30,10 +30,12 @@ Options: | |||
| 
 | ||||
| Create and update a stack from a `compose` file on the swarm. | ||||
| 
 | ||||
| > **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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -26,10 +26,12 @@ Options: | |||
| 
 | ||||
| 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -27,10 +27,12 @@ Options: | |||
| 
 | ||||
| Lists the tasks that are running as part of the specified stack. | ||||
| 
 | ||||
| > **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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -25,10 +25,12 @@ Options: | |||
| 
 | ||||
| Remove the stack from the swarm. | ||||
| 
 | ||||
| > **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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -25,10 +25,12 @@ Options: | |||
| 
 | ||||
| Lists the services that are running as part of the specified stack. | ||||
| 
 | ||||
| > **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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -26,9 +26,12 @@ Options: | |||
| 
 | ||||
| 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -25,9 +25,12 @@ 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. | ||||
| 
 | ||||
| > **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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -26,9 +26,12 @@ swarm. | |||
| 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: | ||||
| 
 | ||||
| > **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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -22,9 +22,12 @@ 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 | ||||
| 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
|  | @ -26,9 +26,12 @@ Options: | |||
| 
 | ||||
| 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. | ||||
| > **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 | ||||
| 
 | ||||
|  |  | |||
		Loading…
	
		Reference in New Issue