MongoDB Database リソースの仕様

項目一覧

Common Resource Settings

必須
条件付き
任意
配置固有のリソース設定
スタンドアロン設定
レプリカセット設定
シャーディングされたクラスターの設定
Prometheus 設定
セキュリティ設定
例
StateftSet 設定

注意

このページのMongoDB Ops Managerが表示されている場所では、 Cloud Managerを置き換えることができます。

は、MongoDBEnterprise Kubernetes Operator をKubernetes 作成し、書込み (write) 仕様ファイルから

Kubernetes Operator は、Kubernetes 内の MongoDB 固有のリソースをカスタムリソースとして作成します。

これらのカスタムリソースを管理するには、次のプロセスを使用します。

MongoDBリソース仕様を作成または更新します。
MongoDB Enterprise Kubernetes Operator に指示して、Kubernetes 環境に適用します。その結果、Kubernetes Operator は次のアクションを実行します。
- 定義されたステートメントを作成します、サービス、およびその他の Kubernetes リソース。
- 変更を反映するようにMongoDB Ops Manager配置構成を更新します。

配置タイプ	StateftSets	ステートメントセットのサイズ
スタンドアロン	1	1 Pod
レプリカセット	1	1ポッドメンバーごと
シャーディングされたクラスター	<numberOfShards> + 2	1 `mongos`ポッド、シャード、またはコンフィギュレーションサーバーノードごと

各MongoDBリソースは、 YAMLのオブジェクト仕様を使用して、MongoDB オブジェクト（スタンドアロン、レプリカセット、シャーディングされたクラスター）の特性と設定を定義します。

Common Resource Settings

すべてのリソースタイプでは、次の設定を使用する必要があります。

必須

apiVersion

型: string

MongoDBリソーススキーマのバージョン。

kind

型: string

作成するMongoDBリソースの種類。これをMongoDBに設定します

metadata.name

型: string

作成するMongoDBリソースの名前。

リソース名は 44 文字以下にする必要があります。

spec.credentials

型: string

必須。 シークレット MongoDB Ops ManagerAPIの名前Kubernetes は、Kubernetes Operator がCloud Manager またはと通信するための認証情報として作成MongoDB Ops Manager しました。

認証情報を保持するMongoDB Ops Manager Kubernetes Secretオブジェクトは、作成するリソースと同じ名前空間に存在する必要があります。

重要

演算子がシークレットへの変更を管理

Kubernetes Operator は、シークレットへの変更を追跡し、 MongoDBリソースの状態を調整します。

spec.persistent

タイプ: ブール値

デフォルト: True

警告: コンテナに永続ボリュームへの書込み (write) 権限を付与。Kubernetes 演算子は、 securityContextでfsGroup = 2000 、 runAsUser = 2000 、 runAsNonRoot = trueを設定します。 Kubernetes Operator は、 fsgroupをrunAsUserと等しく設定して、コンテナでメインプロセスを実行するユーザーがボリュームを書込み可能にします。詳細については、「ポッドまたはコンテナのセキュリティコンテキストの構成」を参照してくださいおよび関連するディスカッション（Kubernetes ドキュメント）。リソースを再デプロイしても永続ボリュームの問題が修正されない場合は、 MongoDB サポートにお問い合わせください。

永続的なボリュームを使用しない場合 Disk UsageDisk IOPSProcesses、Deployment 、Metrics チャートは、この配置のデータを確認するときに、ページのタブまたはページのいずれにも表示できません。

spec.type

型: string

作成するMongoDBリソースのタイプ。指定できる値は以下のとおりです。

Standalone
ReplicaSet
ShardedCluster

spec.version

型: string

このMongoDBリソースにインストールした MongoDB のバージョン。

重要

互換性のある MongoDB Server バージョンを選択していることを確認してください。

互換性のあるバージョンは、MongoDB database リソースが使用する基本イメージによって異なります。

注意

この値をデータベースリソース用のMongoDBの新しいバージョンに更新しても、機能の互換性バージョンはアップグレード元のMongoDBバージョンのままになり、必要に応じてダウングレードのオプションが提供されます。機能の互換性バージョンを新しいMongoDBバージョンと一致させるには、 spec.featureCompatibilityVersionを新しいバージョンに、またはAlwaysMatchVersionに手動で設定する必要があります。詳しくは、 spec.featureCompatibilityVersionを参照してください。

条件付き

すべてのリソースは、次のいずれかの設定を使用する必要があります。

spec.opsManager.configMapRef.name

型: string

ConfigMap の名前Cloud Manager またはMongoDB Ops Manager 接続構成の場合。spec.cloudManager.configMapRef.name設定はこの設定のエイリアスであり、代わりに使用できます。

この値は、作成するリソースと同じ名前空間に存在する必要があります。

重要

演算子が ConfigMap への変更を管理

Kubernetes 演算子は、ConfigMap への変更を追跡し、 MongoDBリソースの状態を調整します。

spec.cloudManager.configMapRef.name

型: string

spec.opsManager.configMapRef.nameのエイリアス。

任意

すべてのリソースの種類では、次の設定を使用できます。

metadata.annotations.mongodb.com/v1.architecture

型: string

具体的な配置で使用されるコンテナアーキテクチャを決定します。

実行時に MongoDB バイナリをダウンロードするデフォルトの非静的コンテナ、または
実行時に不変である静的コンテナ（パブリックプレビュー）。

指定できる値は次のとおりです。

static
non-static

apiVersion: mongodb.com/v1
kind: MongoDB
metadata:
  name: my-project
  annotations:
    mongodb.com/v1.architecture: "static"

spec.agent.backupAgent.logRotate

型: オブジェクト

MongoDB Agent がバックアップログをローテーションするしきい値。

spec.agent.backupAgent.logRotate.sizeThresholdMB

タイプ: 整数

MongoDB Agent がログをローテーションする前のバックアップログファイルの最大サイズ（MB 単位）。

spec.agent.backupAgent.logRotate.timeThresholdHrs

タイプ: 整数

MongoDB Agent がバックアップログファイルをローテーションする時間数。

spec.agent.mongod.auditlogRotate

型: オブジェクト

MongoDB プロセスの監査ログローテーション構成を含むオブジェクト。

spec.agent.mongod.auditlogRotate.sizeThresholdMB

タイプ: 数値

MongoDB Agent がログをローテーションする前の監査ログファイルの最大サイズ（MB 単位）。

spec.agent.mongod.auditlogRotate.timeThresholdHrs

タイプ: 整数

MongoDB Agent が監査ログファイルをローテーションする時間数。

spec.agent.mongod.auditlogRotate.numUncompressed

タイプ: 整数

現在のログファイルを含む、非圧縮のままにする監査ログファイルの最大数。

spec.agent.mongod.auditlogRotate.numTotal

タイプ: 整数

MongoDB Ops Managerが保持する監査ログファイルの合計数。この値を設定しない場合、監査ログファイルの合計数はデフォルトで0になります。

spec.agent.mongod.auditlogRotate.percentOfDiskspace

タイプ: 数値

MongoDB Ops Managerがログファイルを保存するために使用できる合計ディスク領域の最大パーセンテージは小数で表されます。この制限を超えた場合、 MongoDB Ops Managerは、この制限を満たすまで圧縮されたログファイルを削除します。 MongoDB Ops Managerは、最も古いログファイルを最初に削除します。

デフォルトは0.02です。

spec.agent.mongod.logRotate

型: オブジェクト

MongoDB Ops ManagerがプロセスのMongoDBログをローテーションするしきい値。

spec.agent.mongod.logRotate.sizeThresholdMB

タイプ: 整数

MongoDB Ops Managerがログファイルをローテーションする前の、個々のログファイルの最大サイズ（MB 単位）。 MongoDB Ops Manager は、このsizeThresholdMBまたはspec.agent.mongod.logRotate.timeThresholdHrsのいずれかに指定された値を満たす場合、ログファイルをすぐにローテーションします。

spec.agent.mongod.logRotate.timeThresholdHrs

タイプ: 整数

次のローテーションまでの個々のログファイルの最大期間（時間単位）。は最後のローテーション以降の時間です。

MongoDB Ops Manager は、ファイルがこのtimeThresholdHrsまたはspec.agent.mongod.logRotate.sizeThresholdMBのいずれかを満たすと、ログファイルをローテーションします。

spec.agent.monitoringAgent.logRotate

型: オブジェクト

MongoDB Agent が監視ログをローテーションするしきい値。

spec.agent.monitoringAgent.logRotate.sizeThresholdMB

タイプ: 整数

MongoDB Agent が監視ログをローテーションする前の、個々のログファイルの最大サイズ（MB 単位）。

spec.agent.monitoringAgent.logRotate.timeThresholdHrs

タイプ: 整数

MongoDB Agent が監視ログをローテーションする時間数。

spec.agent.readinessProbe.environmentVariables

型: オブジェクト

Readness Probe のログファイルを制御するために使用される次の環境変数を構成します。

apiVersion: mongodb.com/v1
kind: MongoDB
metadata:
  name: my-project
spec:
  agent:
    readinessProbe:
      environmentVariables:
        READINESS_PROBE_LOGGER_BACKUPS: 1
        READINESS_PROBE_LOGGER_MAX_SIZE: 10
        READINESS_PROBE_LOGGER_MAX_AGE: 3
        READINESS_PROBE_LOGGER_COMPRESS: true
        MDB_WITH_AGENT_FILE_LOGGING: false
        LOG_FILE_PATH: /var/log/mongodb-mms-automation/readiness.log

spec.featureCompatibilityVersion

型: string

MongoDBのアップグレード後に、以前のメジャーMongoDBバージョンにデフォルト設定されます。

新しいメジャーバージョンへのアップグレードに関連して発生するデータの変更を制限します。例、 MongoDB 5.0からMongoDB 6.0にアップグレードする場合、機能の互換性バージョンは5.0のままになり、必要に応じてダウングレードのオプションが提供されます。

機能の互換性バージョンを新しいMongoDBバージョンと一致させる場合は、 featureCompatibilityVersionを新しいバージョンに手動で設定する必要があります。例、 featureCompatibilityVersion: 6.0 。

または、 AlwaysMatchVersionオプションを有効にすると、アップグレード中に機能の互換性バージョンがMongoDBバージョンと一致するように自動的に更新されます。例、 featureCompatibilityVersion: AlwaysMatchVersion 。

機能の互換性の詳細については、 MongoDBマニュアルのsetFeatureCompatibilityVersionを参照してください。

spec.clusterDomain

型: string

デフォルト: cluster.local

Kubernetes Operator を配置する Kubernetes クラスターのドメイン名。 Kubernetes がステートメントを作成する場合、Kubernetes は各ポッドに割り当てます FQDN 。またはCloud Manager MongoDB Ops Managerを更新するために、Kubernetes 演算子は各ポッドの FQDN を計算します指定されたクラスター名を使用します。Kubernetes では、これらのホスト名をクエリするためのAPIは提供されていません。

警告

Kubernetes クラスターにデフォルトのドメイン spec.clusterDomain がある場合は、を設定する必要がありますデフォルトのcluster.local 以外。デフォルトを使用せず、 spec.clusterDomainオプションも設定しない場合、Kubernetes 演算子が期待どおりに機能しない可能性があります。

