Docs Menu
Docs Home
/ /

FlexCluster カスタム リソース

A flexcluster, managed by the MongoDB Kubernetes Atlas Operator.

Name
タイプ
説明
必須

apiVersion

string

atlas.generated.mongodb.com/v1

true

kind

string

FlexCluster

true

metadata

オブジェクト

metadataフィールドのフィールドについては、 Kubernetes API のドキュメントを参照してください。

true

spec

オブジェクト

Specification of the flexcluster supporting the following versions:

  • v20250312

バージョン化された を最大 1spec つ指定できます。詳細については、 https://git.k8 s.io/community/contributors/devel/sign-archives/api-conventions.md#spec-and-status 検証:

  • (has(自己.v20250312.``groupId``) & は(自己.`` connectionSecretRef``) || (!has(セルフ.v20250312.``groupId``)):spec.v20250312.``groupId`` が設定されている場合は、spec.`` connectionSecretRef`` を設定する必要があります。

false

status

オブジェクト

Most recently observed read-only status of the flexcluster for the specified resource version. This data may not be up to date and is populated by the system. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

false

Specification of the flexcluster supporting the following versions:

  • v20250312

指定できるバージョン化された仕様は最大 1 つです。詳細については、 https://git.k8 s.io/community/contributors/devel/sign-archives/api-conventions.md#spec-and-status

Name
タイプ
説明
必須

connectionSecretRef

オブジェクト

SENSITIVE FIELD Atlas への接続を設定するための認証情報を含むシークレットへの参照。

false

v20250312

オブジェクト

The spec of the flexcluster resource for version v20250312. Validations:

  • (has(Self.``groupId``) &+ !has(Self.``groupRef``)) ||groupId (ディレクティブを含む)やgroupRef を使用した場合、設定できるのは 1 つだけです

false

機密フィールド

Atlas への接続を設定するための認証情報を含むシークレットへの参照。

Name
タイプ
説明
必須

name

string

Atlas 認証情報を含むシークレットの名前。

false

The spec of the flexcluster resource for version v20250312.

Name
タイプ
説明
必須

entry

オブジェクト

The entry fields of the flexcluster resource spec. These fields can be set for creating and updating flexclusters.

false

groupId

string

プロジェクトを識別する一意の 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。

注意

グループとプロジェクトは同義語です。 そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

検証:

  • 自己 == oldSelf: groupId は作成後に変更できません

false

groupRef

オブジェクト

"Group"リソースへの参照。 "$.status.v20250312.id" の値は、"groupId" を設定するために使用されます。 "groupId"プロパティと排他関係にあります。

false

The entry fields of the flexcluster resource spec. These fields can be set for creating and updating flexclusters.

Name
タイプ
説明
必須

name

string

インスタンスを識別する、人間が判読可能なラベル。

true

providerSettings

オブジェクト

プロビジョニングされたMongoDBフレキシブルなクラスターを構成するクラウドプロバイダー設定のグループ。

true

tags

[]オブジェクト

インスタンスのタグ付けと分類に使用する、長さが 1 から 255 文字のキーと値のペアを含むリスト。

false

terminationProtectionEnabled

ブール値

クラスターで終了保護が有効になっているかどうかを示すフラグ。 true に設定されていると、MongoDB Cloud はクラスターを削除しません。 false に設定されていると、MongoDB Cloud はクラスターを削除します。

false

プロビジョニングされた MongoDB フレックスクラスタを構成するクラウドプロバイダー設定のグループ。

Name
タイプ
説明
必須

backingProviderName

string

Cloud service provider on which MongoDB Cloud provisioned the flex cluster.

true

regionName

string

Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see AWS, GCP, and Azure.

true

MongoDB Cloud の組織、プロジェクト、または クラスター をタグ付けして分類するキーと値のペア。例、environment : production

Name
タイプ
説明
必須

key

string

タグのセットを定義する定数。 たとえば、 environment : productionタグ内のenvironment

true

value

string

タグのセットに属する 変数 。 たとえば、 environment : productionタグ内のproduction

true

"Group"リソースへの参照。 "$.status.v20250312.id" の値は、"groupId" を設定するために使用されます。 "groupId"プロパティと排他関係にあります。

Name
タイプ
説明
必須

name

string

"Group"リソースの名前。

false

Most recently observed read-only status of the flexcluster for the specified resource version. This data may not be up to date and is populated by the system. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name
タイプ
説明
必須

conditions

[]オブジェクト

リソースの現在の状態に関する利用可能な最新の観察を表します。

false

v20250312

オブジェクト

The last observed Atlas state of the flexcluster resource for version v20250312.

false

Name
タイプ
説明
必須

status

string

条件のステータスは、True、False、Unknown のいずれか 1 つです。

true

type

string

条件のタイプ。

true

lastTransitionTime

string

条件があるステータスから別のステータスに最後に移行した時刻。形式: 日時

false

message

string

移行に関する詳細を示す、人間が判読可能な message

false

observedGeneration

integer

observedGeneration は、 を表します。条件が基づいて設定されたメタデータ. 生成。

false

reason

string

条件の最後の移行の reason

false

The last observed Atlas state of the flexcluster resource for version v20250312.

Name
タイプ
説明
必須

providerSettings

オブジェクト

プロビジョニングされたMongoDBフレキシブルなクラスターを構成するクラウドプロバイダー設定のグループ。

true

backupSettings

オブジェクト

柔軟なバックアップ構成。

false

clusterType

string

柔軟なクラスタートポロジー。

false

connectionStrings

オブジェクト

MongoDBデータベースを点均一リソース ロケールのコレクション。

false

createDate

string

Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.

false

groupId

string

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。

false

id

string

インスタンスを識別する一意の 24 桁の 16 進数文字列。

false

mongoDBVersion

string

Version of MongoDB that the instance runs.

false

name

string

インスタンスを識別する、人間が判読可能なラベル。

false

stateName

string

Atlas コントロール プレーンによってこのクラスターで実行されている現在のアクティビティを示す、人間が判読可能なラベル。 CREATING 状態と DELETING 状態を除き、 が進行中のアクティビティを示す 状態であっても、クラスターは常に使用可能であり、 プライマリノードが存在する必要があります。

  • IDLE: Atlas はこのクラスターに変更を加えず、UI または API を介してリクエストされたすべての変更が適用されたと想定できます。

  • CREATING: 初めてプロビジョニングされたクラスターは、接続の準備が整うまで状態 CREATING を返します。接続を試みる前に、IPアクセス リストと DB ユーザーが構成されていることを確認します。

  • UPDATING: UIAPIAutoScaling、またはその他のスケジュールされたアクティビティからリクエストされた変更が実行されています。

  • DELETING: クラスターは削除プロセス中であり、すぐに削除される予定です。

  • REPAIRING: クラスター内の 1 つ以上のノードが Atlas コントロール プレーンによって使用可能に返されています。他のノードは、通常どおりサービスを提供し続ける必要があります。

false

versionReleaseSystem

string

Method by which the cluster maintains the MongoDB versions.

false

プロビジョニングされた MongoDB フレックスクラスタを構成するクラウドプロバイダー設定のグループ。

Name
タイプ
説明
必須

backingProviderName

string

Cloud service provider on which MongoDB Cloud provisioned the flex cluster.

false

diskSizeGB

数値

フレキシブルなクラスターで使用可能なストレージキャパシティー(ギガバイト単位)。

false

providerName

string

プロバイダーの種類を識別する、人間が判読可能なラベル。

false

regionName

string

Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see AWS, GCP, and Azure.

false

柔軟なバックアップ構成。

Name
タイプ
説明
必須

enabled

ブール値

このフレキシブルなクラスターに対してバックアップが実行されているかどうかを示すフラグ。バックアップはフレキシブルなクラスターバックアップを使用します。

false

MongoDB データベースを指すユニフォーム リソース ロケータのコレクション。

Name
タイプ
説明
必須

standard

string

このクラスターに接続するために使用できるパブリック接続文字列。この接続文字列はmongodb://プロトコルを使用します。

false

standardSrv

string

このフレキシブルなクラスターに接続するために使用できるパブリック接続文字列。この接続文字列はmongodb+srv://プロトコルを使用します。

false

戻る

IpaccessListEntry

項目一覧