2016-10-14 18:30:36 -04:00
|
|
|
---
|
|
|
|
title: "node update"
|
|
|
|
description: "The node update command description and usage"
|
2016-11-03 18:48:30 -04:00
|
|
|
keywords: "resources, update, dynamically"
|
2016-10-14 18:30:36 -04:00
|
|
|
---
|
2016-06-13 22:57:19 -04:00
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
# update
|
2016-06-13 22:57:19 -04:00
|
|
|
|
2016-07-07 14:43:18 -04:00
|
|
|
```markdown
|
|
|
|
Usage: docker node update [OPTIONS] NODE
|
2016-06-13 22:57:19 -04:00
|
|
|
|
2016-07-07 14:43:18 -04:00
|
|
|
Update a node
|
2016-06-13 22:57:19 -04:00
|
|
|
|
2016-07-07 14:43:18 -04:00
|
|
|
Options:
|
2017-02-08 03:31:16 -05:00
|
|
|
--availability string Availability of the node ("active"|"pause"|"drain")
|
2016-06-17 00:28:07 -04:00
|
|
|
--help Print usage
|
2016-06-30 20:33:43 -04:00
|
|
|
--label-add value Add or update a node label (key=value) (default [])
|
|
|
|
--label-rm value Remove a node label if exists (default [])
|
2017-02-08 03:31:16 -05:00
|
|
|
--role string Role of the node ("worker"|"manager")
|
2016-07-07 14:43:18 -04:00
|
|
|
```
|
2016-06-13 22:57:19 -04:00
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
## Description
|
|
|
|
|
|
|
|
Update metadata about a node, such as its availability, labels, or roles.
|
|
|
|
|
2020-04-19 11:08:37 -04:00
|
|
|
> **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.
|
2018-12-23 06:27:52 -05:00
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
## Examples
|
|
|
|
|
2022-03-30 09:05:29 -04:00
|
|
|
### <a name=label-add></a> Add label metadata to a node (--label-add)
|
2016-07-11 12:11:18 -04:00
|
|
|
|
|
|
|
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:
|
|
|
|
|
2021-08-21 08:54:14 -04:00
|
|
|
```console
|
2016-07-11 12:11:18 -04:00
|
|
|
$ 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
|
2020-04-19 09:43:08 -04:00
|
|
|
[dockerd](dockerd.md).
|
2016-07-11 12:11:18 -04:00
|
|
|
|
|
|
|
For more information about labels, refer to [apply custom
|
2016-10-20 11:40:36 -04:00
|
|
|
metadata](https://docs.docker.com/engine/userguide/labels-custom-metadata/).
|
2016-06-13 22:57:19 -04:00
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
## Related commands
|
2016-06-13 22:57:19 -04:00
|
|
|
|
2016-12-13 09:15:08 -05:00
|
|
|
* [node demote](node_demote.md)
|
2016-06-13 22:57:19 -04:00
|
|
|
* [node inspect](node_inspect.md)
|
|
|
|
* [node ls](node_ls.md)
|
2016-12-13 09:15:08 -05:00
|
|
|
* [node promote](node_promote.md)
|
|
|
|
* [node ps](node_ps.md)
|
2016-06-13 22:57:19 -04:00
|
|
|
* [node rm](node_rm.md)
|