MongoDB Database リソースの仕様

必須

apiVersion

型: string

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

kind

型: string

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

metadata.name

型: string

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

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

spec.credentials

型: string

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

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

重要

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

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

spec.persistent

タイプ: ブール値

デフォルト: True

WARNING: Grant your containers permission to write to your Persistent Volume. The Kubernetes Operator sets fsGroup = 2000, runAsUser = 2000, and runAsNonRoot = true in securityContext. Kubernetes Operator sets fsgroup equal to runAsUser to make the volume writable for a user that runs the main process in the container. To learn more, see Configure a Security Context for a Pod or Container and the related discussion in the Kubernetes documentation. If redeploying the resource doesn't fix issues with your Persistent Volume, contact MongoDB Support.

If you do not use Persistent Volumes, the Disk Usage and Disk IOPS charts cannot be displayed in either the Processes tab on the Deployment page or in the Metrics page when reviewing the data for this deployment.

spec.type

型: string

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

• Standalone

• ReplicaSet

• ShardedCluster

spec.version

型: string

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

形式は、 MongoDB Community Editionでは X.Y.Z、Enterprise エディションでは X.Y.Z-ent です。

重要

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

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

注意

If you update this value to a later version of MongoDB for your database resources, the feature compatibility version remains at the MongoDB version you're upgrading from to give you the option to downgrade if necessary. If you want the feature compatibility version to match the new MongoDB version, you must manually set spec.featureCompatibilityVersion to the new version or to AlwaysMatchVersion. To learn more, see spec.featureCompatibilityVersion.

条件付き

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

spec.opsManager.configMapRef.name

型: string

Name of the ConfigMap with the Cloud Manager or Ops Manager connection configuration. The spec.cloudManager.configMapRef.name setting is an alias for this setting and can be used in its place.

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

重要

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

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

spec.cloudManager.configMapRef.name

型: string

Alias for 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

型: string

ローテーション前の個別のログファイルの最大サイズ。string は float64 に変換できる必要があります。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

型: string

これらのログファイルが占有するディスク領域の合計の最大パーセンテージ。string は float64 に変換できる必要があります。

spec.agent.mongod.logRotate

型: オブジェクト

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

spec.agent.mongod.logRotate.sizeThresholdMB

型: string

ローテーション前の個別のログファイルの最大サイズ。string は float64 に変換できる必要があります。MB の小数値がサポートされています。

spec.agent.mongod.logRotate.timeThresholdHrs

タイプ: 整数

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

Ops Manager rotates the log file once the file meets either this timeThresholdHrs or the 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 のログファイルを制御するために使用される次の環境変数を構成します。

• readiness_PROBE_LOGER_BACKUPS

• readiness_PROBE_LOGER_COMPRESS

• readiness_PROBE_LOGER_MAX_SIZE

• readiness_PROBE_LOGER_MAX_AGE

• MDB_WITH_AGENT_FILE_LOGGING

• LOG_FILE_PATH

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.role

型: string

Marks this resource as playing a special role for another MongoDB resource in Kubernetes. The only accepted value is AppDB, which marks this resource as the externally managed Application Database for a MongoDBOpsManager resource. When you omit this setting, the Kubernetes Operator manages the resource as an ordinary MongoDB deployment.

To learn how to use an externally managed Application Database, see Back Up the Ops Manager Application Database.

apiVersion: mongodb.com/v1
kind: MongoDB
metadata:
  name: primary-om-db
spec:
  role: AppDB

この設定は不変です。これは、リソースを作成する ときに設定する必要があります。それを 既存のリソースに追加することはできず、その後は変更または削除することはできません。

A resource that sets spec.role to AppDB must meet the following requirements:

• spec.type must be ReplicaSet.

• spec.members must be 3 or greater.

• The resource must use a single Kubernetes cluster. The Kubernetes Operator rejects a MongoDBMultiCluster resource and a MongoDB resource that uses a multi-cluster topology.

• The name of the resource must be <MongoDBOpsManager-name>-db.

• If you configure spec.security.authentication, you must enable it, set its modes to SCRAM only, and set spec.security.authentication.ignoreUnknownUsers to true. If you omit authentication settings, the Kubernetes Operator applies this configuration for you.

spec.featureCompatibilityVersion

型: string

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

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

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

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

To learn more about feature compatibility, see setFeatureCompatibilityVersion in the MongoDB Manual.

spec.clusterDomain

型: string

デフォルト: cluster.local

Domain name of the Kubernetes cluster where you deploy the Kubernetes Operator. When Kubernetes creates a StatefulSet, the Kubernetes assigns each Pod a FQDN. To update Cloud Manager or Ops Manager, the Kubernetes Operator calculates the FQDN for each Pod using a provided cluster name. Kubernetes doesn't provide an API to query these hostnames.

警告

You must set spec.clusterDomain if your Kubernetes cluster has a default domain other than the default cluster.local. If you neither use the default nor set the spec.clusterDomain option, the Kubernetes Operator might not function as expected.

spec.clusterName

型: string

デフォルト: cluster.local

重要

spec.clusterName は非推奨

Use spec.clusterDomain instead.

Domain name of the Kubernetes cluster where you deploy the Kubernetes Operator. When Kubernetes creates a StatefulSet, the Kubernetes assigns each Pod a FQDN. To update Cloud Manager or Ops Manager, the Kubernetes Operator calculates the FQDN for each Pod using a provided cluster name. Kubernetes doesn't provide an API to query these hostnames.

