/ /

Atlas Kubernetes Operator

自定义资源

Docs 主页

管理

Atlas Kubernetes Operator

自定义资源

`AtlasProject` 自定义资源

AtlasProject自定义资源在 Atlas 中配置项目。当您创建AtlasProject资源时，Atlas Kubernetes Operator 会尝试在 Atlas 中创建新项目。

重要

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

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

在连接密钥配置的组织中创建一个新项目。
重复使用现有项目。在这种情况下，Atlas Kubernetes Operator 会验证是否存在具有spec.name的项目。如果项目存在，Atlas Kubernetes Operator 会跳过创建过程。协调后，Atlas Kubernetes Operator 使用项目的 ID 更新status.id字段。

您可以使用 spec.connectionSecretRef.name 参数设立 AtlasProject自定义资源的连接密钥。此参数会覆盖默认的global 连接密钥。

默认下， Atlas Kubernetes Operator将连接密钥保存在与 AtlasProject自定义资源相同的命名空间中。要将密钥存储在其他命名空间中，请指定 spec.connectionSecretRef。命名空间参数。

要连接APIAtlas ， Atlas Kubernetes Operator会从Atlas Kubernetes Operator密钥中读取组织ID和API密钥。

您还可以编辑AtlasProject自定义资源规范来配置以下选项：

带有 spec.projectIpAccessList 参数的IP访问列表。此IP访问列表向项目中的Atlas集群授予网络访问权限。
带有 spec.teams 参数的团队。团队允许您为特定项目的整个Atlas用户群组授予访问权限角色。
带有 spec.maintenanceWindow 参数的维护窗口。维护窗口设置Atlas开始对数据库部署进行每周维护的时间和日期。

使用 spec.networkPeers 参数的网络对等互连。网络对等互连允许您安全地连接到 AWS、 Azure或 Google Cloud VPC。
使用客户管理的密钥和 spec.encryptionAtRest 参数进行静态加密。通过使用客户管理的密钥进行静态加密，您可以将云提供商的KMS与MongoDB加密存储引擎结合使用，从而增加额外的安全层。
带有 spec.privateEndpoints 参数的私有端点。
使用 spec.x509 CertRef.name 参数进行 X.509 身份验证。
使用 spec.settings 参数进行项目设置，包括启用和禁用以下功能的设置：
- 收集集群指标中的数据库统计信息
- 质谱图解析器(Data Explorer)
- 性能顾问
- 实时性能面板
- 模式顾问
- 使用 spec.alertConfigurationSyncEnabled 和 spec.alertConfigurations 参数进行项目警报配置。
  有关这些设置如何交互的信息，请参阅注意事项。

如果您从 Kubernetes 集群中删除AtlasProject资源，Atlas Kubernetes Operator 将从 Atlas 中删除该项目。您必须事先删除项目中的所有集群。否则，Atlas 会拒绝删除请求。

例子

以下示例显示了AtlasProject自定义资源规范：

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
 name: my-project
spec:
 name: Test project
 connectionSecretRef:
   name: my-atlas-key
 projectIpAccessList:
   - cidrBlock: "203.0.113.0/24"
     comment: "CIDR block for Application Server B - D"

Prometheus 示例

以下示例显示了与 Prometheus 集成的AtlasProject自定义资源规范：

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
  name: my-project
spec:
  name: TestPrometheusIntegration
  connectionSecretRef:
    name: my-atlas-key
  projectIpAccessList:
    - cidrBlock: "0.0.0.0/1"
      comment: "Everyone has access. For test purposes only."
    - cidrBlock: "128.0.0.0/1"
      comment: "Everyone has access. For test purposes only."
  integrations:
    - type: "PROMETHEUS"
      enabled: "true"
      username: "prometheus-user"
      passwordRef:
        name: "password-name"
        namespace: "password-namespace"
      scheme: "http"
      serviceDiscovery: "http"

要了解更多信息，请参阅与第三方服务集成。

注意

Atlas Kubernetes Operator提供了一个示例Grafana仪表盘，您可以将其导入 Grafana 中。

团队示例

以下示例显示了一个AtlasProject自定义资源规范，该规范为green-leaf-team赋予了此项目的Organization Owner角色。团队成员在AtlasTeam 自定义资源中定义。

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
  name: my-project
spec:
  name: Test project
  teams:
    - teamRef:
        name: green-leaf-team
      roles:
      - ORGANIZATION_OWNER

要了解详情，请参阅配置团队。

维护窗口示例

以下示例显示了一个AtlasProject自定义资源规范，该规范将维护窗口设置为每周二上午 5:00，并禁用自动延迟：

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
 name: my-project
spec:
 name: Test project
 projectIpAccessList:
   - ipAddress: "192.0.2.15"
     comment: "IP address for Application Server A"
maintenanceWindow:
 dayOfWeek: 3
 hourOfDay: 5
 autoDefer: false

项目设置示例

以下示例显示了 AtlasProject 自定义资源规范，该规范禁用集群指标、数据浏览器、 Performance Advisor 、实时性能面板和模式优化顾问中的数据库统计信息集合。

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
 name: my-project
spec:
 name: Test project
 projectIpAccessList:
   - ipAddress: "192.0.2.15"
     comment: "IP address for Application Server A"
 settings:
   isCollectDatabaseSpecificsStatisticsEnabled: false
   isDataExplorerEnabled: false
   isExtendedStorageSizesEnabled: false
   isPerformanceAdvisorEnabled: false
   isRealtimePerformancePanelEnabled: false
   isSchemaAdvisorEnabled: false

警报配置示例

以下示例显示了一个AtlasProject自定义资源规范，该规范配置了一个警报，该警报在 oplog 窗口达到少于一小时时触发：

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
  name: my-project
spec:
  name: Test Atlas Operator Project
  connectionSecretRef:
    name: my-atlas-key
  alertConfigurations:
    - eventTypeName: "REPLICATION_OPLOG_WINDOW_RUNNING_OUT",
      enabled: true,
      notifications:
      -  delayMin: 0
         emailEnabled: true
         intervalMin: 60
         roles: [ "GROUP_OWNER" ]
         smsEnabled: false
         typeName: "GROUP"
      threshold:
         operator: "LESS_THAN",
         threshold: "1",
         units: "HOURS"
  alertConfigurationSyncEnabled: true
  withDefaultAlertsSettings: false

第三方警报配置示例

以下示例显示了一个AtlasProject自定义资源规范，该规范配置了通过 Slack 发送通知的警报：

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
  name: my-project
spec:
  name: Test Atlas Operator Project
  connectionSecretRef:
    name: my-atlas-key
  alertConfigurations:
    - eventTypeName: "REPLICATION_OPLOG_WINDOW_RUNNING_OUT"
      enabled: true
      notifications:
      -  delayMin: 0
         emailEnabled: true
         intervalMin: 60
         roles: [ "GROUP_OWNER" ]
         smsEnabled: false
         - typeName: "SLACK"
           apiTokenRef:
             name: key-name
             namespace: key-namespace
      threshold:
         operator: "LESS_THAN"
         threshold: "1"
         units: "HOURS"
  alertConfigurationSyncEnabled: true
  withDefaultAlertsSettings: false

参数

Atlas 项目

AtlasProject 是 atlasprojects API的模式