spec.clusterName

型: string

デフォルト: cluster.local

重要

spec.clusterName は非推奨

代わりにspec.clusterDomainを使用してください。

警告

metadata.namespace

型: string

Kubernetes 名前空間このMongoDB リソースと他のオブジェクトを作成する場所。

spec.service

型: string

デフォルト: <resource_name>+"-svc" および <resource_name>+"-svc-external"

重要

spec.service は非推奨

代わりにspec.statefulSet.spec.serviceNameを使用してください。

Atlas App Services が作成または使用する Kubernetes サービスの名前。この名前のサービスがすでに存在する場合、MongoDB Enterprise Kubernetes Operator はサービスを削除または再作成しません。この設定により、独自のカスタムサービスを作成し、Kubernetes Operator でそれらを再利用できます。

spec.logLevel

型: string

デフォルト: INFO

ポッド内のオートメーションエージェントのログ記録のレベルを構成します。受け入れ可能な値は以下の通りです。

DEBUG
INFO
WARN
ERROR
FATAL

spec.security.authentication.ignoreUnknownUsers

タイプ: ブール値

デフォルト: false

Kubernetes Operator、またはCloud ManagerまたはMongoDB Ops Managerユーザーインターフェイスを通じて構成されていないデータベースユーザーを変更できるかどうかを決定します。

mongodまたはmongosを使用してデータベースユーザーを直接管理するには、この設定をtrueに設定します。

配置固有のリソース設定

MongoDBリソース仕様で使用できる他の設定と使用する必要がある他の設定は、作成する MongoDB 配置アイテムによって異なります。

スタンドアロン設定
レプリカセット設定
シャーディングされたクラスターの設定

スタンドアロン設定

注意

すべてのスタンドアロン設定はレプリカセットリソースにも適用されます。

spec.additionalMongodConfig

タイプ: コレクション

MongoDB プロセスを開始するための追加構成オプション。

Kubernetes Operator は、MongoDB Agent を通じて配置する MongoDB バージョンがサポートするすべての構成オプションをサポートしています。ただし、Kubernetes Operator は、次のいずれかのオプションに指定した値を上書きします。

Kubernetes Operator が所有する構成オプションの詳細については、「 MongoDB Kubernetes Operator 専用設定」を参照してください。

使用できる構成オプションについては、 MongoDBドキュメントの「配置の詳細オプションMongoDB Ops Manager 」を参照してください。

spec.agent

タイプ: コレクション

MongoDB データベースリソース用の MongoDB Agent 構成設定。

spec.agent.startupOptions

タイプ: コレクション

MongoDB データベースリソースを起動する MongoDB Agent 設定。

MongoDB Agent 設定はキーと値のペアとして提供する必要があります。値は文字列である必要があります。

サポートされている MongoDB Agent 設定のリストについては、以下を参照してください。

Cloud Manager プロジェクトのMongoDB Agent 設定。
OperatorMongoDB Agent を使用して配置したMongoDB Ops Manager バージョンの設定。Kubernetes

1 ---
2 apiVersion: mongodb.com/v1
3 kind: MongoDB
4 metadata:
5   name: my-standalone
6 spec:
7   version: "6.0.0-ent"
8   service: my-service
9 
10   opsManager:
11     configMapRef:
12       name: my-project
13   credentials: my-credentials
14   type: Standalone
15 
16   persistent: true
17   agent:
18     startupOptions:
19       maxLogFiles: "30"
20       dialTimeoutSeconds: "40"
21 ...

spec.podSpec

型: オブジェクト

MongoDB CustomResourceDefinition の仕様を含むオブジェクトポッド。

spec.externalAccess

タイプ: コレクション

クラスターを外部接続用に公開するための仕様。 Kubernetes クラスターの外部から MongoDB リソースに接続する方法については、「 Kubernetes の外部から MongoDB Database リソースに接続する」を参照してください。

spec.externalAccessを追加すると、Kubernetes Operator はレプリカセット内の各ポッドの外部サービスを作成します。外部サービスは、クラスター内の各 MongoDB database ポッドの外部エントリポイントを提供します。各外部サービスにはセレクターがありますは、外部サービスを特定のポッドに一致させます。

値なしでこの設定を追加すると、Kubernetes Operator は次のデフォルト値を持つ外部サービスを作成します。

フィールド	値	説明
`Name`	`<pod-name>-svc-external`	外部サービスの名前。この値は変更できません。
`Type`	`LoadBalancer`	外部 LoadBalancer を作成します service
`Port`	`<Port Number>`	`mongod`のポート。
`publishNotReadyAddress`	`true`	DNS レコードを指定するは、Ped が準備ができていない場合でも作成されます。どのデータベースポッドでも`false`に設定しないでください。

注意

spec.externalAccess.externalDomainを設定すると、外部サービスはバックアップ用の別のポート（ Port Number + 1 ）を追加します。

spec.externalAccess.externalService

タイプ: コレクション

spec.externalAccessのデフォルト値を上書きするための指定。

spec.externalAccess設定を設定すると、Kubernetes Operator はデフォルト値の外部ロードバランサーサービスを自動的に作成します。ニーズに応じて、特定の値を上書きしたり、新しい値を追加したりできます。たとえば、 NodePort サービスを作成しようとすると、で、ロードバランサーが必要ない場合は、Kubernetes 仕様でオーバーライドを構成する必要があります。

externalAccess:
  externalService:
    annotations:
      # cloud-specific annotations for the service
    spec:
      type: NodePort # default is LoadBalancer
      # you can specify other spec overrides if necessary

Kubernetes 仕様の詳細については、 ServiceSpec を参照してください（Kubernetes ドキュメント）。

spec.externalAccess.externalService.annotations

タイプ: コレクション

配置内のすべてのクラスターにクラウドプロバイダー固有の構成設定を追加できるキーと値のペア。詳細については、注釈を参照してください Kubernetes クラウドプロバイダーのドキュメントとドキュメントを参照してください。

注釈を使用できますで、Kubernetes Operator の配置で使用される外部サービスのプレースホルダー値を指定します。Kubernetes Operator は、これらの値を次の表に記載されている正しい値に自動的に置き換えます。プレースホルダーを使用すると、特定のポッドの各サービスに特定の注釈を提供できます。

値	説明
`{resourceName}`	`metadata.name`に等しい。
`{namespace}`	`metadata.namespace`に等しい。
`{podIndex}`	ステートフルセットによって割り当てられたポッドのインデックス現在の外部サービスが対象とすると
`{podName}`	`{resourceName}-{podIndex}`に等しい。
`{statefulSetName}`	ステートメントセット。`{resourceName}`に等しい。
`{externalServiceName}`	指定したプレースホルダー値に基づいて、外部サービスの生成された名前。 `{resourceName}-{podIndex}-svc-external`に等しい。
`{mongodProcessDomain}`	mongod プロセスをホストしているサーバーのドメイン名。指定されている場合は`spec.externalAccess.externalDomain`と等しくなります。それ以外の場合は、 `mongod`プロセスFQDNに使用されるドメインと等しくなります。たとえば、プロセスホスト名`mdb-rs-1.example.com`の場合、 `example.com`はドメイン名になります。
`{mongodProcessFQDN}`	`mongod`オートメーション構成で設定されたプロセスのホスト名。プロセスホスト名は、配置構成によって異なります。 `external domains`を使用するように配置を構成した場合、プロセスホスト名は次の形式を使用します。 `{resourceName}-{podIndex}.{mongodProcessDomain}` 以下に例を挙げます。 `mdb-rs-1.example.com` 配置で外部ドメインを使用しない場合、プロセスホスト名は次の形式を使用します。 `{resourceName}-{podIndex}.{resourceName}-{podIndex}-svc.{namespace}.svc.cluster.local` 以下に例を挙げます。 `mdb-rs-1.mdb-rs-1-svc.ns.svc.cluster.local`

注意

表に指定されている既知のプレースホルダー値のみを使用し、プレースホルダーが空または null 値を使用しないようにする必要があります。また、単一の MongoDB リソース配置では、複数の Kubernetes クラスター配置に固有のプレースホルダーを使用することもできません。

それ以外の場合、Kubernetes Operator はエラーを返します。たとえば、次のエラーメッセージが表示される場合があります。

error replacing placeholders in map with key=external-dns.alpha.kubernetes.io/hostname, value={resourceName}-{podIndex}-{unknownPlaceholder}.{clusterName}-{clusterIndex}.example.com: missing values for the following placeholders: {clusterName}, {clusterIndex}, {unknownPlaceholder}``

例

次の例えでは、 {resourceName} 、 {podIndex} 、 {namespace}プレースホルダーを指定します。

apiVersion: mongodb.com/v1
kind: MongoDB
metadata:
  name: mdb-rs
  namespace: ns
spec:
  replicas: 3
  externalAccess:
    externalService:
      annotations:
        external-dns.alpha.kubernetes.io/hostname: {resourceName}-{podIndex}-{namespace}.example.com

Kubernetes Operator は、各プレースホルダーの適切な値に基づいて、外部サービスの注釈を自動的に入力します。例:

mdb-rs-0-svc-external:
  annotations:
    external-dns.alpha.kubernetes.io/hostname: mdb-rs-0-ns.example.com
mdb-rs-1-svc-external:
  annotations:
    external-dns.alpha.kubernetes.io/hostname: mdb-rs-1-ns.example.com
mdb-rs-2-svc-external:
  annotations:
    external-dns.alpha.kubernetes.io/hostname: mdb-rs-2-ns.example.com

spec.externalAccess.externalService.spec

タイプ: コレクション

ServiceSpec の構成。詳しくは、 spec.externalAccess.externalServiceを参照してください。

spec.podSpec.persistence.single

タイプ: コレクション

Kubernetes Operator が 1 つの永続ボリューム要求を作成するようにしますとでは、データ、ジャーナル、ログの 3 つのすべてのディレクトリが同じ永続ボリュームにマウントされます。。

注意

spec.persistent : trueの場合は、このコレクションに値を設定する必要があります。
このコレクションまたはpersistence.multipleコレクションを設定できますが、両方は設定できません。

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

spec.podSpec.persistence.multiple.data

タイプ: コレクション

Kubernetes Operator が永続的なボリューム要求を作成するようにしますとは、データのディレクトリを独自の永続ボリュームにマウントします。。

注意

spec.persistent : trueの場合は、このコレクションに値を設定する必要があります。
このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
`labelSelector`	string	タグマウントされたボリュームをディレクトリにバインドするために使用されます。
`storage`	string	Kubernetes ノードで使用可能である必要がある最小ストレージ容量から、Kubernetes でスタンドアロン配置をホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。デフォルト値は 16Gi です。たとえば、この`MongoDB`リソースに60ギガバイトのストレージ容量が必要な場合は、この値を`60Gi`に設定します。
`storageClass`	string	スタンドアロン配置に必要なストレージのタイプ。このストレージタイプは、 StorageClass として作成できます。このオブジェクトで使用する前にオブジェクトを仕様。 StorageClass を必ず設定してください保持する`reclaimPolicy` 。これにより、永続的なボリューム要求が発生した場合にデータが保持できますは削除されます。