警告

You must set spec.clusterDomain if your Kubernetes cluster has a default domain other than the default cluster.local. If you neither use the default nor set the spec.clusterDomain option, the Kubernetes Operator might not function as expected.

metadata.namespace

型: string

Kubernetes namespace where you create this MongoDB resource and other objects.

spec.service

型: string

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

重要

spec.service は非推奨

Use spec.statefulSet.spec.serviceName instead.

Atlas App Servicesが作成または使用するKubernetesサービスの名前。この名前のサービスがすでに存在する場合、 MongoDB Controls for 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ユーザー インターフェイスを通じて構成されていないデータベースユーザーを変更できるかどうかを決定します。

To manage database users directly through the mongod or mongos, set this setting to true.

スタンドアロン設定

spec.additionalMongodConfig

タイプ: コレクション

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

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

• net.port

• net.tls.certificateKeyFile

• net.tls.clusterFile

• replication.replSetName

• security.clusterAuthMode

• sharding.clusterRole

• storage.dbPath

• systemLog.destination

• systemLog.path

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: "8.0.0"
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

タイプ: コレクション

Specification to expose your cluster for external connections. To learn how to connect to your MongoDB resource from outside of the Kubernetes cluster, see Connect to a MongoDB Resource from Outside Kubernetes.

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

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

フィールド	値	説明
Name	<pod-name>-svc-external	外部サービスの名前。 この値は変更できません。
Type	LoadBalancer	外部 LoadBalancer を作成します service
Port	<Port Number>	A port for mongod.
publishNotReadyAddress	true	Specifies that DNS records are created even if the Pod isn't ready. Do not set to false for any database Pod.

注意

If you set spec.externalAccess.externalDomain, the external service adds another port (Port Number + 1) for backups.

spec.externalAccess.externalService

タイプ: コレクション

Specification for overriding the default values in spec.externalAccess.

When you set the spec.externalAccess setting, the Kubernetes Operator automatically creates an external load balancer service with default values. You can override certain values or add new values depending on your needs. For example, if you intend to create NodePort services and don't need a load balancer, you must configure overrides in your Kubernetes specification:

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

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

spec.externalAccess.externalService.annotations

タイプ: コレクション

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

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

値	説明
{resourceName}	Equal to metadata.name.
{namespace}	Equal to metadata.namespace.
{podIndex}	StateftSet によって割り当てられ、現在の外部サービスが対象とする ポッドのインデックス。
{podName}	{resourceName}-{podIndex}に等しい。
{statefulSetName}	The StatefulSet. Equal to {resourceName}.
{externalServiceName}	指定したプレースホルダー値に基づいて、外部サービスの生成された名前。 {resourceName}-{podIndex}-svc-externalに等しい。
{mongodProcessDomain}	The domain name of the server that is hosting the mongod process. Equal to spec.externalAccess.externalDomain if specified. Otherwise, equal to the domain used for the mongod process FQDN. たとえば、プロセス ホスト名mdb-rs-1.example.comの場合、 example.comはドメイン名になります。
{mongodProcessFQDN}	The mongod process hostname set in the automation configuration. The process hostname depends on your deployment configuration. If you've configured your deployment to use external domains, the process hostname uses the following format: {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

タイプ: コレクション

Configuration for the ServiceSpec. To learn more, see spec.externalAccess.externalService.

spec.podSpec.persistence.single

タイプ: コレクション

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

注意

• You must set the values in this collection if spec.persistent : true.

• このコレクションまたはpersistence.multipleコレクションを設定できますが、両方は設定できません。

スカラー	データ型	説明
labelSelector	string	マウントされたボリュームをディレクトリにバインドするために使用されるタグ。
storage	string	永続ボリューム の最小サイズ マウントする必要があるもの。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。 デフォルト値は 16Gi です。 例、のスタンドアロン配置に 60ギガバイトのストレージが必要な場合は、この値を60Gi に設定します。
storageClass	string	永続的なボリューム要求 で指定されるストレージのタイプ 。このストレージ タイプは、 StorageClass として作成できます。 この オブジェクト で使用する前にオブジェクトを 仕様。 Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

spec.podSpec.persistence.multiple.data

タイプ: コレクション

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

注意

• You must set the values in this collection if spec.persistent : true.

• このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
labelSelector	string	マウントされたボリュームをディレクトリにバインドするために使用されるタグ。
storage	string	Kubernetes ノード で使用可能である必要がある最小ストレージ容量 から、Kubernetes で スタンドアロン配置 をホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。 デフォルト値は 16Gi です。 たとえば、このMongoDBリソースに60ギガバイトのストレージ容量が必要な場合は、この値を60Giに設定します。
storageClass	string	スタンドアロン配置に必要なストレージのタイプ。 このストレージ タイプは、 StorageClass として作成できます。 この オブジェクト で使用する前にオブジェクトを 仕様。 Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

spec.podSpec.persistence.multiple.journal

タイプ: コレクション

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

注意

• You must set the values in this collection if spec.persistent : true.

• このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
labelSelector	string	マウントされたボリュームをディレクトリにバインドするために使用されるタグ。
storage	string	Kubernetes ノード で使用可能である必要がある最小ストレージ容量 から、Kubernetes で スタンドアロン配置 をホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。 デフォルト値は 1Gi です。 たとえば、このMongoDBリソースに60ギガバイトのストレージ容量が必要な場合は、この値を60Giに設定します。
storageClass	string	スタンドアロン配置に必要なストレージのタイプ。 このストレージ タイプは、 StorageClass として作成できます。 この オブジェクト で使用する前にオブジェクトを 仕様。 Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

