docker swarm leave
説明
スウォームからノードを削除します。
API 1.24 以上
このコマンドを利用するには、クライアントとデーモンの API はともに、最低でも
1.24
である必要があります。
クライアント上においてdocker version
コマンドを実行して、クライアントとデーモンの API バージョンを確認してください。
Swarm このコマンドは Swarm オーケストレーターにおいて動作します。
利用方法
$ docker swarm leave [OPTIONS]
追加説明
このコマンドをワーカー上で実行した場合、そのワーカーがスウォームから去ります(leave)。
マネージャー上において --force
オプションをつけて実行すると、スウォームからマネージャーを削除します。
しかしスォーム内においてマネージャーの最低必要数(quorum)を維持しているかどうか、これを確認して再設定を行うことはしません。
スウォームからマネージャーを削除する安全な方法は、マネージャーをワーカーに格下げし、最低必要数から除かれるように指示することです。
そのときには --force
オプションをつけずにコマンド実行します。
--force
オプションを利用するのは、マネージャーが去ってしまった後には、もうそのスウォームを利用しない場合にのみ利用するようにしてください。
それはつまりシングルモードスウォームにおける場合などです。
本コマンドの利用例については、以下に示す 利用例の節 を参照してください。
オプション
名前/省略形 | デフォルト | 説明 |
--force , -f |
ノードを強制的にスウォームから除きます。警告は無視します。 |
利用例
以下のようなスウォームがあるとします。これはマネージャーから見たものです。
$ docker node ls
ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS
7ln70fl22uw2dvjn2ft53m3q5 worker2 Ready Active
dkp8vy1dq1kxleu9g4u78tlag worker1 Ready Active
dvfxp4zseq4s0rih1selh0d20 * manager1 Ready Active Leader
worker2
を削除するには worker2
そのものから以下のコマンドを実行します。
$ docker swarm leave
Node left the default swarm.
このノードはノード一覧内にまだ含まれますが down
として印づけされます。
これ以降、スウォーム動作には関わりません。
ただし down
ノードがたくさん表示されると、ノード一覧がわかりにくくなります。
アクティブでないノードを一覧から除くには node rm
コマンドを使います。
上位コマンド
コマンド | 説明 |
---|---|
docker swarm | スウォームを管理します。 |
関連コマンド
コマンド | 説明 |
docker swarm ca | Display and rotate the root CA |
docker swarm init | スウォームを初期化します。 |
docker swarm join | Join a swarm as a node and/or manager |
docker swarm join-token | Manage join tokens |
docker swarm leave | スウォームからノードを削除します。 |
docker swarm unlock | Unlock swarm |
docker swarm unlock-key | Manage the unlock key |
docker swarm update | スウォームを更新する。 |