MongoDB Agent の設定

接続設定

mmsGroupId

型: string

Cloud Manager プロジェクトの ID を指定します。 プロジェクト ID を見つけるには、次のようにします。

1

MongoDB Cloud Managerで、Go Project Settingsページに します。

1. まだ表示されていない場合は、希望するプロジェクトを含む組織を選択しますナビゲーション バーのOrganizationsメニュー

2. まだ表示されていない場合は、ナビゲーション バーのProjectsメニューから目的のプロジェクトを選択します。

3. Projects メニューの横にある Options メニューをクリックし、 Project Settings をクリックします。

   [ Project Settings ]ページが表示されます。

mmsGroupId=8zvbo2s2asigxvmpnkq5yexf

mmsApiKey

型: string

Cloud Manager プロジェクトの Cloud Manager エージェント API キーを指定します。

プロジェクトには、すでに生成したエージェント API キーを使用できます。 それ以外の場合は、新しいエージェント API キーを生成できます。 プロジェクトは複数のエージェント API キーを持つことができ、プロジェクトのエージェントは任意のキーを使用できます。 詳細については、「エージェント API キーの管理 」を参照してください。

エージェントAPIキーを生成するには、[Agent API Keys] タブにGoします。 [] タブに移動するには:

1. MongoDB Cloud Managerで、プロジェクトの Deployment ページにGoします。

   1. まだ表示されていない場合は、目的のプロジェクトを含む組織をナビゲーション バーの Organizations メニューで選択します。

   2. まだ表示されていない場合は、ナビゲーション バーのProjectsメニューから目的のプロジェクトを選択します。

   3. Deployment ページがまだ表示されていない場合は、サイドバーの Deployment をクリックします。

      配置ページが表示されます。

2. 配置の [ Agents ] タブをクリックします。

   [エージェント ]ページが表示されます。

3. [Agent API Keys] タブをクリックします。

重要

エージェント API キーを生成すると、Cloud Manager はそれを1 回だけ表示します。 このキーはコピーする必要があります。 パスワードのように扱います。安全な場所に保存します。 Cloud Manager は完全なキーを再度表示しません。

Cloud Manager は、MongoDB Agent をインストールするときにこの設定を構成します。 モニタリングを個別に構成する必要がある場合は、この設定を含めます。

mmsApiKey=rgdte4w7wwbnds9nceuodx9mcte2zqem

mmsBaseUrl

型: string

Cloud Manager のURLを指定します。

mmsBaseUrl=http://example.com:8080

HTTP proxy設定

httpProxy

型: string

モニタリングで使用できる HTTP プロキシ サーバーの URL を指定します。

httpProxy=http://proxy.example.com:8080

MongoDB Kerberos 設定

モニタリングで Kerberos を使用してホストを認証する場合は、これらの設定を指定します。

Kerberos を構成するには、「 Kerberos用の MongoDB Agent の構成」を参照してください。 同じ手順と要件が適用されますが、モニタリングには異なるUPNを使用するだけです。

krb5Principal

型: string

モニタリングで使用される Kerberos プリンシパルを指定します。

krb5Principal=monitoring/myhost@EXAMPLE.COM

krb5Keytab

型: string

Kerberos プリンシパルのkeytabファイルへの絶対パスを指定します。

krb5Keytab=/path/to/mms-monitoring.keytab

krb5ConfigLocation

型: string

Kerberos 構成ファイルの非システム標準の場所への絶対パスを指定します。

krb5ConfigLocation=/path/to/krb_custom.conf

gssapiServiceName

型: string

gssapiServiceName設定のサービス名を指定します。

デフォルトでは、MongoDB は を使用します mongodb （サービス名として）。

MongoDB TLS 設定

TLSを使用して MongoDB 配置に接続する場合は、これらの設定を指定します。

詳しくは、「 TLS を使用するように MongoDB Agent を構成する 」を参照してください。

useSslForAllConnections

タイプ: ブール値

TLS を使用して MongoDB 配置へ のすべての 接続を暗号化するかどうかを指定します。

重要

これをtrueに設定すると、Cloud Manager インターフェースで構成されたホストごとのTLS設定が上書きされます。

sslClientCertificate

型: string

秘密キー、クライアント証明書、および任意の中間証明書への絶対パスをPEM形式で指定します。 モニタリングでは、クライアント証明書を使用して、 TLSを使用し、クライアント証明書を必要とする構成済みの MongoDB 配置に接続します。 （配置は--tlsCAFile設定で実行されます）。

例

を使用して、 TLS と証明書の検証の両方を使用する MongoDBmongosh 配置に接続する場合は、次のようにします。