spec.podSpec.persistence.multiple.journal

タイプ: コレクション

Kubernetes Operator が永続的なボリューム要求を作成するようにしますおよびジャーナル用のディレクトリを独自の永続ボリュームにマウントする。

注意

spec.persistent : trueの場合は、このコレクションに値を設定する必要があります。
このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
`labelSelector`	string	タグマウントされたボリュームをディレクトリにバインドするために使用されます。
`storage`	string	Kubernetes ノードで使用可能である必要がある最小ストレージ容量から、Kubernetes でスタンドアロン配置をホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。デフォルト値は 1Gi です。たとえば、この`MongoDB`リソースに60ギガバイトのストレージ容量が必要な場合は、この値を`60Gi`に設定します。
`storageClass`	string	スタンドアロン配置に必要なストレージのタイプ。このストレージタイプは、 StorageClass として作成できます。このオブジェクトで使用する前にオブジェクトを仕様。 StorageClass を必ず設定してください保持する`reclaimPolicy` 。これにより、永続的なボリューム要求が発生した場合にデータが保持できますは削除されます。

spec.podSpec.persistence.multiple.logs

タイプ: コレクション

Kubernetes Operator が永続的なボリューム要求を作成するようにしますおよびは、ログ用のディレクトリを独自の永続ボリュームにマウントします。。

注意

spec.persistent : trueの場合は、このコレクションに値を設定する必要があります。
このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
`labelSelector`	string	タグマウントされたボリュームをディレクトリにバインドするために使用されます。
`storage`	string	Kubernetes ノードで使用可能である必要がある最小ストレージ容量から、Kubernetes でスタンドアロン配置をホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。デフォルト値は 3Gi です。たとえば、この`MongoDB`リソースに60ギガバイトのストレージ容量が必要な場合は、この値を`60Gi`に設定します。
`storageClass`	string	スタンドアロン配置に必要なストレージのタイプ。このストレージタイプは、 StorageClass として作成できます。このオブジェクトで使用する前にオブジェクトを仕様。 StorageClass を必ず設定してください保持する`reclaimPolicy` 。これにより、永続的なボリューム要求が発生した場合にデータが保持できますは削除されます。

spec.podSpec.podTemplate.affinity.nodeAffinity

型: 構造体

Kubernetes ルール : ポッドを配置する特定の範囲のノード上のレプリカセット用。

読み取りおよび書込みパフォーマンスを最適化するには、ノードのアフィニティルールを使用してノードを制限します特定のノード上でを実行する、または特定のノードでの実行を優先する場合は。

spec.podSpec.podTemplate.affinity.podAffinity

型: 構造体

Kubernetes ルール複数のMongoDB リソースポッドかどうかを判断は他のポッドと同じ場所に配置する必要があります。ユースケースの詳細については、「アフィニティと非アフィニティ」を参照してください。（Kubernetes ドキュメント）。

spec.podSpec.podTemplate.affinity.podAntiAffinity

型: 構造体

Default: kubernetes.io/hostname

ルールMongoDB を設定するポッドを分散するリソースを異なる場所でホストする。ロケーションは、単一のノード、ロック、またはリージョンにすることができます。デフォルトでは、Kubernetes Operator は異なるノードにポッドを分散しようとします。

spec.podSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey

型: 構造体

Default: kubernetes.io/hostname

このキーは、どのラベルを定義しますかどのトポロジードメインを決定するために使用されるかノードが属する。

spec.podSpec.podTemplate

タイプ: コレクション

テンプレート MongoDB Enterprise Kubernetes Operator が MongoDB データベースリソース用に作成する Kubernetes ポッド用。

テンプレート値は、 spec.podSpecで指定された値よりも優先されます。

注意

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

spec.podSpec.podTemplate.metadata

タイプ: コレクション

MongoDB Enterprise Kubernetes Operator が MongoDB database リソース用に作成する Kubernetes ポッドのメタデータ。

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

spec.podSpec.podTemplate.spec

タイプ: コレクション

MongoDB Enterprise Kubernetes Operator が MongoDB データベースリソース用に作成する Kubernetes ポッドの仕様。

spec.podSpec.podTemplate.specに追加できるフィールドを確認するには、Kubernetes PodSpec v1Core API を参照してください。

注意

spec.podSpec.podTemplate.spec.containersにコンテナを追加すると、Kubernetes Operator はそれらを Kubernetes ポッドに追加します。これらのコンテナは、ポッド内の MongoDB database リソースコンテナに追加されます。

この設定を使用して、各ポッドの CPU と RAM の割り当てを指定します。例について Githubは、のサンプルを参照してください。

レプリカセット設定

注意

すべてのスタンドアロン設定はレプリカセットリソースにも適用されます。

レプリカセットのリソースタイプには次の設定が適用されます。

spec.backup

タイプ: コレクション

spec.backup.modeのコレクションコンテナ。Kubernetes Operator で MongoDB リソースの継続的なバックアップを可能にします。

spec.backup.assignmentLabels

タイプ: 配列

バックアップデーモン、oplog ストア、ブロックストア、 S3スナップショットストア、ファイルシステムストアを特定のプロジェクトまたはグループに割り当てるためのラベルのコンマ区切りリスト。割り当てラベルを使用して、特定のバックアップストアが特定のプロジェクトに関連付けられていることを識別します。

Kubernetes Operator を使用して割り当てラベルを設定すると、割り当てラベルのKubernetes構成ファイルで設定した値が、 MongoDB Ops Manager UI で定義された値を上書きします。 Kubernetes Operator を使用して設定しない割り当てラベルは、 MongoDB Ops Manager UI で設定された値を引き続き使用します。

注意

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

spec.backup.mode

型: string

MongoDB リソースの継続的なバックアップを有効にします。指定できる値は、 enabled 、 disabled 、 terminatedです。

注意

spec.backup.modeの設定は、 MongoDB Ops Managerで有効になっているspec.backup.enabled バックアップMongoDB Ops Manager trueに依存します。また、リソース仕様の値がに設定されている必要があります。

spec.backup.modeを使用して MongoDB リソースの継続的なバックアップを有効にすると、バックアップステータスを確認できます。

spec.backup.encryption

型: オブジェクト

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

spec.backup.encryption.kmip

型: オブジェクト

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

spec.backup.encryption.kmip.client

型: オブジェクト

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

spec.backup.encryption.kmip.client.clientCertificatePrefix: 型: string

spec.backup.snapshotSchedule

タイプ: コレクション

Kubernetes Operator の MongoDB リソースの継続的なバックアップのスナップショットスケジュール設定のコレクションコンテナ。

spec.backup.snapshotSchedule.snapshotIntervalHours

タイプ: 数値

スナップショット間の時間数。 6 、 8 、 12 、または24の値を設定できます。

spec.backup.snapshotSchedule.snapshotRetentionDays

タイプ: 数値

最近のスナップショットを保持する日数。 2から5までの値を設定できます。

spec.backup.snapshotSchedule.dailySnapshotRetentionDays

タイプ: 数値

日次スナップショットを保持する日数。 1から365までの値を設定できます。値を0に設定すると、このルールが無効になります。

spec.backup.snapshotSchedule.weeklySnapshotRetentionWeeks

タイプ: 数値

Number of weeks to keep weekly snapshots. 1から52までの値を設定できます。値を0に設定すると、このルールが無効になります。

spec.backup.snapshotSchedule.monthlySnapshotRetentionMonths

タイプ: 数値

月次スナップショットを保持する月数。 1から36までの値を設定できます。値を0に設定すると、このルールが無効になります。

spec.backup.snapshotSchedule.pointInTimeWindowHours

タイプ: 数値

ポイントインタイムスナップショットを作成できる過去の時間数。

spec.backup.snapshotSchedule.referenceHourOfDay

タイプ: 数値

24 時間制でスナップショットをスケジュールする時刻のUTC時間。 0から23までの値を設定できます。

spec.backup.snapshotSchedule.referenceMinuteOfHour

タイプ: 数値

スナップショットをスケジュールする時間のUTC分。 0から59までの値を設定できます。

spec.backup.snapshotSchedule.fullIncrementalDayOfWeek

型: string

MongoDB Ops Managerが完全なスナップショットを取得する曜日。この設定により、最新の完全なバックアップが保証されます。 MongoDB Ops Manager はデフォルト値をSUNDAYに設定します。

spec.clusterName

型: string

デフォルト: cluster.local

重要

spec.clusterName は非推奨

代わりにspec.clusterDomainを使用してください。

警告

spec.connectivity.replicaSetHorizons

タイプ: コレクション

クライアントアプリケーションと MongoDB エージェントに対して異なるDNS設定を提供できます。 Kubernetes Operator は、レプリカセットノードにスプリットホライゾンDNSを使用します。この機能により、Kubernetes クラスター内と Kubernetes 外部からの両方で通信が可能になります。

ホストごとに複数の外部マッピングを追加できます。

スプリットホライゾンの要件:

この配列内の各値が一意であることを確認してください。
この配列内のエントリ数がspec.membersの値と一致していることを確認します。
TLSspec.security.certsSecretPrefix を有効にするには、設定の値を指定します。このメソッドでスプリットホライズンを使用するには、 TLSプロトコルのサーバー名表示拡張機能が必要です。
外部ホスト名のルーティングを構成します。

例

この例では、レプリカセットのメンバーはexample-localhostホライゾンで相互に通信します。クライアントはexample-websiteホライゾンを使用してレプリカセットと通信します。

1 ---
2 apiVersion: mongodb.com/v1
3 kind: MongoDB
4 metadata:
5   name: <my-replica-set>
6 spec:
7   members: 3
8   version: "4.2.2-ent"
9   type: ReplicaSet
10   opsManager:
11     configMapRef:
12       name: <configMap.metadata.name>
13   credentials: <mycredentials>
14   persistent: true

15   security:
16     tls:
17       enabled: true
18   connectivity:
19     replicaSetHorizons:
20       - "example-website": "web1.example.com:30907"
21       - "example-website": "web2.example.com:32350"
22       - "example-website": "web3.example.com:31185"
23 ...

spec.externalAccess.externalDomain

型: string

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

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

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

以下に例を挙げます。

replica-set-1.example.com

この設定でレプリカセットを配置すると、 Kubernetes Operator は外部ドメインを含むホスト名を使用して、 MongoDB Ops Managerオートメーション構成の processes[n].hostname フィールドを上書きします。次に、MongoDB Agent はこのホスト名を使用してmongodに接続します。

レプリカセットに接続するための他のホスト名を指定するには、 spec.connectivity.replicaSetHorizons設定を使用できます。ただし、次の接続では、外部ドメインを含むホスト名は引き続き使用されます。

mongodに接続する MongoDB Agent
mongodを使用して他のmongodインスタンスに接続します。

