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.port値を指定しない場合、 Kubernetesサービスは、30000 - のデフォルト範囲からランダムに選択された使用可能なポートから Ops Manager32767 アプリケーションにトラフィックをルーティングします。

    注意

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

• spec.externalConnectivity.typeがLoadBalancer の場合:

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

  • spec.externalConnectivity.port値を指定しない場合、 Kubernetesサービスは 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ドキュメントの「 Kubernetesのソース IP 」を参照してください。

注意

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 バックアップ暗号化の構成 」を参照してください。

注意

このパラメータを設定する場合、 の値にリンクされたAPIキーにspec.credentials 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

hostname.port形式を使用する KMIPサーバーのURL （例: 、192.168.1.3:5696、my-kmip-server.mycorp.com:5696）。

spec.backup.headDB

タイプ: コレクション

ヘッドデータベースの構成設定。Kubernetes Operator は、指定された構成で永続的なボリューム要求を作成します。

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

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 になります。バックアップサービスの高可用性を確保するには、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 データベースに接続するための ユーザー リソースを作成します。

• nameOps 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

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

spec.backup.statefulSet.spec

タイプ: コレクション

MongoDB Controls for Kubernetes Operator がバックアップデーモンサービス用に作成するステートフルセットの仕様。

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

spec.backup.statefulSet.spec.template

タイプ: コレクション

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

注意

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

spec.backup.statefulSet.spec.template.metadata

タイプ: コレクション

MongoDB Controls for Kubernetes Operator がバックアップデーモンサービス用に作成するステートメントセット内のKubernetesポッドのメタデータ。

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

spec.backup.statefulSet.spec.template.spec

タイプ: コレクション

MongoDB Controls for Kubernetes Operator がバックアップデーモンサービス用に作成するステートメントセット内のKubernetesポッドの仕様。

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

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

Tip

Ops Manager コンポーネントを**実行する**ホストするのハードウェア、ソフトウェア、およびネットワーク要件の詳細については、Ops Manager ドキュメントの「Ops Manager システム要件」を参照してください。

statefulSet:
  spec:
    template:
      spec:
        containers:
        - name: mongodb-backup-daemon
          resources:
            requests:
              cpu: "4"
              memory: "8Gi"
            limits:
              cpu: "8"
              memory: "16Gi"

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

タイプ: コレクション

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

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

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

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

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

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

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

spec.backup.s3OpLogStores.assignmentLabels

タイプ: 文字列の配列

S3 oplogストアの割り当てラベルのリスト。割り当てラベルを使用して、特定の S3 oplogストアが特定のプロジェクトに関連付けられていることを識別します。 Kubernetes Operator を使用して割り当てラベルを設定すると、割り当てラベルのKubernetes構成ファイルで設定した値が、Ops Manager UIで定義された値を上書きします。 Kubernetes Operator を使用して設定しない割り当てラベルは、 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ストアのカスタム証明書のリスト。 base64 でエンコードされた 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

S3 oplogストアのカスタム証明書を使用するために必要です。カスタム証明書を含むKubernetesシークレット。

spec.configuration.mms.mongoDbUsage.defaultUsageType

型: string

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

spec.backup.s3OpLogStores.customCertificateSecretRefs.key

型: string

Required to use custom certificates for your S3 oplog store. File that represents the key in the secret that contains the base64-encoded x.509 certificate. If you don't specify this setting, the Kubernetes Operator can't utilize the custom certificate for S3 oplog store backups.

spec.backup.s3OpLogStores.irsaEnabled

タイプ: ブール値

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

spec.backup.s3OpLogStores.name

型: string

Required to store the oplog using an S3 store. Name of the S3 oplog store.

spec.backup.s3OpLogStores.mongodbResourceRef.name

型: string

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

注意

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

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

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

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

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

spec.backup.s3OpLogStores.mongodbUserRef.name

型: string

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

• readWriteAnyDatabase

• dbAdminAnyDatabase

• clusterMonitor

重要

Once specified, don't edit the name of the S3 metadata oplog store username.

spec.backup.s3OpLogStores.s3SecretRef.name

型: string

spec.backup.s3OpLogStores.irsaEnabled が true に設定されていない場合に、S3 ストアを使用してoplogを保存するために必要です。

