MongoDB Ops Managerリソース仕様

外部接続設定

This section describes optional settings related to external connectivity in Ops Manager. For optional external connectivity settings specific to your multi-cluster Ops Manager deployment, see Multi-Cluster Settings.

spec.externalConnectivity

タイプ: コレクション

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

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

spec.externalConnectivity.type

型: string

MongoDB Ops Manager をKubernetesの外部で公開するKubernetesサービス ServiceType 。

Required if spec.externalConnectivity.type is present.

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

spec.externalConnectivity.port

タイプ: 整数

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

• If spec.externalConnectivity.type is NodePort:

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

  • If you don't provide a spec.externalConnectivity.port value, the Kubernetes service routes traffic to the Ops Manager Application from an available port selected randomly from the following default range: 30000-32767.

    注意

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

• If spec.externalConnectivity.type is LoadBalancer:

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

  • If you don't provide a spec.externalConnectivity.port value, the Kubernetes service exposes the Ops Manager Application to external traffic through the default HTTP (8080) or HTTPS (8443) port.

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

タイプ: コレクション

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

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

バックアップ設定

このセクションでは、 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 バックアップ暗号化の構成 」を参照してください。

注意

If you set this parameter, the API key linked with the value of spec.credentials must have the Global Owner role.

spec.backup.encryption.kmip.server

型: オブジェクト

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

spec.backup.encryption.kmip.server.ca

型: string

KMIP 認証に使用する CA 証明書 () のエントリが含まれている ConfigMapca.pem を識別する、人間が判読できるラベル。

spec.backup.encryption.kmip.server.url

型: string

形式を使用する KMIP サーバーの URLhostname.port （例：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オブジェクトとして作成できます。 StorageClass reclaimPolicy を 保持 するように設定します。これにより、永続的なボリューム要求が削除されてもデータが保持されます。

spec.backup.jvmParameters

タイプ: 文字列の配列

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

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

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

警告

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

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

spec.backup.members

タイプ: 整数

Optional. Number of backup daemon services to deploy in Kubernetes. If not specified, defaults to 1. To ensure high availability for your backup service, deploy multiple backup daemons in Ops Manager.

spec.backup.opLogStores

タイプ: コレクション

Required if you enable backup. Array of oplog stores used for backup. Each item in the array references a MongoDB database resource deployed in the Kubernetes cluster by the Kubernetes Operator.

spec.backup.opLogStores.assignmentLabels

タイプ: 文字列の配列

A list of assignment labels for the oplog store. Use assignment labels to identify that specific oplog stores are associated with particular projects. If you set assignment labels using the Kubernetes Operator, the values that you set in the Kubernetes configuration file for assignment labels override the values defined in the Ops Manager UI. Assignment labels that you don't set using the Kubernetes Operator continue to use the values set in the 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 データベースに接続するための ユーザー リソースを作成します。

• Specify the name of the user in the Ops Manager resource definition.

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

タイプ: コレクション

Required if you enable Backup using a blockstore. Array of blockstores used for Backup. Each item in the array references a MongoDB database resource deployed in the Kubernetes cluster by the Kubernetes Operator.

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

• Specify the name of the user in the Ops Manager resource definition.

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

Name of the secret that contains the queryable.pem file from Ops Manager that you will use for accessing and querying backups based on your deployment's TLS requirements.The PEM file contains a public key certificate and its associated private key that are needed to access and run queries on backup snapshots in Ops Manager. To query backups, specify the value for this parameter. If not set, backups are not affected, but you can't query them.

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ポッドのテンプレート。

注意

The Kubernetes Operator doesn't validate the fields you provide in 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

For more information on the hardware, software, and networking requirements for the hosts that run the Ops Manager components, see Ops Manager System Requirements in the Ops Manager Documentation.

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ポッドに属するコンテナのリスト。

To modify the specifications of the backup daemon service container, you must provide the exact name of the container using the name field, as shown in the following example:

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キャパシティー。

The requested value must be less than or equal to 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未満の値ではエラーが発生する可能性があります。

The requested value must be less than or equal to 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 設定

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

To configure custom CA keys, use the ConfigMap with which you configured TLS for your Application Database as described on the TLS-Encrypted Connection (HTTPS) tab of Deploy an Ops Manager Resource. Set spec.applicationDatabase.security.tls.ca to this ConfigMap.

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

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

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

spec.backup.s3OpLogStores.assignmentLabels

タイプ: 文字列の配列

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

spec.backup.s3OpLogStores.customCertificate

タイプ: ブール値