`Name`	类型	说明	必需
`apiVersion`	字符串	atlas.mongodb.com/v1	true
`kind`	字符串	`AtlasProject`	true
`metadata`	对象	有关 `metadata`字段的字段，请参阅Kubernetes `API` 文档。	true
`spec`	对象	`AtlasProjectSpec` 定义Atlas中项目的目标状态	false
`status`	对象	`AtlasProjectStatus` 定义了观察到的状态 `AtlasProject`	false

AtlasProject.spec

AtlasProjectSpec 定义了Atlas中 Project 的目标状态

`Name`	类型	说明	必需
`name`	字符串	名称是`name` Operator 在Atlas中创建的项目的（如果尚不存在）。`name` 长度不得超过64 个字符。`name` 必须仅包含字母、数字、空格、破折号和下划线。验证： self == `oldSelf`：名称在项目创建后无法修改	true
`alertConfigurationSyncEnabled`	布尔	`AlertConfigurationSyncEnabled` 是一个标志，用于启用/禁用当前项目的警报配置同步。如果为 true —项目警报配置将根据 `AlertConfigurations` 进行同步。如果没有警报，操作符将不会修改配置。可以通过 `API`、`CLI` 和 `UI`托管它们。	false
`alertConfigurations`	[]对象	`AlertConfiguration` 是为当前项目配置的警报配置列表。如果使用此设置，还必须设立spec.``alertConfigurationSyncEnabled`` 设置为 true， Atlas Kubernetes Operator才能修改项目警报配置。如果您省略此设置或将其留空，Atlas Kubernetes Operator不会更改项目的警报配置。如果创建项目， Atlas会应用默认项目警报配置。	false
`auditing`	对象	审核代表 `MongoDB` Maintenance Windows。	false
`backupCompliancePolicyRef`	对象	`BackupCompliancePolicyRef` 是对备份合规自定义资源的引用。	false
`cloudProviderAccessRoles`	[]对象	`CloudProviderAccessRoles` 是为当前项目配置的云提供商访问角色列表。已弃用：此配置已弃用，取而代之的是 `CloudProviderIntegrations`	false
`cloudProviderIntegrations`	[]对象	`CloudProviderIntegrations` 是为当前项目配置的云提供商集成列表。	false
`connectionSecretRef`	对象	`ConnectionSecret` 是Kubernetes密钥的名称，其中包含有关连接到Atlas 的方式的信息（组织`ID`、`API` 密钥）。如果未提供，将使用默认的Operator 连接配置。	false
`customRoles`	[]对象	`CustomRoles` 允许您在集群中创建和更改自定义角色。使用自定义角色来指定Atlas内置角色无法描述的自定义操作集。已弃用：根据迁移指南迁移到自定义资源，网址为：https:`AtlasCustomRoles` 操作符 8so-migrate-ptr	false
`encryptionAtRest`	对象	`EncryptionAtRest` 允许为 `AWS`、 Azure和 `GCP` 提供程序设立加密。	false
`integrations`	[]对象	Integrations`MongoDB` `integrations`是项目的 Atlas 列表。已弃用：根据迁移指南迁移到`AtlasThirdPartyIntegration` 自定义资源，网址为：https: 操作符 8so-migrate-ptr	false
`maintenanceWindow`	对象	`MaintenanceWindow` 允许指定一周中运行维护操作的首选时间。更多信息请访问 https://www.mongodb.com/zh-cn/docs/atlas/reference/api/maintenance-windows/	false
`networkPeers`	[]对象	`NetworkPeers` 是为当前项目配置的网络对等方列表。已弃用：根据迁移指南迁移到`AtlasNetworkPeering` 和自定义资源，网址为：https:`AtlasNetworkContainer` 操作符 label-ak8 so-migrate-ptr	false
`privateEndpoints`	[]对象	`PrivateEndpoints` 是为当前项目配置的私有端点列表。已弃用：根据迁移指南迁移到自定义资源，网址为：https:`AtlasPrivateEndpoint` 操作符 8so-migrate-ptr	false
`projectIpAccessList`	[]对象	`ProjectIPAccessList` 允许使用项目的`IP` 访问列表。更多信息，请访问 https://mongodb.com/zh-cn/docs/atlas/reference/api/ip-access-list/add-entries-to-access-list/ 已弃用：迁移到`AtlasIPAccessList` 自定义资源根据迁移指南：https://www.mongodb.com/zh-cn/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak {操作符}8 so-migrate-ptr	false
`regionUsageRestrictions`	枚举	`RegionUsageRestrictions` 在使用Atlas for Government 时指定项目的地区。此参数不应与商业Atlas一起使用。在Atlas for Government 中，不设置此字段（默认为`AWSNONE` ）意味着项目仅限于`COMMERCIAL_FEDRAMP_REGIONS_ONLY` 。枚举：`NONE` 、`GOV_REGIONS_ONLY` 、`COMMERCIAL_FEDRAMP_REGIONS_ONLY` 默认值：`NONE`	false
`settings`	对象	设置允许配置项目设置。	false
`teams`	[]对象	Teams启用你能够向多个用户授予项目访问权限角色。	false
`withDefaultAlertsSettings`	布尔	指示Atlas Kubernetes Operator是否使用默认警报配置创建项目的标志。如果使用此设置，还必须设立spec.``alertConfigurationSyncEnabled`` 设置为 true， Atlas Kubernetes Operator才能修改项目警报配置。如果您在创建项目时将此参数设立为 false，Atlas不会默认警报配置添加到项目中。此设置对现有项目没有影响。默认值：true	false
`x509CertRef`	对象	X509CertRef 是对Kubernetes密钥的引用，其中包含 `PEM` 编码的 `CA` 证书。 Atlas Kubernetes Operator仅监视带有标签 atlas.mongodb.com/type=凭证的密钥，以避免监视不必要的密钥。	false

AtlasProject.spec.alertConfigurations

`Name`	类型	说明	必需
`enabled`	布尔	如果省略，则禁用配置。	false
`eventTypeName`	字符串	将触发警报的事件类型。	false
`matchers`	[]对象	仅当`EventTypeName`指定主机、副本集或分片集群的事件时，才能使用`matchers`数组进行筛选。	false
`metricThreshold`	对象	`MetricThreshold` 导致触发警报。	false
`notifications`	[]对象	检测到警报条件时发送通知。	false
`severityOverride`	枚举	`SeverityOverride` （可选）覆盖警报的默认严重性级别。枚举：`INFO` 、`WARNING` 、`ERROR` 、`CRITICAL`	false
`threshold`	对象	阈值会触发警报。	false

AtlasProject.spec.alertConfigurations.matchers

`Name`	类型	说明	必需
`fieldName`	字符串	目标对象中要匹配的字段的名称。	false
`operator`	字符串	用于测试字段值的 `operator`。	false
`value`	字符串	要使用指定操作符进行测试的值。	false

AtlasProject.spec.alertConfigurations.metricThreshold

MetricThreshold 会触发警报。

`Name`	类型	说明	必需
`threshold`	字符串	阈值，超出该阈值将触发警报。	true
`metricName`	字符串	要检查的指标名称。	false
`mode`	字符串	必须将其设立为 `AVERAGE`。 Atlas会将当前指标值计算为平均值。	false
`operator`	字符串	根据阈值检查当前指标值时要应用的操作符。	false
`units`	字符串	阈值的 `units`。	false

AtlasProject.spec.alertConfigurations。通知

