diff --git a/docs/reference/commandline/node_demote.md b/docs/reference/commandline/node_demote.md index e978fa7fc..cf13b9096 100644 --- a/docs/reference/commandline/node_demote.md +++ b/docs/reference/commandline/node_demote.md @@ -27,9 +27,11 @@ Options: ## Description -Demotes an existing manager so that it is no longer a manager. This command -targets a docker engine that is a manager in the swarm. +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 +> manager node. To learn about managers and workers, refer to the [Swarm mode +> section](https://docs.docker.com/engine/swarm/) in the documentation. ## Examples diff --git a/docs/reference/commandline/node_inspect.md b/docs/reference/commandline/node_inspect.md index e72d0ed1a..fb71b5d24 100644 --- a/docs/reference/commandline/node_inspect.md +++ b/docs/reference/commandline/node_inspect.md @@ -34,6 +34,10 @@ 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. + ## Examples ### Inspect a node diff --git a/docs/reference/commandline/node_ls.md b/docs/reference/commandline/node_ls.md index 503354492..bdde24377 100644 --- a/docs/reference/commandline/node_ls.md +++ b/docs/reference/commandline/node_ls.md @@ -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 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 ```bash diff --git a/docs/reference/commandline/node_promote.md b/docs/reference/commandline/node_promote.md index e10e99965..bfde58b95 100644 --- a/docs/reference/commandline/node_promote.md +++ b/docs/reference/commandline/node_promote.md @@ -28,6 +28,10 @@ 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. + ## Examples ```bash diff --git a/docs/reference/commandline/node_ps.md b/docs/reference/commandline/node_ps.md index 81e3ca18d..ae785cd4e 100644 --- a/docs/reference/commandline/node_ps.md +++ b/docs/reference/commandline/node_ps.md @@ -32,7 +32,13 @@ Options: ## 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 diff --git a/docs/reference/commandline/node_rm.md b/docs/reference/commandline/node_rm.md index 545b09108..0034d0ab7 100644 --- a/docs/reference/commandline/node_rm.md +++ b/docs/reference/commandline/node_rm.md @@ -30,8 +30,11 @@ Options: ## 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 diff --git a/docs/reference/commandline/node_update.md b/docs/reference/commandline/node_update.md index 61e0e16a3..972f74474 100644 --- a/docs/reference/commandline/node_update.md +++ b/docs/reference/commandline/node_update.md @@ -32,6 +32,10 @@ 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. + ## Examples ### Add label metadata to a node diff --git a/docs/reference/commandline/secret_create.md b/docs/reference/commandline/secret_create.md index 66fc78f9f..30839e7d7 100644 --- a/docs/reference/commandline/secret_create.md +++ b/docs/reference/commandline/secret_create.md @@ -27,10 +27,14 @@ Options: ## 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/). +> **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 ### Create a secret diff --git a/docs/reference/commandline/secret_inspect.md b/docs/reference/commandline/secret_inspect.md index 349e28e6e..46d6a043c 100644 --- a/docs/reference/commandline/secret_inspect.md +++ b/docs/reference/commandline/secret_inspect.md @@ -27,8 +27,7 @@ Options: ## Description -Inspects the specified secret. This command has to be run targeting a manager -node. +Inspects the specified secret. By default, this renders all results in a JSON array. If a format is specified, 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/). +> **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 ### Inspect a secret by name or ID diff --git a/docs/reference/commandline/secret_ls.md b/docs/reference/commandline/secret_ls.md index 5fed7732a..a2bfae73f 100644 --- a/docs/reference/commandline/secret_ls.md +++ b/docs/reference/commandline/secret_ls.md @@ -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/). +> **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 ```bash diff --git a/docs/reference/commandline/secret_rm.md b/docs/reference/commandline/secret_rm.md index 3fc90a2dd..4069fb842 100644 --- a/docs/reference/commandline/secret_rm.md +++ b/docs/reference/commandline/secret_rm.md @@ -29,11 +29,14 @@ Options: ## Description -Removes the specified secrets from the swarm. This command has to be run -targeting a manager node. +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. + ## Examples This example removes a secret: diff --git a/docs/reference/commandline/service.md b/docs/reference/commandline/service.md index a68030465..5e69c04d8 100644 --- a/docs/reference/commandline/service.md +++ b/docs/reference/commandline/service.md @@ -40,3 +40,6 @@ 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. diff --git a/docs/reference/commandline/service_create.md b/docs/reference/commandline/service_create.md index b6f773c80..744397990 100644 --- a/docs/reference/commandline/service_create.md +++ b/docs/reference/commandline/service_create.md @@ -92,8 +92,11 @@ Options: ## Description -Creates a service as described by the specified parameters. You must run this -command on a manager node. +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. ## Examples diff --git a/docs/reference/commandline/service_inspect.md b/docs/reference/commandline/service_inspect.md index 1149b7dd3..58208464c 100644 --- a/docs/reference/commandline/service_inspect.md +++ b/docs/reference/commandline/service_inspect.md @@ -28,8 +28,7 @@ Options: ## Description -Inspects the specified service. This command has to be run targeting a manager -node. +Inspects the specified service. By default, this renders all results in a JSON array. If a format is specified, 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 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 ### Inspect a service by name or ID diff --git a/docs/reference/commandline/service_logs.md b/docs/reference/commandline/service_logs.md index 560090a16..4a8aaf977 100644 --- a/docs/reference/commandline/service_logs.md +++ b/docs/reference/commandline/service_logs.md @@ -35,6 +35,10 @@ 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. + 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 for all of the containers in that service. If a task is passed, it will only diff --git a/docs/reference/commandline/service_ls.md b/docs/reference/commandline/service_ls.md index 95346759a..407e8ade2 100644 --- a/docs/reference/commandline/service_ls.md +++ b/docs/reference/commandline/service_ls.md @@ -32,8 +32,11 @@ Options: ## Description -This command when run targeting a manager, lists services are running in the -swarm. +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. ## Examples diff --git a/docs/reference/commandline/service_ps.md b/docs/reference/commandline/service_ps.md index 4a9ebc449..ed7142c6c 100644 --- a/docs/reference/commandline/service_ps.md +++ b/docs/reference/commandline/service_ps.md @@ -32,8 +32,11 @@ Options: ## Description -Lists the tasks that are running as part of the specified services. This command -has to be run targeting a manager node. +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. ## Examples diff --git a/docs/reference/commandline/service_rm.md b/docs/reference/commandline/service_rm.md index a5d5d5247..2c950d6a6 100644 --- a/docs/reference/commandline/service_rm.md +++ b/docs/reference/commandline/service_rm.md @@ -29,8 +29,11 @@ Options: ## Description -Removes the specified services from the swarm. This command has to be run -targeting a manager node. +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. ## Examples diff --git a/docs/reference/commandline/service_rollback.md b/docs/reference/commandline/service_rollback.md index 927fd4acf..fbacc8c6b 100644 --- a/docs/reference/commandline/service_rollback.md +++ b/docs/reference/commandline/service_rollback.md @@ -28,8 +28,11 @@ Options: ## Description -Roll back a specified service to its previous version from the swarm. This command must be run -targeting a manager node. +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. ## Examples diff --git a/docs/reference/commandline/service_scale.md b/docs/reference/commandline/service_scale.md index 1cd512414..c56fb5621 100644 --- a/docs/reference/commandline/service_scale.md +++ b/docs/reference/commandline/service_scale.md @@ -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 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 ### Scale a single service diff --git a/docs/reference/commandline/service_update.md b/docs/reference/commandline/service_update.md index ed11080fc..f9b51edf1 100644 --- a/docs/reference/commandline/service_update.md +++ b/docs/reference/commandline/service_update.md @@ -109,9 +109,9 @@ Options: ## Description -Updates a service as described by the specified parameters. This command has to be run targeting a manager node. -The parameters are the same as [`docker service create`](service_create.md). Please look at the description there -for further information. +Updates a service as described by the specified parameters. The parameters are +the same as [`docker service create`](service_create.md). Refer to the description +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 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 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 ### Update a service diff --git a/docs/reference/commandline/stack_deploy.md b/docs/reference/commandline/stack_deploy.md index 334d5cfb5..d21514955 100644 --- a/docs/reference/commandline/stack_deploy.md +++ b/docs/reference/commandline/stack_deploy.md @@ -37,8 +37,12 @@ Options: ## Description -Create and update a stack from a `compose` file on the swarm. This command has to -be run targeting a manager node. +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. ## Examples diff --git a/docs/reference/commandline/stack_ls.md b/docs/reference/commandline/stack_ls.md index dd0857ebc..3fa205aa3 100644 --- a/docs/reference/commandline/stack_ls.md +++ b/docs/reference/commandline/stack_ls.md @@ -35,6 +35,11 @@ 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. + ## Examples The following command shows all stacks and some additional information: diff --git a/docs/reference/commandline/stack_ps.md b/docs/reference/commandline/stack_ps.md index bf25c722b..693871d79 100644 --- a/docs/reference/commandline/stack_ps.md +++ b/docs/reference/commandline/stack_ps.md @@ -34,8 +34,12 @@ Options: ## Description -Lists the tasks that are running as part of the specified stack. This -command has to be run targeting a manager node. +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. ## Examples diff --git a/docs/reference/commandline/stack_rm.md b/docs/reference/commandline/stack_rm.md index b9d48a345..7bc706171 100644 --- a/docs/reference/commandline/stack_rm.md +++ b/docs/reference/commandline/stack_rm.md @@ -32,8 +32,12 @@ Options: ## Description -Remove the stack from the swarm. This command has to be run targeting -a manager node. +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. ## Examples diff --git a/docs/reference/commandline/stack_services.md b/docs/reference/commandline/stack_services.md index 2f60df426..169fac939 100644 --- a/docs/reference/commandline/stack_services.md +++ b/docs/reference/commandline/stack_services.md @@ -32,8 +32,12 @@ Options: ## Description -Lists the services that are running as part of the specified stack. This -command has to be run targeting a manager node. +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. ## Examples diff --git a/docs/reference/commandline/swarm_ca.md b/docs/reference/commandline/swarm_ca.md index 18c7ad2eb..a7113afb5 100644 --- a/docs/reference/commandline/swarm_ca.md +++ b/docs/reference/commandline/swarm_ca.md @@ -33,7 +33,11 @@ Options: ## 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 diff --git a/docs/reference/commandline/swarm_join_token.md b/docs/reference/commandline/swarm_join_token.md index 3786ebf24..8f15ffaca 100644 --- a/docs/reference/commandline/swarm_join_token.md +++ b/docs/reference/commandline/swarm_join_token.md @@ -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. +> **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 You can view or rotate the join tokens using `swarm join-token`. diff --git a/docs/reference/commandline/swarm_unlock.md b/docs/reference/commandline/swarm_unlock.md index 7b00c49a4..eb64c1a5f 100644 --- a/docs/reference/commandline/swarm_unlock.md +++ b/docs/reference/commandline/swarm_unlock.md @@ -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 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 ```bash diff --git a/docs/reference/commandline/swarm_unlock_key.md b/docs/reference/commandline/swarm_unlock_key.md index a6267221b..43a608578 100644 --- a/docs/reference/commandline/swarm_unlock_key.md +++ b/docs/reference/commandline/swarm_unlock_key.md @@ -35,6 +35,10 @@ 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. + ## Examples ```bash diff --git a/docs/reference/commandline/swarm_update.md b/docs/reference/commandline/swarm_update.md index 9caea3c7d..fd3c4e2ce 100644 --- a/docs/reference/commandline/swarm_update.md +++ b/docs/reference/commandline/swarm_update.md @@ -33,7 +33,11 @@ Options: ## 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