Deprecated. Use spec.backup.s3OpLogStores.customCertificateSecretRefs instead.

AppDB 証明書 ()appdb-ca をユーザーの S3 oplog 保存のカスタム TLS 証明書として使用するかどうかを示すフラグ。デフォルト値は False です。

spec.backup.s3OpLogStores.customCertificateSecretRefs

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

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

Each entry in the list specifies the name and the key. If you specify multiple secrets, Kubernetes Operator uses all the certificates in the specified secrets.

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

spec.backup.s3OpLogStores.customCertificateSecretRefs.name

型: string

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

spec.configuration.mms.mongoDbUsage.defaultUsageType

型: string

The Kubernetes service's default server type.

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

タイプ: ブール値

Flag that enables using AWS IAM roles for service accounts in AWS EKS to configure an S3 oplog 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 oplog store is disabled. To learn more, see IAM roles for service accounts in EKS.

spec.backup.s3OpLogStores.name

型: string

oplog を S3 ストアを使用して保存することが必要です。S3 oplog 保存 (する)の名前。

spec.backup.s3OpLogStores.mongodbResourceRef.name

型: string

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

注意

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

If you omit this setting, you must also omit the spec.backup.s3OpLogStores.mongodbUserRef.name setting. The Kubernetes Operator handles SCRAM user authentication internally.

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

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

• Specify the name of the user in the Ops Manager resource definition.

spec.backup.s3OpLogStores.mongodbUserRef.name

型: string

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

• readWriteAnyDatabase

• dbAdminAnyDatabase

• clusterMonitor

重要

一度指定した`S3` メタデータ oplog 保存ユーザー名の名前は編集しないでください。

spec.backup.s3OpLogStores.s3SecretRef.name

型: string

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

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

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

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

注意

If your endpoint doesn't include a region in its URL, specify the s3RegionOverride field.

spec.backup.s3OpLogStores.s3BucketName

型: string

oplog を S3 ストアを使用して保存することが必要です。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

タイプ: ブール値

Deprecated. Use spec.backup.s3Stores.customCertificateSecretRefs instead.

アプリケーションデータベースの証明書 (appdb-ca) をカスタム TLS 証明書として、お使いの S3 バックアップに対して使用するかどうかを指定するフラグ。デフォルト値は False です。

spec.backup.s3Stores.customCertificateSecretRefs

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

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

Each entry in the list specifies the name and the key. If you specify multiple secrets, Kubernetes Operator uses all the specified secrets.

この設定を指定しない場合、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

oplog を S3 ストアを使用して保存することが必要です。S3 読み取りの名前。

重要

一度指定したら、S3 読み取りの名前を編集しないでください。バックアップが古い名前を使用している場合、この変更は失敗する可能性が高いでしょう。成功させる変更の結果は予測不可能です。

spec.backup.s3Stores.mongodbResourceRef.name

型: string

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

注意

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

If you omit this setting, you must also omit the spec.backup.s3Stores.mongodbUserRef.name setting. The Kubernetes Operator handles SCRAM user authentication internally.

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

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

• Specify the name of the user in the Ops Manager resource definition.

重要

一度指定したら、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

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

• readWriteAnyDatabase

• dbAdminAnyDatabase

• clusterMonitor

重要

一度指定したら、S3 メタデータ読み取りのユーザー名は編集しないでください。

spec.backup.s3Stores.s3SecretRef.name

型: string

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

accessKeyフィールドとsecretKey フィールドを含むシークレットの名前。バックアップデーモンサービスは、これらのフィールドの値を認証情報として使用して、 AWS S3 または S3 と互換性のあるバケットにアクセスします。シークレットにいずれかのキーがない場合、S3 読み取りを構成することはできません。

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

spec.backup.s3Stores.objectLockEnabled

タイプ: ブール値

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

This field is supported only with Ops Manager version 8.0.19 or later. For information about configuring immutable backups in Ops Manager, see Set Immutable Backup.

デフォルト値は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。

注意

If your endpoint doesn't include a region in its URL, specify the s3RegionOverride field.

spec.backup.s3Stores.s3BucketName

型: string

S3 保存 (する)を使用してバックアップを有効にする場合は必須です。スナップショットストアをホストする Amazon Web Services 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

タイプ: 整数

Conditional. The number of Ops Manager members in the Ops Manager cluster in a multi-Kubernetes cluster MongoDB deployment. When you set spec.topology to MultiCluster, you must specify the value for this parameter. Omit this parameter for single-cluster deployments. If you set this parameter to zero, this removes this Ops Manager member cluster from the list of member clusters in the multi-Kubernetes cluster of Ops Manager