`Name`	类型	说明	必需
`apiTokenRef`	对象	包含Slack `API` 令牌或 Bot 令牌的密钥。为 `SLACK`通知类型填充。如果令牌后来变得无效， Atlas会向项目所有者发送电子邮件，并最终删除令牌。	false
`channelName`	字符串	Slack渠道名称。为 `SLACK`通知类型填充。	false
`datadogAPIKeyRef`	对象	包含 Datadog `API` 密钥的密钥。可在 Datadog仪表盘盘中找到。为 `DATADOG`通知类型填充。	false
`datadogRegion`	字符串	指示要使用哪个 `API` `URL` 的区域。	false
`delayMin`	整型	检测到警报条件后发送第一个通知之前的等待分钟数。	false
`emailAddress`	字符串	发送警报通知的电子邮件解决。为 `EMAIL`通知类型填充。	false
`emailEnabled`	布尔	指示是否应发送电子邮件通知的标志。针对 `ORG`、`GROUP` 和 `USER`通知类型进行填充。	false
`flowName`	字符串	Flowdock 流名称（以小写字母表示）。	false
`flowdockApiTokenRef`	对象	Flowdock 个人 `API` 令牌。为 `FLOWDOCK`通知类型填充。如果令牌后来变得无效， Atlas会向项目所有者发送电子邮件，并最终删除令牌。	false
`intervalMin`	整型	未解决的未确认警报的连续通知之间等待的分钟数。	false
`mobileNumber`	字符串	向其发送警报通知的手机号码。为 `SMS`通知类型填充。	false
`opsGenieApiKeyRef`	对象	`OpsGenie` `API` 键。为 `OPS_GENIE`通知类型填充。如果密钥后来变得无效， Atlas会向项目所有者发送电子邮件，并最终删除令牌。	false
`opsGenieRegion`	字符串	指示要使用哪个 `API` `URL` 的区域。	false
`orgName`	字符串	Flowdock组织小写字母名称。这是 `URL` 字符串中应用之后出现的名称。为 `FLOWDOCK`通知类型填充。	false
`roles`	[]string	以下 `roles` 授予项目内的权限。	false
`serviceKeyRef`	对象	`PagerDuty` 服务密钥。为 `PAGER_DUTY`通知类型填充。如果密钥后来变得无效， Atlas会向项目所有者发送电子邮件，并最终删除密钥。	false
`smsEnabled`	布尔	指示是否应发送文本消息通知的标志。针对 `ORG`、`GROUP` 和 `USER`通知类型进行填充。	false
`teamId`	字符串	团队的唯一标识符。	false
`teamName`	字符串	接收此通知的团队的标签。	false
`typeName`	字符串	警报通知类型。	false
`username`	字符串	向其发送通知的Atlas 用户的名称。此处仅允许项目中拥有警报配置的用户。为 `USER`通知类型填充。	false
`victorOpsSecretRef`	对象	包含 `VictorOps` `API` 密钥和路由密钥的密钥。为 `VICTOR_OPS`通知类型填充。如果密钥后来变得无效， Atlas会向项目所有者发送电子邮件，并最终删除密钥。	false

AtlasProject.spec.alertConfigurations。通知.apiTokenRef

包含Slack API令牌或 Bot 令牌的密钥。为 SLACK通知类型填充。如果令牌后来变得无效， Atlas会向项目所有者发送电子邮件，并最终删除令牌。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.alertConfigurations。通知.datadogAPIKeyRef

包含 Datadog API密钥的密钥。可在 Datadog仪表盘盘中找到。为 DATADOG通知类型填充。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.alertConfigurations。通知.flowdockApiTokenRef

Flowdock 个人API令牌。为 FLOWDOCK通知类型填充。如果令牌后来变得无效， Atlas会向项目所有者发送电子邮件，并最终删除令牌。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.alertConfigurations。通知.opsGenieApiKeyRef

OpsGenie API密钥。为 OPS_GENIE通知类型填充。如果密钥后来变得无效， Atlas会向项目所有者发送电子邮件，并最终删除令牌。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.alertConfigurations。通知.serviceKeyRef

PagerDuty 服务密钥。针对 PAGER_DUTY通知类型进行填充。如果密钥后来变得无效， Atlas会向项目所有者发送电子邮件，并最终删除密钥。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.alertConfigurations。通知.victorOpsSecretRef

包含 VictorOps API密钥和路由密钥的密钥。为 VICTOR_OPS通知类型填充。如果密钥后来变得无效， Atlas会向项目所有者发送电子邮件，并最终删除密钥。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.alertConfigurations.threshold

阈值会触发警报。

`Name`	类型	说明	必需
`operator`	字符串	根据阈值检查当前指标值时要应用的操作符。它接受以下值：`GREATER_THAN`、`LESS_THAN`。	false
`threshold`	字符串	阈值，超出该阈值将触发警报。	false
`units`	字符串	阈值的 `units`。	false

AtlasProject.spec.auditing

审核代表MongoDB Maintenance Windows。

`Name`	类型	说明	必需
`auditAuthorizationSuccess`	布尔	指示审核系统是否使用 "atype": "`authCheck`" 审核事件捕获Atlas 审核筛选器的成功身份验证尝试。有关更多信息，请参阅 `auditAuthorizationSuccess`。	false
`auditFilter`	字符串	`JSON`项目使用的 - 格式的Atlas 审核过滤。	false
`enabled`	布尔	表示与 {`GROUP`-`ID`} 关联的项目是否启用了数据库审核。	false

AtlasProject.spec.backupCompliancePolicyRef

BackupCompliancePolicyRef 是对备份合规自定义资源的引用。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.cloudProviderAccessRoles

CloudProviderAccessRole 定义与云提供商的集成已弃用：此类型已弃用并替换为 CloudProviderIntegration

`Name`	类型	说明	必需
`providerName`	字符串	`ProviderName` 是云提供商的名称。目前仅支持 `AWS`。	true
`iamAssumedRoleArn`	字符串	`IamAssumedRoleArn` 是Atlas 集群所担任的 `IAM`角色的 `ARN`。	false

AtlasProject.spec.cloudProviderIntegrations

CloudProviderIntegration 定义与云提供商的集成

`Name`	类型	说明	必需
`providerName`	字符串	`ProviderName` 是云提供商的名称。目前仅支持 `AWS`。	true
`iamAssumedRoleArn`	字符串	`IamAssumedRoleArn` 是Atlas 集群所担任的 `IAM`角色的 `ARN`。	false

AtlasProject.spec.connectionSecretRef

ConnectionSecret 是Kubernetes密钥的名称，其中包含有关连接到Atlas的方式的信息（组织ID、 API密钥）。如果未提供，将使用默认的Operator 连接配置。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.customRoles

CustomRole 允许您在集群中创建和更改自定义角色。使用自定义角色来指定Atlas内置角色无法描述的自定义操作集。已弃用：根据迁移指南迁移到 AtlasCustomRoles 自定义资源，网址为：https: 操作符 8so-migrate-ptr

`Name`	类型	说明	必需
`name`	字符串	标识角色的人类可读标签。对于此项目中的此自定义角色，此 `name` 必须是唯一的。	true
`actions`	[]对象	角色授予的个人权限`actions` 的列表。	false
`inheritedRoles`	[]对象	该自定义角色继承的内置角色列表。	false

AtlasProject.spec.customRoles.actions