警告:このフィールドを指定すると、 MongoDB Ops Managerがmongodプロセスを登録する方法が変更されます。このフィールドは、Kubernetes Operator バージョン1.19以降の新しいレプリカセット配置でのみ指定できます。実行中のレプリカセット配置のMongoDB Ops Manager自動化構成で、このフィールドまたは任意の processes[n].hostname フィールドの値を変更することはできません。

spec.members

タイプ: 整数

必須。レプリカセットのノード数。

spec.memberConfig

タイプ: コレクション

MongoDBリソースから配置された各 MongoDB レプリカセットノードの仕様。

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

例

3 つのノードからなるレプリカセットの次の仕様例を検討してみましょう。

spec:
  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.5"
      tags:
        tag2: "value2"
        environment: "prod"

spec.memberConfig.priority

型: string

MongoDB レプリカセットがプライマリになる相対的な可能性を示す数値。

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

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

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

spec.memberConfig.tags

タイプ: map

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

spec.memberConfig.votes

タイプ: 数値

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

次の設定はレプリカセットのリソースタイプにのみ適用されます。

spec.backup.autoTerminateOnDeletion

タイプ: ブール値

MongoDB リソースを削除するときに Kubernetes Operator がバックアップを停止して終了するかどうかを制御するフラグ。省略した場合、デフォルト値はfalseです。このフラグをtrueに設定すると、 spec.backup.mode設定がenabledに設定されているときに MongoDB カスタムリソースを削除する場合に便利です。

シャーディングされたクラスターの設定

注意

すべてのレプリカセット設定は、特に指定がない限り、シャーディングされたクラスターリソースにも適用されます。

次の設定は、シャーディングされたクラスターのリソースタイプにのみ適用されます。

spec.backup.snapshotSchedule.clusterCheckpointIntervalMin

タイプ: 数値

連続するクラスターチェックポイント間の分数。この設定は、 MongoDBを機能の互換性バージョン4.0またはそれ以前のバージョンで実行するシャーディングされたクラスターにのみ適用されます。この数値により、シャーディングされたクラスターのポイントインタイム復元の粒度が決まります。 15 、 30 、または60の値を設定できます。

spec.configServerCount

タイプ: 整数

必須。コンフィギュレーションサーバー内のメンバーの数。

spec.configSrv.additionalMongodConfig

タイプ: コレクション

各コンフィギュレーションサーバーノードを起動するための追加構成オプション。

Kubernetes Operator が所有する構成オプションの詳細については、「 MongoDB Kubernetes Operator 専用設定」を参照してください。

使用できる構成オプションについては、 MongoDBドキュメントの「配置の詳細オプションMongoDB Ops Manager 」を参照してください。

spec.configSrv.agent

タイプ: コレクション

各コンフィギュレーションサーバーノードの MongoDB Agent 構成設定。

spec.configSrv.agent.startupOptions

タイプ: コレクション

各コンフィギュレーションサーバーノードを起動する MongoDB Agent 設定。

MongoDB Agent 設定はキーと値のペアとして提供する必要があります。値は文字列である必要があります。

サポートされている MongoDB Agent 設定のリストについては、以下を参照してください。

Cloud Manager プロジェクトのMongoDB Agent 設定。
OperatorMongoDB Agent を使用して配置したMongoDB Ops Manager バージョンの設定。Kubernetes

1 ---
2 apiVersion: mongodb.com/v1
3 kind: MongoDB
4 metadata:
5   name: my-sharded-cluster-options
6 spec:
7   version: "6.0.0-ent"
8   type: ShardedCluster
9   opsManager:
10     configMapRef:
11       name: my-project
12   credentials: my-credentials
13   persistent: true
14   shardCount: 2
15   mongodsPerShardCount: 3
16   mongosCount: 2
17   configServerCount: 1
18 
19   mongos:
20     agent:
21       startupOptions:
22         maxLogFiles: "30"
23 
24   configSrv:
25      agent:
26        startupOptions:
27          dialTimeoutSeconds: "40"
28   shard:
29      agent:
30        startupOptions:
31          serverSelectionTimeoutSeconds: "20"
32 ...

spec.configSrvPodSpec

型: オブジェクト

MongoDB CustomResourceDefinition の仕様を含むオブジェクトコンフィギュレーションサーバーポッド。

spec.configSrvPodSpec.persistence.single

タイプ: コレクション

注意

spec.persistent : trueの場合は、このコレクションに値を設定する必要があります。
このコレクションまたはpersistence.multipleコレクションを設定できますが、両方は設定できません。

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

spec.configSrvPodSpec.persistence.multiple.data

タイプ: コレクション

Kubernetes Operator が永続的なボリューム要求を作成するようにしますとは、データのディレクトリを独自の永続ボリュームにマウントします。。

注意

spec.persistent : trueの場合は、このコレクションに値を設定する必要があります。
このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
`labelSelector`	string	タグマウントされたボリュームをディレクトリにバインドするために使用されます。
`storage`	string	Kubernetes ノードで使用可能である必要がある最小ストレージ容量は、Kubernetes で各コンフィギュレーションサーバーノードをホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。デフォルト値は 16Gi です。たとえば、この`MongoDB`リソースに60ギガバイトのストレージ容量が必要な場合は、この値を`60Gi`に設定します。
`storageClass`	string	各コンフィギュレーションサーバーノードに必要なストレージのタイプ。このストレージタイプは、 StorageClass として作成できます。このオブジェクトで使用する前にオブジェクトを仕様。 StorageClass を必ず設定してください保持する`reclaimPolicy` 。これにより、永続的なボリューム要求が発生した場合にデータが保持できますは削除されます。

spec.configSrvPodSpec.persistence.multiple.journal

タイプ: コレクション

Kubernetes Operator が永続的なボリューム要求を作成するようにしますおよびジャーナル用のディレクトリを独自の永続ボリュームにマウントする。

注意

spec.persistent : trueの場合は、このコレクションに値を設定する必要があります。
このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
`labelSelector`	string	タグマウントされたボリュームをディレクトリにバインドするために使用されます。
`storage`	string	Kubernetes ノードで使用可能である必要がある最小ストレージ容量は、Kubernetes で各コンフィギュレーションサーバーノードをホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。デフォルト値は 1Gi です。たとえば、この`MongoDB`リソースに60ギガバイトのストレージ容量が必要な場合は、この値を`60Gi`に設定します。
`storageClass`	string	各コンフィギュレーションサーバーノードに必要なストレージのタイプ。このストレージタイプは、 StorageClass として作成できます。このオブジェクトで使用する前にオブジェクトを仕様。 StorageClass を必ず設定してください保持する`reclaimPolicy` 。これにより、永続的なボリューム要求が発生した場合にデータが保持できますは削除されます。

spec.configSrvPodSpec.persistence.multiple.logs

タイプ: コレクション

Kubernetes Operator が永続的なボリューム要求を作成するようにしますおよびは、ログ用のディレクトリを独自の永続ボリュームにマウントします。。

注意

spec.persistent : trueの場合は、このコレクションに値を設定する必要があります。
このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
`labelSelector`	string	タグマウントされたボリュームをディレクトリにバインドするために使用されます。
`storage`	string	Kubernetes ノードで使用可能である必要がある最小ストレージ容量は、Kubernetes で各コンフィギュレーションサーバーノードをホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。デフォルト値は 3Gi です。たとえば、この`MongoDB`リソースに60ギガバイトのストレージ容量が必要な場合は、この値を`60Gi`に設定します。
`storageClass`	string	各コンフィギュレーションサーバーノードに必要なストレージのタイプ。このストレージタイプは、 StorageClass として作成できます。このオブジェクトで使用する前にオブジェクトを仕様。 StorageClass を必ず設定してください保持する`reclaimPolicy` 。これにより、永続的なボリューム要求が発生した場合にデータが保持できますは削除されます。

spec.configSrvPodSpec.podTemplate

タイプ: コレクション

テンプレート MongoDB Enterprise Kubernetes Operator が各コンフィギュレーションサーバーノードに対して作成する Kubernetes ポッド用。

テンプレート値は、 spec.configSrvPodSpecで指定された値よりも優先されます。

注意

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

spec.configSrvPodSpec.podTemplate.affinity.podAffinity

タイプ: コレクション

spec.configSrvPodSpec.podTemplate.affinity.nodeAffinity

タイプ: コレクション

Kubernetes ルール : ポッドを配置する特定の範囲のノード上のレプリカセット用。

spec.configSrvPodSpec.podTemplate.affinity.podAntiAffinity

型: string

Default: kubernetes.io/hostname

spec.configSrvPodSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey

型: string

Default: kubernetes.io/hostname

このキーは、どのラベルを定義しますかどのトポロジードメインを決定するために使用されるかノードが属する。

spec.configSrvPodSpec.podTemplate.metadata

タイプ: コレクション

MongoDB Enterprise Kubernetes Operator が各コンフィギュレーションサーバーノードに対して作成する Kubernetes ポッドのメタデータ。

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

spec.configSrvPodSpec.podTemplate.spec

タイプ: コレクション

MongoDB Enterprise Kubernetes Operator が各コンフィギュレーションサーバーノードに対して作成する Kubernetes ポッドの仕様。

spec.configSrvPodSpec.podTemplate.specに追加できるフィールドを確認するには、Kubernetes PodSpec v1Core API を参照してください。

注意

spec.configSrvPodSpec.podTemplate.spec.containersにコンテナを追加すると、Kubernetes Operator はそれらを Kubernetes ポッドに追加します。これらのコンテナは、ポッド内の各コンフィギュレーションサーバーノードコンテナに追加されます。

この設定を使用して、各ポッドの CPU と RAM の割り当てを指定します。例について Githubは、のサンプルを参照してください。

spec.mongodsPerShardCount

タイプ: 整数

必須。シャードあたりのメンバー数。

spec.mongosCount

タイプ: 整数

必須。シャーディングされた mongosクラスター内のインスタンスの数。

spec.mongos.additionalMongodConfig

タイプ: コレクション

各 mongos インスタンスを起動するための追加構成オプション。

Kubernetes Operator が所有する構成オプションの詳細については、「 MongoDB Kubernetes Operator 専用設定」を参照してください。

使用できる構成オプションについては、 MongoDBドキュメントの「配置の詳細オプションMongoDB Ops Manager 」を参照してください。

spec.mongos.agent

タイプ: コレクション

各mongosインスタンスの MongoDB Agent 構成設定。

spec.mongos.agent.startupOptions

タイプ: コレクション

各mongosインスタンスの起動に使用する MongoDB Agent 設定。

MongoDB Agent 設定はキーと値のペアとして提供する必要があります。値は文字列である必要があります。

サポートされている MongoDB Agent 設定のリストについては、以下を参照してください。

Cloud Manager プロジェクトのMongoDB Agent 設定。
OperatorMongoDB Agent を使用して配置したMongoDB Ops Manager バージョンの設定。Kubernetes

