MongoDB.local SF, Jan 15: See the speaker lineup & ship your AI vision faster. Use WEB50 to save 50%
Find out more >
Docs 菜单
Docs 主页
/ /
自定义资源
Docs 主页
/
管理
/
Atlas Kubernetes Operator
/
自定义资源
Docs 主页
/
管理
/
Atlas Kubernetes Operator
/
自定义资源

AtlasFederatedAuth 自定义资源

AtlasFederatedAuth自定义资源为您的 Atlas 组织配置联合身份验证。

当您创建AtlasFederatedAuth自定义资源时， Atlas Kubernetes Operator使用联合身份验证API资源来更新联合的组织配置。 在组织配置中，您可以为Atlas组织指定联合设置，例如组织和角色映射。

重要

自定义资源不再默认删除对象

  • Atlas Kubernetes Operator使用自定义资源配置文件来管理Atlas配置，但从Atlas Kubernetes Operator2.0 开始，您在Kubernetes中删除的自定义资源不再（默认）在Atlas中删除。相反， Atlas Kubernetes Operator只是停止管理Atlas中的这些资源。 AtlasProject示例，如果您在Kubernetes中删除 自定义资源，默认默认， Atlas Kubernetes Operator不再自动从Atlas中删除相应的项目。这种行为更改旨在帮助防止意外删除。 要学习；了解详情，包括如何将此行为恢复为在Atlas Kubernetes Operator.2 0之前使用的默认，请参阅新默认值： Atlas Kubernetes2 Operator.0 中的删除保护。

    同样，如果您使用Atlas Kubernetes Operator从Kubernetes中的Atlas项目中删除团队，则Atlas Kubernetes Operator不会从Atlas中删除团队。

  • 显式定义所需的配置详细信息，以避免隐式使用默认Atlas配置值。 在某些情况下，继承Atlas默认值可能会导致协调循环，从而阻止自定义资源实现 READY 状态。 示例，在 AtlasDeployment 自定义资源中显式定义所需的自动伸缩行为（如所包含的示例所示）可确保自定义资源中的静态实例大小不会重复应用于已启用自动伸缩的Atlas部署。

    autoScaling:
      diskGB:
        enabled: true
      compute:
        enabled: true
        scaleDownEnabled: true
        minInstanceSize: M30
        maxInstanceSize: M40

要使用此资源，您必须有一个链接到您的 Atlas 组织的现有身份提供商 ( IdP )。 要了解更多信息，请参阅利用 Kubernetes 的联合身份验证。

示例

以下示例配置了执行以下操作的AtlasFederatedAuth自定义资源：

apiVersion: atlas.mongodb.com/v1
kind: AtlasFederatedAuth
metadata:
  name: atlas-default-federated-auth
  namespace: mongodb-atlas-system
spec:
  enabled: true
  dataAccessIdentityProviders:
    - 32b6e34b3d91647abb20e7b8
    - 42d8v92k5a34184rnv93f0c1
  connectionSecretRef:
    name: my-org-secret
    namespace: mongodb-atlas-system
  domainAllowList:
    - my-org-domain.com
  domainRestrictionEnabled: true
  ssoDebugEnabled: false
  postAuthRoleGrants:
    - ORG_MEMBER
  roleMappings:
    - externalGroupName: org-admin
      roleAssignments:
        - role: ORG_OWNER
    - externalGroupName: dev-team
      roleAssignments:
        - role: ORG_GROUP_CREATOR
        - projectName: dev-project
          role: GROUP_OWNER
status:
  conditions:
    - type: Ready
      status: True
    - type: RolesReady
      status: True
    - type: UsersReady
      status: True

注意

前面的示例包括描述更新过程的status部分。 要了解更多信息，请参阅创建和更新进程。

参数

AtlasFederatedAuth

AtlasFederatedAuth 是 Atlasfederatedauth API的模式

Name
类型
说明
必需

apiVersion

字符串

atlas.mongodb.com/v1

true

kind

字符串

AtlasFederatedAuth

true

metadata

对象

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

true

spec

对象

AtlasFederatedAuthSpec 定义了 AtlasFederatedAuth 的目标状态。