`Name`	类型	说明	必需
`name`	字符串	用于标识特权操作的可读标签。	true
`resources`	[]对象	您授予动作权限的 `resources` 列表。	true

AtlasProject.spec.customRoles.actions.resources

`Name`	类型	说明	必需
`cluster`	布尔	指示是否允许对 `cluster`资源动作的标志。如果为 true，`MongoDB` Cloud 将忽略数据库和集合参数。	false
`collection`	字符串	人类可读标签，用于标识您向一个 `MongoDB` 用户授予动作的`collection`。	false
`database`	字符串	人类可读标签，用于标识您向一个 `MongoDB` 用户授予动作的`database`。	false

AtlasProject.spec.customRoles.inheritedRoles

`Name`	类型	说明	必需
`database`	字符串	人类可读标签，用于标识某人向一个 `MongoDB` 用户授予动作的`database`。	true
`name`	字符串	人类可读标签，用于标识继承的角色。	true

AtlasProject.spec.encryptionAtRest

EncryptionAtRest 允许为 AWS、 Azure和GCP提供商设立加密。

`Name`	类型	说明	必需
`awsKms`	对象	`AwsKms` 指定 `AWS` `KMS` 配置详细信息以及是否为Atlas项目启用静态加密。	false
`azureKeyVault`	对象	`AzureKeyVault` 指定Azure Key Vault配置详细信息以及是否为Atlas项目启用静态加密。	false
`googleCloudKms`	对象	`GoogleCloudKms` 指定 `GCP` `KMS` 配置详细信息以及是否为Atlas项目启用静态加密。	false

AtlasProject.spec.encryptionAtRest.awsKms

AwsKms 指定 AWS KMS配置详细信息以及是否为Atlas项目启用静态加密。

`Name`	类型	说明	必需
`enabled`	布尔	指定Atlas项目的“静态加密”是否为 `enabled`。要禁用静态加密，请仅传递值为 false 的此参数。当您禁用静态加密时， Atlas还会删除配置详细信息。	false
`region`	字符串	其中存在 `AWS` 客户主密钥的 `AWS` `region`。	false
`secretRef`	对象	对 as Secret 的引用，包含 `AccessKeyID`、`SecretAccessKey`、`CustomerMasterKeyID` 和 `RoleID` 字段	false
`valid`	布尔	指定为提供商设立的加密密钥是否为 `valid`，以及可用于加密和解密数据。	false

AtlasProject.spec.encryptionAtRest.awsKms.secretRef

对包含 AccessKeyID、SecretAccessKey、CustomerMasterKeyID 和 RoleID 字段的 as Secret 的引用

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.encryptionAtRest.azureKeyVault

AzureKeyVault 指定Azure Key Vault配置详细信息以及是否为Atlas项目启用静态加密。

`Name`	类型	说明	必需
`azureEnvironment`	字符串	Azure帐户凭证所在的Azure环境。有效值为：`AZURE`、`AZURE_CHINA`、`AZURE_GERMANY`	false
`clientID`	字符串	客户端 `ID`，也称为应用程序`ID`，用于与Azure `AD` 租户关联的Azure应用程序。	false
`enabled`	布尔	指定Atlas项目的“静态加密”是否为 `enabled`。要禁用静态加密，请仅传递值为 false 的此参数。当您禁用静态加密时， Atlas还会删除配置详细信息。	false
`resourceGroupName`	字符串	包含Azure Key Vault的Azure资源群组的名称。	false
`secretRef`	对象	对包含 `SubscriptionID`、`KeyVaultName`、`KeyIdentifier`、密钥字段的密钥的引用	false
`tenantID`	字符串	Azure订阅中Azure `AD` 租户的唯一标识符。	false

AtlasProject.spec.encryptionAtRest.azureKeyVault.secretRef

对 as Secret 的引用，包含 SubscriptionID、KeyVaultName、KeyIdentifier、Secret 字段

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.encryptionAtRest.googleCloudKms

GoogleCloudKms 指定GCP KMS配置详细信息以及是否为Atlas项目启用静态加密。

`Name`	类型	说明	必需
`enabled`	布尔	指定Atlas项目的“静态加密”是否为 `enabled`。要禁用静态加密，请仅传递值为 false 的此参数。当您禁用静态加密时， Atlas还会删除配置详细信息。	false
`secretRef`	对象	对包含 `ServiceAccountKey`、`KeyVersionResourceID` 字段的密钥的引用	false

AtlasProject.spec.encryptionAtRest.googleCloudKms.secretRef

对包含 ServiceAccountKey、KeyVersionResourceID 字段的密钥的引用

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.integrations

Atlas与第三方服务之间的项目集成。已弃用：根据迁移指南迁移到 AtlasThirdPartyIntegration 自定义资源，网址为：https: 操作符 8so-migrate-ptr

`Name`	类型	说明	必需
`accountId`	字符串	唯一的 40-十六进制数字字符串，用于标识您的 New Relic 帐户。	false
`apiKeyRef`	对象	对Kubernetes密钥的引用，其中包含 Datadog、`OpsGenie` 或 Victor Ops 的 `API` 密钥。	false
`apiTokenRef`	对象	对包含允许Atlas访问权限您的Slack帐户的密钥的Kubernetes密钥的引用。	false
`channelName`	字符串	Atlas向其发送警报通知的Slack渠道的名称。	false
`enabled`	布尔	指示某人是否已激活 Prometheus 集成的标志。	false
`flowName`	字符串	`DEPRECATED`：Flowdock 流名称。该字段已从Atlas中删除，并且不起作用。	false
`licenseKeyRef`	对象	对Kubernetes密钥的引用，其中包含唯一的 40-十六进制数字字符串，用于标识 New Relic 许可证。	false
`microsoftTeamsWebhookUrl`	字符串	Atlas向其发送通知的Microsoft Teams Webhook 端点 Web解决。	false
`name`	字符串		false
`orgName`	字符串	`DEPRECATED`：Flowdock组织名称。该字段已从Atlas中删除，并且不起作用。	false
`passwordRef`	对象	引用包含密码的Kubernetes密钥，以允许Atlas访问权限您的 Prometheus 帐户。	false
`readTokenRef`	对象	对Kubernetes密钥的引用，其中包含与您的 New Relic 帐户关联的查询密钥。	false
`region`	字符串	地区代码，指示Atlas使用哪个地区 `API` 来访问权限`PagerDuty`、Datadog 或 `OpsGenie`。	false
`routingKeyRef`	对象	对包含与 Splunk On-Call 帐户关联的路由密钥的Kubernetes密钥的引用。用于 Victor Ops。	false
`scheme`	字符串		false
`secretRef`	对象	对包含 Webhook 密钥的Kubernetes密钥的引用。	false
`serviceDiscovery`	字符串	发现 Prometheus 服务的所需方法。	false
`serviceKeyRef`	对象	对Kubernetes密钥的引用，其中包含与您的 `PagerDuty` 帐户关联的服务密钥。	false
`teamName`	字符串	用于标识Slack团队的人类可读标签。	false
`type`	枚举	第三方集成`type` ，例如Slack、New Relic 等。每个集成`type` 都需要一设立不同的配置字段。示例，如果将`type` 设立为`DATADOG` ，则必须仅配置 datadog 子字段。枚举：`PAGER_DUTY` 、`SLACK` 、`DATADOG` 、`NEW_RELIC` 、`OPS_GENIE` 、`VICTOR_OPS` 、`FLOWDOCK` 、`WEBHOOK` 、`MICROSOFT_TEAMS` 、`PROMETHEUS`	false
`url`	字符串	Atlas向其发送通知的端点解决。用于 Webhook。	false
`username`	字符串	人类可读标签，用于标识 Prometheus 传入的 Webhook。	false
`writeTokenRef`	对象	对Kubernetes密钥的引用，其中包含与 New Relic 帐户关联的插入密钥。	false