1 ---
2 apiVersion: mongodb.com/v1
3 kind: MongoDB
4 metadata:
5   name: my-sharded-cluster-options
6 spec:
7   version: "6.0.0-ent"
8   type: ShardedCluster
9   opsManager:
10     configMapRef:
11       name: my-project
12   credentials: my-credentials
13   persistent: true
14   shardCount: 2
15   mongodsPerShardCount: 3
16   mongosCount: 2
17   configServerCount: 1
18 
19   mongos:
20     agent:
21       startupOptions:
22         maxLogFiles: "30"
23 
24   configSrv:
25      agent:
26        startupOptions:
27          dialTimeoutSeconds: "40"
28   shard:
29      agent:
30        startupOptions:
31          serverSelectionTimeoutSeconds: "20"
32 ...

spec.mongosPodSpec

型: オブジェクト

MongoDB CustomResourceDefinition の仕様を含むオブジェクト mongos ポッド。

spec.mongosPodSpec.podTemplate

タイプ: コレクション

テンプレート MongoDB Enterprise Kubernetes Operator が各インスタンスに対して作成する Kubernetesmongos ポッドの場合、

テンプレート値は、 spec.mongosPodSpecで指定された値よりも優先されます。

注意

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

spec.mongosPodSpec.podTemplate.affinity.podAffinity

タイプ: コレクション

任意。 Kubernetes ルール複数のMongoDB リソースポッドかどうかを判断するは他のポッドと同じ場所に配置する必要があります。

spec.mongosPodSpec.podTemplate.affinity.nodeAffinity

タイプ: コレクション

Kubernetes ルール : ポッドを配置する特定の範囲のノード上のレプリカセット用。

spec.mongosPodSpec.podTemplate.affinity.podAntiAffinity

型: string

Default: kubernetes.io/hostname

spec.mongosPodSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey

型: string

Default: kubernetes.io/hostname

このキーは、どのラベルを定義しますかどのトポロジードメインを決定するために使用されるかノードが属する。

spec.mongosPodSpec.podTemplate.metadata

タイプ: コレクション

MongoDB Enterprise Kubernetes Operator が各mongosインスタンスに対して作成する Kubernetes ポッドのメタデータ。

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

spec.mongosPodSpec.podTemplate.spec

タイプ: コレクション

MongoDB Enterprise Kubernetes Operator が各mongosインスタンスに対して作成する Kubernetes ポッドの仕様。

spec.mongosPodSpec.podTemplate.specに追加できるフィールドを確認するには、Kubernetes PodSpec v1Core API を参照してください。

注意

spec.mongosPodSpec.podTemplate.spec.containersにコンテナを追加すると、Kubernetes Operator はそれらを Kubernetes ポッドに追加します。これらのコンテナは、ポッド内の各mongosインスタンスコンテナに追加されます。

この設定を使用して、各ポッドの CPU と RAM の割り当てを指定します。例について Githubは、のサンプルを参照してください。

spec.shardCount

タイプ: 整数

必須。シャーディングされたクラスター内のシャードの数。

spec.shard.additionalMongodConfig

タイプ: コレクション

各シャーディングされたクラスターのシャードノードを起動するための追加構成オプション。

Kubernetes Operator が所有する構成オプションの詳細については、「 MongoDB Kubernetes Operator 専用設定」を参照してください。

使用できる構成オプションについては、 MongoDBドキュメントの「配置の詳細オプションMongoDB Ops Manager 」を参照してください。

spec.shard.agent

タイプ: コレクション

各シャーディングされたクラスターのシャードノードの MongoDB Agent の構成設定。

spec.shard.agent.startupOptions

タイプ: コレクション

各シャーディングされたクラスターのシャードノードを起動する MongoDB Agent 設定。

MongoDB Agent 設定はキーと値のペアとして提供する必要があります。値は文字列である必要があります。

サポートされている MongoDB Agent 設定のリストについては、以下を参照してください。

Cloud Manager プロジェクトのMongoDB Agent 設定。
OperatorMongoDB Agent を使用して配置したMongoDB Ops Manager バージョンの設定。Kubernetes

1 ---
2 apiVersion: mongodb.com/v1
3 kind: MongoDB
4 metadata:
5   name: my-sharded-cluster-options
6 spec:
7   version: "6.0.0-ent"
8   type: ShardedCluster
9   opsManager:
10     configMapRef:
11       name: my-project
12   credentials: my-credentials
13   persistent: true
14   shardCount: 2
15   mongodsPerShardCount: 3
16   mongosCount: 2
17   configServerCount: 1
18 
19   mongos:
20     agent:
21       startupOptions:
22         maxLogFiles: "30"
23 
24   configSrv:
25      agent:
26        startupOptions:
27          dialTimeoutSeconds: "40"
28   shard:
29      agent:
30        startupOptions:
31          serverSelectionTimeoutSeconds: "20"
32 ...

spec.shardPodSpec

型: オブジェクト

MongoDB CustomResourceDefinition の仕様を含むオブジェクトシャードポッド。

spec.shardPodSpec.persistence.single

タイプ: コレクション

注意

spec.persistent : trueの場合は、このコレクションに値を設定する必要があります。
このコレクションまたはpersistence.multipleコレクションを設定できますが、両方は設定できません。

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

spec.shardPodSpec.persistence.multiple.data

タイプ: コレクション

Kubernetes Operator が永続的なボリューム要求を作成するようにしますとは、データのディレクトリを独自の永続ボリュームにマウントします。。

注意

spec.persistent : trueの場合は、このコレクションに値を設定する必要があります。
このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
`labelSelector`	string	タグマウントされたボリュームをディレクトリにバインドするために使用されます。
`storage`	string	Kubernetes ノードで使用可能である必要がある最小ストレージ容量各シャーディングされたクラスターのシャードノードを Kubernetes でホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。デフォルト値は 16Gi です。たとえば、この`MongoDB`リソースに60ギガバイトのストレージ容量が必要な場合は、この値を`60Gi`に設定します。
`storageClass`	string	各シャーディングされたクラスターのシャードノードに必要なストレージのタイプ。このストレージタイプは、 StorageClass として作成できます。このオブジェクトで使用する前にオブジェクトを仕様。 StorageClass を必ず設定してください保持する`reclaimPolicy` 。これにより、永続的なボリューム要求が発生した場合にデータが保持できますは削除されます。

spec.shardPodSpec.persistence.multiple.journal

タイプ: コレクション

Kubernetes Operator が永続的なボリューム要求を作成するようにしますおよびジャーナル用のディレクトリを独自の永続ボリュームにマウントする。

注意

spec.persistent : trueの場合は、このコレクションに値を設定する必要があります。
このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
`labelSelector`	string	タグマウントされたボリュームをディレクトリにバインドするために使用されます。
`storage`	string	Kubernetes ノードで使用可能である必要がある最小ストレージ容量各シャーディングされたクラスターのシャードノードを Kubernetes でホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。デフォルト値は 1Gi です。たとえば、この`MongoDB`リソースに60ギガバイトのストレージ容量が必要な場合は、この値を`60Gi`に設定します。
`storageClass`	string	各シャーディングされたクラスターのシャードノードに必要なストレージのタイプ。このストレージタイプは、 StorageClass として作成できます。このオブジェクトで使用する前にオブジェクトを仕様。 StorageClass を必ず設定してください保持する`reclaimPolicy` 。これにより、永続的なボリューム要求が発生した場合にデータが保持できますは削除されます。

spec.shardPodSpec.persistence.multiple.logs

タイプ: コレクション

Kubernetes Operator が永続的なボリューム要求を作成するようにしますおよびは、ログ用のディレクトリを独自の永続ボリュームにマウントします。。

注意

spec.persistent : trueの場合は、このコレクションに値を設定する必要があります。
このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
`labelSelector`	string	タグマウントされたボリュームをディレクトリにバインドするために使用されます。
`storage`	string	Kubernetes ノードで使用可能である必要がある最小ストレージ容量各シャーディングされたクラスターのシャードノードを Kubernetes でホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。デフォルト値は 3Gi です。たとえば、この`MongoDB`リソースに60ギガバイトのストレージ容量が必要な場合は、この値を`60Gi`に設定します。
`storageClass`	string	各シャーディングされたクラスターのシャードノードに必要なストレージのタイプ。このストレージタイプは、 StorageClass として作成できます。このオブジェクトで使用する前にオブジェクトを仕様。 StorageClass を必ず設定してください保持する`reclaimPolicy` 。これにより、永続的なボリューム要求が発生した場合にデータが保持できますは削除されます。

spec.shardPodSpec.podTemplate

タイプ: コレクション

テンプレート MongoDB Enterprise Kubernetes Operator が各シャーディングされたクラスターのシャードノードに対して作成する Kubernetes ポッド用。

テンプレート値は、 spec.shardPodSpecで指定された値よりも優先されます。

注意

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

spec.shardPodSpec.podTemplate.affinity.podAffinity

型: string

spec.shardPodSpec.podTemplate.affinity.nodeAffinity

型: string

Kubernetes ルール : ポッドを配置する特定の範囲のノード上のレプリカセット用。

spec.shardPodSpec.podTemplate.affinity.podAntiAffinity

型: string

Default: kubernetes.io/hostname

spec.shardPodSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey

型: string

Default: kubernetes.io/hostname

このキーは、どのラベルを定義しますかどのトポロジードメインを決定するために使用されるかノードが属する。

spec.shardPodSpec.podTemplate.metadata

タイプ: コレクション

MongoDB Enterprise Kubernetes Operator が各シャーディングされたクラスターのシャードノードに対して作成する Kubernetes ポッドのメタデータ。

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

spec.shardPodSpec.podTemplate.spec

タイプ: コレクション

MongoDB Enterprise Kubernetes Operator が各シャーディングされたクラスターのシャードノードに対して作成する Kubernetes ポッドの仕様。

spec.shardPodSpec.podTemplate.specに追加できるフィールドを確認するには、Kubernetes PodSpec v1Core API を参照してください。

注意

spec.shardPodSpec.podTemplate.spec.containersにコンテナを追加すると、Kubernetes Operator はそれらを Kubernetes ポッドに追加します。これらのコンテナは、ポッド内の各シャーディングされたクラスターのシャードノードのコンテナに追加されます。

この設定を使用して、各ポッドの CPU と RAM の割り当てを指定します。例について Githubは、のサンプルを参照してください。

spec.shardSpecificPodSpec

タイプ: 配列

ステートメントを含むリストは、シャードごとに上書きします。

spec.shardSpecificPodSpec.persistence.single

タイプ: コレクション

注意

spec.persistent : trueの場合は、このコレクションに値を設定する必要があります。
このコレクションまたはpersistence.multipleコレクションを設定できますが、両方は設定できません。

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

spec.shardSpecificPodSpec.persistence.multiple.data

タイプ: コレクション

Kubernetes Operator が永続的なボリューム要求を作成するようにしますとは、データのディレクトリを独自の永続ボリュームにマウントします。。

注意

spec.persistent : trueの場合は、このコレクションに値を設定する必要があります。
このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
`labelSelector`	string	タグマウントされたボリュームをディレクトリにバインドするために使用されます。
`storage`	string	Kubernetes ノードで使用可能である必要がある最小ストレージ容量「」を使用して、Kubernetes で特定のシャードをホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。デフォルト値は 16Gi です。たとえば、この`MongoDB`リソースに60ギガバイトのストレージ容量が必要な場合は、この値を`60Gi`に設定します。
`storageClass`	string	特定のシャードに必要なストレージのタイプ。このストレージタイプは、 StorageClass として作成できます。このオブジェクトで使用する前にオブジェクトを仕様。 StorageClass を必ず設定してください保持する`reclaimPolicy` 。これにより、永続的なボリューム要求が発生した場合にデータが保持できますは削除されます。