spec.podSpec.persistence.multiple.logs

タイプ: コレクション

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

注意

• You must set the values in this collection if spec.persistent : true.

• このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
labelSelector	string	マウントされたボリュームをディレクトリにバインドするために使用されるタグ。
storage	string	Kubernetes ノード で使用可能である必要がある最小ストレージ容量 から、Kubernetes で スタンドアロン配置 をホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。 デフォルト値は 3Gi です。 たとえば、このMongoDBリソースに60ギガバイトのストレージ容量が必要な場合は、この値を60Giに設定します。
storageClass	string	スタンドアロン配置に必要なストレージのタイプ。 このストレージ タイプは、 StorageClass として作成できます。 この オブジェクト で使用する前にオブジェクトを 仕様。 Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

spec.podSpec.podTemplate

タイプ: コレクション

Template for the Kubernetes Pods that the MongoDB Controllers for Kubernetes Operator creates for MongoDB database resources.

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

注意

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

spec.podSpec.podTemplate.metadata

タイプ: コレクション

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

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

spec.podSpec.podTemplate.spec

タイプ: コレクション

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

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

注意

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

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

spec.podSpec.podTemplate.spec.affinity.nodeAffinity

型: 構造体

Kubernetes rule to place Pods for replica set on a specific range of nodes.

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

spec.podSpec.podTemplate.spec.affinity.podAffinity

型: 構造体

Kubernetes rule to determine whether multiple MongoDB resource Pods must be co-located with other Pods. To learn more about the use cases, see Affinity and Anti-Affinity in the Kubernetes documentation.

spec.podSpec.podTemplate.spec.affinity.podAntiAffinity

型: 構造体

Default: kubernetes.io/hostname

Sets a rule to spread Pods hosting MongoDB resource to different locations. A location can be a single node, rack, or region. By default, Kubernetes Operator tries to spread pods across different nodes.

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

型: 構造体

Default: kubernetes.io/hostname

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

レプリカセット設定

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

spec.backup

タイプ: コレクション

The collection container for spec.backup.mode, which enables continuous backups for MongoDB resources in Kubernetes Operator.

spec.backup.assignmentLabels

タイプ: 配列

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

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

注意

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

spec.backup.mode

型: string

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

注意

The spec.backup.mode setting relies on Backup that is enabled in the Ops Manager and requires that spec.backup.enabled value in the Ops Manager resource specification is set to true.

After you enable continuous backups for your MongoDB resource with spec.backup.mode, you can check the backup status.

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

タイプ: 数値

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

spec.backup.snapshotSchedule.referenceMinuteOfHour

タイプ: 数値

UTC minute of the hour to schedule snapshots. You can set a value between 0 and 59, inclusive.

spec.backup.snapshotSchedule.fullIncrementalDayOfWeek

型: string

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

spec.clusterName

型: string

デフォルト: cluster.local

重要

spec.clusterName は非推奨

Use spec.clusterDomain instead.

Domain name of the Kubernetes cluster where you deploy the Kubernetes Operator. When Kubernetes creates a StatefulSet, the Kubernetes assigns each Pod a FQDN. To update Cloud Manager or Ops Manager, the Kubernetes Operator calculates the FQDN for each Pod using a provided cluster name. Kubernetes doesn't provide an API to query these hostnames.

警告

You must set spec.clusterDomain if your Kubernetes cluster has a default domain other than the default cluster.local. If you neither use the default nor set the spec.clusterDomain option, the Kubernetes Operator might not function as expected.

spec.connectivity.replicaSetHorizons

タイプ: コレクション

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

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

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

• この配列内の各値が一意であることを確認してください。

• Make sure that the number of entries in this array matches the value given in spec.members.

• Provide a value for the spec.security.certsSecretPrefix setting to enable TLS. This method to use split horizons requires the Server Name Indication extension of the TLS protocol.

• 外部ホスト名のルーティングを構成します。

例

この例では、レプリカセットのメンバーは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: "8.0.0"
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

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

By default, each replica set member uses the Kubernetes Pod's FQDN (*.svc.cluster.local) as the default hostname. However, if you add an external domain to this setting, the replica set uses a hostname that is a subdomain of the specified domain instead. This hostname uses the following format:

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

以下に例を挙げます。

replica-set-1.example.com

After you deploy the replica set with this setting, the Kubernetes Operator uses the hostname with the external domain to override the processes[n].hostname field in the Ops Manager automation configuration. Then, the MongoDB Agent uses this hostname to connect to mongod.

To specify other hostnames for connecting to the replica set, you can use the spec.connectivity.replicaSetHorizons setting. However, the following connections still use the hostname with the external domain:

• The MongoDB Agent to connect to mongod.

• mongod to connect to other mongod instances.

WARNING: Specifying this field changes how Ops Manager registers mongod processes. You can't change the value of this field or any processes[n].hostname fields in the Ops Manager automation configuration for a running replica set deployment.

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

タイプ: 数値

Determines whether a MongoDB 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.

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

spec.backup.autoTerminateOnDeletion

タイプ: ブール値

Flag that controls whether the Kubernetes Operator stops and terminates the backup when you delete a MongoDB resource. If omitted, the default value is false. Setting this flag to true is useful when you want to delete the MongoDB custom resource while the spec.backup.mode setting is set to enabled.

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

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