AtlasProject.spec.integrations.apiKeyRef

对包含 Datadog、OpsGenie 或 Victor Ops API密钥的Kubernetes密钥的引用。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.integrations.apiTokenRef

对包含允许Atlas访问权限您的Slack帐户的密钥的Kubernetes密钥的引用。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.integrations.licenseKeyRef

对Kubernetes密钥的引用，其中包含唯一的 40-十六进制数字字符串，用于标识 New Relic 许可证。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.integrations.passwordRef

引用包含密码的Kubernetes密钥，以允许Atlas访问权限您的 Prometheus 帐户。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.integrations.readTokenRef

对Kubernetes密钥的引用，其中包含与您的 New Relic 帐户关联的查询密钥。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.integrations.routingKeyRef

对包含与 Splunk On-Call 帐户关联的路由密钥的Kubernetes密钥的引用。用于 Victor Ops。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.integrations.secretRef

对包含 Webhook 密钥的Kubernetes密钥的引用。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.integrations.serviceKeyRef

对包含与 PagerDuty 帐户关联的服务密钥的Kubernetes密钥的引用。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.integrations.writeTokenRef

对Kubernetes密钥的引用，其中包含与 New Relic 帐户关联的插入密钥。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.maintenanceWindow

MaintenanceWindow 允许指定一周中运行维护操作的首选时间。更多信息请访问 https://www.mongodb.com/zh-cn/docs/atlas/reference/api/maintenance-windows/

`Name`	类型	说明	必需
`autoDefer`	布尔	指示任何计划的项目维护是否应自动推迟一周的标志。	false
`dayOfWeek`	整型	您希望维护窗口在一周中的哪一天开始，它是基于 1的整数。星期日1 、星期一2 、星期二3 、星期三4 567、星期四、星期五、星期六。最小值：1 最大值：7	false
`defer`	布尔	指示下一个计划项目维护是否应推迟一周的标志。如果 `startASAP` 为 true，则无法指定	false
`hourOfDay`	整型	您希望维护窗口启动的时间。此参数使用24 小时时钟，其中午夜为0 ，中午为12 。最小值：0 最大值：23	false
`startASAP`	布尔	指示是否已指示项目维护立即开始的标志。如果 defer 为 true，则无法指定	false

AtlasProject.spec.networkPeers

为当前项目配置的 NetworkPeer。已弃用：根据迁移指南迁移到 AtlasNetworkPeering 和 AtlasNetworkContainer 自定义资源，网址为：https://www.mongodb.com/zh-cn/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8 so-migrate-ptr

`Name`	类型	说明	必需
`accepterRegionName`	字符串	`AccepterRegionName` 是用户 `VPC` 的提供商地区名称。	false
`atlasCidrBlock`	字符串	Atlas `CIDR`。如果未设立`ContainerID`，则需要进行设立。	false
`awsAccountId`	字符串	`AccountID` 用户的 `VPC`。	false
`azureDirectoryId`	字符串	`AzureDirectoryID` 是Azure `AD`目录的唯一标识符。	false
`azureSubscriptionId`	字符串	`AzureSubscriptionID` 是 VNet 所在Azure订阅的唯一标识符。	false
`containerId`	字符串	`ID` 网络对等容器的。如果未设立，操作符将创建一个包含 `ContainerRegion` 和 `AtlasCIDRBlock` 输入的新容器。	false
`containerRegion`	字符串	`ContainerRegion` 是Atlas网络对等容器的提供商地区名称。如果未设立，则使用 `AccepterRegionName`。	false
`gcpProjectId`	字符串	用户 `GCP` 项目 `ID`。它仅适用于 `GCP`。	false
`networkName`	字符串	`GCP` 网络对等名称。它仅适用于 `GCP`。	false
`providerName`	字符串	`ProviderName` 是提供商的名称。如果未设立，则设立为“`AWS`”。	false
`resourceGroupName`	字符串	`ResourceGroupName` 是Azure资源群组的名称。	false
`routeTableCidrBlock`	字符串	用户 `VPC` `CIDR`。	false
`vnetName`	字符串	VNetName 是Azure VNet 的名称。它仅适用于Azure。	false
`vpcId`	字符串	`AWS` `VPC` `ID`.	false

AtlasProject.spec.privateEndpoints

PrivateEndpoint 是为当前项目配置的私有端点列表。已弃用：根据迁移指南迁移到 AtlasPrivateEndpoint 自定义资源，网址为：https: 操作符 8so-migrate-ptr

`Name`	类型	说明	必需
`provider`	枚举	要检索其私有端点服务的 Cloud 。 Atlas接受`providerAWS` 、`GCP` 或`AZURE` 。枚举：`AWS` 、`GCP` 、`AZURE` 、`TENANT`	true
`region`	字符串	您要为其创建私有端点服务的云提供商`region`。	true
`endpointGroupName`	字符串	端点群组的唯一标识符。端点群组包含您在 Google Cloud 中创建的所有端点。	false
`endpoints`	[]对象	构成端点群组的单个私有 `endpoints` 的集合。	false
`gcpProjectId`	字符串	您在其中创建端点的 Google Cloud项目的唯一标识符。	false
`id`	字符串	您在 `AWS` `VPC` 或Azure VNet 中创建的私有端点的唯一标识符。	false
`ip`	字符串	在Azure VNet 中创建的私有端点网络接口的私有 `IP`解决。	false

AtlasProject.spec.privateEndpoints.endpoints

`Name`	类型	说明	必需
`endpointName`	字符串	与您在 Google Cloud 中创建的端点相对应的转发规则。	false
`ipAddress`	字符串	您在 Google Cloud 中创建的端点的私有 `IP`解决。	false

AtlasProject.spec.projectIpAccessList

IPAccessList 允许为项目使用IP访问列表。更多信息，请访问 https://mongodb.com/zh-cn/docs/atlas/reference/api/ip-access-list/add-entries-to-access-list/ 已弃用：迁移到 AtlasIPAccessList 自定义资源迁移指南：https: 操作符 8so-migrate-ptr

`Name`	类型	说明	必需
`awsSecurityGroup`	字符串	此访问权限列表条目中 `AWS` 安全群组的唯一标识符。	false
`cidrBlock`	字符串	此访问权限列表条目中采用 `CIDR` 表示法的 `IP` 地址范围。	false
`comment`	字符串	与此访问权限列表条目关联的注释。	false
`deleteAfterDate`	字符串	`ISO` 8601 日期和时间格式（格式为 `UTC`）的时间戳，在此之后， Atlas会删除临时访问权限列表条目。	false
`ipAddress`	字符串	在此访问权限列表条目中使用 `IP`解决的条目。	false

AtlasProject.spec.settings

设置允许配置项目设置。