false

status

对象

AtlasFederatedAuthStatus 定义了 AtlasFederatedAuth 的观察到的状态。

false

AtlasFederatedAuth.spec

AtlasFederatedAuthSpec 定义了 AtlasFederatedAuth 的目标状态。

Name
类型
说明
必需

connectionSecretRef

对象

具有用于配置联合的 API凭证的连接密钥。这些凭证必须具有 OrganizationOwner 权限。

false

dataAccessIdentityProviders

[]string

代表可用于此组织中的数据访问的身份提供程序的唯一 ID 的集合。如果此字段缺少当前已连接的数据访问身份提供程序，则将断开连接。

false

domainAllowList

[]string

根据电子邮件地址限制用户加入组织的批准域。

false

domainRestrictionEnabled

布尔

防止联合中的用户访问联合外的组织以及创建新组织。此选项适用于整个联邦。更多信息，请访问 https://www.mongodb.com/zh-cn/docs/atlas/security/federation-advanced-options/#restrict-user-membership-to-the-federation 默认值：false

false

enabled

布尔

默认：false

false

postAuthRoleGrants

[]string

身份验证后授予该组织中的用户的Atlas角色。

false

roleMappings

[]对象

将 IDP 群组映射到Atlas角色。

false

ssoDebugEnabled

布尔

默认：false

false

AtlasFederatedAuth.spec.connectionSecretRef

带有用于配置联合的 API凭证的连接密钥。这些凭证必须具有 OrganizationOwner 权限。

Name
类型
说明
必需

name

字符串

Kubernetes资源名称

true

namespace

字符串

Kubernetes资源的命名空间

false

AtlasFederatedAuth.spec.roleMappings

RoleMapping 将外部群组从身份提供商程序映射到Atlas中的角色。

Name
类型
说明
必需

externalGroupName

字符串

ExternalGroupName 是此映射适用的 IDP群组的名称。

false

roleAssignments

[]对象

RoleAssignments 定义项目中应赋予群组成员的角色。

false

AtlasFederatedAuth.spec.roleMappings.roleAssignments

Name
类型
说明
必需

projectName

字符串

应在其中指定角色的同一组织中的Atlas项目。

false

role

枚举

roleAtlas中应提供给群组成员的 。枚举：ORG_MEMBER 、ORG_READ_ONLY 、ORG_BILLING_ADMIN 、ORG_GROUP_CREATOR 、ORG_OWNER 、ORG_BILLING_READ_ONLY 、GROUP_OWNER 、GROUP_READ_ONLY 、GROUP_DATA_ACCESS_ADMIN 、GROUP_DATA_ACCESS_READ_ONLY 、GROUP_DATA_ACCESS_READ_WRITE 、GROUP_CLUSTER_MANAGER 、GROUP_SEARCH_INDEX_EDITOR 、GROUP_DATABASE_ACCESS_ADMIN 、GROUP_BACKUP_MANAGER 、GROUP_STREAM_PROCESSING_OWNER 、ORG_STREAM_PROCESSING_ADMIN 、GROUP_OBSERVABILITY_VIEWER

false

AtlasFederatedAuth.status

AtlasFederatedAuthStatus 定义了观察到的 AtlasFederatedAuth 状态。

Name
类型
说明
必需

conditions

[]对象

条件是显示Atlas自定义资源当前状态的状态列表

true

observedGeneration

整型

ObservedGeneration 表示Atlas Operator 感知的资源规范的生成。 Atlas Operator 在开始资源协调后立即将该字段更新为“元数据生成”的值。格式：int64

false

AtlasFederatedAuth.status.conditions

条件描述了Atlas自定义资源在某一点的状态。

Name
类型
说明
必需

status

字符串

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

true

type

字符串

Atlas自定义资源条件的类型。

true

lastTransitionTime

字符串

上次条件从一种状态转换为另一种状态的时间。以ISO8601 格式表示。格式：日期-时间

false

message

字符串

提供有关转换的详细信息的 message。

false

reason

字符串

条件的最后一次转换的 reason。

false

后退

Atlas Data Federation

来年

从 Flex 到专用的迁移

在此页面上