MongoDB Ops Managerリソース仕様

外部接続設定

このセクションでは、 MongoDB Ops Managerの外部接続に関連するオプションの設定について説明します。 MongoDB Ops Managerマルチクラスター配置に固有のオプションの外部接続設定については、「マルチクラスター設定 」を参照してください。

spec.externalConnectivity

タイプ: コレクション

MongoDB Ops Managerへの外部接続を有効にする 構成 オブジェクト。 指定した場合、Kubernetes Operator はKubernetes サービス を作成します これにより、Kubernetes クラスターの外部からのトラフィックはMongoDB Ops Manager アプリケーションに到達できます。

指定しない場合、Kubernetes Operator は Kubernetes サービスを作成しません。 手動で作成するか、サードパーティのソリューションを使用して外部トラフィックをMongoDB Ops Manager クラスター内のKubernetes アプリケーションにルーティングする必要があります。

spec.externalConnectivity.type

型: string

Kubernetesサービス ServiceType MongoDB Ops ManagerKubernetesこれは を の外部で公開します。

が存在する場合は spec.externalConnectivity.type必須 。

指定可能な値はLoadBalancerとNodePortです。 クラウドプロバイダーがサポートしている場合は、 LoadBalancerが推奨されます。 ローカル配置にはNodePortを使用します。

spec.externalConnectivity.port

タイプ: 整数

KubernetesサービスがMongoDB Ops Managerアプリケーションを外部トラフィックに使用するポートを示す値。

• spec.externalConnectivity.typeがNodePortの場合

  • Kubernetesサービスは、 MongoDB Ops Managerアプリケーションをこのポートを介して外部トラフィックに公開します。

  • spec.externalConnectivity.portKubernetes値を指定しない場合、MongoDB Ops Manager サービスは、次のデフォルト範囲からランダムに選択された使用可能なポートから30000 32767アプリケーションにトラフィックをルーティングします。

    注意

    このポート経由のトラフィックを許可するには、ネットワークのファイアウォールを設定する必要があります。

• spec.externalConnectivity.typeがLoadBalancerの場合

  • クラウドプロバイダーが作成するロード バランサー リソースは、このポートを介してMongoDB Ops Managerアプリケーションを公開します。

  • spec.externalConnectivity.port値を指定しない場合、 KubernetesサービスはMongoDB Ops ManagerアプリケーションをデフォルトのHTTP （8080）または HTTPS（8443）ポートを介して外部トラフィックに公開します。

spec.externalConnectivity.loadBalancerIP

型: string

Kubernetes Operator による作成時にLoadBalancer Kubernetes サービスが使用する IP アドレス。

この設定は、クラウドプロバイダーがこの設定をサポートしており、かつspec.externalConnectivity.typeがLoadBalancerである場合にのみ使用できます。 ロードバランサー の詳細については、 については、 Kubernetes のドキュメント を参照してください。

spec.externalConnectivity.externalTrafficPolicy

型: string

MongoDB Ops Manager Kubernetesサービスへの外部トラフィックのルーティング ポリシー。 サービスは、この設定の値に応じて外部トラフィックをノードローカルまたはクラスター全体のエンドポイントにルーティングします。

指定可能な値はClusterとLocalです。 要件を満たす値については、「 Kubernetes のソース IP 」を参照してください。 （Kubernetes ドキュメント）。

注意

Clusterを選択した場合、Kubernetes ネットワーク境界で発生するネットワーク ホスティング中にクライアントのSource-IPが失われます。

spec.externalConnectivity.annotations

タイプ: コレクション

クラウドプロバイダー固有の構成設定を提供できるキーと値のペア。

注釈 の詳細については、 での TLS サポート については、Amazon Web ServicesKubernetes のドキュメント を参照してください。

バックアップ設定

このセクションでは、 MongoDB Ops Managerのバックアップに関連するオプション設定について説明します。 マルチクラスターMongoDB Ops Manager配置に固有のオプションのバックアップ設定については、「マルチクラスター設定 」を参照してください。

spec.backup.assignmentLabels

タイプ: 文字列の配列

バックアップデーモン サービスプロセスの割り当てラベルのリスト。 割り当てラベル を使用して、特定のバックアップデーモン プロセスが特定のプロジェクトに関連付けられていることを識別します。 Kubernetes Operator を使用して割り当てラベルを設定すると、割り当てラベルのKubernetes構成ファイルで設定した値が、 MongoDB Ops Manager UI で定義された値を上書きします。 Kubernetes Operator を使用して設定しない割り当てラベルは、 MongoDB Ops Manager UI で設定された値を引き続き使用します。

spec.backup.enabled

タイプ: ブール値

MongoDB Ops Managerリソースのバックアップを有効にするフラグ。 falseに設定されている場合、バックアップは無効になります。

デフォルト値はtrueです。

spec.backup.encryption

型: オブジェクト

バックアップ暗号化の構成設定を含むオブジェクト。

spec.backup.encryption.kmip

型: オブジェクト

KMIPバックアップ暗号化の構成設定を含むオブジェクトです。 詳細については、「 MongoDB Ops Managerの KMIP バックアップ暗号化の構成 」を参照してください。

注意

このパラメータを設定する場合、 spec.credentialsの値にリンクされた API キーにGlobal Ownerロールが必要です。

spec.backup.encryption.kmip.server

型: オブジェクト

KMIPバックアップ暗号化サーバーの構成設定を含むオブジェクト。

spec.backup.encryption.kmip.server.ca

型: string

KMIP 認証に使用する CA 証明書（ca.pem ）のエントリを含む ConfigMap を識別する、人間が判読可能なラベル。

spec.backup.encryption.kmip.server.url

型: string

形式を使用する KMIP hostname.port192.168.1.3:5696my-kmip-server.mycorp.com:5696サーバーの URL （たとえば、 や など）。

spec.backup.headDB

タイプ: コレクション

ヘッドデータベースの構成設定。 Kubernetes Operator による 永続的なボリューム要求 の作成 指定された構成で。

