docker node update

説明

ノードを更新します。

API 1.24 以上  このコマンドを利用するには、クライアントとデーモンの API はともに、最低でも 1.24 である必要があります。 クライアント上においてdocker versionコマンドを実行して、クライアントとデーモンの API バージョンを確認してください。

Swarm このコマンドは Swarm オーケストレーターにおいて動作します。

利用方法

$ docker node update [オプション] NODE

追加説明

ノードに関するメタデータを更新します。 たとえば利用状態(availability)、ラベル、ロールなどです。

メモ

これはクラスター管理コマンドであるため、Swarm のマネージャーノード上で実行する必要があります。 マネージャーノードとワーカーノードについては、本ドキュメントの Swarm モード を参照してください。

本コマンドの利用例については、以下に示す 利用例の節 を参照してください。

オプション

名前/省略形 デフォルト 説明
--availability ノードの利用状態(availability)。("active"|"pause"|"drain")
--label-add ノードのラベルを追加または更新します。(key=value)
--label-rm ノードにラベルが存在している場合に削除します。
--role ノードのロール(role)。 ("worker"|"manager")

利用例

ラベルのメタデータをノードに追加

ノードラベルを用いてメタデータを Swarm ノードに追加します。 ノードラベルは、キーに対して空の値を設定することができます。

$ docker node update --label-add foo worker1

複数ラベルをノードに加えるには、--label-add フラグを各ラベル指定に利用します。

$ docker node update --label-add foo --label-add bar worker1

サービスの生成 を行う際には、ノードラベルを制約として設定することができます。 この制約は、ノードにおけるスケジューラーが、サービスに対するタスクのデプロイを制限します。

たとえば type ラベルを追加し、ノードにおけるスケジューラーが、メッセージキューサービスタスクをデプロイするものとするには、以下のようにします。

$ docker node update --label-add type=queue worker1

docker node update を使ってノードに設定するラベルは、Swarm 内にあるノードエンティティにのみ適用されます。 これを dockerd に対する Docker デーモンラベルと混同しないように注意してください。

ラベルに関する詳細は 独自メタデータの適用 を参照してください。

上位コマンド

コマンド 説明
docker node Swarm ノードを管理します。
コマンド 説明
docker node demote Swarm 内において 1 つあるいは複数のノードをマネージャーから降格させます。
docker node inspect 1 つまたは複数ノードに関する詳細情報を表示します。
docker node ls Swarm 内ノードを一覧表示します。
docker node promote Swarm 内において 1 つまたは複数ノードをマネージャーに昇格させます。
docker node ps 1 つまたは複数ノードにおいて実行中のタスク一覧を表示します。デフォルトはカレントノードのみです。
docker node rm 1 つまたは複数ノードを Swarm から削除します。
docker node update ノードを更新します。