spec.backup.snapshotSchedule.clusterCheckpointIntervalMin

タイプ: 数値

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

spec.configServerCount

タイプ: 整数

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

spec.configSrv.additionalMongodConfig

タイプ: コレクション

Additional configuration options with which you want to start each config server member.

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

• net.tls.certificateKeyFile

• net.tls.clusterFile

• replication.replSetName

• security.clusterAuthMode

• sharding.clusterRole

• storage.dbPath

• systemLog.destination

• systemLog.path

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: "8.0.0"
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

タイプ: コレクション

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

注意

• You must set the values in this collection if spec.persistent : true.

• このコレクションまたはpersistence.multipleコレクションを設定できますが、両方は設定できません。

スカラー	データ型	説明
labelSelector	string	マウントされたボリュームをディレクトリにバインドするために使用されるタグ。
storage	string	永続ボリューム の最小サイズ マウントする必要があるもの。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。 デフォルト値は 5Gi です。 例、 の各コンフィギュレーションサーバーノードに60 ギガバイトのストレージ容量が必要な場合は、この値を60Gi に設定します。
storageClass	string	永続的なボリューム要求 で指定されるストレージのタイプ 。このストレージ タイプは、 StorageClass として作成できます。 この オブジェクト で使用する前にオブジェクトを 仕様。 Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

spec.configSrvPodSpec.persistence.multiple.data

タイプ: コレクション

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

注意

• You must set the values in this collection if spec.persistent : true.

• このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
labelSelector	string	マウントされたボリュームをディレクトリにバインドするために使用されるタグ。
storage	string	Kubernetes ノード で使用可能である必要がある最小ストレージ容量 は、Kubernetes で各コンフィギュレーション サーバー ノード をホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。 デフォルト値は 16Gi です。 たとえば、このMongoDBリソースに60ギガバイトのストレージ容量が必要な場合は、この値を60Giに設定します。
storageClass	string	各コンフィギュレーションサーバー ノードに必要なストレージのタイプ。 このストレージ タイプは、 StorageClass として作成できます。 この オブジェクト で使用する前にオブジェクトを 仕様。 Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

spec.configSrvPodSpec.persistence.multiple.journal

タイプ: コレクション

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

注意

• You must set the values in this collection if spec.persistent : true.

• このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
labelSelector	string	マウントされたボリュームをディレクトリにバインドするために使用されるタグ。
storage	string	Kubernetes ノード で使用可能である必要がある最小ストレージ容量 は、Kubernetes で各コンフィギュレーション サーバー ノード をホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。 デフォルト値は 1Gi です。 たとえば、このMongoDBリソースに60ギガバイトのストレージ容量が必要な場合は、この値を60Giに設定します。
storageClass	string	各コンフィギュレーションサーバー ノードに必要なストレージのタイプ。 このストレージ タイプは、 StorageClass として作成できます。 この オブジェクト で使用する前にオブジェクトを 仕様。 Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

spec.configSrvPodSpec.persistence.multiple.logs

タイプ: コレクション

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

注意

• You must set the values in this collection if spec.persistent : true.

• このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
labelSelector	string	マウントされたボリュームをディレクトリにバインドするために使用されるタグ。
storage	string	Kubernetes ノード で使用可能である必要がある最小ストレージ容量 は、Kubernetes で各コンフィギュレーション サーバー ノード をホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。 デフォルト値は 3Gi です。 たとえば、このMongoDBリソースに60ギガバイトのストレージ容量が必要な場合は、この値を60Giに設定します。
storageClass	string	各コンフィギュレーションサーバー ノードに必要なストレージのタイプ。 このストレージ タイプは、 StorageClass として作成できます。 この オブジェクト で使用する前にオブジェクトを 仕様。 Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

spec.configSrvPodSpec.podTemplate

タイプ: コレクション

Template for the Kubernetes Pods that the MongoDB Controllers for Kubernetes Operator creates for each config server member.

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

注意

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

spec.configSrvPodSpec.podTemplate.metadata

タイプ: コレクション

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

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

spec.configSrvPodSpec.podTemplate.spec

タイプ: コレクション

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

To review which fields you can add to spec.configSrvPodSpec.podTemplate.spec, see the Kubernetes PodSpec v1 core API.

注意

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

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

spec.configSrvPodSpec.podTemplate.spec.affinity.podAffinity

タイプ: コレクション

Kubernetes rule to determine whether multiple MongoDB resource Pods must be co-located with other Pods. To learn more about the use cases, see Affinity and Anti-Affinity in the Kubernetes documentation.

spec.configSrvPodSpec.podTemplate.spec.affinity.nodeAffinity

タイプ: コレクション

Kubernetes rule to place Pods for replica set on a specific range of nodes.

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

spec.configSrvPodSpec.podTemplate.spec.affinity.podAntiAffinity

型: string

Default: kubernetes.io/hostname

Sets a rule to spread Pods hosting MongoDB resource to different locations. A location can be a single node, rack, or region. By default, Kubernetes Operator tries to spread pods across different nodes.

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

型: string

Default: kubernetes.io/hostname

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

spec.mongodsPerShardCount

タイプ: 整数

Required. Number of members per shard.

spec.mongosCount

タイプ: 整数

Required. Number of mongos instances in the sharded cluster.

spec.mongos.additionalMongodConfig

タイプ: コレクション

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

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