スカラー	データ型	説明
labelSelector	string	タグ マウントされたボリュームをディレクトリにバインドするために使用されます。
storage	string	永続ボリューム の最小サイズ マウントする必要があるもの。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。 デフォルト値は30Giです。 詳細については、「バックアップデーモンのハードウェア要件 」を参照してください。 たとえば、ヘッドデータベースに60ギガバイトのストレージが必要な場合は、この値を60Giに設定します。
storageClass	string	永続的なボリューム要求 で指定されるストレージのタイプ 。このストレージ タイプは、 StorageClass として作成できます。 この オブジェクト で使用する前にオブジェクトを 仕様。 StorageClass を必ず設定してください 保持 するreclaimPolicy 。これにより、 永続的なボリューム要求 が発生した場合にデータが保持できます は削除されます。

spec.backup.jvmParameters

タイプ: 文字列の配列

任意。 コンテナ内の バックアップ サービスに渡される JVM パラメータ。MongoDB Ops Manager

この Kubernetes Operator パラメーターのデフォルトは空のリストです。

spec:
  backup:
    jvmParameters: ["-XX:+UseStringCache"]

警告

JVM メモリ ヒープの値は自分のリスクで変更

Kubernetes Operator は、コンテナのメモリに基づいてバックアップ サービスのJVMメモリ ヒープ値を計算します。 -Xmsと-Xmxの値を変更すると、MongoDB Ops Manager で問題が発生する可能性があります。

spec.backup.members

タイプ: 整数

任意。 Kubernetes に配置するバックアップ デーモン サービスの数。 指定しない場合、デフォルトは1になります。 バックアップ サービスの高可用性を確保するには、 MongoDB Ops Managerで 複数のバックアップデーモン を配置します。

spec.backup.opLogStores

タイプ: コレクション

バックアップを有効にする場合は必須です。 バックアップに使用されるoplog ストアの配列。 配列内の各項目は、 Kubernetes Operator によって Kubernetes クラスターに配置された MongoDB database リソースを参照します。

spec.backup.opLogStores.assignmentLabels

タイプ: 文字列の配列

oplog ストアの割り当てラベルのリスト。 割り当てラベルを使用して、特定の oplog ストアが特定のプロジェクトに関連付けられていることを識別します。 Kubernetes Operator を使用して割り当てラベルを設定すると、割り当てラベルのKubernetes構成ファイルで設定した値が、 MongoDB Ops Manager UI で定義された値を上書きします。 Kubernetes Operator を使用して設定しない割り当てラベルは、 MongoDB Ops Manager UI で設定された値を引き続き使用します。

spec.backup.opLogStores.name

型: string

バックアップを有効にする場合は必須です。 oplog ストアの名前。

重要

oplog ストアの名前を指定した後は、その名前を編集しないでください。

spec.backup.opLogStores.mongodbResourceRef.name

型: string

バックアップを有効にする場合は必須です。 oplog スライスを保存するために作成するMongoDBリソースまたはMongoDBMultiClusterリソースの名前。 このリソースは、 MongoDB Ops Managerのリソースと同じ名前空間に配置する必要があります。

oplogデータベースは SCRAM 認証メカニズムのみをサポートしています。 他の認証メカニズムを有効にすることはできません。

oplog データベースでSCRAM認証を有効にする場合は、次の操作を行う必要があります。

• MongoDBMongoDB Ops Managerをoplog データベースに接続するための ユーザー リソースを作成します。

• nameのリソース定義でユーザーのMongoDB Ops Manager を指定します。

この名前の MongoDB database リソースが存在しない場合、 backupリソースはPending状態になります。 Kubernetes Operator は、この名前の MongoDB database リソースが作成されるまで、10 秒ごとに再試行します。

注意

この設定で参照するデータベース リソースにセキュリティを変更すると、 Kubernetes Operator はMongoDB Ops Managerリソースの調整を自動的に開始します。 Kubernetes Operator は、 の変更に基づいてMongoDB Ops Manager構成の mongoURI フラグと ssl フラグを更新します。

spec.backup.opLogStores.mongodbUserRef.name

型: string

SCRAMOplog Store Databaseで 認証が有効になっている場合は必須です。MongoDBへの接続に使用される ユーザーOplog Store Database リソースの名前。このユーザー リソースをMongoDB Ops Managerのリソースと同じ名前空間に、次のすべてのロールを使用して配置します。

• readWriteAnyDatabase

• dbAdminAnyDatabase

• clusterMonitor

spec.backup.blockStores

タイプ: コレクション

ブロックストアを使用してバックアップを有効にする場合は必須です。 バックアップに使用されるブロックストアの配列。 配列内の各項目は、 Kubernetes Operator によって Kubernetes クラスターに配置された MongoDB database リソースを参照します。

spec.backup.blockStores.assignmentLabels

タイプ: 文字列の配列

ブロックストア の割り当てラベルのリスト。 割り当てラベルを使用して、特定のブロックストアが特定のプロジェクトに関連付けられていることを識別します。 Kubernetes Operator を使用して割り当てラベルを設定すると、割り当てラベルのKubernetes構成ファイルで設定した値が、 MongoDB Ops Manager UI で定義された値を上書きします。 Kubernetes Operator を使用して設定しない割り当てラベルは、 MongoDB Ops Manager UI で設定された値を引き続き使用します。

spec.backup.blockStores.name

型: string

ブロックストアを使用してバックアップを有効にする場合は必須です。 ブロックストアの名前。

重要

一度指定したブロックストアの名前は編集しないでください。

spec.backup.blockStores.mongodbResourceRef.name

型: string

ブロックストアを使用してバックアップを有効にする場合は必須です。 ブロックストア用に作成する MongoDB database リソースの名前。 このデータベース リソースは、 MongoDB Ops Managerリソースと同じ名前空間に配置する必要があります。

ブロックストア データベースはSCRAM認証メカニズムのみをサポートしています。 他の認証メカニズムを有効にすることはできません。

ブロックストア データベースでSCRAM認証を有効にする場合は、次の操作を行う必要があります。

• をブロックストア データベースに接続するための MongoDBユーザー リソースを作成します。MongoDB Ops Manager

• nameのリソース定義でユーザーのMongoDB Ops Manager を指定します。

この名前の MongoDB database リソースが存在しない場合、 backupリソースはPending状態になります。 Kubernetes Operator は、この名前の MongoDB database リソースが作成されるまで、10 秒ごとに再試行します。

注意

