Docs 菜单
Docs 主页
/ /

DatabaseUser 自定义资源

数据库用户,由MongoDB Kubernetes Atlas Operator托管。

Name
类型
说明
必需

apiVersion

字符串

atlas.生成.mongodb.com/v1

true

kind

字符串

DatabaseUser

true

metadata

对象

有关 metadata 字段的字段,请参阅 Kubernetes API 文档。

true

spec

对象

支持以下版本的数据库用户规范:

  • v20250312

spec最多可以指定一个版本化的 。更多信息: https://git.k8 s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status 验证:

  • (has(self.v20250312.``groupId``) && has(self.``connectionSecretRef``)) || (!has(self.v20250312.``groupId``)):如果设立了spec.v20250312.``groupId``,则必须设立spec.``connectionSecretRef``。

false

status

对象

false

支持以下版本的数据库用户规范:

  • v20250312

最多可以指定一个版本化规范。更多信息:https://git.k8 s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name
类型
说明
必需

connectionSecretRef

对象

SENSITIVE FIELD 引用包含用于设置与Atlas的连接的凭证的密钥。

false

v20250312

对象

版本 v20250312 的数据库用户资源规范。验证:

  • (has(self.``groupId``) && !has(self.``groupRef``)) || (!has(self.``groupId``) && has(self.``groupRef``)):groupIdgroupRef 是互斥的;只能设立其中之一

false

敏感领域

引用包含用于设置与Atlas的连接的凭证的密钥。

Name
类型
说明
必需

name

字符串

包含Atlas凭证的密钥名称。

false

版本 v20250312 的数据库用户资源规范。

Name
类型
说明
必需

entry

对象

数据库用户资源规范的 entry 字段。可以设立这些字段来创建和更新数据库用户。

false

groupId

字符串

用于标识项目的唯一 24-十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户访问权限检索的所有项目。

注意

注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的终结点使用“群组”一词。

验证:

  • self == oldSelfgroupId 创建后无法修改

false

groupRef

对象

对“群组”资源的引用。 "$.status.v20250312.id" 的值将用于设立"groupId"。与“groupId”属性互斥。

false

数据库用户资源规范的条目字段。可以设立这些字段来创建和更新数据库用户。

Name
类型
说明
必需

databaseName

字符串

数据库用户进行身份验证所依据的数据库。数据库用户必须提供用户名和身份验证数据库才能日志MongoDB。如果用户使用 AWS IAM、x.509、LDAPOIDC 工作负载进行身份验证,此值应为 $external。如果用户使用 SCRAM-SHAOIDC Workforce 进行身份验证,则此值应为 admin

true

roles

[]对象

提供单个角色与单个适用数据库配对的列表。

true

username

字符串

人类可读标签,表示向 MongoDB 进行身份验证的用户。此标签的格式取决于身份验证方法:

身份验证方法
所需参数
参数值
username format

AWS IAM

awsIAMType

ROLE

ARN

AWS IAM

awsIAMType

USER

ARN

x.509

x509Type

CUSTOMER

RFC2253 标识名

x.509

x509Type

MANAGED

RFC2253 标识名

LDAP

ldapAuthType

USER

RFC2253 标识名

LDAP

ldapAuthType

GROUP

RFC2253 标识名

OIDC 劳动力

oidcAuthType

IDP_GROUP

Atlas OIDC IdP ID(可在联合设置中找到),然后是“/”,然后是 IdP群组名称

OIDC 工作负载

oidcAuthType

USER

Atlas OIDC IdP ID(可在联合设置中找到),然后是“/”,然后是 IdP 用户名

SCRAM-SHA

awsIAMType, x509Type , ldapAuthType , oidcAuthType

NONE

字母数字字符串

true

awsIAMType

字符串

人类可读标签,指示新数据库用户是否使用与用户或用户角色关联的Amazon Web Services (AWS) 身份和访问管理 (IAM)凭证进行身份验证。

false

deleteAfterDate

字符串

MongoDB Cloud 删除用户的日期和时间。此参数在 UTC 中以 ISO 8601 时间戳格式表示其值,并且可以包括时区域名称。您必须指定发出应用程序编程接口 (API)请求后一周内的未来日期。

false

description

字符串

此数据库用户的描述。

false

labels

[]对象

列表,其中包含用于标记和分类 MongoDB数据库用户的键值对。您定义的 labels 不会出现在控制台中。

false

ldapAuthType

字符串

轻量级目录访问协议 (LDAP)记录的一部分,数据库使用它来验证 LDAP托管上的此数据库用户的身份。

false

oidcAuthType

字符串

人类可读标签,指示新的数据库用户或群组是否使用 OIDC联合身份验证进行身份验证。要创建联合身份验证用户,请在此字段中指定 USER 的值。要创建联合身份验证群组,请在此字段中指定 IDP_GROUP 的值。

false

passwordSecretRef

对象