• net.tls.certificateKeyFile

• net.tls.clusterFile

• replication.replSetName

• security.clusterAuthMode

• sharding.clusterRole

• storage.dbPath

• systemLog.destination

• systemLog.path

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

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

spec.mongos.agent

タイプ: コレクション

MongoDB Agent configuration settings for each mongos instance.

spec.mongos.agent.startupOptions

タイプ: コレクション

MongoDB Agent settings with which you want to start each mongos instance.

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: "8.0.0"
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

タイプ: コレクション

Template for the Kubernetes Pods that the MongoDB Controllers for Kubernetes Operator creates for each mongos instance.

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

注意

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

spec.mongosPodSpec.podTemplate.metadata

タイプ: コレクション

Metadata for the Kubernetes Pods that the MongoDB Controllers for Kubernetes Operator creates for each mongos instance.

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

spec.mongosPodSpec.podTemplate.spec

タイプ: コレクション

Specifications of the Kubernetes Pods that the MongoDB Controllers for Kubernetes Operator creates for each mongos instance.

To review which fields you can add to spec.mongosPodSpec.podTemplate.spec, see the Kubernetes PodSpec v1 core API.

注意

When you add containers to spec.mongosPodSpec.podTemplate.spec.containers, the Kubernetes Operator adds them to the Kubernetes pod. These containers are appended to each mongos instance containers in the pod.

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

spec.mongosPodSpec.podTemplate.spec.affinity.podAffinity

タイプ: コレクション

Optional. Kubernetes rule to determine if multiple MongoDB resource Pods must be co-located with other Pods.

spec.mongosPodSpec.podTemplate.spec.affinity.nodeAffinity

タイプ: コレクション

Kubernetes rule to place Pods for replica set on a specific range of nodes.

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

spec.mongosPodSpec.podTemplate.spec.affinity.podAntiAffinity

型: string

Default: kubernetes.io/hostname

Sets a rule to spread Pods hosting MongoDB resource to different locations. A location can be a single node, rack, or region. By default, Kubernetes Operator tries to spread pods across different nodes.

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

型: string

Default: kubernetes.io/hostname

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

spec.shardCount

タイプ: 整数

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

spec.shard.additionalMongodConfig

タイプ: コレクション

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

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

• net.tls.certificateKeyFile

• net.tls.clusterFile

• replication.replSetName

• security.clusterAuthMode

• sharding.clusterRole

• storage.dbPath

• systemLog.destination

• systemLog.path

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: "8.0.0"
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.multiple.data

タイプ: コレクション

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

注意

• You must set the values in this collection if spec.persistent : true.

• このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
labelSelector	string	マウントされたボリュームをディレクトリにバインドするために使用されるタグ。
storage	string	Kubernetes ノード で使用可能である必要がある最小ストレージ容量 各シャーディングされた クラスター のシャード ノードを Kubernetes でホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。 デフォルト値は 16Gi です。 たとえば、このMongoDBリソースに60ギガバイトのストレージ容量が必要な場合は、この値を60Giに設定します。
storageClass	string	各シャーディングされたクラスターのシャード ノードに必要なストレージのタイプ。 このストレージ タイプは、 StorageClass として作成できます。 この オブジェクト で使用する前にオブジェクトを 仕様。 Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

spec.shardPodSpec.persistence.multiple.journal

タイプ: コレクション

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

注意

• You must set the values in this collection if spec.persistent : true.

• このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
labelSelector	string	マウントされたボリュームをディレクトリにバインドするために使用されるタグ。
storage	string	Kubernetes ノード で使用可能である必要がある最小ストレージ容量 各シャーディングされた クラスター のシャード ノードを Kubernetes でホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。 デフォルト値は 1Gi です。 たとえば、このMongoDBリソースに60ギガバイトのストレージ容量が必要な場合は、この値を60Giに設定します。
storageClass	string	各シャーディングされたクラスターのシャード ノードに必要なストレージのタイプ。 このストレージ タイプは、 StorageClass として作成できます。 この オブジェクト で使用する前にオブジェクトを 仕様。 Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

spec.shardPodSpec.persistence.multiple.logs

タイプ: コレクション

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

注意

• You must set the values in this collection if spec.persistent : true.

• このコレクションまたはpersistence.singleコレクションを設定できますが、両方を設定することはできません。

スカラー	データ型	説明
labelSelector	string	マウントされたボリュームをディレクトリにバインドするために使用されるタグ。
storage	string	Kubernetes ノード で使用可能である必要がある最小ストレージ容量 各シャーディングされた クラスター のシャード ノードを Kubernetes でホストします。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。 デフォルト値は 3Gi です。 たとえば、このMongoDBリソースに60ギガバイトのストレージ容量が必要な場合は、この値を60Giに設定します。
storageClass	string	各シャーディングされたクラスターのシャード ノードに必要なストレージのタイプ。 このストレージ タイプは、 StorageClass として作成できます。 この オブジェクト で使用する前にオブジェクトを 仕様。 Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

spec.shardPodSpec.podTemplate

タイプ: コレクション

Template for the Kubernetes Pods that the MongoDB Controllers for Kubernetes Operator creates for each sharded cluster shard member.

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

注意

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

spec.shardPodSpec.podTemplate.metadata

タイプ: コレクション

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

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

spec.shardPodSpec.podTemplate.spec

タイプ: コレクション

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

To review which fields you can add to spec.shardPodSpec.podTemplate.spec, see the Kubernetes PodSpec v1 core API.