spec.shardSpecifcPodSpec.persistence.multiple.journal

タイプ: コレクション

Kubernetes Operator が永続的なボリューム要求を作成するようにしますおよびジャーナル用のディレクトリを独自の永続ボリュームにマウントする。

注意

spec.persistent : trueの場合は、このコレクションに値を設定する必要があります。
このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
`labelSelector`	string	タグマウントされたボリュームをディレクトリにバインドするために使用されます。
`storage`	string	Kubernetes ノードで使用可能である必要がある最小ストレージ容量「」を使用して、Kubernetes で特定のシャードをホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。デフォルト値は 1Gi です。たとえば、この`MongoDB`リソースに60ギガバイトのストレージ容量が必要な場合は、この値を`60Gi`に設定します。
`storageClass`	string	特定のシャードに必要なストレージのタイプ。このストレージタイプは、 StorageClass として作成できます。このオブジェクトで使用する前にオブジェクトを仕様。 StorageClass を必ず設定してください保持する`reclaimPolicy` 。これにより、永続的なボリューム要求が発生した場合にデータが保持できますは削除されます。

spec.shardSpecificPodSpec.persistence.multiple.logs

タイプ: コレクション

Kubernetes Operator が永続的なボリューム要求を作成するようにしますおよびは、ログ用のディレクトリを独自の永続ボリュームにマウントします。。

注意

spec.persistent : trueの場合は、このコレクションに値を設定する必要があります。
このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
`labelSelector`	string	タグマウントされたボリュームをディレクトリにバインドするために使用されます。
`storage`	string	Kubernetes ノードで使用可能である必要がある最小ストレージ容量「」を使用して、Kubernetes で特定のシャードをホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。デフォルト値は 3Gi です。たとえば、この`MongoDB`リソースに60ギガバイトのストレージ容量が必要な場合は、この値を`60Gi`に設定します。
`storageClass`	string	特定のシャードに必要なストレージのタイプ。このストレージタイプは、 StorageClass として作成できます。このオブジェクトで使用する前にオブジェクトを仕様。 StorageClass を必ず設定してください保持する`reclaimPolicy` 。これにより、永続的なボリューム要求が発生した場合にデータが保持できますは削除されます。

spec.shardSpecificPodSpec.podTemplate

タイプ: コレクション

テンプレート MongoDB Enterprise Kubernetes Operator が特定のシャードに対して作成する Kubernetes ポッド用。

テンプレート値は、 spec.shardSpecificPodSpecで指定された値よりも優先されます。

注意

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

spec.shardSpecificPodSpec.podTemplate.affinity.podAffinity

型: string

spec.shardSpecificPodSpec.podTemplate.affinity.podAntiAffinity

型: string

Default: kubernetes.io/hostname

spec.shardSpecificPodSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey

型: string

Default: kubernetes.io/hostname

このキーは、どのラベルを定義しますかどのトポロジードメインを決定するために使用されるかノードが属する。

spec.shardSpecificPodSpec.podTemplate.metadata

タイプ: コレクション

MongoDB Enterprise Kubernetes Operator が特定のシャードに対して作成する Kubernetes ポッドのメタデータ。

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

spec.shardSpecificPodSpec.podTemplate.spec

タイプ: コレクション

MongoDB Enterprise Kubernetes Operator が特定のシャードに対して作成する Kubernetes ポッドの仕様。

spec.shardSpecificPodSpec.podTemplate.specに追加できるフィールドを確認するには、Kubernetes PodSpec v1Core API を参照してください。

注意

spec.shardSpecificPodSpec.podTemplate.spec.containersにコンテナを追加すると、Kubernetes Operator はそれらを Kubernetes ポッドに追加します。これらのコンテナは、ポッド内の特定のシャードコンテナに追加されます。

この設定を使用して、各ポッドの CPU と RAM の割り当てを指定します。例について Githubは、のサンプルを参照してください。

Prometheus 設定

Prometheus は、スタンドアロンリソース、レプリカセット、またはシャーディングされたクラスターで使用できます。詳細については、「 Prometheus で使用するリソースの配置」を参照してください。例については、「 Prometheus と MongoDB リソース」を参照してください。

MongoDB リソースで Prometheus を使用する場合、次の設定が適用されます。

spec.prometheus

タイプ: 配列

任意

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

spec.prometheus.metricsPath

型: string

任意

デフォルト: "/metrics"

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

spec.prometheus.passwordSecretRef

型: オブジェクト

条件付き

シークレットの詳細を含むオブジェクト基本的な HTTP 認証用。MongoDB リソースで Prometheus を使用する場合は、この設定を指定する必要があります。

spec.prometheus.passwordSecretRef.key

型: string

任意

デフォルト: "password"

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

spec.prometheus.passwordSecretRef.name

型: string

条件付き

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

spec.prometheus.port

タイプ: 整数

任意

デフォルト: 9216

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

spec.prometheus.tlseSecretKeyRef

型: オブジェクト

任意

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

spec.prometheus.tlseSecretKeyRef.key

型: string

任意

デフォルト: "password"

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

spec.prometheus.tlseSecretKeyRef.name

型: string

条件付き

秘密を識別する、人間が判読可能なラベル TLS 認証用のパスワードを含むMongoDB リソースで Prometheus を使用し、 TLS認証を使用する場合は、この設定を指定する必要があります。

spec.prometheus.username

型: string

条件付き

基本的な HTTP 認証のユーザーを識別する、人間が判読可能なラベル。 MongoDB リソースで Prometheus を使用する場合は、この設定を指定する必要があります。

セキュリティ設定

次のセキュリティ設定は、レプリカセットとシャーディングされたクラスターのリソースタイプにのみ適用されます。

spec.security.tls.enabled

タイプ: ブール値

デフォルト: false

重要

spec.security.tls.enabledは Kubernetes Operator バージョン1.19以降非推奨です。 TLSを有効にするには、 spec.security.certsSecretPrefix設定の値を指定します。

TLS 証明書を使用して以下の間の通信を暗号化します。

レプリカセットまたはシャーディングされたクラスター構成内の MongoDB ホスト
クライアント（ mongo shell、ドライバー、 MongoDB Compassなど）と MongoDB の配置

デフォルトでは、 net.ssl.modeはrequireSSLに設定されています。クライアントとデータベース接続に使用されるTLSモードを変更するには、 spec.additionalMongodConfig.net.ssl.modeを参照してください。

spec.security.tls.ca

型: string

ConfigMap の名前を指定するMongoDB これはリソースの CA を保存します。

重要

カスタムCAを使用してMongoDBリソースのTLS証明書に署名する場合は、このパラメータを指定する必要があります。

Kubernetes Operator では、ConfigMap でMongoDBリソース証明書ca-pemに名前を付ける必要があります。

spec.security.certsSecretPrefix

型: string

Kubernetes シークレットのプレフィックスへのテキストレプリカセットのまたはシャーディングされたクラスターの TLS キーと証明書を含むを作成した

シークレットの前に<prefix>-<metadata.name>を付ける必要があります。

たとえば、配置をmy-deployment mdbと呼び出し、プレフィックスをに設定する場合は、クライアント TLS 通信の TLS シークレットにmdb-my-deployment-cert という名前を付ける必要があります。また、内部クラスター認証用のTLSシークレット（有効になっている場合） mdb-my-deployment-clusterfileに名前を付ける必要があります。

TLS証明書を含むシークレットの名前の詳細については、配置に適用される「レプリカセットの配置」のトピックを参照してください。

spec.security.tls.additionalCertificateDomains

タイプ: ブール値

この配置内の各ポッドへのTLS証明書に追加する必要があるすべてのドメインのリスト。このパラメーターを設定すると、Kubernetes Operator が TLS 証明書に変換するすべての CSR に、形式の SAN が含まれ<pod name>.<additional cert domain> 。

レプリカセットリソースには、このパラメーターは必要ありません。 Use spec.connectivity.replicaSetHorizons instead.

注意

このパラメータをTLS対応のリソースに追加すると、リソースがPending状態に達したときに Kubernetes にエラーが表示されます。このエラーは表示されます。 Please manually remove the |csr| in order to proceed.この問題を解決するには、以下の手順を行います。

Kubernetes が新しい CSR を生成できるように、既存の CSR を削除します。リソースを削除する方法については、リソースの削除を参照してください。（Kubernetes ドキュメント）。
Kubernetes が CSR を生成した後に、 CSRを承認します。

spec.additionalMongodConfig.net.ssl.mode

型: string

デフォルト: requireSSL

ネットワーク接続に使用するsslModeを指定します。以下は有効なオプションです。

値	説明
`allowSSL`	サーバー間の接続ではTLSは使用されません。着信接続の場合、サーバーではTLSと非 TLS のいずれも受け付けます。
`preferSSL`	サーバー間の接続ではTLSが使用されます。着信接続の場合、サーバーではTLSと非 TLS のいずれも受け付けます。
`requireSSL`	サーバーはTLS暗号化接続のみを使用し、受け入れます。

spec.additionalMongodConfig.net.tls.disabledProtocols

型: string

MongoDB バージョン 4.2 の新機能。

TLSによって実行されている MongoDB サーバーで、1 つ以上の特定のプロトコルを使用する着信接続を受け付けないようにします。複数のプロトコルを指定するには、プロトコルをコンマで区切ったリストで入力します。たとえば、 TLS1_0,TLS1_1 。

この設定は、次のプロトコルを認識します: TLS1_0 、 TLS1_1 、 TLS1_2 、および MongoDB 4.0.4 以降（および 3.6.9）、 TLS1_3 。認識されないプロトコルを指定すると、サーバーは起動しません。

macOS では、 TLS1_1を無効にして、 TLS1_0とTLS1_2の両方を有効にすることはできません。少なくともTLS1_0またはTLS1_2も無効にする必要があります。たとえば、 TLS1_0,TLS1_1は macOS でTLS1_2を無効にします。

無効にするプロトコルのリストは、無効なプロトコルのデフォルトのリストを置き換えます。

MongoDB バージョン4.0以降、 MongoDB 1.01.1は、システムで TLS + が利用可能な場合、 TLS の使用を無効にします。無効になっているTLSを有効にするには1を使用します。 0 、 spec.additionalMongodConfig.net.tls.disabledProtocolsの値としてnoneを指定する。この設定の詳細については、「 TLS を無効にする1 」を参照してください。 0 。

レプリカセットとシャーディングされたクラスターのノード間では、少なくとも 1 つのプロトコルが共通している必要があります。

spec.security.authentication

タイプ: コレクション

MongoDB 配置の認証仕様。

spec.security.authentication.enabled

タイプ: ブール値

デフォルト: false