SENSITIVE FIELD 对包含“密码”字段数据的密钥的引用:字母数字字符串,用于根据 databaseName 中指定的数据库对此数据库用户进行身份验证。要使用 SCRAM-SHA 进行身份验证,您必须指定此参数。此参数不会出现在此响应中。

false

scopes

[]对象

包含此数据库用户可以访问权限的集群、MongoDB Atlas Data Lakes 和 MongoDB Atlas Streams 工作区的列表。如果省略,MongoDB Cloud 会授予数据库用户访问权限项目中所有集群、MongoDB Atlas Data Lake 和 MongoDB Atlas Streams 工作区的权限。

false

x509Type

字符串

X.509 方法,MongoDB Cloud 用于对数据库用户进行身份验证。

  • 对于应用程序托管的 X.509,请指定 MANAGED

  • 对于自我托管的 X.509,请指定 CUSTOMER

使用CUSTOMER 方法创建的用户需要在用户名参数中使用公用名CN ()。您必须在$external 数据库上创建经过外部身份验证的用户。

false

该数据库用户可用的资源范围。

Name
类型
说明
必需

databaseName

字符串

向该用户授予访问权限权限的数据库。

true

roleName

字符串

人类可读标签,用于标识分配给数据库用户的一群组权限。此值可以是内置角色或自定义角色。

true

collectionName

字符串

此角色适用的集合。

false

应用于此MongoDB Cloud 组件的人类可读标签。

Name
类型
说明
必需

key

字符串

用于标签和分类该组件的键。

false

value

字符串

设立为用于标签和分类该组件的键的值。

false

敏感领域

对包含“密码”字段数据的密钥的引用:

用于根据 databaseName 中指定的数据库验证此数据库用户身份的字母数字字符串。要使用 SCRAM-SHA 进行身份验证,您必须指定此参数。该参数不出现在此响应中。

Name
类型
说明
必需

name

字符串

包含敏感字段值的密钥名称。

true

key

字符串

包含敏感字段值的密钥数据的密钥,默认为“password”。默认:密码

false

该数据库用户可用的资源范围。

Name
类型
说明
必需

name

字符串

人类可读标签,用于标识此数据库用户可以访问权限的集群或 MongoDB Atlas Data Lake 。

true

type

字符串

此数据库用户可以访问权限的资源类别。

true

对“群组”资源的引用。 "$.status.v20250312.id" 的值将用于设立"groupId"。与“groupId”属性互斥。

Name
类型
说明
必需

name

字符串

“群组”资源的名称。

false

最近观察到的指定资源版本的数据库用户的只读状态。此数据可能不是最新的,由系统填充。更多信息:https://git.k8 s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name
类型
说明
必需

conditions

[]对象

表示资源当前状态的最新可用观察结果。

false

v20250312

对象

上次观察到的版本 v20250312 的数据库用户资源的Atlas状态。

false

Name
类型
说明
必需

status

字符串

条件的状态,为 True、False、未知之一。

true

type

字符串

条件类型。

true

lastTransitionTime

字符串

上次条件从一种状态转换为另一种状态的时间。格式:日期-时间

false

message

字符串

人类可读的 message,表示有关转换的详细信息。

false

observedGeneration

整型

observedGeneration 代表 。设立条件所依据的元数据.Generation。

false

reason

字符串

条件的最后一次转换的 reason

false

上次观察到的版本 v20250312 的数据库用户资源的Atlas状态。

Name
类型
说明
必需

databaseName

字符串

数据库用户进行身份验证所依据的数据库。数据库用户必须提供用户名和身份验证数据库才能日志MongoDB。如果用户使用 AWS IAM、x.509、LDAPOIDC 工作负载进行身份验证,此值应为 $external。如果用户使用 SCRAM-SHAOIDC Workforce 进行身份验证,则此值应为 admin

true

groupId

字符串

用于标识项目的唯一的 24 位十六进制数字字符串。

true

username

字符串

人类可读标签,表示向 MongoDB 进行身份验证的用户。此标签的格式取决于身份验证方法:

身份验证方法
所需参数
参数值
username format

AWS IAM

awsIAMType

ROLE

ARN

AWS IAM

awsIAMType

USER

ARN

x.509

x509Type

CUSTOMER

RFC2253 标识名

x.509

x509Type

MANAGED

RFC2253 标识名

LDAP

ldapAuthType

USER

RFC2253 标识名

LDAP

ldapAuthType

GROUP

RFC2253 标识名

OIDC 劳动力

oidcAuthType

IDP_GROUP

Atlas OIDC IdP ID(可在联合设置中找到),然后是“/”,然后是 IdP群组名称

OIDC 工作负载

oidcAuthType

USER

Atlas OIDC IdP ID(可在联合设置中找到),然后是“/”,然后是 IdP 用户名

SCRAM-SHA

awsIAMType, x509Type , ldapAuthType , oidcAuthType

NONE

字母数字字符串

true

后退

FlexCluster

在此页面上