定義
replSetReconfigThe
replSetReconfigadministrative command modifies the configuration of an existing replica set. You can use this command to add and remove members, and to alter the options set on existing members. You must run this command on theadmindatabase of the primary replica set member.Tip
In
mongosh, this command can also be run through thers.reconfig()helper method.Helper methods are convenient for
mongoshusers, but they may not return the same level of information as database commands. In cases where the convenience is not needed or the additional return fields are required, use the database command.
互換性
このコマンドは、次の環境でホストされている配置で使用できます。
MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン
重要
This command is not supported in MongoDB Atlas clusters. For information on Atlas support for all commands, see Unsupported Commands.
構文
このコマンドの構文は、次のとおりです。
db.adminCommand( { replSetReconfig: <new_config_document>, force: <boolean>, maxTimeMS: <int> } )
コマンドフィールド
コマンドは、次の任意フィールドがあります。
フィールド | 説明 |
|---|---|
デフォルトは 強制的に再構成すると、 | |
Optional. Specifies a cumulative time limit in milliseconds for processing the |
You may also run replSetReconfig with the shell's rs.reconfig() method.
動作
グローバル書込み保証 (write concern)
暗黙的なデフォルトの書込み保証 (write concern) を変更する 構成 で レプリカセット を再構成する前に、グローバルでデフォルトの 書込み保証 (write concern) を明示的に設定する必要があります。グローバルのデフォルトの書込み保証 (write concern) を設定するには、setDefaultRWConcern コマンドを使用します。
term レプリカ構成フィールド
The term field is set by the primary replica set member. The primary ignores the term field if set explicitly in the replSetReconfig operation.
再構成により追加または除外できるのは一度に 1 つの投票ノードのみ
replSetReconfig by default allows adding or removing no more than 1 voting member at a time. For example, a new configuration can make at most one of the following changes to the cluster membership:
新しい投票レプリカセット ノードを追加
既存の投票レプリカセット ノードを排除
既存のレプリカセット ノードの
votesを変更
To add or remove multiple voting members, issue a series of replSetReconfig operations to add or remove one member at a time.
強制再構成を発行すると、複数の投票ノードを追加または削除する場合でも、新しい構成がすぐにインストールされます。 強制的に再構成すると、 "majority"がコミットした書込み操作のロールバックなど、予期しない動作が発生する可能性があります。
再構成により、過半数のノードをレプリカ構成をインストールするまで待機させる
replSetReconfig waits until a majority of voting replica set members install the new replica configuration before returning success. A voting member is any replica set member where members[n].votes is 1, including arbiters.
レプリカセット ノードは、ハートビートを介してレプリカ構成を伝達します。ノードは、より高い version および term を持つ構成を学ぶたびに、新しい構成をインストールします。再構成プロセスには、2 つの異なる「待機」フェーズがあります。
- 1) 新しい構成をインストールする前に、現在の構成がコミットされるまで待機します。
The "current" configuration refers to the replica configuration in use by the primary at the time
replSetReconfigis issued.構成は、次の場合にコミットされます。
投票権のあるレプリカセット ノードの過半数が、現在の構成をインストールした
以前の構成で
"majority"でコミットされたすべての書込みが、現在の構成でも過半数に複製された
通常、現在の構成は、投票権のあるレプリカセット ノードの過半数にすでにインストールされています。ただし、以前の構成でコミットされた書込みの過半数が、現在の構成ですべてコミットされるとは限りません。
Delayedノードまたはlagging behindプライマリであるノードは、このフェーズで費やす時間を増やすことができます。操作がmaxTimeMS制限付きで発行され、待機中に操作が制限を超えた場合、操作はエラーを返し、新しい構成を破棄します。 制限は累積であり、次のフェーズに進んでリセットされません。
- 2) 新しい構成の投票ノードの過半数が新しい構成をインストールするまで待機します。
The "new" configuration refers to the replica configuration specified to
replSetReconfig.プライマリは、新しいレプリカ構成をインストールして使用を開始し、その後に構成を残りのレプリカセット ノードに伝達します。 この操作は、投票権のあるノードの過半数が新しい構成をインストールすることは待ちますが、新しい構成がコミットされることを待つ必要はありません。
操作がmaxTimeMS制限付きで発行され、待機中に操作が制限を超えた場合、操作はエラーを返しますが、新しい構成の使用と伝達は続行されます。
強制再構成を発行すると、前の構成のコミット ステータスに関係なく、新しい構成がすぐにインストールされます。 強制的に再構成すると、 "majority"がコミットした書込み操作のロールバックなど、予期しない動作が発生する可能性があります。
現在のレプリカ構成のコミット ステータスを確認するには、レプリカ セットのプライマリで、commitStatus パラメータを指定して replSetGetConfig を発行します。
新しい投票レプリカセットノードの自動再構成
MongoDB 5.0 以降では、新しく追加されたセカンダリは投票ノードとしてカウントされず、SECONDARY 状態に達するまで選出されません。
When a new voting node is added to a replica set, replSetReconfig will internally add a newlyAdded field to the node's configuration. Nodes with the newlyAdded field do not count towards the current number of voting nodes. When initial sync completes and the node reaches SECONDARY state, the newlyAdded field is automatically removed.
注意
newlyAddedという名前のフィールドを追加しようとする構成は、{ force: true }で実行した場合でもエラーになります。既存のノードに
newlyAddedフィールドがある場合、rs.reconfig()を使用して構成を変更してもnewlyAddedフィールドは削除されません。newlyAddedフィールドは、ユーザーが提供した構成に追加されます。replSetGetConfigは、その出力からすべてのnewlyAddedフィールドを除きます。newlyAddedフィールドを表示する場合は、local.system.replsetコレクションに直接クエリできます。
アクセス制御
アクセス制御を強制する配置で コマンドを実行するには、ユーザーはクラスター リソースに対するreplSetConfigure特権アクションを持っている必要があります。 adminデータベースで使用可能なclusterManager組み込みロールは、このコマンドに必要な特権を提供します。
ロック動作
replSetReconfig obtains a special mutually exclusive lock to prevent more than one replSetReconfig operation from occurring at the same time.
混合バージョンのレプリカセット
警告
MongoDB のバージョンによって検証ルールが異なる可能性があるため、異なるバージョンの MongoDB のノードを含むレプリカセットの再設定は避けてください。
可用性
変更が正しく伝達されるようにするには、セットのノードの過半数が稼働中である必要があります。
replSetReconfig can trigger the current primary to step down in some situations. Primary step-down triggers an election to select a new primary:
新しいプライマリが選出されると、
termフィールドが増加して、新しいプライマリで行われた構成の変更と前のプライマリで行われた変更を区別します。プライマリが降格しても、すべてのクライアント接続は閉じられなくなります。ただし、進行中の書込みは強制終了されます。 詳細については、「動作 」を参照してください。
デフォルトの replica configuration settings を前提とすると、クラスターが新しいプライマリを選択するまでの時間の中央値は、通常 12 秒を超えないはずです。これには、プライマリを利用不可としてマークし、選挙を呼び出して完了するために必要な時間が含まれます。settings.electionTimeoutMillis レプリケーション構成オプションを変更することで、この期間を調整できます。ネットワーク レイテンシなどの要因により、レプリカセット選挙が完了するまでにかかる時間が長くなる可能性があり、その結果、クラスターがプライマリなしで稼働できる時間にも影響します。これらの要因は、お使いのクラスター アーキテクチャによって異なります。
選挙プロセス中、クラスタは新しいプライマリを選出するまで書込み (write) 操作を受け付けません。
アプリケーション接続ロジックには、自動フェールオーバーとその後の選挙に対する許容範囲が含まれている必要があります。MongoDB ドライバーはプライマリの損失を検出し、自動的に 1 回、特定の書き込み操作を再試行することで、自動フェイルオーバーと選挙の組み込み処理を追加で行います。
互換性のあるドライバでは、デフォルトで再試行可能な書き込みが有効になります
実稼働クラスターへの潜在的な影響をさらに軽減するには、スケジュールされたメンテナンス期間中にのみ再構成してください。
{ force: true }
ノードを除外した後に発信接続を削除する
Using replSetReconfig to remove a replica set member does not automatically drop open outgoing connections from other replica set members to the removed member.
デフォルトでは、レプリカセット ノードは 5 分間待機してから、除外されたノードへの接続を削除します。シャーディングされたレプリカセットでは、ShardingTaskExecutorPoolHostTimeoutMS サーバー パラメーターを使用してこのタイムアウトを変更できます。
レプリカセットから削除されたノードへのすべての送信接続をすぐに削除するには、レプリカセット上の残りの各ノードでdropConnections管理コマンドを実行します。
db.adminCommand( { "dropConnections" : 1, "hostAndPort" : [ "<hostname>:<port>" ] } )
<hostname> と <port> を除外されたノードのものに置き換えます。
警告
MongDB5.0 以降、 IPアドレスのみが設定されている分裂ホライゾン DNS ノードはスタートアップの検証に失敗し、エラーを報告します。disableSplitHorizonIPCheck詳しくは、 を参照してください。