AtlasProject自定义资源在 Atlas 中配置项目。 当您创建AtlasProject资源时,Atlas Kubernetes Operator 会尝试在 Atlas 中创建新项目。
重要
自定义资源不再默认删除对象
Atlas Kubernetes Operator使用自定义资源配置文件来管理Atlas配置,但从Atlas Kubernetes Operator2.0 开始,您在Kubernetes中删除的自定义资源不再(默认)在Atlas中删除。相反, Atlas Kubernetes Operator只是停止管理Atlas中的这些资源。示例,如果您在Kubernetes中删除
AtlasProject自定义资源,默认下, 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 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。命名空间参数。
要连接到Atlas Administration API, 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 参数进行项目设置,包括启用和禁用以下功能的设置:
收集集群指标中的数据库统计信息
使用 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-teamOrganization 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 | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | atlas.mongodb.com/v1 | true |
| 字符串 |
| true |
| 对象 | 有关 | true |
| 对象 |
| false |
| 对象 |
| false |
AtlasProject.spec
AtlasProjectSpec 定义了 Atlas 中项目的目标省/市/自治区
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 名称是 Operator 在Atlas中创建的项目的
| true |
| 布尔 |
| false |
| []对象 |
| false |
| 对象 | Atlas 审核代表 | false |
| 对象 |
| false |
| []对象 |
| false |
| []对象 |
| false |
| 对象 |
| false |
| []对象 |
| false |
| 对象 |
| false |
| []对象 | Integrations | false |
| 对象 |
| false |
| []对象 |
| false |
| []对象 |
| false |
| []对象 |
| false |
| 枚举 |
| false |
| 对象 |
| false |
| 对象 | 设置允许配置项目设置。 | false |
| []对象 | 标签是用于对项目标签和分类的键值对列表。更多信息,请访问 https://www.mongodb.com/zh-cn/docs/atlas/tags/。 如果省略此设置, Atlas Kubernetes Operator将不会更改项目的标签。将其设置为空列表以从项目中删除所有 | false |
| []对象 | Teams启用你能够向多个用户授予项目访问权限角色。 | false |
| 布尔 | 指示Atlas Kubernetes Operator是否使用默认警报配置创建项目的标志。如果使用此设置,还必须将spec.``alertConfigurationSyncEnabled`` 设置为 true,Atlas Kubernetes Operator才能修改项目警报配置。如果您在创建项目时将此参数设为 false,Atlas 不会将默认警报配置添加到项目中。此设置对现有项目没有影响。默认:true | false |
| 对象 | X509CertRef 是对kubernetes secret的引用,其中包含 | false |
AtlasProject.spec.alertConfigurations
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 布尔 | 如果省略,则禁用配置。 | false |
| 字符串 | 将触发警报的事件类型。 | false |
| []对象 | 仅当 | false |
| 对象 |
| false |
| []对象 | 检测到警报条件时发送通知。 | false |
| 枚举 |
| false |
| 对象 | 阈值会触发警报。 | false |
AtlasProject.spec.alertConfigurations.matchers
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 目标对象中要匹配的字段的名称。 | false |
| 字符串 | 用于测试字段值的 | false |
| 字符串 | 要使用指定操作符进行测试的值。 | false |
AtlasProject.spec.alertConfigurations.metricThreshold
MetricThreshold 会触发警报。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 阈值,超出该阈值将触发警报。 | true |
| 字符串 | 要检查的指标名称。 | false |
| 字符串 | 必须将其设立为 | false |
| 字符串 | 根据阈值检查当前指标值时要应用的操作符。 | false |
| 字符串 | 阈值的 | false |
AtlasProject.spec.alertConfigurations。通知
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 对象 | 包含Slack | false |
| 字符串 | Slack渠道名称。为 | false |
| 对象 | 包含 Datadog | false |
| 字符串 | 指示要使用哪个 | false |
| 整型 | 检测到警报条件后发送第一个通知之前的等待分钟数。 | false |
| 字符串 | 发送警报通知的电子邮件解决。为 | false |
| 布尔 | 指示是否应发送电子邮件通知的标志。针对 | false |
| 字符串 | Flowdock 流名称(以小写字母表示)。 | false |
| 对象 | Flowdock 个人 | false |
| 整型 | 未解决的未确认警报的连续通知之间等待的分钟数。 | false |
| 字符串 | 向其发送警报通知的手机号码。为 | false |
| 对象 |
| false |
| 字符串 | 指示要使用哪个 | false |
| 字符串 | false | |
| []string | 以下 | false |
| 对象 |
| false |
| 布尔 | 指示是否应发送文本消息通知的标志。针对 | false |
| 字符串 | 团队的唯一标识符。 | false |
| 字符串 | 接收此通知的团队的标签。 | false |
| 字符串 | 警报通知类型。 | false |
| 字符串 | 向其发送通知的Atlas user的名称。此处仅允许项目中拥有警报配置的用户。为 | false |
| 对象 | 包含 | false |
AtlasProject.spec.alertConfigurations。通知.apiTokenRef
包含Slack API令牌或 Bot 令牌的密钥。为 SLACK通知类型填充。如果令牌后来变得无效,Atlas会向项目所有者发送电子邮件,并最终删除令牌。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.alertConfigurations。通知.datadogAPIKeyRef
包含 Datadog API密钥的密钥。可在 Datadog 仪表盘中找到。为 DATADOG通知类型填充。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.alertConfigurations。通知.flowdockApiTokenRef
Flowdock 个人API令牌。为 FLOWDOCK通知类型填充。如果令牌后来变得无效,Atlas会向项目所有者发送电子邮件,并最终删除令牌。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.alertConfigurations。通知.opsGenieApiKeyRef
OpsGenie API密钥。为 OPS_GENIE通知类型填充。如果密钥后来变得无效,Atlas会向项目所有者发送电子邮件,并最终删除令牌。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.alertConfigurations。 通知.serviceKeyRef
PagerDuty 服务密钥。针对 PAGER_DUTY通知类型进行填充。如果密钥后来变得无效,Atlas会向项目所有者发送电子邮件,并最终删除密钥。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.alertConfigurations。通知.victorOpsSecretRef
包含 VictorOps API密钥和路由密钥的密钥。为 VICTOR_OPS通知类型填充。如果密钥后来变得无效,Atlas会向项目所有者发送电子邮件,并最终删除密钥。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.alertConfigurations.threshold
阈值会触发警报。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 根据阈值检查当前指标值时要应用的操作符。它接受以下值: | false |
| 字符串 | 阈值,超出该阈值将触发警报。 | false |
| 字符串 | 阈值的 | false |
AtlasProject.spec.Atlas 审核
Atlas 审核代表MongoDB Maintenance Windows。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 布尔 | 指示 Atlas 审核系统是否使用 "atype": " | false |
| 字符串 |
| false |
| 布尔 | 表示与 { | false |
AtlasProject.spec.backupCompliancePolicyRef
BackupCompliancePolicyRef 是对备份合规自定义资源的引用。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.cloudProviderAccessRoles
CloudProviderAccessRole 定义与云提供商的集成 已弃用:此类型已弃用并替换为 CloudProviderIntegration
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 |
| true |
| 字符串 |
| false |
AtlasProject.spec.cloudProviderIntegrations
CloudProviderIntegration 定义与云提供商的集成
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 |
| true |
| 字符串 |
| false |
AtlasProject.spec.connectionSecretRef
ConnectionSecret 是 kubernetes secret 的名称,其中包含有关连接到 Atlas 的方式的信息(组织ID、API密钥)。如果未提供,将使用默认的Operator 连接配置。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.customRoles
CustomRole 允许您在集群中创建和更改自定义角色。使用自定义角色来指定Atlas内置角色无法描述的自定义操作集。已弃用:根据迁移指南迁移到 AtlasCustomRoles 自定义资源 ,网址为:https: 操作符8 so-migrate-ptr
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 标识角色的人类可读标签。对于此项目中的此自定义角色,此 | true |
| []对象 | 角色授予的个人权限 | false |
| []对象 | 该自定义角色继承的内置角色列表。 | false |
AtlasProject.spec.customRoles.操作
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 用于标识特权操作的可读标签。 | true |
| []对象 | 您授予操作权限的 | true |
AtlasProject.spec.customRoles.actions.resources
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 布尔 | 指示是否允许对 | false |
| 字符串 | 人类可读标签,用于标识您向一个 | false |
| 字符串 | 人类可读标签,用于标识您向一个 | false |
AtlasProject.spec.customRoles.inheritedRoles
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 人类可读标签,用于标识某人向一个 | true |
| 字符串 | 人类可读标签,用于标识继承的角色。 | true |
AtlasProject.spec.encryptionAtRest
EncryptionAtRest 允许为 AWS、Azure 和 GCP 提供商设立加密。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 对象 |
| false |
| 对象 |
| false |
| 对象 |
| false |
AtlasProject.spec.encryptionAtRest.awsKms
AwsKms 指定 AWS KMS 配置详细信息以及是否为 Atlas 项目启用静态加密。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 布尔 | 指定Atlas项目的“静态加密”是否为 | false |
| 字符串 | 其中存在 | false |
| 对象 | 对 as Secret 的引用,包含 | false |
| 布尔 | 指定为提供商设立的加密密钥是否为 | false |
AtlasProject.spec.encryptionAtRest.awsKms.secretRef
对包含 AccessKeyID、SecretAccessKey、CustomerMasterKeyID 和 RoleID 字段的 as Secret 的引用
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.encryptionAtRest.azureKeyVault
AzureKeyVault 指定 Azure Key Vault 配置详细信息以及是否为 Atlas 项目启用静态加密。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Azure帐户凭证所在的Azure环境。有效值为: | false |
| 字符串 | 客户端 | false |
| 布尔 | 指定Atlas项目的“静态加密”是否为 | false |
| 字符串 | 包含Azure Key Vault的Azure资源组的名称。 | false |
| 对象 | 对包含 | false |
| 字符串 | Azure订阅中Azure | false |
AtlasProject.spec.encryptionAtRest.azureKeyVault.secretRef
对 as Secret 的引用,包含 SubscriptionID、KeyVaultName、KeyIdentifier、Secret 字段
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.encryptionAtRest.googleCloudKms
GoogleCloudKms 指定GCP KMS配置详细信息以及是否为Atlas项目启用静态加密。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 布尔 | 指定Atlas项目的“静态加密”是否为 | false |
| 对象 | 对包含 | false |
AtlasProject.spec.encryptionAtRest.googleCloudKms.secretRef
对包含 ServiceAccountKey、KeyVersionResourceID 字段的密钥的引用
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.integrations
Atlas与第三方服务之间的项目集成。已弃用:根据迁移指南迁移到 AtlasThirdPartyIntegration 自定义资源, 网址为:https: 操作符8 so-migrate-ptr
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 唯一的 40-十六进制数字字符串,用于标识您的 New Relic 帐户。 | false |
| 对象 | 参考 kubernetes secret,其中包含 Datadog、 | false |
| 对象 | 参考包含允许Atlas访问您的Slack帐户的密钥的kubernetes secret。 | false |
| 字符串 | Atlas向其发送警报通知的Slack渠道的名称。 | false |
| 布尔 | 指示某人是否已激活 Prometheus 集成的标志。 | false |
| 字符串 |
| false |
| 对象 | 参考 kubernetes secret,其中包含唯一的 40-十六进制数字 string,用于标识 New Relic 许可证。 | false |
| 字符串 | Atlas 向其发送通知的 Microsoft Teams Webhook 终结点。 | false |
| 字符串 | false | |
| 字符串 |
| false |
| 对象 | 参考一个包含密码的kubernetes secret,以允许Atlas访问您的Prometheus帐户。 | false |
| 对象 | 对 kubernetes secret 的参考,其中包含与您的 New Relic 帐户关联的查询密钥。 | false |
| 字符串 | 区域代码,指示区域 Atlas 使用哪个区域 | false |
| 对象 | 参考包含与 Splunk On-Call 帐户关联的路由密钥的 kubernetes secret。用于 Victor Ops。 | false |
| 字符串 | false | |
| 对象 | 对包含 Webhook 密钥的 kubernetes secret 的参考。 | false |
| 字符串 | 发现 Prometheus 服务的所需方法。 | false |
| 对象 | 对kubernetes secret的参考,其中包含与您的 | false |
| 字符串 | 用于标识Slack团队的人类可读标签。 | false |
| 枚举 | 第三方集成 | false |
| 字符串 | Atlas发送通知的终结点网址。用于 Webhook。 | false |
| 字符串 | 人类可读标签,用于标识 Prometheus 传入的 Webhook。 | false |
| 对象 | 对 kubernetes secret 的参考,其中包含与 New Relic 帐户关联的插入密钥。 | false |
AtlasProject.spec.integrations.apiKeyRef
对包含 Datadog、OpsGenie 或 Victor Ops API 密钥的 kubernetes secret 的参考。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.integrations.apiTokenRef
参考包含允许Atlas访问您的Slack帐户的密钥的kubernetes secret。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.integrations.licenseKeyRef
参考 kubernetes secret,其中包含唯一的 40-十六进制数字 string,用于标识 New Relic 许可证。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.integrations.passwordRef
参考一个包含密码的kubernetes secret,以允许Atlas访问您的Prometheus帐户。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.integrations.readTokenRef
对 kubernetes secret 的参考,其中包含与您的 New Relic 帐户关联的查询密钥。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.integrations.routingKeyRef
参考包含与 Splunk On-Call 帐户关联的路由密钥的 kubernetes secret。用于 Victor Ops。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.integrations.secretRef
对包含 Webhook 密钥的 kubernetes secret 的参考。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.integrations.serviceKeyRef
对包含与 PagerDuty 帐户关联的服务密钥的 kubernetes secret 的参考。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.integrations.writeTokenRef
对 kubernetes secret 的参考,其中包含与 New Relic 帐户关联的插入密钥。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.maintenanceWindow
MaintenanceWindow 允许指定一周中运行维护操作的首选时间。更多信息请访问 https://www.mongodb.com/zh-cn/docs/atlas/reference/api/maintenance-windows/
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 布尔 | 指示任何计划的项目维护是否应自动推迟一周的标志。 | false |
| 整型 | 您希望维护窗口在一周中的哪一天开始,它是基于 1 的整数。星期日 1、星期一 2、星期二 3、星期三 4、星期四 5、星期五 6、星期六 7。最小值:1 最大值:7 | false |
| 布尔 | 指示下一个计划项目维护是否应推迟一周的标志。如果 | false |
| 整型 | 您希望维护窗口启动的时间。此参数使用 24 小时时钟,其中午夜为 0,中午为 12。最小值:0 最大值:23 | false |
| 布尔 | 指示是否已指示项目维护立即开始的标志。如果 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 | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 |
| false |
| 字符串 | Atlas | false |
| 字符串 |
| false |
| 字符串 |
| false |
| 字符串 |
| false |
| 字符串 |
| false |
| 字符串 |
| false |
| 字符串 | 用户 | false |
| 字符串 |
| false |
| 字符串 |
| false |
| 字符串 |
| false |
| 字符串 | 用户 | false |
| 字符串 | VNetName 是 Azure VNet 的名称。它仅适用于Azure。 | false |
| 字符串 |
| false |
AtlasProject.spec.privateEndpoints
PrivateEndpoint 是为当前项目配置的私有端点列表。已弃用:根据迁移指南迁移到 AtlasPrivateEndpoint 自定义资源 ,网址为:https: 操作符 8so-migrate-ptr
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 枚举 | 要检索其私有端点服务的 Cloud | true |
| 字符串 | 您要为其创建私有端点服务的云提供商 | true |
| 字符串 | 终结点群组的唯一标识符。终结点群组包含您在 Google Cloud 中创建的所有终结点。 | false |
| []对象 | 构成终结点群组的单个私有 | false |
| 字符串 | 您在其中创建终结点的 Google Cloud项目的唯一标识符。 | false |
| 字符串 | 您在 | false |
| 字符串 | 在Azure VNet 中创建的私有端点网络接口的私有 | false |
AtlasProject.spec.privateEndpoints.终结点
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 与您在 Google Cloud 中创建的终结点相对应的转发规则。 | false |
| 字符串 | 您在 Google Cloud 中创建的终结点的私有 | 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 ://www.mongodb.com/zh-cn/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8 so-migrate-ptr
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 此访问权限列表条目中 | false |
| 字符串 | 此访问权限列表条目中采用 | false |
| 字符串 | 与此访问权限列表条目关联的注释。 | false |
| 字符串 |
| false |
| 字符串 | 在此访问权限列表条目中使用 | false |
AtlasProject.spec.regionalizedPrivateEndpoint
RegionalizedPrivateEndpoint 允许启用区域化私有端点。更多信息,请访问 https://www.mongodb.com/zh-cn/docs/atlas/security-private-endpoint/
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 布尔 | 指示是否应启用区域化私有端点模式。 | false |
AtlasProject.spec.settings
设置允许配置项目设置。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 布尔 | 指示是否为指定项目收集特定于数据库的指标的标志。 | false |
| 布尔 | 该标志指示是否为指定项目启用数据浏览器。 | false |
| 布尔 | 指示是否为指定项目启用扩展存储大小的标志。 | false |
| 布尔 | 指示是否为指定项目启用性能优化顾问和分析器的标志。 | false |
| 布尔 | 指示是否为指定项目启用“实时性能面板”的标志。 | false |
| 布尔 | 指示是否为指定项目启用模式顾问程序的标志。 | false |
AtlasProject.spec.tags
TagSpec 包含用于在该资源上添加资源标签的键值对。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 定义标签设立的常量。 | true |
| 字符串 | 属于该标签设立的变量。 | true |
AtlasProject.spec.团队
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| []enum | 团队中的用户在项目中的角色。枚举: | true |
| 对象 | 对将分配给项目的 | true |
AtlasProject.spec.团队.teamRef
对将分配给项目的AtlasTeam 自定义资源的参考。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.spec.x509CertRef
X509CertRef 是对 kubernetes secret 的引用,其中包含 PEM 编码的 CA 证书。Atlas Kubernetes Operator仅监视带有标签 atlas.mongodb.com/type=凭证以免看到不必要的秘密。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |
AtlasProject.status
AtlasProjectStatus 定义了 AtlasProject 的观察到的省/市/自治区
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| []对象 | 条件是显示Atlas自定义资源当前省/市/自治区的列表 | true |
| []对象 |
| false |
| []string |
| false |
| []对象 |
| false |
| []对象 |
| false |
| []对象 | 由于“ | false |
| 字符串 | Atlas项目的 | false |
| []对象 | 为当前项目配置的对等互连列表 | false |
| 整型 |
| false |
| []对象 | 为当前项目配置的私有端点列表 | false |
| 对象 | Prometheus 包含 Prometheus 集成的状态,包括 | false |
| 对象 | 多个区域化私有端点设置的状态( | false |
| []对象 | Teams 包含 | false |
AtlasProject.status.conditions
条件描述了Atlas自定义资源在某一点的省/市/自治区。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 条件的状态; True、False、未知之一。 | true |
| 字符串 | Atlas自定义资源条件的类型。 | true |
| 字符串 | 上次条件从一种状态转换为另一种状态的时间。以 | false |
| 字符串 | 提供有关转换的详细信息的 | false |
| 字符串 | 条件的最后一次转换的 | false |
AtlasProject.status.alertConfigurations
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 确认警报的日期。如果警报从未得到确认,则不会出现。 | false |
| 字符串 | 确认警报的用户留下的评论。如果警报从未得到确认,则不会出现。 | false |
| 字符串 | 确认警报的用户的用户名。如果警报从未得到确认,则不会出现。 | false |
| 字符串 |
| false |
| 字符串 | 此警报应用的集群的 | false |
| 字符串 | 此警报应用的集群的名称。仅适用于类型为 | false |
| 字符串 | 创建此警报配置时的时间戳,采用 | false |
| 对象 |
| false |
| 布尔 | 如果省略,则禁用配置。 | false |
| 字符串 |
| false |
| 字符串 | 将触发警报的事件类型。 | false |
| 字符串 | 拥有此警报配置的项目的唯一标识符。 | false |
| 字符串 |
| false |
| 字符串 | 警报应用的每个托管的主机名和端口。仅适用于类型为 | false |
| 字符串 | 唯一标识符。 | false |
| 字符串 | 上次为此警报发送通知的时间。 仅在已发送通知时显示。 | false |
| []对象 | 仅当 | false |
| 字符串 | 其值超出阈值的测量的名称。仅当 | false |
| 对象 |
| false |
| []对象 | 检测到警报条件时发送通知。 | false |
| 字符串 | 副本集的名称。仅适用于类型为 | false |
| 字符串 | 警报关闭的时间。仅在状态为 | false |
| 字符串 | 警报的严重性。 | false |
| 字符串 | 对于 | false |
| 字符串 | 警报的当前省/市/自治区。可能的值为: | false |
| 对象 | 阈值会触发警报。 | false |
| 字符串 | 上次更新此警报配置的时间戳,采用 | false |
AtlasProject.status.alertConfigurations.currentValue
CurrentValue 表示触发警报的指标的当前值。仅适用于 HOST_METRIC 类型的警报。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 指标的值。 | false |
| 字符串 | 值的 | false |
AtlasProject.status.alertConfigurations.matchers
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 目标对象中要匹配的字段的名称。 | false |
| 字符串 | 用于测试字段值的 | false |
| 字符串 | 要使用指定操作符进行测试的值。 | false |
AtlasProject.status.alertConfigurations.metricThreshold
MetricThreshold 会触发警报。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 阈值,超出该阈值将触发警报。 | true |
| 字符串 | 要检查的指标名称。 | false |
| 字符串 | 必须将其设立为 | false |
| 字符串 | 根据阈值检查当前指标值时要应用的操作符。 | false |
| 字符串 | 阈值的 | false |
AtlasProject.status.alertConfigurations。通知
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Slack | false |
| 字符串 | Slack渠道名称。为 | false |
| 字符串 | Datadog | false |
| 字符串 | 指示要使用哪个 | false |
| 整型 | 检测到警报条件后发送第一个通知之前的等待分钟数。 | false |
| 字符串 | 发送警报通知的电子邮件解决。为 | false |
| 布尔 | 指示是否应发送电子邮件通知的标志。针对 | false |
| 字符串 | Flowdock 流名称以小写字母表示。 | false |
| 字符串 | Flowdock 个人 | false |
| 整型 | 未解决的未确认警报的连续通知之间等待的分钟数。 | false |
| 字符串 | 向其发送警报通知的手机号码。为 | false |
| 字符串 | Opsgenie | false |
| 字符串 | 指示要使用哪个 | false |
| 字符串 | false | |
| []string | 以下 | false |
| 字符串 |
| false |
| 布尔 | 指示是否应发送文本消息通知的标志。针对 | false |
| 字符串 | 团队的唯一标识符。 | false |
| 字符串 | 接收此通知的团队的标签。 | false |
| 字符串 | 警报通知类型。 | false |
| 字符串 | 向其发送通知的Atlas user的名称。此处仅允许项目中拥有警报配置的用户。为 | false |
| 字符串 |
| false |
| 字符串 |
| false |
AtlasProject.status.alertConfigurations.threshold
阈值会触发警报。
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 根据阈值检查当前指标值时要应用的操作符。它接受以下值: | false |
| 字符串 | 阈值,超出该阈值将触发警报。 | false |
| 字符串 | 阈值的 | false |
AtlasProject.status.cloudProviderIntegrations
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 |
| true |
| 字符串 | 用于标识角色的云提供商的人类可读标签。 | true |
| 字符串 | Amazon资源名称,用于标识 | false |
| 字符串 | 有人为指定云服务提供商授权此角色的日期和时间。此参数以 | false |
| 字符串 | 有人为指定云服务提供商创建此角色的日期和时间。此参数以 | false |
| 字符串 | 返回应用程序错误消息。 | false |
| []对象 | 列表,其中包含与此Amazon Web Services身份和访问管理角色关联的应用程序功能。 | false |
| 字符串 | Amazon资源名称,用于标识 | false |
| 字符串 | 用于标识角色的唯一的 24 位十六进制数字字符串。 | false |
| 字符串 | 预配服务帐户的 | false |
AtlasProject.status.cloudProviderIntegrations.featureUsages
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 识别与此Amazon Web Services身份和访问管理角色相关联的data lake的特征。 | false |
| 字符串 | 人类可读标签,用于描述与此Amazon Web Services Identity and Access Management角色相关联的一项 | false |
AtlasProject.status.customRoles
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 |
| true |
| 字符串 | 给定自定义角色的 | true |
| 字符串 | 自定义角色处于 | false |
AtlasProject.status.expiredIpAccessList
IPAccessList 允许为项目使用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-ak8 so-migrate-ptr
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 此访问权限列表条目中 | false |
| 字符串 | 此访问权限列表条目中采用 | false |
| 字符串 | 与此访问权限列表条目关联的注释。 | false |
| 字符串 |
| false |
| 字符串 | 在此访问权限列表条目中使用 | false |
AtlasProject.status.networkPeers
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 |
| true |
| 字符串 | 要检索其对等互连的云提供商。 | true |
| 字符串 | 要为其创建对等互连的区域。不需要它 | true |
| 字符串 |
| false |
| 字符串 | Atlas网络名称。仅适用于 | false |
| 字符串 | 网络对等连接的唯一标识符。仅适用于 | false |
| 字符串 |
| false |
| 字符串 | 对等互连的省/市/自治区错误。仅适用于 | false |
| 字符串 | 对等互连的省/市/自治区错误。仅适用于Azure。 | false |
| 字符串 | 对等互连的省/市/自治区错误。仅适用于 | false |
| 字符串 |
| false |
| 字符串 | 网络对等互连的状态。仅适用于 | false |
| 字符串 | 网络对等互连的状态。仅适用于 | false |
| 字符串 |
| false |
AtlasProject.status.privateEndpoints
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 要检索其私有端点服务的 Cloud | true |
| 字符串 | 您要为其创建私有端点服务的云提供商 | true |
| []对象 | 构成网络终结点群组的单个 | false |
| 字符串 |
| false |
| 字符串 |
| false |
| []string | 唯一的字母数字和特殊字符串,用于标识与 | false |
| 字符串 | Atlas托管的 | false |
| 字符串 | Azure Private Link服务的唯一标识符( | false |
AtlasProject.status.privateEndpoints.终结点
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | 人类可读标签,用于标识您创建的 Google Cloud 消费者转发规则。 | true |
| 字符串 | 此 Google Cloud 使用方转发规则解析为的一个私有互联网协议版本 4 (IPv4)解决。 | true |
| 字符串 |
| true |
AtlasProject.status.prometheus
Prometheus 包含 Prometheus 集成的状态,包括 prometheusDiscoveryURL
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 |
| false |
| 字符串 | 用于 Prometheus 请求的协议 | false |
AtlasProject.status.regionalizedPrivateEndpoint
多个区域化私有端点设置(用户界面中的“多个区域化私有端点”设置)的状态
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 布尔 | 指示是否应启用区域化私有端点模式。 | false |
AtlasProject.status.团队
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 对象 |
| true |
| 字符串 | false |
AtlasProject.status.teams.teamRef
ResourceRefNamespaced 是对 Kubernetes 资源的引用,允许配置命名空间
Name | 类型 | 说明 | 必需 |
|---|---|---|---|
| 字符串 | Kubernetes资源名称 | true |
| 字符串 | Kubernetes资源的命名空间 | false |