summaryrefslogtreecommitdiff
path: root/docs/reference/commandline/node_update.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/commandline/node_update.md')
-rw-r--r--docs/reference/commandline/node_update.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/docs/reference/commandline/node_update.md b/docs/reference/commandline/node_update.md
index aa65d0309e..ba824c9494 100644
--- a/docs/reference/commandline/node_update.md
+++ b/docs/reference/commandline/node_update.md
@@ -13,7 +13,7 @@ keywords: "resources, update, dynamically"
will be rejected.
-->
-## update
+# update
```markdown
Usage: docker node update [OPTIONS] NODE
@@ -28,6 +28,12 @@ Options:
--role string Role of the node (worker/manager)
```
+## Description
+
+Update metadata about a node, such as its availability, labels, or roles.
+
+## Examples
+
### Add label metadata to a node
Add metadata to a swarm node using node labels. You can specify a node label as
@@ -39,7 +45,7 @@ $ docker node update --label-add foo worker1
To add multiple labels to a node, pass the `--label-add` flag for each label:
-``` bash
+```bash
$ docker node update --label-add foo --label-add bar worker1
```
@@ -61,7 +67,7 @@ entity within the swarm. Do not confuse them with the docker daemon labels for
For more information about labels, refer to [apply custom
metadata](https://docs.docker.com/engine/userguide/labels-custom-metadata/).
-## Related information
+## Related commands
* [node demote](node_demote.md)
* [node inspect](node_inspect.md)