Name of the secret that contains the accessKey and secretKey fields. The backup daemon service uses the values of these fields as credentials to access your AWS S3 or S3-compatible bucket. To configure the S3 oplog store, you must specify both keys in the secret.

spec.backup.s3OpLogStores.irsaEnabled を true に設定する場合、 Amazon Web Services S3 の認証情報は pod 環境変数としてマウントされているため、s3SecretRef を設定する必要はありません。

spec.backup.s3OpLogStores.pathStyleAccessEnabled

タイプ: ブール値

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

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

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

デフォルト値はtrueです。

spec.backup.s3OpLogStores.s3BucketEndpoint

型: string

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

注意

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

spec.backup.s3OpLogStores.s3BucketName

型: string

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

spec.backup.s3OpLogStores.s3RegionOverride

型: string

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

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

spec.backup.s3Stores.assignmentLabels

タイプ: 文字列の配列

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

spec.backup.s3Stores.customCertificate

タイプ: ブール値

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

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

spec.backup.s3Stores.customCertificateSecretRefs

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

Kubernetesシークレットを使用した S3読み取りのカスタム証明書のリスト。 base64 でエンコードされた 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

S3 oplogストアのカスタム証明書を使用するために必要です。カスタム証明書を含むKubernetesシークレット。

spec.backup.s3Stores.customCertificateSecretRefs.key

型: string

Required to use custom certificates for your S3 oplog store. File that represents the key in the secret that contains the base64-encoded x.509 certificate. If you don't specify this setting, Kubernetes Operator can't utilize the custom certificate for S3 snapshot store and defaults to the default trust store used by Ops Manager.

spec.backup.s3Stores.irsaEnabled

タイプ: ブール値

Flag that enables using AWS IAM roles for service accounts in AWS EKS to configure an S3 snapshot store. The default is False. If you aren't using AWS EKS, this flag has no effect. When set to False, using AWS IAM roles for service accounts in EKS to configure an S3 snapshot store is disabled. To learn more, see IAM roles for service accounts in EKS.

spec.backup.s3Stores.name

型: string

Required to store the oplog using an S3 store. Name of the S3 snapshot store.

重要

Once specified, don't edit the name of the S3 snapshot store. This change will likely fail if backups use the old name. The consequences of a successful change are unpredictable.

spec.backup.s3Stores.mongodbResourceRef.name

型: string

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

注意

この設定を省略すると、アプリケーション データベースを使用して S3読み取りのメタデータが保存されます。

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

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

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

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

重要

Once specified, don't edit the name of the S3 snapshot store. This change will likely fail if backups use the old name. The consequences of a successful change are unpredictable.

この名前の 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

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

• readWriteAnyDatabase

• dbAdminAnyDatabase

• clusterMonitor

重要

Once specified, don't edit the name of the S3 metadata snapshot store username.

spec.backup.s3Stores.s3SecretRef.name

型: string

S3 ストアを使用してバックアップを有効にし、かつ spec.backup.s3Stores.irsaEnabled を true に設定していない場合に必要です。

Name of the secret that contains the accessKey and secretKey fields. The backup daemon service uses the values of these fields as credentials to access your AWS S3 or S3-compatible bucket. The S3 snapshot store can't be configured if the secret is missing either key.

spec.backup.s3Stores.irsaEnabled を true に設定する場合、 Amazon Web Services S3 の認証情報は pod 環境変数としてマウントされているため、s3SecretRef を設定する必要はありません。

spec.backup.s3Stores.objectLockEnabled

タイプ: ブール値

この読み取りをバックアップするAWS S3 または S3 互換バケットで、オブジェクト ロックが有効になっているかどうかを指定します。このフィールドをtrue に設定して、ストアの不変バックアップを有効にします。

このフィールドは MongoDB Ops Manager バージョン8.0.19 以降でのみサポートされています。 Ops Manager で不変バックアップを構成する方法について詳しくは、「 不変バックアップの設定 」を参照してください。

デフォルト値はfalseです。

spec.backup.s3Stores.pathStyleAccessEnabled

タイプ: ブール値

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

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

デフォルト値はtrueです。