`Name`	类型	说明	必需
`isCollectDatabaseSpecificsStatisticsEnabled`	布尔	指示是否为指定项目收集特定于数据库的指标的标志。	false
`isDataExplorerEnabled`	布尔	该标志指示是否为指定项目启用数据浏览器。	false
`isExtendedStorageSizesEnabled`	布尔	指示是否为指定项目启用扩展存储大小的标志。	false
`isPerformanceAdvisorEnabled`	布尔	指示是否为指定项目启用性能优化顾问和分析器的标志。	false
`isRealtimePerformancePanelEnabled`	布尔	指示是否为指定项目启用“实时性能面板”的标志。	false
`isSchemaAdvisorEnabled`	布尔	指示是否为指定项目启用模式顾问程序的标志。	false

AtlasProject.spec.teams

`Name`	类型	说明	必需
`roles`	[]enum	团队中的用户在项目中的角色。枚举：`GROUP_OWNER` 、`GROUP_CLUSTER_MANAGER` 、`GROUP_DATA_ACCESS_ADMIN` 、`GROUP_DATA_ACCESS_READ_WRITE` 、`GROUP_DATA_ACCESS_READ_ONLY` 、`GROUP_READ_ONLY`	true
`teamRef`	对象	对将分配给项目的`AtlasTeam` 自定义资源的引用。	true

AtlasProject.spec.teams.teamRef

对将分配给项目的AtlasTeam 自定义资源的引用。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.spec.x509CertRef

X509CertRef 是对Kubernetes密钥的引用，其中包含 PEM 编码的 CA 证书。 Atlas Kubernetes Operator仅监视带有标签 atlas.mongodb.com/type=凭证的密钥，以避免监视不必要的密钥。

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

AtlasProject.status

AtlasProjectStatus 定义了 AtlasProject 的观察到的状态

`Name`	类型	说明	必需
`conditions`	[]对象	条件是显示Atlas自定义资源当前状态的状态列表	true
`alertConfigurations`	[]对象	`AlertConfigurations` 包含警报配置状态列表	false
`authModes`	[]string	`AuthModes` 包含已配置的身份验证模式列表 “`SCRAM`”是默认身份验证方法，需要为每个用户提供密码 “`X509`”表示已配置自我管理的 X.509身份验证	false
`cloudProviderIntegrations`	[]对象	`CloudProviderIntegrations` 包含已配置的云提供商访问权限角色的列表。仅支持`AWS`	false
`customRoles`	[]对象	`CustomRoles` 包含自定义角色状态列表	false
`expiredIpAccessList`	[]对象	由于“`deleteAfterDate`”早于当前日期而过期的 `IP` 访问列表条目的列表。请注意，仅在规范更改后， Atlas Operator 才会更新此字段	false
`id`	字符串	Atlas项目的 `ID`	false
`networkPeers`	[]对象	为当前项目配置的网络对等方列表	false
`observedGeneration`	整型	`ObservedGeneration` 表示Atlas Operator 感知的资源规范的生成。 Atlas Operator 在开始资源协调后立即将该字段更新为“元数据生成”的值。格式：int64	false
`privateEndpoints`	[]对象	为当前项目配置的私有端点列表	false
`prometheus`	对象	Prometheus 包含 Prometheus 集成的状态，包括 `prometheusDiscoveryURL`	false
`teams`	[]对象	Teams 包含 `teams` 分配状态列表	false

AtlasProject.status.conditions

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

`Name`	类型	说明	必需
`status`	字符串	条件的状态； True、False、未知之一。	true
`type`	字符串	Atlas自定义资源条件的类型。	true
`lastTransitionTime`	字符串	上次条件从一种状态转换为另一种状态的时间。以`ISO`8601 格式表示。格式：日期-时间	false
`message`	字符串	提供有关转换的详细信息的 `message`。	false
`reason`	字符串	条件的最后一次转换的 `reason`。	false

AtlasProject.status.alertConfigurations

`Name`	类型	说明	必需
`acknowledgedUntil`	字符串	确认警报的日期。如果警报从未得到确认，则不会出现。	false
`acknowledgementComment`	字符串	确认警报的用户留下的评论。如果警报从未得到确认，则不会出现。	false
`acknowledgingUsername`	字符串	确认警报的用户的用户名。如果警报从未得到确认，则不会出现。	false
`alertConfigId`	字符串	`ID` 触发此警报的警报配置的。	false
`clusterId`	字符串	此警报适用的集群的 `ID`。仅适用于类型为 `BACKUP`、`REPLICA_SET` 和 `CLUSTER` 的警报。	false
`clusterName`	字符串	此警报适用的集群的名称。仅适用于类型为 `BACKUP`、`REPLICA_SET` 和 `CLUSTER` 的警报。	false
`created`	字符串	创建此警报配置时的时间戳，采用 `ISO`8601 日期和时间格式（格式为 `UTC`）。	false
`currentValue`	对象	`CurrentValue` 表示触发警报的指标的当前值。仅适用于类型为 `HOST_METRIC` 的警报。	false
`enabled`	布尔	如果省略，则禁用配置。	false
`errorMessage`	字符串	`ErrorMessage` 如果警报配置处于不正确状态，则为 message。	false
`eventTypeName`	字符串	将触发警报的事件类型。	false
`groupId`	字符串	拥有此警报配置的项目的唯一标识符。	false
`hostId`	字符串	`ID` 指标所属托管的 ID。仅适用于类型为 `HOST`、`HOST_METRIC` 和 `REPLICA_SET` 的警报。	false
`hostnameAndPort`	字符串	警报适用的每个托管的主机名和端口。仅适用于类型为 `HOST`、`HOST_METRIC` 和 `REPLICA_SET` 的警报。	false
`id`	字符串	唯一标识符。	false
`lastNotified`	字符串	上次为此警报发送通知的时间。仅在已发送通知时显示。	false
`matchers`	[]对象	仅当`EventTypeName`指定主机、副本集或分片集群的事件时，才能使用`matchers`数组进行筛选。	false
`metricName`	字符串	其值超出阈值的测量的名称。仅当 `eventTypeName`设立为 `OUTSIDE_METRIC_THRESHOLD` 时才出现。	false
`metricThreshold`	对象	`MetricThreshold` 导致触发警报。	false
`notifications`	[]对象	检测到警报条件时发送通知。	false
`replicaSetName`	字符串	副本集的名称。仅适用于类型为 `HOST`、`HOST_METRIC`、`BACKUP` 和 `REPLICA_SET` 的警报。	false
`resolved`	字符串	警报关闭的时间。仅在状态为 `CLOSED` 时出现。	false
`severityOverride`	字符串	警报的严重性。	false
`sourceTypeName`	字符串	对于 `BACKUP` 类型的警报，正在备份的服务器的类型。	false
`status`	字符串	警报的当前状态。可能的值为：`TRACKING`、`OPEN`、`CLOSED`、`CANCELED`	false
`threshold`	对象	阈值会触发警报。	false
`updated`	字符串	上次更新此警报配置的时间戳，采用 `ISO` 8601 日期和时间格式，日期和时间为 `UTC`。	false

AtlasProject.status.alertConfigurations.currentValue

CurrentValue 表示触发警报的指标的当前值。仅适用于 HOST_METRIC 类型的警报。

`Name`	类型	说明	必需
`number`	字符串	指标的值。	false
`units`	字符串	值的 `units`。取决于指标类型。	false

AtlasProject.status.alertConfigurations.matchers

`Name`	类型	说明	必需
`fieldName`	字符串	目标对象中要匹配的字段的名称。	false
`operator`	字符串	用于测试字段值的 `operator`。	false
`value`	字符串	要使用指定操作符进行测试的值。	false