spec.topology

型: string

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

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

• MultiClusterを指定した場合

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

  • Specify at least one member cluster on which you want to deploy Ops Manager, using spec.clusterSpecList and its nested spec.clusterSpecList.clusterName and spec.clusterSpecList.members parameters.

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

MongoDB Ops Manager任意設定

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

spec.clusterSpecList

タイプ: コレクション

Conditional. Details of selected Kubernetes member clusters in a multi-Kubernetes cluster where you intend to deploy Ops Manager or Backup Daemon instances. See also the example of the resource specification.

• When you set spec.topology to MultiCluster, you must specify the value for spec.clusterSpecList.members. All other parameters under spec.clusterSpecList are optional.

• When you set spec.topology to SingleCluster, the Kubernetes Operator ignores all parameters under spec.clusterSpecList.

spec.clusterSpecList.clusterName

型: string

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

spec.clusterSpecList.clusterDomain

型: string

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

spec.clusterSpecList.configuration

タイプ: コレクション

Optional. Ops Manager configuration properties that override properties you set in spec.configuration for the specific cluster. See Ops Manager Configuration Settings for property names and descriptions. Each property takes a value of type string. For example, setting these properties allows you to change environment variables that you must pass to Ops Manager and the Backup Daemon in that particular member cluster.

If you omit specifying values, defaults to the values set in spec.configuration.

spec.clusterSpecList.jvmParameters

タイプ: 文字列の配列

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

• If you specify this parameter, its values override the values specified in spec.jvmParameters. For example values, see the example of the resource specification.

• If you omit this parameter, values from the spec.jvmParameters are used for the Ops Manager and Backup Daemon instances in this member cluster.

spec.clusterSpecList.externalConnectivity

タイプ: コレクション

Optional. Configuration object that enables external connectivity to Ops Manager for the specific cluster. This is an override for spec.externalConnectivity for the specific cluster.

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

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

• The Kubernetes Operator doesn't use spec.externalConnectivity values for this member Ops Manager cluster.

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

If you omit this parameter, the Kubernetes Operator uses values from spec.externalConnectivity for this member cluster.

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で指定された値を上書きするバックアップ設定。

• You can set these values only if spec.backup.enabled is set to true.

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

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

  • externalServiceEnabled

  • headDB

  • opLogStores

  • blockStores

  • s3Stores

  • fileSystemStores

  • queryableBackupSecretRef

  • encryption

spec.clusterSpecList[*].backup.members

タイプ: 整数

Optional. Override for spec.backup.members. The number of Backup Daemon instances to deploy in this cluster. if you omit this value or provide a value of 0, the Kubernetes Operator won't deploy Backup Daemon instances in a particular member cluster.

spec.clusterSpecList[*].backup.assignmentLabels

タイプ: 文字列の配列

Optional. Override for spec.backup.assignmentLabels. If specified, the Kubernetes Operator uses the values you specify in this override for all Backup Daemon instances in a particular member cluster. If you omit values for this parameter, the values default to those specified in spec.backup.assignmentLabels for all Backup Daemon instances in a member cluster.

spec.clusterSpecList[*].backup.jvmParameters

タイプ: 文字列の配列

Optional. Override for spec.backup.jvmParameters. Allows you to customize the JVM value for Backup Daemon instances in a particular member cluster.

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クラスターの名前。

重要

You can't convert a single cluster Ops Manager instance to a multi-Kubernetes cluster MongoDB deployment instance by modifying the topology and the clusterSpecList settings in the CRD.

spec.applicationDatabase.clusterSpecList.members

タイプ: 数値

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

spec.applicationDatabase.topology

型: string

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

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

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

• cluster on which you want to deploy the Application Database using the clusterSpecList, clusterName, members parameters.

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

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

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

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

spec.applicationDatabase.clusterSpecList.externalAccess

型: string

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

デフォルトで、各レプリカセットは Kubernetes Pod の 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配置内の各アプリケーション データベース レプリカセット ノードの仕様。

重要

If you set spec.topology to SingleCluster, use spec.applicationDatabase.memberConfig instead of spec.applicationDatabase.clusterSpecList.memberConfig.

The number of elements in the memberConfig list must equal 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

Map of replica set tags for directing read and write operations to specific members of your Application Database replica set.

spec.applicationDatabase.clusterSpecList.memberConfig.votes

タイプ: 数値

Determines whether an Application Database replica set member can vote in an election. Set to 1 to allow the member to vote. Set to 0 to exclude the member from an election.