mirror of
https://github.com/docker/cli.git
synced 2025-08-30 12:01:10 +03:00
f30bde6adb
these markdown files are not consumed directly in the docs, but only their content is included through the YAML does, so there's no need to have these comments in them Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
73 lines
2.1 KiB
Markdown
73 lines
2.1 KiB
Markdown
---
|
|
title: "node update"
|
|
description: "The node update command description and usage"
|
|
keywords: "resources, update, dynamically"
|
|
---
|
|
|
|
# update
|
|
|
|
```markdown
|
|
Usage: docker node update [OPTIONS] NODE
|
|
|
|
Update a node
|
|
|
|
Options:
|
|
--availability string Availability of the node ("active"|"pause"|"drain")
|
|
--help Print usage
|
|
--label-add value Add or update a node label (key=value) (default [])
|
|
--label-rm value Remove a node label if exists (default [])
|
|
--role string Role of the node ("worker"|"manager")
|
|
```
|
|
|
|
## Description
|
|
|
|
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
|
|
|
|
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](https://docs.docker.com/engine/userguide/labels-custom-metadata/#daemon-labels).
|
|
|
|
For more information about labels, refer to [apply custom
|
|
metadata](https://docs.docker.com/engine/userguide/labels-custom-metadata/).
|
|
|
|
## Related commands
|
|
|
|
* [node demote](node_demote.md)
|
|
* [node inspect](node_inspect.md)
|
|
* [node ls](node_ls.md)
|
|
* [node promote](node_promote.md)
|
|
* [node ps](node_ps.md)
|
|
* [node rm](node_rm.md)
|