AtlasProject.status.alertConfigurations.metricThreshold

MetricThreshold 会触发警报。

`Name`	类型	说明	必需
`threshold`	字符串	阈值，超出该阈值将触发警报。	true
`metricName`	字符串	要检查的指标名称。	false
`mode`	字符串	必须将其设立为 `AVERAGE`。 Atlas会将当前指标值计算为平均值。	false
`operator`	字符串	根据阈值检查当前指标值时要应用的操作符。	false
`units`	字符串	阈值的 `units`。	false

AtlasProject.status.alertConfigurations。通知

`Name`	类型	说明	必需
`apiToken`	字符串	Slack `API` 令牌或 Bot 令牌。为 `SLACK`通知类型填充。如果令牌后来变得无效， Atlas会向项目所有者发送电子邮件，并最终删除令牌。	false
`channelName`	字符串	Slack渠道名称。为 `SLACK`通知类型填充。	false
`datadogApiKey`	字符串	Datadog `API` 密钥。可在 Datadog仪表盘盘中找到。为 `DATADOG`通知类型填充。	false
`datadogRegion`	字符串	指示要使用哪个 `API` `URL` 的区域	false
`delayMin`	整型	检测到警报条件后发送第一个通知之前的等待分钟数。	false
`emailAddress`	字符串	发送警报通知的电子邮件解决。为 `EMAIL`通知类型填充。	false
`emailEnabled`	布尔	指示是否应发送电子邮件通知的标志。针对 `ORG`、`GROUP` 和 `USER`通知类型进行填充。	false
`flowName`	字符串	Flowdock 流名称以小写字母表示。	false
`flowdockApiToken`	字符串	Flowdock 个人 `API` 令牌。为 `FLOWDOCK`通知类型填充。如果令牌后来变得无效， Atlas会向项目所有者发送电子邮件，并最终删除令牌。	false
`intervalMin`	整型	未解决的未确认警报的连续通知之间等待的分钟数。	false
`mobileNumber`	字符串	向其发送警报通知的手机号码。为 `SMS`通知类型填充。	false
`opsGenieApiKey`	字符串	Opsgenie `API` 密钥。为 `OPS_GENIE`通知类型填充。如果密钥后来变得无效， Atlas会向项目所有者发送电子邮件，并最终删除令牌。	false
`opsGenieRegion`	字符串	指示要使用哪个 `API` `URL` 的区域。	false
`orgName`	字符串	Flowdock组织小写字母名称。这是 `URL` 字符串中应用之后出现的名称。为 `FLOWDOCK`通知类型填充。	false
`roles`	[]string	以下 `roles` 授予项目内的权限。	false
`serviceKey`	字符串	`PagerDuty` 服务密钥。为 `PAGER_DUTY`通知类型填充。如果密钥后来变得无效， Atlas会向项目所有者发送电子邮件，并最终删除密钥。	false
`smsEnabled`	布尔	指示是否应发送文本消息通知的标志。针对 `ORG`、`GROUP` 和 `USER`通知类型进行填充。	false
`teamId`	字符串	团队的唯一标识符。	false
`teamName`	字符串	接收此通知的团队的标签。	false
`typeName`	字符串	警报通知类型。	false
`username`	字符串	向其发送通知的Atlas 用户的名称。此处仅允许项目中拥有警报配置的用户。为 `USER`通知类型填充。	false
`victorOpsApiKey`	字符串	`VictorOps` `API` 键。为 `VICTOR_OPS`通知类型填充。如果密钥后来变得无效， Atlas会向项目所有者发送电子邮件，并最终删除密钥。	false
`victorOpsRoutingKey`	字符串	`VictorOps` 路由键。为 `VICTOR_OPS`通知类型填充。如果密钥后来变得无效， Atlas会向项目所有者发送电子邮件，并最终删除密钥。	false

AtlasProject.status.alertConfigurations.threshold

阈值会触发警报。

`Name`	类型	说明	必需
`operator`	字符串	根据阈值检查当前指标值时要应用的操作符。它接受以下值：`GREATER_THAN`、`LESS_THAN`	false
`threshold`	字符串	阈值，超出该阈值将触发警报。	false
`units`	字符串	阈值的 `units`	false

AtlasProject.status.cloudProviderIntegrations

`Name`	类型	说明	必需
`atlasAssumedRoleExternalId`	字符串	`MongoDB` Atlas在您的Amazon Web Services帐户中担任 `IAM`角色时使用的唯一外部 `ID`。	true
`providerName`	字符串	用于标识角色的云提供商的人类可读标签。	true
`atlasAWSAccountArn`	字符串	Amazon资源名称，用于标识 `MongoDB` Atlas在假定身份和访问管理角色时使用的Amazon Web Services用户帐户。	false
`authorizedDate`	字符串	有人为指定云服务提供商授权此角色的日期和时间。此参数以 `UTC` 中的 `ISO` 8601 时间戳格式表示其值。	false
`createdDate`	字符串	有人为指定云服务提供商创建此角色的日期和时间。此参数以 `UTC` 中的 `ISO` 8601 时间戳格式表示其值。	false
`errorMessage`	字符串	返回应用程序错误消息。	false
`featureUsages`	[]对象	列表，其中包含与此Amazon Web Services身份和访问管理角色关联的应用程序功能。	false
`iamAssumedRoleArn`	字符串	Amazon资源名称，用于标识 `MongoDB` Cloud 在访问 `AWS` 账户中的资源时所担任的Amazon Web Services Identity and Access Management角色。	false
`roleId`	字符串	用于标识角色的唯一的 24 位十六进制数字字符串。	false
`status`	字符串	预配服务帐户的 `status`。值为 `IN_PROGRESS`、`COMPLETE`、`FAILED` 或 `NOT_INITIATED`。	false

AtlasProject.status.cloudProviderIntegrations.featureUsages

`Name`	类型	说明	必需
`featureId`	字符串	识别与此Amazon Web Services身份和访问管理角色相关联的data lake的特征。	false
`featureType`	字符串	人类可读标签，用于描述与此Amazon Web Services Identity and Access Management角色相关联的一项 `MongoDB` Cloud功能。	false

AtlasProject.status.customRoles

`Name`	类型	说明	必需
`name`	字符串	`name` 角色是唯一的	true
`status`	字符串	给定自定义角色的 `status`（`OK` 或 `FAILED`）	true
`error`	字符串	自定义角色处于 `FAILED` 状态时的消息	false

AtlasProject.status.expiredIpAccessList

`Name`	类型	说明	必需
`awsSecurityGroup`	字符串	此访问权限列表条目中 `AWS` 安全群组的唯一标识符。	false
`cidrBlock`	字符串	此访问权限列表条目中采用 `CIDR` 表示法的 `IP` 地址范围。	false
`comment`	字符串	与此访问权限列表条目关联的注释。	false
`deleteAfterDate`	字符串	`ISO` 8601 日期和时间格式（格式为 `UTC`）的时间戳，在此之后， Atlas会删除临时访问权限列表条目。	false
`ipAddress`	字符串	在此访问权限列表条目中使用 `IP`解决的条目。	false

AtlasProject.status.networkPeers