注意

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

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

spec.shardPodSpec.podTemplate.spec.affinity.podAffinity

型: string

Kubernetes rule to determine whether multiple MongoDB resource Pods must be co-located with other Pods. To learn more about the use cases, see Affinity and Anti-Affinity in the Kubernetes documentation.

spec.shardPodSpec.podTemplate.spec.affinity.nodeAffinity

型: string

Kubernetes rule to place Pods for replica set on a specific range of nodes.

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

spec.shardPodSpec.podTemplate.spec.affinity.podAntiAffinity

型: string

Default: kubernetes.io/hostname

Sets a rule to spread Pods hosting MongoDB resource to different locations. A location can be a single node, rack, or region. By default, Kubernetes Operator tries to spread pods across different nodes.

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

型: string

Default: kubernetes.io/hostname

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

spec.shardSpecificPodSpec

タイプ: 配列

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

spec.shardSpecificPodSpec.podTemplate

タイプ: コレクション

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

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

注意

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

spec.shardSpecificPodSpec.podTemplate.metadata

タイプ: コレクション

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

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

spec.shardSpecificPodSpec.podTemplate.spec

タイプ: コレクション

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

To review which fields you can add to spec.shardSpecificPodSpec.podTemplate.spec, see the Kubernetes PodSpec v1 core API.

注意

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

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

spec.shardSpecificPodSpec.podTemplate.spec.affinity.podAffinity

型: string

Kubernetes rule to determine whether multiple MongoDB resource Pods must be co-located with other Pods. To learn more about the use cases, see Affinity and Anti-Affinity in the Kubernetes documentation.

spec.shardSpecificPodSpec.podTemplate.spec.affinity.podAntiAffinity

型: string

Default: kubernetes.io/hostname

Sets a rule to spread Pods hosting MongoDB resource to different locations. A location can be a single node, rack, or region. By default, Kubernetes Operator tries to spread pods across different nodes.

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

型: string

Default: kubernetes.io/hostname

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

spec.topology

型: string

任意

デフォルト: SingleCluster

シャーディングされたシャーディングされたクラスターのトポロジーを定義します。 既存の配置では変更できません。 MultiClusterに設定されている場合:

• すべてのシャーディングされたクラスターコンポーネントには clusterSpecList が定義されている必要があります。

  • spec.mongos.clusterSpecList

  • spec.configSrv.clusterSpecList

  • spec.shard.clusterSpecList

• 次のフィールドは無視され、spec.<section>.clusterSpecList オブジェクト内の各クラスターに同等の値が渡されます。

  • spec.mongodsPerShardCount は で定義されています spec.shard.clusterSpecList.members

  • spec.mongosCount は で定義されています spec.mongos.clusterSpecList.members

  • spec.configServerCount は で定義されています spec.configSrv.clusterSpecList.members

  • spec.shardOverrides.memberConfig は で定義されています spec.shardOverrides.clusterSpecList.memberConfig

  • spec.shardOverrides.members は で定義されています spec.shardOverrides.clusterSpecList.members

  • spec.shardOverrides.statefulSet は で定義されています spec.shardOverrides.clusterSpecList.statefulSet

例:

apiVersion: mongodb.com/v1
kind: MongoDB
metadata:
  name: sc
spec:
  shardCount: 3
  # we don't specify mongodsPerShardCount, mongosCount and configServerCount as they don't make sense for multi-cluster
  topology: MultiCluster
  type: ShardedCluster
  version: 7.0.12
  cloudManager:
    configMapRef:
      name: my-project
  credentials: my-credentials
  persistent: true
  shard:
    clusterSpecList:
      - clusterName: member-cluster-0
        members: 2 # each shard will have 2 members in cluster 0, unless overriden
      - clusterName: member-cluster-1
        members: 2
      - clusterName: member-cluster-2
        members: 1
  shardOverrides:
    - shardNames: [sc-2] # this override will apply to the third shard (here, shards are indexed from 0 to 2 as we have 3 shards)
      clusterSpecList:
        - clusterName: member-cluster-0 # all other fields are optional, if not provided the fields from matching member cluster from shard.clusterSpecList will be taken by default
          members: 3
        - clusterName: member-cluster-1 # we don't deploy this shard to member-cluster-1
          # Note that it is also possible to make it explicit with members: 0
        # we don't provide entry for clusterName: member-cluster-1, so it won't be deployed there
        - clusterName: member-cluster-2
          members: 2
  configSrv:
    clusterSpecList:
      - clusterName: member-cluster-0
        members: 2 # config server will have 2 members in this cluster
      - clusterName: member-cluster-1
        members: 1
      - clusterName: member-cluster-2
        members: 2
  mongos:
    clusterSpecList:
      - clusterName: member-cluster-0
        members: 2 # router will have 2 members in this cluster
      - clusterName: member-cluster-1
        members: 1

次のフィールドは、 topology=MultiClusterが実行される配置にのみ関連します。

spec.configSrv.clusterSpecList

注意

このフィールドは、マルチクラスターのシャーディングされたクラスターの配置でのみ使用できます。

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

必須topology=MultiClusterの場合）

次の最上位フィールドを持つマルチクラスターのシャーディングされたクラスター配置で使用するオブジェクトの配列。

clusterName

型: string

MongoDB Controls for Kubernetes Operator が StateftSet をスケジュールするクラスターの名前。

externalAccess

タイプ: コレクション

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