mongosh --tls --tlsCertificateKeyFile /path/to/client.pem --tlsCAFile /path/to/ca.pem example.net:27017

これらの設定はCustom Settingsで設定する必要があります。

sslTrustedServerCertificates=/path/to/ca.pem
sslClientCertificate=/path/to/client.pem

sslClientCertificatePassword

型: string

sslClientCertificateファイル内の秘密キーを復号化するために必要なパスワードを指定します。 クライアント証明書PEMファイルを暗号化した場合は、この設定を含めます。

sslClientCertificatePassword=password

sslTrustedServerCertificates

型: string

PEM 形式の信頼できる証明機関証明書を含む 絶対 パスを指定します。これらの証明書は、 TLSを使用して実行されている MongoDB 配置から返されたサーバー証明書を検証します。

sslTrustedServerCertificates=/path/to/ca.pem

sslRequireValidServerCertificates

タイプ: ブール値

MongoDB データベースによって提示されたTLS証明書をモニタリングで検証するかどうかを指定します。

sslRequireValidServerCertificates=true

デフォルトでは、Cloud Manager はsslRequireValidServerCertificatesをtrueに設定します。 TLSを使用して MongoDB インスタンスに接続するには、有効な信頼できる証明書が必要です。

• MongoDB Agent がモニタリングを管理している場合は、このオプションをfalseに設定することはできません。

• モニタリングを手動で構成する場合は、 をsslRequireValidServerCertificates に設定 できfalse ます。

• sslRequireValidServerCertificatesをfalseに設定する場合は、 sslTrustedServerCertificatesを設定しないでください。 Cloud Manager は証明書を検証しません。

警告

この設定をfalseに変更すると、証明書の検証が無効になり、モニタリングと MongoDB の配置間の接続が中間者攻撃（man-in-the-middle attack）の影響を受けやすくなります。 テスト目的のみでこの設定をfalseに変更します。

Cloud Manager サーバー TLS 設定

TLSを使用して Cloud Manager と通信するときに使用するモニタリング設定を指定します。

httpsCAFile

型: string

PEM 形式の信頼できる証明機関証明書を含む 絶対 パスを指定します。モニタリングはこの証明書を使用して、エージェントが指定された Cloud Manager インスタンスと通信できることを確認します。

デフォルトでは、モニタリングにはホストにインストールされている信頼できるルート認証局が使用されます。

エージェントが信頼できるルート認証局を見つけられない場合は、これらの設定を手動で構成します。

httpsCAFile=/path/to/mms-certs.pem

接続設定

mmsGroupId

型: string

Cloud Manager プロジェクトの ID を指定します。 プロジェクト ID を見つけるには、次のようにします。

1

MongoDB Cloud Managerで、Go Project Settingsページに します。

1. まだ表示されていない場合は、希望するプロジェクトを含む組織を選択しますナビゲーション バーのOrganizationsメニュー

2. まだ表示されていない場合は、ナビゲーション バーのProjectsメニューから目的のプロジェクトを選択します。

3. Projects メニューの横にある Options メニューをクリックし、 Project Settings をクリックします。

   [ Project Settings ]ページが表示されます。

mmsGroupId=8zvbo2s2asigxvmpnkq5yexf

mmsApiKey

型: string

Cloud Manager プロジェクトの MongoDB Agent APIキーを指定します。

プロジェクトには、すでに生成したエージェント API キーを使用できます。 それ以外の場合は、新しいエージェント API キーを生成できます。 プロジェクトは複数のエージェント API キーを持つことができ、プロジェクトのエージェントは任意のキーを使用できます。 詳細については、「エージェント API キーの管理 」を参照してください。

エージェントAPIキーを生成するには、[Agent API Keys] タブにGoします。 [] タブに移動するには:

1. MongoDB Cloud Managerで、プロジェクトの Deployment ページにGoします。

   1. まだ表示されていない場合は、目的のプロジェクトを含む組織をナビゲーション バーの Organizations メニューで選択します。

   2. まだ表示されていない場合は、ナビゲーション バーのProjectsメニューから目的のプロジェクトを選択します。

   3. Deployment ページがまだ表示されていない場合は、サイドバーの Deployment をクリックします。

      配置ページが表示されます。

2. 配置の [ Agents ] タブをクリックします。

   [エージェント ]ページが表示されます。

3. [Agent API Keys] タブをクリックします。

重要

エージェント API キーを生成すると、Cloud Manager はそれを1 回だけ表示します。 このキーはコピーする必要があります。 パスワードのように扱います。安全な場所に保存します。 Cloud Manager は完全なキーを再度表示しません。

