Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
Click here >
Docs Menu
Docs Home
/ /

DatabaseUser カスタム リソース

MongoDB Kubernetes Atlas 演算子によって管理されるデータベースユーザー。

Name
タイプ
説明
必須

apiVersion

string

atlas.generated.mongodb.com/v1

true

kind

string

DatabaseUser

true

metadata

オブジェクト

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

true

spec

オブジェクト

次のバージョンをサポートするデータベースユーザーの仕様。

  • v20250312

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

  • (has(セルフ.v20250312.``groupId``)&=has(自分.`` connectionSecretRef``))|| (ディレクティブを使用した置換20250312spec.v20250312.``groupId`` が設定されている場合は、spec.`` connectionSecretRef`` を設定する必要があります。

false

status

オブジェクト

指定されたリソースバージョンのデータベースユーザーの読み取り専用 status が最近監視されたリソース バージョンのデータベースユーザーの読み取り専用 です。このデータは最新ではなく、システムによって入力されている場合があります。詳細については、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

false

次のバージョンをサポートするデータベースユーザーの仕様。

  • v20250312

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

Name
タイプ
説明
必須

connectionSecretRef

オブジェクト

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

false

v20250312

オブジェクト

バージョン v20250312 のデータベースユーザーリソースの仕様。検証:

  • (has(自分自身.``groupId``)&+ !has(Self.``groupRef``))|| (!has(自分自身.``groupId``)& は(自己 .``groupRef``):groupIdgroupRef は相互に排他的です。設定できるのは 1 つだけです

false

機密フィールド

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

Name
タイプ
説明
必須

name

string

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

false

バージョン v20250312 のデータベースユーザーリソースの仕様。

Name
タイプ
説明
必須

entry

オブジェクト

データベースユーザーリソース仕様の entry フィールド。これらのフィールドは、データベースユーザーの作成および更新に設定できます。

false

groupId

string

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

注意

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

検証:

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

false

groupRef

オブジェクト

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

false

データベースリソースリソースのエントリ フィールドを指定します。これらのフィールドは、データベースユーザーの作成および更新に設定できます。

Name
タイプ
説明
必須

databaseName

string

データベースユーザーが認証するデータベース。データベースユーザーは、MongoDB にログするにはユーザー名と認証データベースの両方を指定する必要があります。ユーザーが AWS IAM、x.509、LDAP、または OIDC ワークロードで認証する場合、この値は $external になります。ユーザーが SCRAM-SHA または OIDC Workforce で認証される場合、この値は admin になります。

true

roles

[]オブジェクト

1 つのロールと適用される 1 つのデータベースの組み合わせを提供するリスト。

true

username

string

MongoDB に認証するユーザーを表す、人間が判読できるラベル。このラベルの形式は、認証の方法によって異なります。

認証方法
必要なパラメーター
パラメーターの値
username 形式

AWS IAM

awsIAMType

ROLE

ARN

AWS IAM

awsIAMType

USER

ARN

x.509

x509Type

CUSTOMER

RFC 2253 識別名

x.509

x509Type

MANAGED

RFC 2253 識別名

LDAP

ldapAuthType

USER

RFC 2253 識別名

LDAP

ldapAuthType

GROUP

RFC 2253 識別名

OIDC 従業員

oidcAuthType

IDP_GROUP

Atlas OIDCIdP ID(フェデレーション設定で確認可能)、その後に「/」、その後に IdP グループ名が続きます

OIDC ワークロード

oidcAuthType

USER

Atlas OIDCIdP ID(フェデレーション設定で確認可能)、その後に「/」、その後に IdP ユーザー名が続きます

SCRAM-SHA

awsIAMType, x509Type, ldapAuthType, oidcAuthType

NONE

英数字の文字列

true

awsIAMType

string

新しいデータベースユーザーが、ユーザーに関連付けられたAmazon Web Services (AWS)の ID とアクセス管理(IAM)の認証情報で認証されるか、またはユーザーのロールで認証されるを示す、人間が判読できるラベル。

false

deleteAfterDate

string

MongoDB Cloud がユーザーを削除する日時。このパラメータは、UTCISO 8601 タイムスタンプ形式で値を表し、タイムゾーンの指定を含めることができます。API(API)のリクエストを行ってから 1 週間以内の未来の日付を指定する必要があります。

false

description

string

このデータベースユーザーの説明。

false

labels

[]オブジェクト

MongoDBデータベースユーザー をタグ付けおよび分類するためのキーと値のペアが格納されたリスト。定義した labels はコンソールに表示されません。

false

ldapAuthType

string

データベースがLDAP ホスト上でこのデータベースユーザーを認証するために使用する Lightweight Directory Access Protocol(LDAP)レコードの一部。

false

oidcAuthType

string

新しいデータベースユーザーまたはグループが OIDC フェデレーション認証で認証されるかどうかを示す、人間に判読可能なラベル。フェデレーション認証ユーザーを作成するには、このフィールドに USER の値を指定します。フェデレーション認証グループを作成するには、このフィールドに IDP_GROUP の値を指定します。

false

passwordSecretRef

オブジェクト

SENSITIVE FIELD 「パスワード」フィールドのデータを含むシークレットへの参照: databaseName で指定されたデータベースに対してこのデータベースユーザーを認証する文字列。SCRAM-SHA で認証するには、このパラメータを指定する必要があります。このパラメーターは、この応答には含まれません。

false

scopes

[]オブジェクト

このデータベースユーザーがアクセスできるクラスター、MongoDB Atlas データレイク、MongoDB Atlas Streams ワークスペースが格納されたリスト。省略した場合、MongoDBCloud はデータベースユーザーに、プロジェクト内のすべてのクラスター、MongoDB Atlas Data Lakes、MongoDB Atlas Streams ワークスペースへのアクセスを許可します。

false

x509Type

string

MongoDB Cloud がデータベースユーザー の認証に使用する X.509 メソッド。

  • アプリケーション管理 X.509 の場合は、MANAGED を指定します。

  • 自己管理型 X.509 の場合は、CUSTOMER を指定します。

CUSTOMER メソッドで作成されたユーザーには、ユーザー名パラメータにコモン ネーム(CN)が必要です。$externalデータベースで外部認証ユーザーを作成する必要があります。

false

このデータベースユーザーが利用できるリソースの範囲。

Name
タイプ
説明
必須

databaseName

string

ユーザーがアクセス特権を付与されるデータベース。

true

roleName

string

データベースユーザーに割り当てられた特権のグループを識別する、人間が判読可能なラベル。この値は、 組み込みロール またはカスタムロールにすることができます。

true

collectionName

string

このロールが適用されるコレクション。

false

このMongoDB Cloud コンポーネントに適用された、人間が判読可能なラベル。

Name
タイプ
説明
必須

key

string

このコンポーネントをタグ付けおよび分類するために適用されるキー。

false

value

string

このコンポーネントをタグ付けおよび分類するために適用されるキーに設定された値。

false

機密フィールド

「パスワード」フィールドのデータを含むシークレットへの参照。

databaseName で指定されたデータベースに対してこのデータベースユーザーを認証する文字列。SCRAM-SHA で認証するには、このパラメーターを指定する必要があります。このパラメーターは、この応答には含まれません。

Name
タイプ
説明
必須

name

string

機密フィールド値を含むシークレットの名前。

true

key

string

機密フィールド値を含むシークレット データのキー。デフォルトは「パスワード」です。デフォルト: パスワード

false

このデータベースユーザーが利用できるリソースの範囲。

Name
タイプ
説明
必須

name

string

このデータベースユーザーがアクセスできるクラスターまたは MongoDB Atlas Data Lake を識別する、人間が判読できるラベル。

true

type

string

このデータベースユーザーがアクセスできるリソースのカテゴリ。

true

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

Name
タイプ
説明
必須

name

string

"Group"リソースの名前。

false

指定されたリソースバージョンのデータベースユーザーの直近で確認された読み取り専用のステータス。このデータは最新ではなく、システムによって入力されている場合があります。詳細については、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name
タイプ
説明
必須

conditions

[]オブジェクト

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

false

v20250312

オブジェクト

バージョン v20250312 のデータベースユーザーリソースの最後に確認された Atlas の状態。

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

バージョン v20250312 のデータベースユーザーリソースの最後に確認された Atlas の状態。

Name
タイプ
説明
必須

databaseName

string

データベースユーザーが認証するデータベース。データベースユーザーは、MongoDB にログするにはユーザー名と認証データベースの両方を指定する必要があります。ユーザーが AWS IAM、x.509、LDAP、または OIDC ワークロードで認証する場合、この値は $external になります。ユーザーが SCRAM-SHA または OIDC Workforce で認証される場合、この値は admin になります。

true

groupId

string

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

true

username

string

MongoDB に認証するユーザーを表す、人間が判読できるラベル。このラベルの形式は、認証の方法によって異なります。

認証方法
必要なパラメーター
パラメーターの値
username 形式

AWS IAM

awsIAMType

ROLE

ARN

AWS IAM

awsIAMType

USER

ARN

x.509

x509Type

CUSTOMER

RFC 2253 識別名

x.509

x509Type

MANAGED

RFC 2253 識別名

LDAP

ldapAuthType

USER

RFC 2253 識別名

LDAP

ldapAuthType

GROUP

RFC 2253 識別名

OIDC 従業員

oidcAuthType

IDP_GROUP

Atlas OIDCIdP ID(フェデレーション設定で確認可能)、その後に「/」、その後に IdP グループ名が続きます

OIDC ワークロード

oidcAuthType

USER

Atlas OIDCIdP ID(フェデレーション設定で確認可能)、その後に「/」、その後に IdP ユーザー名が続きます

SCRAM-SHA

awsIAMType, x509Type, ldapAuthType, oidcAuthType

NONE

英数字の文字列

true

戻る

FlexCluster

項目一覧