この設定で参照するデータベース リソースにセキュリティを変更すると、 Kubernetes Operator はMongoDB Ops Managerリソースの調整を自動的に開始します。 Kubernetes Operator は、 の変更に基づいてMongoDB Ops Manager構成の mongoURI フラグと ssl フラグを更新します。

spec.backup.blockStores.mongodbUserRef.name

型: string

ブロックストア データベースで SCRAM 認証が有効になっている場合は必須です。 ブロックストア データベースに接続するために使用される MongoDB ユーザー リソースの名前。 このユーザー リソースをMongoDB Ops Managerのリソースと同じ名前空間に、次のすべてのロールを使用して配置します。

• readWriteAnyDatabase

• dbAdminAnyDatabase

• clusterMonitor

spec.backup.queryableBackupSecretRef.name

型: string

配置の TLS 要件に基づいてバックアップへのアクセスとクエリを実行するために使用する からの Queryable.pem ファイルを含むシークレットの名前 。PEM ファイルには公開鍵証明書とそれに関連付けられた秘密キーが含まれており、 でバックアップ スナップショットに対してクエリを実行します。MongoDB Ops ManagerMongoDB Ops Managerバックアップをクエリするには、このパラメーターの値を指定します。 設定されていない場合、バックアップは影響を受けませんが、クエリはできません。

spec.backup.statefulSet.spec

タイプ: コレクション

ステートメントセット MongoDBEnterprise Kubernetes Operatorの仕様 が バックアップ デーモン サービス 用に作成する

spec.backup.statefulSet.specに追加できるフィールドを確認するには、「 StatulSetSpec v1 アプリ 」を参照してください （Kubernetes ドキュメント）。

spec.backup.statefulSet.spec.template

タイプ: コレクション

テンプレート Kubernetesステートメント セット内の ポッドの場合MongoDBEnterprise Kubernetes Operator が バックアップ デーモン サービス 用に作成する

注意

Kubernetes 演算子は、 spec.backup.statefulSet.spec.templateで指定したフィールドを検証しません。

spec.backup.statefulSet.spec.template.metadata

タイプ: コレクション

StateftSet 内の Kubernetes ポッドのメタデータ MongoDB Enterprise Kubernetes Operator が バックアップ デーモン サービス 用に作成する

spec.backup.statefulSet.spec.template.metadataに追加できるフィールドを確認するには、 Kubernetes のドキュメント を参照してください。

spec.backup.statefulSet.spec.template.spec

タイプ: コレクション

StateftSet 内の Kubernetes ポッドの仕様 MongoDB Enterprise Kubernetes Operator が バックアップ デーモン サービス 用に作成する

spec.backup.statefulSet.spec.template.specに追加できるフィールドの完全なリストを確認するには、 Kubernetes のドキュメント を参照してください。

次の例では、 spec.backup.statefulSet.spec.template.specは、MongoDB Enterprise Kubernetes Operator が配置する 1 つのバックアップ デーモン サービスコンテナの最小と最大の CPU とメモリ容量を定義します。

statefulSet:
  spec:
    template:
      spec:
        containers:
        - name: mongodb-backup-daemon
          resources:
            requests:
              cpu: "0.50"
              memory: "4500M"
            limits:
              cpu: "1"
              memory: "6000M"

spec.backup.statefulSet.spec.template.spec.containers

タイプ: コレクション

ステートメントセット内の Kubernetes ポッドに属するコンテナのリスト MongoDB Enterprise Kubernetes Operator が バックアップ デーモン サービス 用に作成する

バックアップデーモンのサービスコンテナの仕様を変更するには、次の例に示すように、 nameフィールドを使用してコンテナの正確な名前を指定する必要があります。

backup:
 statefulSet:
   spec:
     template:
       spec:
         containers:
         - name: mongodb-backup-daemon

注意

spec.backup.statefulSet.spec.template.spec.containersにコンテナを追加すると、Kubernetes Operator はそれらを Kubernetes ポッドに追加します。 これらのコンテナは、ポッド内のバックアップデーモン サービスコンテナに追加されます。

spec.backup.statefulSet.spec.template.spec.containers.resources.requests.cpu

型: string

Kubernetes ノード で使用可能である必要がある最小 CPU 容量 バックアップデーモン サービスをホストします。

リクエスト値はspec.backup.statefulSet.spec.template.spec.containers.resources.limits.cpu以下である必要があります。

spec.backup.statefulSet.spec.template.spec.containers.resources.limits.cpu

型: string

ノード の最大 CPU 容量 は、 バックアップ デーモン サービス をホストするために作成されています。省略された場合、この値はspec.backup.statefulSet.spec.template.spec.containers.resources.requests.cpuに設定されます。

spec.backup.statefulSet.spec.template.spec.containers.resources.requests.memory

型: string

Kubernetes ノード で使用可能である必要がある最小メモリ容量 使用して、Kubernetes で バックアップ デーモン サービス をホストします。この値は、 JEDEC表記では、整数とそれに続くメモリ単位として表されます。

注意

この値は少なくとも4.5Giに設定します。 4.5Gi未満の値ではエラーが発生する可能性があります。

リクエスト値はspec.backup.statefulSet.spec.template.spec.containers.resources.limits.memory以下である必要があります。

spec.backup.statefulSet.spec.template.spec.containers.resources.limits.memory

型: string

ノード の最大メモリ容量 は、 バックアップ デーモン サービス をホストするために作成されています。省略された場合、この値はspec.backup.statefulSet.spec.template.spec.containers.resources.requests.memoryに設定されます。

Kubernetes Operator は、コンテナのメモリに基づいて Java ヒープ サイズのパラメータを計算し、設定します。

警告

この値は 32 GB 未満に制限します

この値を 32 GB（ 32Gi ）を超える値に設定すると、バックアップサービスに問題が発生する可能性があります。 ヒープが過剰な場合、 MongoDB Ops Managerで予期しない結果を引き起こす可能性があります。

S3 設定

は、oplog MongoDB Ops Managerとバックアップ スナップショットの保存に S3 を使用し、カスタム CA によって発行されたキーを使用して TLS によって S3 への接続を保護するように構成できます。