`Name`	类型	说明	必需
`id`	字符串	`NetworkPeer` 的唯一标识符。	true
`providerName`	字符串	要检索其网络对等方的云提供商。	true
`region`	字符串	要为其创建网络对等方的区域。不需要它 `GCP`	true
`atlasGcpProjectId`	字符串	`ProjectID` Atlas容器。仅适用于 `GCP`。需要添加网络对等连接。	false
`atlasNetworkName`	字符串	Atlas网络名称。仅适用于 `GCP`。需要添加网络对等连接。	false
`connectionId`	字符串	网络对等连接的唯一标识符。仅适用于 `AWS`。	false
`containerId`	字符串	`ContainerID` Atlas网络对等容器的。	false
`errorMessage`	字符串	对等网络的错误状态。仅适用于 `GCP`。	false
`errorState`	字符串	对等网络的错误状态。仅适用于Azure。	false
`errorStateName`	字符串	对等网络的错误状态。仅适用于 `AWS`。	false
`gcpProjectId`	字符串	`ProjectID` 用户的 vpc。仅适用于 `GCP`。	false
`status`	字符串	网络对等方的状态。仅适用于 `GCP` 和Azure。	false
`statusName`	字符串	网络对等方的状态。仅适用于 `AWS`。	false
`vpc`	字符串	`VPC` 是通用字段，用于存储 `VPC` 的名称。 `VPC` 对于 `AWS` 是 `vpcID`，对于 `GCP` 是用户 `networkName`，对于Azure是 `vnetName`。	false

AtlasProject.status.privateEndpoints

`Name`	类型	说明	必需
`provider`	字符串	要检索其私有端点服务的 Cloud `provider`。 Atlas接受 `AWS` 或 `AZURE`。	true
`region`	字符串	您要为其创建私有端点服务的云提供商`region`。	true
`endpoints`	[]对象	构成网络端点群组的单个 `GCP` 私有 `endpoints` 的集合。	false
`id`	字符串	`AWS` 或 `AZURE` 专用链接连接的唯一标识符。	false
`interfaceEndpointId`	字符串	`AWS` 或Azure Private Link接口端点的唯一标识符。	false
`serviceAttachmentNames`	[]string	唯一的字母数字和特殊字符串，用于标识与 `GCP` Private Service Connect 端点服务关联的服务附件。	false
`serviceName`	字符串	Atlas管理的 `AWS` 或Azure Private Link服务的名称。	false
`serviceResourceId`	字符串	Azure Private Link服务的唯一标识符（`AWS` 与 `ID` 相同）。	false

AtlasProject.status.privateEndpoints.endpoints

`Name`	类型	说明	必需
`endpointName`	字符串	人类可读标签，用于标识您创建的 Google Cloud 消费者转发规则。	true
`ipAddress`	字符串	此 Google Cloud 使用方转发规则解析为的一个私有互联网协议版本 4 (IPv4)解决。	true
`status`	字符串	`MongoDB` Cloud 收到此请求时 `MongoDB` Atlas端点群组的状态。	true

AtlasProject.status.prometheus

Prometheus 包含 Prometheus 集成的状态，包括 prometheusDiscoveryURL

`Name`	类型	说明	必需
`prometheusDiscoveryURL`	字符串	`URL` Prometheus 从中获取目标。	false
`scheme`	字符串	用于 Prometheus 请求的协议 `scheme`。	false

AtlasProject.status.teams

`Name`	类型	说明	必需
`teamRef`	对象	`ResourceRefNamespaced` 是对Kubernetes资源的引用，允许配置命名空间	true
`id`	字符串		false

AtlasProject.status.teams.teamRef

ResourceRefNamespaced 是对Kubernetes资源的引用，允许配置命名空间

`Name`	类型	说明	必需
`name`	字符串	Kubernetes资源名称	true
`namespace`	字符串	Kubernetes资源的命名空间	false

后退

自定义资源

来年

Atlas 部署

重要

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

例子

Prometheus 示例

注意

团队示例

维护窗口示例

项目设置示例

警报配置示例

第三方警报配置示例

参数

Atlas 项目

AtlasProject.spec

AtlasProject.spec.alertConfigurations

AtlasProject.spec.alertConfigurations.matchers

AtlasProject.spec.alertConfigurations.metricThreshold

AtlasProject.spec.alertConfigurations。通知

AtlasProject.spec.alertConfigurations。通知.apiTokenRef

AtlasProject.spec.alertConfigurations。通知.datadogAPIKeyRef

AtlasProject.spec.alertConfigurations。通知.flowdockApiTokenRef

AtlasProject.spec.alertConfigurations。通知.opsGenieApiKeyRef

AtlasProject.spec.alertConfigurations。 通知.serviceKeyRef

AtlasProject.spec.alertConfigurations。通知.victorOpsSecretRef

AtlasProject.spec.alertConfigurations.threshold

AtlasProject.spec.auditing

AtlasProject.spec.backupCompliancePolicyRef

AtlasProject.spec.cloudProviderAccessRoles

AtlasProject.spec.cloudProviderIntegrations

AtlasProject.spec.connectionSecretRef

AtlasProject.spec.customRoles

AtlasProject.spec.customRoles.actions

AtlasProject.spec.customRoles.actions.resources

AtlasProject.spec.customRoles.inheritedRoles

AtlasProject.spec.encryptionAtRest

AtlasProject.spec.encryptionAtRest.awsKms

AtlasProject.spec.encryptionAtRest.awsKms.secretRef

AtlasProject.spec.encryptionAtRest.azureKeyVault

AtlasProject.spec.encryptionAtRest.azureKeyVault.secretRef

AtlasProject.spec.encryptionAtRest.googleCloudKms

AtlasProject.spec.encryptionAtRest.googleCloudKms.secretRef

AtlasProject.spec.integrations

AtlasProject.spec.integrations.apiKeyRef

AtlasProject.spec.integrations.apiTokenRef

AtlasProject.spec.integrations.licenseKeyRef

AtlasProject.spec.integrations.passwordRef

AtlasProject.spec.integrations.readTokenRef

AtlasProject.spec.integrations.routingKeyRef

AtlasProject.spec.integrations.secretRef

AtlasProject.spec.integrations.serviceKeyRef

AtlasProject.spec.integrations.writeTokenRef

AtlasProject.spec.maintenanceWindow

AtlasProject.spec.networkPeers

AtlasProject.spec.privateEndpoints

AtlasProject.spec.privateEndpoints.endpoints

AtlasProject.spec.projectIpAccessList

AtlasProject.spec.settings

AtlasProject.spec.teams

AtlasProject.spec.teams.teamRef

AtlasProject.spec.x509CertRef

AtlasProject.status

AtlasProject.status.conditions

AtlasProject.status.alertConfigurations

AtlasProject.status.alertConfigurations.currentValue

AtlasProject.status.alertConfigurations.matchers

AtlasProject.status.alertConfigurations.metricThreshold

AtlasProject.status.alertConfigurations。通知

AtlasProject.status.alertConfigurations.threshold

AtlasProject.status.cloudProviderIntegrations

AtlasProject.status.cloudProviderIntegrations.featureUsages

AtlasProject.status.customRoles

AtlasProject.status.expiredIpAccessList

AtlasProject.status.networkPeers

AtlasProject.status.privateEndpoints

AtlasProject.status.privateEndpoints.endpoints

AtlasProject.status.prometheus

AtlasProject.status.teams

AtlasProject.status.teams.teamRef

AtlasProject.spec.alertConfigurations。通知.serviceKeyRef