オートメーション構成の更新

項目一覧

前提条件

Automation Config API リソースの変数
手順

Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。

Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。: 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用するサービスアカウントを作成します。

プロジェクトのオートメーション構成によって、MongoDB プロセスとエージェントの最終状態が決まります。 MongoDB Agent は、指定された目的に従って配置を構築します。

構成を更新するには:

現在の構成を取得します。
必要に応じて変更を加え、変更したいアイテムのみを変更します。
PUTを使用して構成全体を置き換えます。 PUTを使用する必要があります。 PATCHは使用しないでください。

注意

一部のパラメータは、 automationConfigエンドポイントを介して更新できません。詳しくは、以下を参照してください。

前提条件

APIへのアクセス権が必要です。詳しくは、「 API アクセスの設定」を参照してください。

Automation Config API リソースの変数

API リソースは、これらの変数の 1 つ以上を使用します。これらの API リソースを呼び出す前に、これらの変数を目的の値に置き換えます。

名前	タイプ	説明
`PUBLIC-KEY`	string	API認証情報の公開 API キー。
`PRIVATE-KEY`	string	API 認証情報のプライベート API キー。
`cloud.mongodb.com`	string	Cloud Manager インスタンスのURL 。
`GROUP-ID`	string	プロジェクト設定からのプロジェクトの一意の識別子。
`CLUSTER-ID`	string	クラスターの一意の識別子です。

手順

Cloud Manager からオートメーション構成を取得して検証します。

構成を取得するには、 automationConfigリソースを使用します。次のコマンドを発行して、プレースホルダーを Automation Config API リソースの変数に置き換えます。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig?pretty=true" \
     --output currentAutomationConfig.json

ダウンロードしたオートメーション構成ファイルを検証します。
versionのcurrentAutomationConfig.json フィールドと Automation Configuration バックアップファイルのmms-cluster-config-backup.json フィールドを比較します。version値は両方のJSONドキュメントの最後の要素です。このファイルは、MongoDB Agent を実行しているホスト上の次の場所にあります。
- Linux と macOS: /var/lib/mongodb-mms-automation/mms-cluster-config-backup.json
- Windows: %SystemDrive%\MMSAutomation\versions\mms-cluster-config-backup.json
version値が一致する場合は、現在のバージョンの Automation 構成ファイルを操作します。

ダウンロードしたオートメーション構成ファイルを編集します。

テキストエディターでcurrentAutomationConfig.jsonを開きます。

オートメーション構成オプションの詳細については、「オートメーション構成」を参照してください。

MongoDB Agent を更新する場合は、この手順を続行する前に「 Agent のバージョンを更新する」を参照してください。

更新された自動化構成を送信します。

更新されたオートメーション構成を送信するには、 automationConfigリソースを使用します。

更新された構成ドキュメントへのパスを指定して次のコマンドを実行し、プレースホルダーを Automation Config API リソースの変数に置き換えます。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Content-Type: application/json"
     --request PUT "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig?pretty=true" \
     --data @currentAutomationConfig.json

構成の更新に成功すると、API はリクエストが成功したことを示す HTTP 200 OKステータスコードを返します。

オートメーション構成の更新が成功したことを確認します。

Cloud Manager からオートメーション構成を取得し、変更が含まれていることを確認します。構成を取得するには、次のコマンドを実行して、プレースホルダーを Automation Config API リソースの変数に置き換えます。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig?pretty=true"

配置ステータスをチェックし、目的の状態に達していることを確認します。

配置ステータスを取得するには、 automationStatusリソースを使用します。次のコマンドを発行して、プレースホルダーを Automation Config API リソースの変数に置き換えます。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationStatus?pretty=true"

processes配列内のすべてのlastGoalVersionAchievedフィールドの値がgoalVersionフィールドと一致していることを確認します。配置ステータスの詳細については、「最新プランのオートメーションステータスを取得する」を参照してください。

戻る

シャーディングされたクラスターの配置

キーファイルのローテーション