Cloud Manager は、MongoDB Agent をインストールするときにこの設定を構成します。 バックアップを個別に構成する必要がある場合は、この設定を含めます。

mmsApiKey=rgdte4w7wwbnds9nceuodx9mcte2zqem

mothership

型: string

バックアップエージェントが使用する Cloud Manager のホスト名とポートを指定します。

注意

mothership設定にプロトコル（ http://またはhttps:// ）を含めないでください。

mothership=example.com:8080

mothershipResponseHeaderTimeout

タイプ: 整数

Cloud Manager が応答するまでバックアップが待機する時間の長さを秒単位で指定します。 MongoDB Agent が応答を受け取らない場合、Cloud Manager への接続をリセットし、再試行します。 この値のデフォルトは90秒です。

backupSocketTimeoutMs

タイプ: 整数

Cloud Manager が接続を中断する前に、バックアップと Cloud Manager 間のソケットがアイドル状態を維持できる時間の長さをミリ秒単位で指定します。 省略した場合、デフォルトは180000ミリ秒（ 3分）になります。

https

タイプ: ブール値

Cloud Manager ウェブ サーバーとの通信でセキュアHTTPを使用するかどうかを指定します。

HTTP proxy設定

httpProxy

型: string

バックアップが使用できる HTTP プロキシ の URL を指定します。

httpProxy=http://proxy.example.com:8080

MongoDB Kerberos 設定

Kerberos を構成するには、「 Kerberos用の MongoDB Agent の構成」を参照してください。 同じ手順と要件が適用されますが、バックアップには異なるUPNを使用するだけです。

krb5Principal

型: string

バックアップが使用する Kerberos プリンシパルを指定します。

krb5Principal=backup/myhost@EXAMPLE.COM

krb5Keytab

型: string

Kerberos プリンシパルのキータブ ファイルへの絶対パスを指定します。

krb5Keytab=/path/to/mms-backup.keytab

krb5ConfigLocation

型: string

Kerberos 構成ファイルの非システム標準の場所への絶対パスを指定します。

krb5ConfigLocation=/path/to/krb_custom.conf

gsapiServiceName

型: string

gsapiServiceName設定のサービス名を指定します。

デフォルトでは、MongoDB は を使用します mongodb （サービス名として）。

MongoDB TLS 設定

バックアップがTLSを使用して MongoDB 配置に接続する場合は、これらの設定を指定します。

詳しくは、「 TLS を使用するように MongoDB Agent を構成する 」を参照してください。

sslClientCertificate

型: string

PEM形式で秘密キー、クライアント証明書、オプションの中間証明書へのパスを指定します。 バックアップは、 TLSを使用し、クライアント証明書を必要とする MongoDB 配置に接続するときにクライアント証明書を使用します。 （配置は--tlsCAFile設定で実行されます）。

sslClientCertificatePassword

型: string

sslClientCertificateファイル内の秘密キーを復号化するために必要なパスワードを指定します。 クライアント証明書PEMファイルを暗号化した場合は、この設定を含めます。

sslTrustedServerCertificates

型: string

PEM形式の信頼できる CA 証明書を含むパスを指定します。 これらの証明書は、 TLSを使用して実行されている MongoDB 配置から返されたサーバー証明書を検証します。

sslTrustedServerCertificates=/path/to/mongodb-certs.pem

sslRequireValidServerCertificates

タイプ: ブール値

MongoDB 配置によって提示されたTLS証明書をバックアップが検証するかどうかを指定します。

警告

この設定をfalseに変更すると、証明書の検証が無効になり、バックアップと MongoDB の配置間の接続が中間者攻撃（man-in-the-middle attack）の影響を受けやすくなります。 テスト目的のみでこの設定をfalseに変更します。

Cloud Manager サーバー TLS 設定

TLSを使用して Cloud Manager と通信するときに使用する設定を指定します。

sslTrustedMMSBackupServerCertificate

PEM 形式の信頼できる証明機関証明書を含む 絶対 パスを指定します。バックアップはこの証明書を使用して、MongoDB Agent が指定された Cloud Manager インスタンスと通信できることを確認します。

デフォルトでは、バックアップはシステムにインストールされている信頼できるルート認証局を使用します。

バックアップが信頼できるルート認証局を見つけられない場合は、これらの設定を手動で構成します。

Cloud Manager が自己署名TLS証明書を使用する場合は、この設定に値を指定します。

sslTrustedMMSBackupServerCertificate=/path/to/mms-certs.pem