これらの設定は、すべてのクラスターのサービスに適用されます。 特定のクラスターでこれらのグローバル設定をオーバーライドするには、 spec.clusterSpecList.externalAccess.externalService を使用します。

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

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

フィールド	値	説明
Name	<pod-name>-svc-external	外部サービスの名前。 この値は変更できません。
Type	LoadBalancer	外部 LoadBalancer を作成します service
Port	<Port Number>	A port for mongod.
publishNotReadyAddress	true	Specifies that DNS records are created even if the Pod isn't ready. Do not set to false for any database Pod.

注意

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

members

タイプ: 数値

MongoDB レプリカセット内のノードの数。

memberConfig

タイプ: コレクション

マルチ Kubernetes クラスターMongoDBデプロイ内の各MongoDBシャードとそのノードの仕様。

シャードのオブジェクト内の要素の順序は、レプリカセット内のノードの順序を反映する必要があります。 例、最初の要素はインデックス0の ポッドに影響し、2 番目の要素はインデックス1に影響するなど、 に影響します。

例

3 つのレプリカ セットを含むマルチ Kubernetes クラスター MongoDB 配置の次の例の仕様を検討してみましょう。

apiVersion: mongodb.com/v1
kind: MongoDBMultiCluster
metadata:
  name: multi-replica-set
spec:
  version: 8.0.0
  type: ReplicaSet
  duplicateServiceObjects: false
  credentials: my-credentials
  opsManager:
    configMapRef:
      name: my-project
  clusterSpecList:
    - clusterName: cluster1.example.com
      members: 2
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"
          - votes: 1
            priority: "1.5"
            tags:
                  tag2: "value2"
                  environment: "prod"
    - clusterName: cluster2.example.com
      members: 1
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"
    - clusterName: cluster3.example.com
      members: 1
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"

podSpec.persistence

タイプ: コレクション

spec.configSrv.clusterSpecListとspec.shard.clusterSpecListに渡されるclusterSpecItemオブジェクトでのみ利用可能。 特定のクラスターの既存の永続化構成を上書きします。

statefulSet

タイプ: コレクション

Provides the configuration for the StatefulSet override for each of the cluster's StatefulSets in a multi-Kubernetes cluster MongoDB deployment. To set the global configuration that applies to all clusters in your multi-Kubernetes cluster MongoDB deployment, see spec.statefulSet.spec.

この設定は、マルチ Kubernetes クラスター MongoDB 配置のレプリカセット リソース タイプにのみ適用されます。

spec.duplicateServiceObjects

注意

このフィールドは、マルチクラスターのシャーディングされたクラスターの配置でのみ使用できます。

タイプ: ブール値

任意

デフォルト: true

トポロジーがMultiClusterでない場合は無視されます。 すべてのシャーディングされたクラスターコンポーネントのサービスに適用されます（ mongos 、 configSrv 、 shards 。

trueに設定されている場合:

Kubernetes演算子は、各ノード クラスター内のすべてのノード クラスターからすべてのPod Servicesを作成します。

falseに設定されている場合:

Kubernetes演算子は、次のみを作成します:

spec.mongos.clusterSpecList

注意

このフィールドは、マルチクラスターのシャーディングされたクラスターの配置でのみ使用できます。

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

必須topology=MultiClusterの場合）

次の最上位フィールドを持つマルチクラスターのシャーディングされたクラスター配置で使用するオブジェクトの配列。

clusterName

型: string

MongoDB Controls for Kubernetes Operator が StateftSet をスケジュールするクラスターの名前。

externalAccess

タイプ: コレクション

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

これらの設定は、すべてのクラスターのサービスに適用されます。 特定のクラスターでこれらのグローバル設定をオーバーライドするには、 spec.clusterSpecList.externalAccess.externalService を使用します。

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

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

フィールド	値	説明
Name	<pod-name>-svc-external	外部サービスの名前。 この値は変更できません。
Type	LoadBalancer	外部 LoadBalancer を作成します service
Port	<Port Number>	A port for mongod.
publishNotReadyAddress	true	Specifies that DNS records are created even if the Pod isn't ready. Do not set to false for any database Pod.

注意

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

members

タイプ: 数値

MongoDB レプリカセット内のノードの数。

memberConfig

タイプ: コレクション

マルチ Kubernetes クラスターMongoDBデプロイ内の各MongoDBシャードとそのノードの仕様。

シャードのオブジェクト内の要素の順序は、レプリカセット内のノードの順序を反映する必要があります。 例、最初の要素はインデックス0の ポッドに影響し、2 番目の要素はインデックス1に影響するなど、 に影響します。

例

3 つのレプリカ セットを含むマルチ Kubernetes クラスター MongoDB 配置の次の例の仕様を検討してみましょう。

apiVersion: mongodb.com/v1
kind: MongoDBMultiCluster
metadata:
  name: multi-replica-set
spec:
  version: 8.0.0
  type: ReplicaSet
  duplicateServiceObjects: false
  credentials: my-credentials
  opsManager:
    configMapRef:
      name: my-project
  clusterSpecList:
    - clusterName: cluster1.example.com
      members: 2
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"
          - votes: 1
            priority: "1.5"
            tags:
                  tag2: "value2"
                  environment: "prod"
    - clusterName: cluster2.example.com
      members: 1
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"
    - clusterName: cluster3.example.com
      members: 1
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"

statefulSet

タイプ: コレクション