Cloud ManagerまたはMongoDB Ops Managerプロジェクトで認証が有効になっているかどうかを指定します。 trueに設定されている場合は、 spec.security.authentication.modesで認証メカニズムを設定する必要があります。

重要

この設定を含めると、 falseに設定されている場合でも、Kubernetes Operator はこの MongoDB リソースの認証を管理します。この設定がリソース仕様に存在している間は、 Cloud ManagerまたはMongoDB Ops Managerの UI または API を使用してこのリソースの認証を構成することはできません。

Cloud ManagerまたはMongoDB Ops Managerの UI または API を使用して認証を管理する場合は、この設定を省略します。

spec.security.authentication.modes

タイプ: 配列

MongoDB 配置で使用する認証メカニズムを指定します。有効な値は、 SCRAM 、 SCRAM-SHA-1 、 MONGODB-CR 、 X509 、 LDAPです。 SCRAM-SHA-1よりもSCRAM-SHA-256 （ SCRAM ）を推奨します。 SCRAM-SHA-1を指定する場合は、 MONGODB-CRも指定する必要があります。

注意

X.509 内部クラスター認証

509またはCloud Manager MongoDB Ops Managerプロジェクトで X. 内部クラスター認証を有効にするには、この値を["X509"] に設定し、次の設定を指定します。

spec.security.authentication.internalCluster : "X509"
spec.security.certsSecretPrefix設定に値を指定します。

spec.security.authentication.modesに複数の値を指定する場合は、 spec.security.authentication.agents.modeの値も指定する必要があります。

spec.security.authentication.internalCluster

型: string

X. 509内部クラスター認証を有効にするかどうかを指定します。

X.509 内部クラスター認証を有効にするには、を"X509"に設定します。次の設定を指定する必要があります。

spec.security.authentication.modes : ["X509"]
spec.security.certsSecretPrefix

Kubernetes 演算子は次の値を受け入れます。

["X509"]: X.509 内部クラスター認証が有効になっています。
"" または省略: 内部クラスター認証が有効になっていません。

重要

内部クラスター認証を有効にした後で、無効にすることはできません。

spec.security.authentication.requireClientTLSAuthentication

タイプ: ブール値

デフォルト: false

MongoDB ホストがクライアントにTLS証明書を使用して接続することを要求するかどうかを指定します。 TLS認証を有効にする場合、デフォルトはtrueになります。

TLS認証を有効にするには、 spec.security.certsSecretPrefix設定の値を指定します。

spec.security.authentication.ldap

タイプ: コレクション

LDAP 認証に必要です。

LDAPCloud ManagerまたはMongoDB Ops Manager プロジェクトの認証を構成します。LDAP認証を有効にするには、 spec.security.authentication.modesを["LDAP"]に設定します。

spec.security.authentication.ldap.servers

タイプ: 文字列の配列

LDAP 認証に必要です。

LDAPサーバーのホスト名とポートのリスト。次の形式で、それぞれのポートを持つホスト名を指定します。

spec:
  security:
    authentication:
      ldap:
        servers:
          - "<hostname1>:<port1>"
          - "<hostname2>:<port2>"

spec.security.authentication.ldap.timeoutMS

タイプ: 整数

認証リクエストがタイムアウトするまでの待機時間をミリ秒単位で指定します。

spec.security.authentication.ldap.transportSecurity

型: string

LDAP 認証に必要です。

LDAPサーバーがTLSを受け入れるかどうかを指定します。

LDAPサーバーがTLSを受け入れている場合は、値をtlsに設定します。 LDAPサーバーがTLSを受け入れていない場合は、この値を空白のままにするか、値をnoneに設定します。

注意

noneまたはtls以外の string を指定した場合でも、Kubernetes Operator は設定をtlsに設定します。

spec.security.authentication.ldap.caConfigMapRef

タイプ: コレクション

TLS による LDAP 認証に必要です。

ConfigMap は、 LDAP サーバーの TLS 証明書を検証する CA を含みます。

spec.security.authentication.ldap.caConfigMapRef.name

型: string

TLS による LDAP 認証に必要です。

ConfigMap の名前は、 LDAP サーバーの TLS 証明書を検証する CA を含みます。

spec.security.authentication.ldap.caConfigMapRef.key

型: string

TLS による LDAP 認証に必要です。

LDAP サーバーの TLS 証明書を検証する CA を保存するフィールド名。

spec.security.authentication.ldap.bindQueryUser

型: string

LDAP 認証に必要です。

MongoDB が LDAP サーバーに接続するときにバインドする LDAP 識別名。

spec.security.authentication.ldap.bindQueryPasswordSecretRef

タイプ: コレクション

LDAP 認証に必要です。

シークレットを指定しますは、 LDAP サーバーに接続するときに MongoDB がバインドするパスワードを含みます。

spec.security.authentication.ldap.bindQueryPasswordSecretRef.name

型: string

LDAP 認証に必要です。

シークレットの名前は、 LDAP サーバーに接続するときに MongoDB がバインドするパスワードを含みます。

シークレット passwordには、パスワードを保存するフィールドのみを含める必要があります。

spec.security.authentication.ldap.authzQueryTemplate

型: string

LDAP 認可に必要です。

RFC4515 と RFC4516 ユーザーが属する LDAP グループを取得するために MongoDB によって実行される LDAP 形式のクエリ URL テンプレート。クエリは、 spec.security.authentication.ldap.serversで指定されたホストに対して相対的です。テンプレートでは、次のトークンを使用できます。

{USER}
認証されたユーザー名、またはtransformedユーザー名を LDAP クエリに置き換えます。
{PROVIDED_USER}
認証または LDAP 変換の前に、指定されたユーザー名を LDAP クエリに置き換えます。（ MongoDB バージョン 4.2 以降で利用可能）

Tip

以下も参照してください。

MongoDB マニュアルのLDAP クエリテンプレート

spec.security.authentication.agents.automationLdapGroupDN

型: string

MongoDB Agent ユーザーが属する LDAP グループの DN（Distinguished Name、識別名）。

この設定は、次の場合に必要です。

spec.security.authentication.ldap.authzQueryTemplate が存在し、かつ
spec.security.authentication.agents.modeはLDAPまたはX509です。

spec.security.authentication.ldap.userToDNMapping

型: string

認証用にmongodまたはmongosに指定されたユーザー名を LDAP 識別名（DN）にマッピングします。

Tip

以下も参照してください。

MongoDB マニュアルのsecurity.ldap.userToDNMapping

spec.security.authentication.ldap.userCacheInvalidationInterval

タイプ: 整数

MongoDB が LDAP ユーザーキャッシュをフラッシュするまでの待機時間を秒単位で指定します。デフォルトは 30 秒です。

spec.security.authentication.agents

タイプ: コレクション

MongoDB AgentCloud ManagerまたはMongoDB Ops Manager プロジェクトの認証構成。

spec.security.authentication.agents.mode

型: string

MongoDB 配置の MongoDB エージェントが使用する認証メカニズム。有効な値は、 SCRAM 、 SCARM-SHA-1 、 MONGODB-CR 、 X509 、 LDAPです。指定する値はspec.security.authentication.modesにも存在する必要があります。 SCRAM-SHA-1よりもSCRAM-SHA-256 （ SCRAM ）を推奨します。 SCRAM-SHA-1を指定する場合は、 MONGODB-CRも指定する必要があります。

この設定は、 spec.security.authentication.modesに複数の値を指定した場合に必要です。

spec.security.authentication.agents.automationUserName

型: string

MongoDB エージェントが MongoDB 配置を操作するために使用するユーザーの名前。ユーザー名は、 spec.security.authentication.ldap.userToDNMappingに従って LDAP 識別名（DN）にマッピングされます。結果の DN は LDAP 配置にすでに存在している必要があります。

この設定は、 spec.security.authentication.agents.modeがLDAPである場合に必要です。

spec.security.authentication.agents.automationPasswordSecretRef

タイプ: コレクション

シークレットの詳細spec.security.authentication.agents.automationUserName これにはユーザーのパスワードが含まれます。

この設定は、 spec.security.authentication.agents.modeがLDAPである場合に必要です。

spec.security.authentication.agents.automationPasswordSecretRef.name

型: string

シークレットの名前 spec.security.authentication.agents.automationUserNameこれにはユーザーのパスワードが含まれます。このシークレットは、Kubernetes Operator を配置するのと同じ名前空間に作成する必要があります。

kubectl create secret generic ldap-agent-user \
--from-literal="password=<password>" -n <metadata.namespace>

このシークレットには 1 つのキーが含まれている必要があり、その値は LDAP 配置内のspec.security.authentication.agents.automationUserNameユーザーのパスワードと一致します。

この設定は、 spec.security.authentication.agents.modeがLDAPである場合に必要です。

spec.security.authentication.agents.automationPasswordSecretRef.key

型: string

シークレット内のキーspec.security.authentication.agents.automationPasswordSecretRef.name spec.security.authentication.agents.automationUserNameこれは、のユーザーのパスワードを含みます。

この設定は、 spec.security.authentication.agents.modeがLDAPである場合に必要です。

spec.security.authentication.agents.clientCertificateSecretRef.name

型: string

シークレットを指定します MongoDB Agent の TLS 証明書が含まれる。省略された場合、デフォルトはagent-certsとなります。

このシークレットには、次のキーが含まれている必要があります。これらのキーの値は、サーバーによって検証できるTLS証明書です。

mms-automation-agent-pem
mms-backup-agent-pem
mms-monitoring-agent-pem

このシークレットは、Kubernetes Operator を配置するのと同じ名前空間に作成する必要があります。

kubectl create secret generic agent-certs \
--from-file=mms-automation-agent-pem=<automation-cert.pem> \
--from-file=mms-backup-agent-pem=<backup-cert.pem> \
--from-file=mms-monitoring-agent-pem=<monitoring-cert.pem> \
--namespace=<metadata.namespace>

spec.security.roles

タイプ: 配列

MongoDB 配置に対するきめ細かなアクセス制御を付与するユーザー定義のロールを定義する配列。

ユーザー定義ロールを有効にするには、 spec.security.authentication.enabledがtrueである必要があります。

例

上記の例では、 customRoleという名前のユーザー定義ロールにより、このロールを割り当てられたユーザーには次の操作を許可します。

petsデータベースのcatsコレクションにドキュメントを挿入し、
petsデータベース内のdogsコレクションにドキュメントを検索して挿入します。

1 ---
2 apiVersion: mongodb.com/v1
3 kind: MongoDB
4 metadata:
5   name: <my-replica-set>
6 spec:
7   members: 3
8   version: "4.2.2-ent"
9   type: ReplicaSet
10   opsManager:
11     configMapRef:
12       name: <configMap.metadata.name>
13   credentials: <mycredentials>
14   persistent: true
15   security:
16     authentication:
17       enabled: true
18       modes:
19         - "SCRAM"
20     roles:
21       - role: "customRole"
22         db: admin    
23         privileges:
24         - actions:
25           - insert
26           resource:
27             collection: cats
28             db: pets
29         - actions:
30           - insert
31           - find
32           resource:
33             collection: dogs
34             db: pets
35 ...

spec.security.roles.role

型: string

ユーザー定義ロールの名前。

