add ref docs for node label
Signed-off-by: Charles Smith <charles.smith@docker.com>
(cherry picked from commit 9594ac97ce
)
Signed-off-by: Tibor Vass <tibor@docker.com>
This commit is contained in:
parent
61936227d0
commit
05e6d5f5db
2 changed files with 34 additions and 2 deletions
|
@ -26,6 +26,38 @@ Options:
|
||||||
--role string Role of the node (worker/manager)
|
--role string Role of the node (worker/manager)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Add label metadata to a node
|
||||||
|
|
||||||
|
Add metadata to a swarm node using node labels. You can specify a node label as
|
||||||
|
a key with an empty value:
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
$ docker node update --label-add foo worker1
|
||||||
|
```
|
||||||
|
|
||||||
|
To add multiple labels to a node, pass the `--label-add` flag for each label:
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
$ docker node update --label-add foo --label-add bar worker1
|
||||||
|
```
|
||||||
|
|
||||||
|
When you [create a service](service_create.md),
|
||||||
|
you can use node labels as a constraint. A constraint limits the nodes where the
|
||||||
|
scheduler deploys tasks for a service.
|
||||||
|
|
||||||
|
For example, to add a `type` label to identify nodes where the scheduler should
|
||||||
|
deploy message queue service tasks:
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
$ docker node update --label-add type=queue worker1
|
||||||
|
```
|
||||||
|
|
||||||
|
The labels you set for nodes using `docker node update` apply only to the node
|
||||||
|
entity within the swarm. Do not confuse them with the docker daemon labels for
|
||||||
|
[dockerd]( ../../userguide/labels-custom-metadata.md#daemon-labels).
|
||||||
|
|
||||||
|
For more information about labels, refer to [apply custom
|
||||||
|
metadata](../../userguide/labels-custom-metadata.md).
|
||||||
|
|
||||||
## Related information
|
## Related information
|
||||||
|
|
||||||
|
|
|
@ -133,7 +133,7 @@ $ docker service create \
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information about labels, refer to [apply custom
|
For more information about labels, refer to [apply custom
|
||||||
metadata](../../userguide/labels-custom-metadata.md)
|
metadata](../../userguide/labels-custom-metadata.md).
|
||||||
|
|
||||||
### Set service mode
|
### Set service mode
|
||||||
|
|
||||||
|
@ -164,7 +164,7 @@ follows:
|
||||||
|
|
||||||
`engine.labels` apply to Docker Engine labels like operating system,
|
`engine.labels` apply to Docker Engine labels like operating system,
|
||||||
drivers, etc. Swarm administrators add `node.labels` for operational purposes by
|
drivers, etc. Swarm administrators add `node.labels` for operational purposes by
|
||||||
using the `docker node update` command.
|
using the [`docker node update`](node_update.md) command.
|
||||||
|
|
||||||
For example, the following limits tasks for the redis service to nodes where the
|
For example, the following limits tasks for the redis service to nodes where the
|
||||||
node type label equals queue:
|
node type label equals queue:
|
||||||
|
|
Loading…
Reference in a new issue