Provides the configuration for the StatefulSet override for each of the cluster's StatefulSets in a multi-Kubernetes cluster MongoDB deployment. To set the global configuration that applies to all clusters in your multi-Kubernetes cluster MongoDB deployment, see spec.statefulSet.spec.

この設定は、マルチ Kubernetes クラスター MongoDB 配置のレプリカセット リソース タイプにのみ適用されます。

spec.shard.clusterSpecList

注意

このフィールドは、マルチクラスターのシャーディングされたクラスターの配置でのみ使用できます。

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

必須topology=MultiClusterの場合）

次の最上位フィールドを持つマルチクラスターのシャーディングされたクラスター配置で使用するオブジェクトの配列。

clusterName

型: string

MongoDB Controls for Kubernetes Operator が StateftSet をスケジュールするクラスターの名前。

externalAccess

タイプ: コレクション

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

これらの設定は、すべてのクラスターのサービスに適用されます。 特定のクラスターでこれらのグローバル設定をオーバーライドするには、 spec.clusterSpecList.externalAccess.externalService を使用します。

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

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

フィールド	値	説明
Name	<pod-name>-svc-external	外部サービスの名前。 この値は変更できません。
Type	LoadBalancer	外部 LoadBalancer を作成します service
Port	<Port Number>	A port for mongod.
publishNotReadyAddress	true	Specifies that DNS records are created even if the Pod isn't ready. Do not set to false for any database Pod.

注意

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

members

タイプ: 数値

MongoDB レプリカセット内のノードの数。

memberConfig

タイプ: コレクション

マルチ Kubernetes クラスターMongoDBデプロイ内の各MongoDBシャードとそのノードの仕様。

シャードのオブジェクト内の要素の順序は、レプリカセット内のノードの順序を反映する必要があります。 例、最初の要素はインデックス0の ポッドに影響し、2 番目の要素はインデックス1に影響するなど、 に影響します。

例

3 つのレプリカ セットを含むマルチ Kubernetes クラスター MongoDB 配置の次の例の仕様を検討してみましょう。

apiVersion: mongodb.com/v1
kind: MongoDBMultiCluster
metadata:
  name: multi-replica-set
spec:
  version: 8.0.0
  type: ReplicaSet
  duplicateServiceObjects: false
  credentials: my-credentials
  opsManager:
    configMapRef:
      name: my-project
  clusterSpecList:
    - clusterName: cluster1.example.com
      members: 2
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"
          - votes: 1
            priority: "1.5"
            tags:
                  tag2: "value2"
                  environment: "prod"
    - clusterName: cluster2.example.com
      members: 1
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"
    - clusterName: cluster3.example.com
      members: 1
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"

podSpec.persistence

タイプ: コレクション

spec.configSrv.clusterSpecListとspec.shard.clusterSpecListに渡されるclusterSpecItemオブジェクトでのみ利用可能。 特定のクラスターの既存の永続化構成を上書きします。

statefulSet

タイプ: コレクション

Provides the configuration for the StatefulSet override for each of the cluster's StatefulSets in a multi-Kubernetes cluster MongoDB deployment. To set the global configuration that applies to all clusters in your multi-Kubernetes cluster MongoDB deployment, see spec.statefulSet.spec.

この設定は、マルチ Kubernetes クラスター MongoDB 配置のレプリカセット リソース タイプにのみ適用されます。

spec.shardOverrides

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

任意

シャードごとのオーバーライドを含むリスト。 各オブジェクトには、次のフィールドが含まれています。

• shardNames

  必須

  このオーバーライドが適用されるシャードの名前。

• podSpec.Persistence

  任意

  Kubernetes Operator が永続ボリュームを作成してシャードにバインドする方法を定義します。 topology=MultiClusterの場合、すべてのノード クラスターの永続化設定を設定します。 spec.shardOverrides.clusterSpecList.persistenceでは、特定のノード クラスターの永続設定を定義できます。

• additionalMongodConfig

  任意

  spec.shard.additionalMongodConfigのシャード固有の上書き。

• agent

  任意

  spec.shard.agentのシャード固有の上書き。

• statefulSet

  任意

  spec.shardPodSpec.podTemplateとspec.shard.clusterSpecList.statefulSetのシャード固有の上書き。

• members

  任意

  topology=SingleClusterの場合にのみ利用可能です。 spec.mongodsPerShardCountのオーバーライド用のシャード固有オーバーライド。

• memberConfig

  任意

  topology=SingleClusterの場合にのみ利用可能です。 spec.shard.memberConfigのシャード固有の上書き。

spec.shardPodSpec.persistence.single

タイプ: コレクション

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

注意

• You must set the values in this collection if spec.persistent : true.

• このコレクションまたはpersistence.multipleコレクションを設定できますが、両方は設定できません。

スカラー	データ型	説明
labelSelector	string	マウントされたボリュームをディレクトリにバインドするために使用されるタグ。
storage	string	永続ボリューム の最小サイズ マウントする必要があるもの。この値は、 JEDEC表記では、整数とそれに続くストレージの単位として表されます。 デフォルト値は 16Gi です。 例、 の各シャーディングされたクラスターのシャード ノードに60 ギガバイトのストレージ容量が必要な場合は、この値を60Gi に設定します。
storageClass	string	永続的なボリューム要求 で指定されるストレージのタイプ 。このストレージ タイプは、 StorageClass として作成できます。 この オブジェクト で使用する前にオブジェクトを 仕様。 Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.