spec.security.roles.db

型: string

ユーザー定義ロールを保存するデータベース。

例

admin

spec.security.roles.authenticationRestrictions

タイプ: 配列

このspec.security.roles.roleを割り当てられたユーザーが接続できる IP アドレスと接続できる IP アドレスを定義する配列。

spec.security.roles.authenticationRestrictions.clientSource

タイプ: 配列

このspec.security.roles.roleを割り当てられたユーザーが接続できる IP アドレスまたは CIDR ブロックの配列。

MongoDB サーバーは、リクエストがこの配列に存在しないクライアントからの接続リクエストである場合、このロールを持つユーザーからの接続リクエストを拒否します。

spec.security.roles.authenticationRestrictions.serverAddress

タイプ: 配列

このspec.security.roles.roleを割り当てられたユーザーが接続できる IP アドレスまたは CIDR ブロックの配列。

MongoDB サーバーは、クライアントがこの配列に存在しないサーバーへの接続をリクエストした場合、このロールを持つユーザーからの接続リクエストを拒否します。

spec.security.roles.privileges

タイプ: 配列

このロールに付与されたユーザーが持つ特権を記述する配列。

spec.security.roles.privileges.actions

タイプ: 配列

このロールを付与されたユーザーが実行できるアクションのリスト。許容値のリストについては、Kubernetes Operator で配置する MongoDB バージョンの MongoDB マニュアルの「特権アクション」を参照してください。

spec.security.roles.privileges.resource

タイプ: コレクション

特権actionsが適用されるリソース。

このコレクションには、次のいずれかを含める必要があります。

spec.security.roles.privileges.resource.databaseとspec.security.roles.privileges.resource.collectionの設定、または
trueの値を持つspec.security.roles.privileges.resource.cluster設定。

spec.security.roles.privileges.resource.database

型: string

特権actionsが適用されるデータベース。

この設定に値を指定する場合は、 spec.security.roles.privileges.resource.collectionの値も指定する必要があります。

spec.security.roles.privileges.resource.collection

型: string

database権限が適用されるactions のコレクション。

この設定に値を指定する場合は、 spec.security.roles.privileges.resource.databaseの値も指定する必要があります。

spec.security.roles.privileges.resource.cluster

タイプ: ブール値

デフォルト: False

特権actionsが MongoDB 配置のすべてのデータベースとコレクションに適用されることを示すフラグ。省略された場合、デフォルトはfalseとなります。

true に設定されている場合、 spec.security.roles.privileges.resource.databaseとspec.security.roles.privileges.resource.collectionの値を指定しないでください。

例

次の例は、すべての設定が指定されたスタンドアロン配置のリソース仕様を示しています。

apiVersion: mongodb.com/v1
kind: MongoDB
metadata:
  name: my-standalone
spec:
  version: "4.2.2-ent"
  service: my-service
  opsManager: # Alias of cloudManager
    configMapRef:
      name: my-project
  credentials: my-credentials
  persistent: true
  type: Standalone
  additionalMongodConfig:
    systemLog:
      logAppend: true
      verbosity: 4
    operationProfiling:
      mode: slowOp
  podSpec:
    persistence:
      single:
        storage: "12Gi"
        storageClass: standard
        labelSelector:
          matchExpressions:
          - {key: environment, operator: In, values: [dev]}
    podTemplate:
      metadata:
        labels:
          label1: mycustomlabel
      affinity:
        podAffinity:
          requiredDuringSchedulingIgnoredDuringExecution:
          - labelSelector:
              matchExpressions:
              - key: security
                operator: In
                values:
                - S1
            topologyKey: failure-domain.beta.kubernetes.io/zone
        nodeAffinity:
          requiredDuringSchedulingIgnoredDuringExecution:
            nodeSelectorTerms:
            - matchExpressions:
              - key: kubernetes.io/e2e-az-name
                operator: In
                values:
                - e2e-az1
                - e2e-az2
        podAntiAffinity:
          preferredDuringSchedulingIgnoredDuringExecution:
            - podAffinityTerm:
                topologyKey: "mykey"
              weight: 50
...

次の例は、提供されたすべての設定を持つレプリカセットのリソース仕様を示しています。

---
apiVersion: mongodb.com/v1
kind: MongoDB
metadata:
  name: my-replica-set
spec:
  members: 3
  version: "6.0.0-ent"
  service: my-service
  opsManager: # Alias of cloudManager
    configMapRef:
      name: my-project
  credentials: my-credentials
  persistent: true
  type: ReplicaSet
  podSpec:
    persistence:
      multiple:
        data:
          storage: "10Gi"
        journal:
          storage: "1Gi"
          labelSelector:
            matchLabels:
              app: "my-app"
        logs:
          storage: "500M"
          storageClass: standard
    podTemplate:
      metadata:
        labels:
          label1: mycustomlabel
      affinity:
        podAffinity:
          requiredDuringSchedulingIgnoredDuringExecution:
          - labelSelector:
              matchExpressions:
              - key: security
                operator: In
                values:
                - S1
            topologyKey: failure-domain.beta.kubernetes.io/zone
        nodeAffinity:
          requiredDuringSchedulingIgnoredDuringExecution:
            nodeSelectorTerms:
            - matchExpressions:
              - key: kubernetes.io/e2e-az-name
                operator: In
                values:
                - e2e-az1
                - e2e-az2
        podAntiAffinity:
          preferredDuringSchedulingIgnoredDuringExecution:
            - podAffinityTerm:
                topologyKey: "mykey"
              weight: 50
      spec:
        affinity:
          podAntiAffinity:
            preferredDuringSchedulingIgnoredDuringExecution:
              - podAffinityTerm:
                  topologyKey: "mykey"
                weight: 50
  security:
    certsSecretPrefix: "prefix"
    tls:
      ca: custom-ca
    authentication:
      enabled: true
      modes: ["X509"]
      internalCluster: "X509"
  statefulSet:
    spec:
      serviceName: my-service
  additionalMongodConfig:
    net:
      ssl:
        mode: preferSSL
...

次の例は、すべての設定が提供されているシャーディングされたクラスターのリソース仕様を示しています。

---
apiVersion: mongodb.com/v1
kind: MongoDB
metadata:
  name: my-sharded-cluster
spec:
  shardCount: 2
  mongodsPerShardCount: 3
  mongosCount: 2
  configServerCount: 3
  version: "6.0.0-ent"
  service: my-service
  type: ShardedCluster
  ## Please Note: The default Kubernetes cluster name is
  ## `cluster.local`.
  ## If your cluster has been configured with another name, you can
  ## specify it with the `clusterDomain` attribute.
  opsManager: # Alias of cloudManager
    configMapRef:
      name: my-project
  credentials: my-credentials
  persistent: true
  configSrvPodSpec:
    # if "persistence" element is omitted then Operator uses the
    # default size (5Gi) for mounting single Persistent Volume
    podTemplate:
      spec:
        affinity:
          podAffinity:
            requiredDuringSchedulingIgnoredDuringExecution:
              - labelSelector:
                  matchExpressions:
                    - key: security
                      operator: In
                      values:
                        - S1
                topologyKey: failure-domain.beta.kubernetes.io/zone
          nodeAffinity:
            requiredDuringSchedulingIgnoredDuringExecution:
              nodeSelectorTerms:
                - matchExpressions:
                    - key: kubernetes.io/e2e-az-name
                      operator: In
                      values:
                        - e2e-az1
                        - e2e-az2
          podAntiAffinity:
            requiredDuringSchedulingIgnoredDuringExecution:
            - podAffinityTerm:
                topologyKey: nodeId
  mongosPodSpec:
    podTemplate:
      spec:
        affinity:
          podAffinity:
            requiredDuringSchedulingIgnoredDuringExecution:
              - labelSelector:
                  matchExpressions:
                    - key: security
                      operator: In
                      values:
                        - S1
                topologyKey: failure-domain.beta.kubernetes.io/zone
          nodeAffinity:
            requiredDuringSchedulingIgnoredDuringExecution:
              nodeSelectorTerms:
                - matchExpressions:
                    - key: kubernetes.io/e2e-az-name
                      operator: In
                      values:
                        - e2e-az1
                        - e2e-az2
          podAntiAffinity:
            requiredDuringSchedulingIgnoredDuringExecution:
            - podAffinityTerm:
                topologyKey: nodeId
  shardPodSpec:
    persistence:
      multiple:
        # if the child of "multiple" is omitted then the default size will be used.
        # 16GB for "data", 1GB for "journal", 3GB for "logs"
        data:
          storage: "20Gi"
        logs:
          storage: "4Gi"
          storageClass: standard
    podTemplate:
      spec:
        affinity:
          podAffinity:
            requiredDuringSchedulingIgnoredDuringExecution:
              - labelSelector:
                  matchExpressions:
                    - key: security
                      operator: In
                      values:
                        - S1
                topologyKey: failure-domain.beta.kubernetes.io/zone
          nodeAffinity:
            requiredDuringSchedulingIgnoredDuringExecution:
              nodeSelectorTerms:
                - matchExpressions:
                    - key: kubernetes.io/e2e-az-name
                      operator: In
                      values:
                        - e2e-az1
                        - e2e-az2
          podAntiAffinity:
            requiredDuringSchedulingIgnoredDuringExecution:
            - podAffinityTerm:
                topologyKey: nodeId
  mongos:
    additionalMongodConfig:
      systemLog:
        logAppend: true
        verbosity: 4
  configSrv:
    additionalMongodConfig:
      operationProfiling:
        mode: slowOp
  shard:
    additionalMongodConfig:
      storage:
        journal:
          commitIntervalMs: 50
  security:
    certsSecretPrefix: "prefix"
    tls:
     ca: custom-ca
    authentication:
      enabled: true
      modes: ["X509"]
      internalCluster: "X509"
  statefulSet:
    spec:
      serviceName: my-service
...

StateftSet 設定

次のステートフルセット設定は、レプリカセットとシャーディングされたクラスターのリソースタイプにのみ適用されます。

spec.statefulSet.spec

タイプ: コレクション

ステートメントセットの仕様 MongoDB Enterprise Kubernetes OperatorMongoDB がリソース用に作成する

spec.statefulSet.spec.serviceName

型: string

デフォルト: <resource_name>-svcと<resource_name>-svc-external

戻る

MongoDB ユーザーリソースの仕様

マルチKubernetes-クラスターリソース仕様

1	---
2	apiVersion: mongodb.com/v1
3	kind: MongoDB
4	metadata:
5	name: my-standalone
6	spec:
7	version: "6.0.0-ent"
8	service: my-service
9
10	opsManager:
11	configMapRef:
12	name: my-project
13	credentials: my-credentials
14	type: Standalone
15
16	persistent: true
17	agent:
18	startupOptions:
19	maxLogFiles: "30"
20	dialTimeoutSeconds: "40"
21	...

15	security:
16	tls:
17	enabled: true
18	connectivity:
19	replicaSetHorizons:
20	- "example-website": "web1.example.com:30907"
21	- "example-website": "web2.example.com:32350"
22	- "example-website": "web3.example.com:31185"
23	...