spec.backup.s3Stores.s3BucketEndpoint

型: string

S3 ストアを使用してバックアップを有効にする場合は必須です。読み取りをホストするAWS S3バケットまたは S3 互換バケットのURL 。

注意

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

spec.backup.s3Stores.s3BucketName

型: string

S3 ストアを使用してバックアップを有効にする場合は必須です。読み取りをホストするAWS S3バケットまたは S3 互換バケットの名前。

spec.backup.s3Stores.s3RegionOverride

型: string

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

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

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"

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

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"

任意。 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 クラスター内の Ops Manager ノードの数。spec.topology をMultiCluster に設定する場合は、このパラメータの値を指定する必要があります。単一クラスター配置の場合は、このパラメーターを省略します。このパラメーターを 0 に設定すると、この Ops Manager ノードクラスターは、Ops Manager インスタンスのマルチ Kubernetes クラスター内のノードクラスターのリストから削除されます。

spec.topology

型: string

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

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

• MultiClusterを指定した場合

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

  • とそのネストされた および spec.clusterSpecList.clusterNamespec.clusterSpecListspec.clusterSpecList.membersパラメータを使用して、Ops Manager を配置するノードクラスターを少なくとも 1 つ指定します。

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

MongoDB Ops Manager任意設定

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

spec.clusterSpecList

タイプ: コレクション

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

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

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

spec.clusterSpecList.clusterName

型: string

任意 。MongoDB Ops Managerまたはバックアップデーモンの ステートメントをスケジュールするMongoDBのマルチKubernetesクラスターMongoDBデプロイ内のメンバーの名前。

spec.clusterSpecList.clusterDomain

型: string

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

spec.clusterSpecList.configuration

タイプ: コレクション

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

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

spec.clusterSpecList.jvmParameters

タイプ: 文字列の配列

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

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

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

spec.clusterSpecList.externalConnectivity

タイプ: コレクション

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

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

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

• Kubernetes Operator は、このノード Ops Manager クラスターにspec.externalConnectivity 値を使用しません。

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

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

spec.clusterSpecList.statefulSet.spec

タイプ: コレクション

任意。 MongoDB Controls for Kubernetes Operator がマルチ Kubernetes クラスター Ops Manager デプロイメント内の特定のノード クラスターに対して作成するステートフルセットの仕様。このパラメータはspec.statefulSet.spec の上書きです。省略すると、 Kubernetes演算子は の値を使用します。例、このパラメータを使用して、 マルチ Kubernetes クラスターMongoDBデプロイ内の各 Ops Manager クラスターに対して異なるストレージ値を指定できます。spec.statefulSet.spec

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

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 に追加できるフィールドを確認するには、 Kubernetesドキュメントの「StateulSetSpec v1 アプリ」を参照してください。

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

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

spec.applicationDatabase.clusterSpecList

タイプ: コレクション

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

spec.applicationDatabase.clusterSpecList.clusterName

型: string

MongoDB Controls for Kubernetes Operator がアプリケーション データベースのステートメントをスケジュールする MongoDB のマルチ Kubernetes クラスターMongoDBデプロイ内の、メンバーのKubernetesクラスターの名前。

重要

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

spec.applicationDatabase.clusterSpecList.members

タイプ: 数値

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

spec.applicationDatabase.topology

型: string

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

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

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

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

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

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

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

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

spec.applicationDatabase.clusterSpecList.externalAccess

型: string

レプリカセットの配置を外部で公開するために使用される外部ドメイン。

デフォルトでは 、各レプリカセットノードはKubernetesポッドの FQDN （*.svc.cluster.local）をデフォルトのホスト名として使用します。ただし、この設定に外部ドメインを追加すると、レプリカセットは代わりに、指定されたドメインのサブドメインであるホスト名を使用します。このホスト名は、次の形式を使用します。

<replica-set-name>-<cluster-idx>-<pod-idx>.<externalDomain>

以下に例を挙げます。

multi-replica-set-0-1.cluster-0.example.com

重要

この設定は、 サービス メトリクスなしで Application Database 配置を配置する場合にのみ使用します。「 サービス メッシュのないマルチクラスター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: 8.0.0
  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に設定します。