カスタム CA キーを構成するに は、 リソース の配置TLS-Encrypted Connection (HTTPS) の {2 タブで説明されているように、アプリケーション データベースの TLS を構成したMongoDB Ops Manager ConfigMap を使用します。この ConfigMap にspec.applicationDatabase.security.tls.caを設定します。

S3 とアプリケーション データベースの両方に TLS を使用することも、 S3 にのみ TLS を使用することもできます。

• 両方にTLSを使用するには、ConfigMap で参照されている同じca-pemから両方の目的の証明書を取得します。

• S3 のみで TLSspec.security.applicationDatabase.certsSecretPrefix を使用するには、ConfigMap で を定義しないでください。

spec.backup.s3OpLogStores.assignmentLabels

タイプ: 文字列の配列

S 3 oplog ストアの割り当てラベルのリスト。 割り当てラベルを使用して、特定のS 3 oplog ストアが特定のプロジェクトに関連付けられていることを識別します。 Kubernetes Operator を使用して割り当てラベルを設定すると、割り当てラベルのKubernetes構成ファイルで設定した値が、 MongoDB Ops Manager UI で定義された値を上書きします。 Kubernetes Operator を使用して設定しない割り当てラベルは、 MongoDB Ops Manager UI で設定された値を引き続き使用します。

spec.backup.s3OpLogStores.customCertificate

タイプ: ブール値

非推奨。 代わりにspec.backup.s3OpLogStores.customCertificateSecretRefsを使用してください。

S3 oplog ストアのカスタム TLS 証明書として AppDB 証明書（appdb-ca ）を使用するかどうかを示すフラグ。デフォルトはFalseです。

spec.backup.s3OpLogStores.customCertificateSecretRefs

タイプ: オブジェクトの配列

Kubernetes シークレット を使用した S3 oplog ストアのカスタム証明書のリスト 。基本64 でエンコードされた x。509 証明書は Kubernetes シークレット にすでに存在している必要があります キーと Java CertificateFactory によって解析可能である必要があります 。1 つのシークレット内で連鎖的に複数の証明書を指定することはできません。 1 つのシークレット内でチェーンに複数の証明書を指定した場合、Kubernetes Operator はチェーン内の最初の証明書のみを使用します。 customCertificate設定も指定した場合、Kubernetes Operator はバックアップのカスタム証明書としてspec.applicationDatabase.security.tls.caを使用します。

リスト内の各エントリは、 nameとkeyを指定します。 複数のシークレットを指定すると、Kubernetes Operator は指定されたシークレット内のすべての証明書を使用します。

この設定を指定しない場合、MongoDBMongoDB Ops Manager Ops Manager は、 で使用される JVM デフォルトの信頼ストアMongoDB Ops Manager を使用します。

spec.backup.s3OpLogStores.customCertificateSecretRefs.name

型: string

S 3 oplog ストアのカスタム証明書を使用するために必要です。 Kubernetes secret カスタム証明書を含む

spec.configuration.mms.mongoDbUsage.defaultUsageType

型: string

Kubernetes サービスのデフォルトのサーバータイプ。

spec.backup.s3OpLogStores.customCertificateSecretRefs.key

型: string

S 3 oplog ストアのカスタム証明書を使用するために必要です。 シークレット 内のキーを表すファイル 基本64 でエンコードされた x509 を含む。 証明書この設定を指定しない場合、Kubernetes Operator はS 3 oplog ストアのバックアップにカスタム証明書を利用できません。

spec.backup.s3OpLogStores.irsaEnabled

タイプ: ブール値

サービス Amazon Web ServicesアカウントにAmazon Web Services IAM ロールの 使用を有効にするフラグ EKS3oplog の S ストアを構成します。デフォルトはFalseです。 Amazon Web Services EKS を使用していない場合、このフラグは効果がありません。 False に設定すると、EKS のサービスアカウントにAmazon Web Services IAM ロールを使用してS3 oplogストアを構成する方法が無効になります。 詳しくは、「 EKS のサービス アカウントの IAM ロール 」を参照してください。

spec.backup.s3OpLogStores.name

型: string

S 3ストアを使用して oplog を保存するために必要です。 S 3 oplog ストアの名前。

spec.backup.s3OpLogStores.mongodbResourceRef.name

型: string

S3 oplog ストアのメタデータを保存するために作成する MongoDB database リソースの名前。 このデータベース リソースは、 MongoDB Ops Managerリソースと同じ名前空間に配置する必要があります。

注意

この設定を省略すると、アプリケーション データベースを使用してS 3 oplog ストアのメタデータを保存します。

この設定を省略する場合は、 spec.backup.s3OpLogStores.mongodbUserRef.name設定も省略する必要があります。 Kubernetes Operator はSCRAMユーザー認証を内部的に処理します。

このデータベースでSCRAM認証を有効にする場合は、次の操作を行う必要があります。

• をデータベースに接続するための MongoDBユーザー リソースを作成します。MongoDB Ops Manager

• nameのリソース定義でユーザーのMongoDB Ops Manager を指定します。

spec.backup.s3OpLogStores.mongodbUserRef.name

型: string

S 3 oplog メタデータを保存するための MongoDB データベース リソースを作成し、 かつ このデータベースで SCRAM が有効になっている場合は必須です。 S 3 oplog ストアのメタデータ データベースに接続するために使用される MongoDB ユーザー リソースの名前。 このユーザー リソースをMongoDB Ops Managerのリソースと同じ名前空間に、次のすべてのロールを使用して配置します。

• readWriteAnyDatabase

• dbAdminAnyDatabase

• clusterMonitor

重要

一度指定した後は、 S3メタデータ oplog ストアのユーザー名を編集しないでください。

spec.backup.s3OpLogStores.s3SecretRef.name

型: string

S 3ストアを使用して oplog を保存するために必要です。 accessKeyフィールドとsecretKey フィールドを含むシークレットの名前。バックアップデーモン サービスは、これらのフィールドの値を認証情報として使用して、 Amazon Web Services S3またはS3互換バケットにアクセスします。 S 3 oplog ストアを構成するには、シークレットに両方のキーを指定する必要があります。

spec.backup.s3OpLogStores.pathStyleAccessEnabled

タイプ: ブール値

バケットエンドポイント URL のスタイルを示します。

値	説明	例
true	パス形式 URL	s3.amazonaws.com/<bucket>
false	仮想ホスト形式の URL	<bucket>.s3.amazonaws.com

注釈 についての詳細は、 での TLS サポート については、Amazon Web ServicesKubernetes のドキュメント を参照してください。

デフォルト値はtrueです。

spec.backup.s3OpLogStores.s3BucketEndpoint

型: string

S 3ストアを使用して oplog を保存するために必要です。 URLストアをホストするAmazon Web Services S3バケットまたはS3互換バケットのoplog 。

注意

エンドポイントのURLにリージョンが含まれていない場合は、 s3RegionOverrideフィールドを指定します。

spec.backup.s3OpLogStores.s3BucketName

型: string

S 3ストアを使用して oplog を保存するために必要です。 ストアをホストする Amazon Web ServicesS3 バケットまたは S3 互換バケットの名前。oplog

spec.backup.s3OpLogStores.s3RegionOverride

型: string

S 3互換バケットが存在するリージョン。 S 3 oplog ストアのs3BucketEndpointがリージョン スコープをサポートしていない場合にのみ、このフィールドを使用します。 リージョンのスコープは 、エンドポイントがURLにリージョンを含めていない場合です。

このフィールドはAmazon Web Services S3バケットでは使用しないでください。 詳しくは、「 S 3ブロックストア構成 」を参照してください。

spec.backup.s3Stores.assignmentLabels

タイプ: 文字列の配列

がデータベースバックアップ スナップショットを 保存 する S3 または S 互換バケットの割り当てラベルのリスト。3割り当てラベルを使用して、特定のS 3ストアが特定のプロジェクトに関連付けられていることを識別します。 Kubernetes Operator を使用して割り当てラベルを設定すると、割り当てラベルのKubernetes構成ファイルで設定した値が、 MongoDB Ops Manager UI で定義された値を上書きします。 Kubernetes Operator を使用して設定しない割り当てラベルは、 MongoDB Ops Manager UI で設定された値を引き続き使用します。

spec.backup.s3Stores.customCertificate

タイプ: ブール値

非推奨。 代わりにspec.backup.s3Stores.customCertificateSecretRefsを使用してください。

アプリケーション データベースの証明書（appdb-ca ）を S3 バックアップのカスタム TLS 証明書として使用するかどうかを示すフラグ。デフォルトはFalseです。

spec.backup.s3Stores.customCertificateSecretRefs

タイプ: オブジェクトの配列

Kubernetes シークレット を使用した S3 スナップショット ストアのカスタム証明書のリスト 。基本64 でエンコードされた x。509 証明書は Kubernetes シークレット にすでに存在している必要があります キーと Java CertificateFactory によって解析可能である必要があります 。1 つのシークレット内で連鎖的に複数の証明書を指定することはできません。 1 つのシークレット内でチェーンに複数の証明書を指定した場合、Kubernetes Operator はチェーン内の最初の証明書のみを使用します。 spec.backup.s3Stores.customCertificate設定も指定した場合、Kubernetes Operator はバックアップのカスタム証明書としてspec.applicationDatabase.security.tls.caを使用します。

リスト内の各エントリは、 nameとkeyを指定します。 複数のシークレットを指定した場合、Kubernetes Operator は指定されたすべてのシークレットを使用します。

この設定を指定しない場合、Kubernetes Operator はバックアップに が使用する JVM デフォルトトラストMongoDB Ops Manager ストアを使用します。

spec.backup.s3Stores.customCertificateSecretRefs.name

型: string

S 3 oplog ストアのカスタム証明書を使用するために必要です。 Kubernetes secret カスタム証明書を含む

spec.backup.s3Stores.customCertificateSecretRefs.key

型: string

S 3 oplog ストアのカスタム証明書を使用するために必要です。 シークレット 内のキーを表すファイル 基本64 でエンコードされた x509 を含む。 証明書この設定を指定しない場合、Kubernetes Operator は S3 スナップショット ストアのカスタム証明書を利用できず、デフォルトは で使用されるデフォルトの JVM {Java Virtual Machine)MongoDB Ops Manager 信頼ストアになります。

spec.backup.s3Stores.irsaEnabled

タイプ: ブール値

サービス アカウントにAmazon Web Services IAM ロールの Amazon Web Services使用を有効にするフラグ EKS の S スナップショット ストアを構成します。3デフォルトはFalseです。 Amazon Web Services EKS を使用していない場合、このフラグは効果がありません。 False に設定すると、EKS のサービスアカウントにAmazon Web Services IAM ロールを使用してS3スナップショット ストアを構成する方法が無効になります。 詳しくは、「 EKS のサービス アカウントの IAM ロール 」を参照してください。

spec.backup.s3Stores.name

型: string

S 3ストアを使用して oplog を保存するために必要です。 S 3スナップショットストアの名前。

重要

S3スナップショットストアの名前を指定した後は、その名前を編集しないでください。 バックアップに古い名前が使用されている場合、この変更は失敗する可能性があります。 変更が成功した場合の影響は予測できません。

spec.backup.s3Stores.mongodbResourceRef.name

型: string

S3スナップショット ストアのメタデータを保存するために作成するMongoDBリソースまたはMongoDBMultiClusterリソースの名前。 このデータベース リソースは、 MongoDB Ops Managerリソースと同じ名前空間に配置する必要があります。

注意

この設定を省略すると、アプリケーション データベースを使用してS 3スナップショット ストアのメタデータを保存します。

この設定を省略する場合は、 spec.backup.s3Stores.mongodbUserRef.name設定も省略する必要があります。 Kubernetes Operator はSCRAMユーザー認証を内部的に処理します。

このデータベースでSCRAM認証を有効にする場合は、次の操作を行う必要があります。

• をデータベースに接続するための MongoDBユーザー リソースを作成します。MongoDB Ops Manager

• nameのリソース定義でユーザーのMongoDB Ops Manager を指定します。

重要

S3スナップショットストアの名前を指定した後は、その名前を編集しないでください。 バックアップに古い名前が使用されている場合、この変更は失敗する可能性があります。 変更が成功した場合の影響は予測できません。

この名前の MongoDB database リソースが存在しない場合、 backupリソースはPending状態になります。 Kubernetes Operator は、この名前の MongoDB database リソースが作成されるまで、10 秒ごとに再試行します。

注意

この設定で参照するデータベース リソースにセキュリティを変更すると、 Kubernetes Operator はMongoDB Ops Managerリソースの調整を自動的に開始します。 Kubernetes Operator は、 の変更に基づいてMongoDB Ops Manager構成の mongoURI フラグと ssl フラグを更新します。

spec.backup.s3Stores.mongodbUserRef.name

型: string

|s 3 | を保存するための MongoDB データベース リソースを作成した場合に必要このデータベースではスナップショット メタデータと SCRAM が有効になっています。 S 3スナップショット ストアのメタデータ データベースに接続するために使用される MongoDB ユーザー リソースの名前。 このユーザー リソースをMongoDB Ops Managerのリソースと同じ名前空間に、次のすべてのロールを使用して配置します。

• readWriteAnyDatabase

• dbAdminAnyDatabase

• clusterMonitor

重要

これを指定した後は、 S3メタデータ スナップショット ストアのユーザー名を編集しないでください。

spec.backup.s3Stores.s3SecretRef.name

型: string

S 3ストアを使用してバックアップを有効にする場合は必須です。 accessKeyフィールドとsecretKey フィールドを含むシークレットの名前。バックアップデーモン サービスは、これらのフィールドの値を認証情報として使用して、 Amazon Web Services S3またはS3互換バケットにアクセスします。 シークレットにいずれかのキーがない場合、 S 3スナップショット ストアを構成することはできません。

spec.backup.s3Stores.pathStyleAccessEnabled

タイプ: ブール値

バケットエンドポイント URL のスタイルを示します。

値	説明	例
true	パス形式 URL	s3.amazonaws.com/<bucket>
false	仮想ホスト形式の URL	<bucket>.s3.amazonaws.com

デフォルト値はtrueです。

spec.backup.s3Stores.s3BucketEndpoint

型: string

S 3ストアを使用してバックアップを有効にする場合は必須です。 URLAmazon Web Servicesスナップショット3 ストアをホストする S バケットまたは S3 互換バケットの 。

注意

エンドポイントのURLにリージョンが含まれていない場合は、 s3RegionOverrideフィールドを指定します。

spec.backup.s3Stores.s3BucketName

型: string

S 3ストアを使用してバックアップを有効にする場合は必須です。 スナップショットストアをホストするAmazon Web Services S3バケットまたはS3互換バケットの名前。

spec.backup.s3Stores.s3RegionOverride

型: string

S 3互換バケットが存在するリージョン。 S 3ストアのs3BucketEndpointがリージョン スコープをサポートしていない場合にのみ、このフィールドを使用します。 リージョンのスコープは 、エンドポイントがURLにリージョンを含めていない場合です。

このフィールドはAmazon Web Services S3バケットでは使用しないでください。 詳しくは、「 S 3ブロックストア構成 」を参照してください。

Prometheus 設定

アプリケーション データベースで Prometheus を使用する場合、次の設定が適用されます。

spec.applicationDatabase.prometheus

タイプ: 配列

任意。 Prometheus にメトリクスを公開するためのパラメーターを含むリスト。

spec.applicationDatabase.prometheus.metricsPath

型: string

デフォルト: "/metrics"

任意。 メトリクス エンドポイントへのパスを示す、人間が判読可能なstring 。 この設定を指定しない場合、デフォルトが適用されます。

spec.applicationDatabase.prometheus.passwordSecretRef

型: オブジェクト

シークレット の詳細を含む 条件付き オブジェクト 基本的な HTTP 認証用。アプリケーション データベースで Prometheus を使用する場合は、この設定を指定する必要があります。

spec.applicationDatabase.prometheus.passwordSecretRef.key

型: string

デフォルト: "password"

任意。 シークレット 内の鍵を識別する、人間が判読可能な 基本的なstringHTTP 認証のパスワードを保存します。この設定を指定しない場合、デフォルトが適用されます。

spec.applicationDatabase.prometheus.passwordSecretRef.name

型: string

条件付き

秘密 を識別する、人間が判読可能なラベル 基本的な HTTP 認証用のパスワードを含むアプリケーション データベースで Prometheus を使用する場合は、この設定を指定する必要があります。

spec.applicationDatabase.prometheus.port

タイプ: 整数

デフォルト: 9216

任意。 メトリクス エンドポイントがバインドするポートを識別する番号。 この設定を指定しない場合、デフォルトが適用されます。

spec.applicationDatabase.prometheus.tlseSecretKeyRef

型: オブジェクト

任意。 シークレット の詳細を含むオブジェクト TLS 認証用。

spec.applicationDatabase.prometheus.tlseSecretKeyRef.key

型: string

デフォルト: "password"

任意。 シークレットstring 内の鍵を識別する、人間が判読可能な は TLS 認証用のパスワードを保存します。この設定を指定しない場合、デフォルトが適用されます。

spec.applicationDatabase.prometheus.tlseSecretKeyRef.name

型: string

条件付き。 秘密 を識別する、人間が判読可能なラベル TLS 認証用のパスワードを含むアプリケーション データベースで Prometheus を使用し、 TLS認証を使用する場合は、この設定を指定する必要があります。

spec.applicationDatabase.prometheus.username

型: string

条件付き。 基本的な HTTP 認証のユーザーを識別する、人間が判読可能なラベル。 アプリケーション データベースで Prometheus を使用する場合は、この設定を指定する必要があります。

MongoDB Ops Managerの必要設定

このセクションでは、必要な MongoDB Ops Manager 設定に加えて、マルチクラスターMongoDB Ops Manager配置に使用する必要がある設定について説明しMongoDB Ops Manager 。

spec.clusterSpecList.members

タイプ: 整数

条件付き。 マルチ Kubernetes クラスター MongoDB Ops Manager配置内の クラスター内の OpsMongoDB Ops ManagerMongoDB Manager ノードの数。spec.topologyをMultiClusterに設定する場合は、このパラメータの値を指定する必要があります。 単一クラスター配置の場合は、このパラメーターを省略します。 このパラメーターを 0 に設定すると、このMongoDB Ops Managerノードクラスターは、 MongoDB Ops Managerインスタンスのマルチ Kubernetes クラスター内のノードクラスターのリストから削除されます。

spec.topology

型: string

KubernetesリソースのMongoDB Ops Manager 配置のタイプ。

• 値はSingleClusterまたはMultiClusterです。 省略した場合、デフォルト値はSingleClusterです。

• MultiClusterを指定した場合

  • MongoDBMultiClusterリソースを監視対象リソース リストに追加します。 これは、Kubernetes Operator に、マルチ Kubernetes クラスター モードで動作し、マルチ Kubernetes リソースの処理に必要な構成アクションを実行する必要があることを示します。

  • を配置するメンバークラスターを少なくとも 1MongoDB Ops Manager つ指定します。 とそのネストされた {7spec.clusterSpecList spec.clusterSpecList.clusterNamespec.clusterSpecList.members} パラメーターと パラメーターを使用します。

  • MultiClusterを指定すると、Kubernetes Operator はspec.membersに設定した値を無視します。 リソース仕様の例を参照してください。

MongoDB Ops Manager任意設定

MongoDB Ops Managerのリソースでは、マルチクラスターのMongoDB Ops Manager配置に固有の次の設定も使用できます。

spec.clusterSpecList

タイプ: コレクション

条件付き。 またはバックアップデーモン Kubernetesインスタンスを配置する予定の複数のKubernetes クラスターで、選択した ノード クラスターの詳細。MongoDB Ops Managerリソース仕様の例も参照してください。

• spec.topologyをMultiClusterに設定する場合は、 spec.clusterSpecList.membersの値を指定する必要があります。 spec.clusterSpecListの下の他のパラメータはすべて任意です。

• spec.topologyをSingleClusterに設定すると、Kubernetes Operator はspec.clusterSpecListの下のすべてのパラメータを無視します。

spec.clusterSpecList.clusterName

型: string

任意。 が をスケジュールする の複数の配置にある クラスターのノード名Kubernetes KubernetesMongoDBMongoDBEnterprise Kubernetes Operatorまたはバックアップデーモン用。MongoDB Ops Manager

spec.clusterSpecList.clusterDomain

型: string

任意。 spec.clusterDomain特定のMongoDB Ops Manager ノードクラスターの の上書き。この値を省略すると、 はデフォルトでspec.clusterDomainに設定された値になります。 Kubernetes は各 ポッド を割り当てます FQDN 。Kubernetes 演算子は、各 ポッド の FQDN を計算します 指定されたclusterDomain 値を使用します。Kubernetes では、これらのホスト名をクエリするためのAPIは提供されていません。

spec.clusterSpecList.configuration

タイプ: コレクション

任意。 MongoDB Ops Manager特定のクラスターのspec.configuration で設定したプロパティを上書きする の構成プロパティ。プロパティ名と説明については、「 MongoDB Ops Managerの構成設定」を参照してください。 各プロパティはstring型の値を受け取ります。 たとえば、これらのプロパティを設定すると、その特定のノード クラスター内のMongoDB Ops Managerとバックアップ デーモンに渡す必要がある環境変数を変更できます。

値の指定を省略すると、 はデフォルトでspec.configurationに設定された値になります。

spec.clusterSpecList.jvmParameters

タイプ: 文字列の配列

任意。 このノード クラスターの MongoDB Ops Manager インスタンスとバックアップデーモン インスタンスに渡されるJVMパラメーター。

• このパラメータを指定すると、その値はspec.jvmParametersで指定された値を上書きします。 値の例については、 リソース仕様の例 を参照してください。

• このパラメーターを省略すると、 spec.jvmParametersの値がこのノードクラスター内の MongoDB Ops Manager とバックアップデーモン インスタンスに使用されます。

spec.clusterSpecList.externalConnectivity

タイプ: コレクション

任意。 特定のクラスターの MongoDB Ops Manager への外部接続を有効にする 構成 オブジェクト。 これは、特定のクラスターのspec.externalConnectivityの上書きです。

MongoDB Ops Managerアプリケーションがさまざまなクラスターで外部に公開される方法を変更するには、このパラメーターの値を指定します。 たとえば、異なるクラウドプロバイダーのMongoDB Ops Manager Kubernetesノードに配置する場合は、このパラメーターにクラウドプロバイダー固有の値を指定する必要がある場合があります。

このパラメーターを設定すると、次の効果が生じます。

• Kubernetesspec.externalConnectivity演算子は、このノードの クラスターにMongoDB Ops Manager 値を使用しません。

• KubernetesOperator はKubernetes サービス を作成します<om-name>-svc-ext 、 という名前のKubernetes は、MongoDB Ops Manager クラスターの外部から送信されるトラフィックが、このノード クラスター上の アプリケーションに到達することを許可します。

このパラメーターを省略すると、Kubernetes Operator はこのノードクラスターに対してspec.externalConnectivityの値を使用します。

spec.clusterSpecList.statefulSet.spec

タイプ: コレクション

任意。 ステートメントセット MongoDBEnterprise Kubernetes OperatorKubernetesMongoDB Ops Managerの仕様 が、複数の クラスター 配置内の特定のノードクラスターに対して作成するこのパラメータはspec.statefulSet.specの上書きです。 省略すると、Kubernetes 演算子はspec.statefulSet.specの値を使用します。 たとえば、このパラメーターを使用して、Kubernetes クラスター のマルチ配置内の各 クラスターに対して異なるストレージ値を指定できます。MongoDB Ops ManagerMongoDB

spec.clusterSpecList.statefulSet.specに追加できるフィールドを確認するには、「 StatulSetSpec v1 アプリ 」を参照してください （Kubernetes ドキュメント）。

spec.clusterSpecList[*].backup

任意。 その特定のノード クラスターのspec.backupで指定された値を上書きするバックアップ設定。

• これらの値は、 spec.backup.enabledがtrueに設定されている場合にのみ設定できます。

• このパラメータの値を設定しない場合、デフォルトはspec.backupの下の設定で指定された値になります。

• このオーバーライドでは、すべてのバックアップ設定がサポートされていません。 次のバックアップ設定は、 spec.backupで指定されている場合、すべてのノード クラスターにグローバルに適用されるため、上書きできません。

  • externalServiceEnabled

  • headDB

  • opLogStores

  • blockStores

  • s3Stores

  • fileSystemStores

  • queryableBackupSecretRef

  • encryption

spec.clusterSpecList[*].backup.members

タイプ: 整数

任意。 spec.backup.membersのオーバーライド。 このクラスターに配置するバックアップデーモン インスタンスの数。 この値を省略するか、 0の値を指定すると、Kubernetes Operator は特定のノードクラスターにバックアップデーモン インスタンスを配置しません。

spec.clusterSpecList[*].backup.assignmentLabels

タイプ: 文字列の配列

任意。 spec.backup.assignmentLabelsのオーバーライド。 指定すると、Kubernetes Operator は、特定のノードクラスター内のすべてのバックアップデーモン インスタンスに対して、このオーバーライドで指定した値を使用します。 このパラメータの値を省略すると、値はデフォルトで ノードクラスター内のすべてのバックアップデーモン インスタンスのspec.backup.assignmentLabelsで指定された値になります。

spec.clusterSpecList[*].backup.jvmParameters

タイプ: 文字列の配列

任意。 spec.backup.jvmParametersのオーバーライド。 特定のノード クラスター内のバックアップデーモン インスタンスのJVM値をカスタマイズできます。

spec.clusterSpecList[*].backup.statefulSet

型: string

任意。 spec.backup.statefulSet.specのオーバーライド。 特定のノードクラスター内のバックアップデーモンの 値をカスタマイズできます。 spec.clusterSpecList[*].backup.statefulSetに追加できるフィールドを確認するには、「 StatulSetSpec v1 アプリ 」を参照してください （Kubernetes ドキュメント）。

アプリケーションデータベースに必要な設定

このセクションでは、アプリケーション データベースで使用する必要があるマルチクラスターMongoDB Ops Manager配置に固有の設定について説明します。

spec.applicationDatabase.clusterSpecList

タイプ: コレクション

MongoDB のマルチ Kubernetes クラスター配置で、アプリケーション データベースをホストするノードとして機能する選択した Kubernetes ノード クラスターの詳細。

spec.applicationDatabase.clusterSpecList.clusterName

型: string

MongoDB Enterprise Kubernetes Operator がステートメントをスケジュールする MongoDB のマルチ Kubernetes クラスター MongoDB 配置内のメンバーの Kubernetes クラスターの名前 : アプリケーション データベース用。

重要

CRDclusterSpecList のtopology と の設定を変更して、単一の インスタンスを複数のMongoDB Ops Manager Kubernetes クラスターの 配置インスタンスに変換することはできません。MongoDB

spec.applicationDatabase.clusterSpecList.members

タイプ: 数値

指定されたノード クラスター内のステートメント ノードの数。 ノードクラスターは、Kubernetes クラスターの MongoDB 配置でアプリケーション データベースをホストするノード クラスターの 1 つです。

spec.applicationDatabase.topology

型: string

アプリケーション データベースの Kubernetes 配置のタイプ。

• 値はSingleClusterまたはMultiClusterです。 省略した場合、デフォルト値はSingleClusterです。

• MultiClusterを指定する場合は、少なくとも 1 つのメンバーを指定する必要があります

• clusterSpecList 、 clusterName 、 membersパラメータを使用してアプリケーション データベースを配置するクラスター。

• MultiClusterを指定すると、Kubernetes Operator はspec.applicationDatabase.membersフィールドに設定した値を無視します。

詳しくは、 マルチクラスターのリソース仕様 の例を参照してください。

アプリケーションデータベースの任意設定

このセクションでは、アプリケーション データベースで使用できるマルチクラスターMongoDB Ops Manager配置に固有の設定について説明します。

spec.applicationDatabase.clusterSpecList.memberConfig

タイプ: 文字列の配列

マルチクラスターMongoDB Ops Manager配置内の各アプリケーション データベース レプリカセット ノードの仕様。

重要

spec.topologySingleClusterspec.applicationDatabase.clusterSpecList.memberConfigをspec.applicationDatabase.memberConfig に設定する場合は、 ではなく を使用します。

memberConfigリスト内の要素数はspec.applicationDatabase.clusterSpecList.membersと等しくなければなりません。

memberConfigリスト内の要素の順序は、レプリカセット内のメンバーの順序を反映する必要があります。 たとえば、 配列の最初の要素はインデックス0の ポッドに影響し、2 番目の要素はインデックス1に影響するなどします。

例

アプリケーション データベースの 3 つのノードからなるレプリカセットの次の指定例を検討してみましょう。

spec:
  replicas: 3
  version: 4.4.1
  backup:
    enabled: true
  storage:
    resources:
      requests:
        storage: 10Gi
      storageClassName: standard
  applicationDatabase:
    clusterSpecList:
      - name: appdb
        members: 3
        memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
              tag1: "value1"
              environment: "prod"
          - votes: 1
            priority: "1.5"
            tags:
              tag2: "value2"
              environment: "prod"
          - votes: 0
            priority: "0"
            tags:
              tag2: "value2"
              environment: "prod"

spec.applicationDatabase.clusterSpecList.memberConfig.priority

型: string

アプリケーション データベースのレプリカセットがプライマリ になる相対的な可能性を示す数値。

• レプリカセット メンバーがプライマリになる相対的な可能性を高めるには、 priorityの値を高く指定します。

• レプリカセット メンバーがプライマリになる相対的な可能性を減らすには、 priorityの値を低く指定します。

たとえば、 memberConfig.priorityが1.5のメンバーは、 memberConfig.priorityが0.5のメンバーよりも多く、プライマリになる可能性が高くなります。

かつmemberConfig.priorityが0のノードはプライマリになる資格がありません。 詳しくは、「メンバーの優先順位 」を参照してください。

spec.applicationDatabase.clusterSpecList.memberConfig.tags

タイプ: map

アプリケーション データベース レプリカセットの特定のノードに読み取りおよび書込み (write) 操作を指示するためのレプリカセット タグのマップ。

spec.applicationDatabase.clusterSpecList.memberConfig.votes

タイプ: 数値

アプリケーション データベースのレプリカセットのノードが選挙で投票できるかどうかを決定します。 メンバーに投票を許可するには を1に設定します。 ノードを選挙から除外するには、 0に設定します。