/ /

自定义资源

Docs 主页

管理

Atlas Kubernetes Operator

自定义资源

Docs 主页

管理

Atlas Kubernetes Operator

自定义资源

`AtlasPrivateEndpoint` 自定义资源

重要

旧版子资源自相应的 CRD发布以来已被弃用。如果您的配置当前依赖于此资源定义的子资源形式，请迁移到 CRD。

AtlasPrivateEndpoint自定义资源为Atlas项目配置私有端点。这样，您就可以将云提供商连接到Atlas，而无需通过公共网络发送信息。私有端点是从虚拟网络到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 Kubernetes Operator使用Atlas 私有端点服务API资源：执行以下操作之一：

创建新的私有端点服务。
更新现有的私有端点服务。

要学习；了解有关在Atlas Kubernetes Operator中实施私有端点的更多信息，请参阅管理私有端点。

示例

基本示例

以下示例显示了一个自定义资源，该资源在项目中定义了 AtlasPrivateEndpointAmazon Web Services私有端点。my-project

apiVersion: atlas.mongodb.com/v1
kind: AtlasPrivateEndpoint
metadata:
 name: my-atlas-pe1
spec:
  projectRef:
    name: my-project
    namespace: my-operator-namespace
  provider: AWS
  region: US_EAST_1
  awsConfiguration:
    - id: vpcpe-xyz

独立 CRD 示例

以下示例显示了一个独立于AtlasPrivateEndpoint 的 CRD，它定义了基本示例中定义的相同私有端点。通过此自定义资源定义，您可以在某个项目中创建此私有端点，而该项目并非在您定义此资源的Atlas Kubernetes Operator实例中管理。要启用独立操作，必须使用 externalProjectRef 而不是 projectRef，并且必须直接提供 connectionSecret，因为此资源无法从其父项目继承API凭证。

apiVersion: atlas.mongodb.com/v1
kind: AtlasPrivateEndpoint
metadata:
 name: my-atlas-pe1
spec:
  externalProjectRef:
    projectID: 66e2f2b621571b7e69a89b66
  connectionSecret:
    name: atlas-connection-secret
  provider: AWS
  region: US_EAST_1
  awsConfiguration:
    - id: vpcpe-xyz

参数

Atlas 私有终结点

AtlasPrivateEndpoint 自定义资源定义 (CRD) 定义了 Atlas 项目所需的私有端点配置。它支持在云提供商和Atlas之间建立私有连接，不通过公共网络发送信息。

您可以使用私有终结点，创建从虚拟网络到 Atlas 集群的单向连接。

`Name`	类型	说明	必需
`apiVersion`	字符串	atlas.mongodb.com/v1	true
`kind`	字符串	`AtlasPrivateEndpoint`	true
`metadata`	对象	有关 `metadata` 字段的字段，请参阅 Kubernetes `API` 文档。	true
`spec`	对象	`AtlasPrivateEndpointSpec` 是项目私有端点所需配置的验证： (has(self.``externalProjectRef``)&& !has(self.``projectRef``))\|\| (!has(self.``externalProjectRef``)&& has(self.``projectRef``)):只能通过 `externalProjectRef` 或 `projectRef` 定义一个项目引用 (has(self.``externalProjectRef``)&& has(self.``connectionSecret``))\|\| !has(self.``externalProjectRef``):引用外部项目时必须定义本地连接密钥	false
`status`	对象	`AtlasPrivateEndpointStatus` 是 `AtlasPrivateEndpoint`集群中最近观察到的 `status`。只读。	false

AtlasPrivateEndpoint.spec

AtlasPrivateEndpointSpec 是项目私有端点所需配置的规范

`Name`	类型	说明	必需
`provider`	枚举	要为其创建私有端点服务的云服务 `provider` 的名称。枚举：`AWS`、`GCP`、`AZURE`	true
`region`	字符串	您要在其中创建私有端点服务的所选云提供商的区域。	true
`awsConfiguration`	[]对象	AWSConfiguration 是私有端点的特定 `AWS` 设置。	false
`azureConfiguration`	[]对象	`AzureConfiguration` 是私有端点的特定Azure设置。	false
`connectionSecret`	对象	包含Atlas `API` 私钥和公钥的密钥名称。	false
`externalProjectRef`	对象	`externalProjectRef` 包含父Atlas项目`ID`。与“`projectRef`”字段互斥。	false
`gcpConfiguration`	[]对象	GCPConfiguration 是私有端点的特定 Google Cloud 设置。	false
`projectRef`	对象	`projectRef` 是对父 `AtlasProject`资源的引用。与“`externalProjectRef`”字段互斥。	false

AtlasPrivateEndpoint.spec.awsConfiguration

AWSPrivateEndpointConfiguration 保存在客户数网络上完成的 AWS 配置。

`Name`	类型	说明	必需
`id`	字符串	`ID` 标识有人添加到此私有端点服务的私有端点的网络接口。	true

AtlasPrivateEndpoint.spec.azureConfiguration

AzurePrivateEndpointConfiguration 保存在客户数网络上完成的Azure配置。

`Name`	类型	说明	必需
`id`	字符串	`ID` 标识有人添加到此私有端点服务的私有端点的网络接口。	true
`ipAddress`	字符串	`IP` 有人添加到此私有端点服务的你的 Azure VNet 中私有端点的地址。	true

AtlasPrivateEndpoint.spec.connectionSecret

包含Atlas API私钥和公钥的密钥名称。

`Name`	类型	说明	必需
`name`	字符串	所引用资源的名称。更多信息：https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true

AtlasPrivateEndpoint.spec.externalProjectRef

externalProjectRef 保存父Atlas群组 ID（group ID）。与 "projectRef"字段互斥。

`Name`	类型	说明	必需
`id`	字符串	`ID` 是Atlas项目`ID`。	true

AtlasPrivateEndpoint.spec.gcpConfiguration

GCPPrivateEndpointConfiguration 保存在客户数网络上完成的GCP配置。

`Name`	类型	说明	必需
`endpoints`	[]对象	Endpoints 是构成此端点群组的各个私有 `endpoints` 的列表。	true
`groupName`	字符串	`GroupName` 是标识一组终结点的标签。	true
`projectId`	字符串	`ProjectID` 标识您在其中创建终结点的 Google Cloud项目。	true

AtlasPrivateEndpoint.spec.gcpConfiguration.终结点

GCPPrivateEndpoint 保存在客户数网络上配置的GCP转发规则。

`Name`	类型	说明	必需
`ipAddress`	字符串	`IP` 此 Google Cloud 使用方转发规则解析的解决。	true
`name`	字符串	用于标识您创建的 Google Cloud 使用者转发规则的名称。	true

AtlasPrivateEndpoint.spec.projectRef

projectRef 是对父 AtlasProject资源的引用。与 "externalProjectRef"字段互斥。

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

AtlasPrivateEndpoint.status

AtlasPrivateEndpointStatus 是最近观察到的 AtlasPrivateEndpoint集群状态。只读。

`Name`	类型	说明	必需
`conditions`	[]对象	条件是显示Atlas自定义资源当前省/市/自治区的列表	true
`endpoints`	[]对象	终结点是连接到服务的 `endpoints` 的状态	false
`error`	字符串	错误是对配置私有端点时发生的故障的说明	false
`observedGeneration`	整型	`ObservedGeneration` 表示 Atlas 操作符感知的资源规范的生成。Atlas Operator 将此字段更新为“元数据.Generation ”的值一旦开始资源协调。格式：int64	false
`resourceId`	字符串	`ResourceID` 是标识Atlas Azure Private Link Service 的根相对路径	false
`serviceAttachmentNames`	[]string	`ServiceAttachmentNames` URL 列表，用于标识 Atlas 可用于通过专用连接访问一项服务的终结点	false
`serviceId`	字符串	`ServiceID` 是Atlas中私有端点的唯一标识符	false
`serviceName`	字符串	`ServiceName` 是由Atlas托管的Amazon Web Services (`AWS`) `PrivateLink` 终结点服务或Azure Private Link 服务的唯一标识符	false
`serviceStatus`	字符串	`ServiceStatus` 是私有端点服务的省/市/自治区	false

AtlasPrivateEndpoint.status.conditions

条件描述了Atlas自定义资源在某一点的省/市/自治区。

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

AtlasPrivateEndpoint.status.终结点

EndpointInterfaceStatus 是连接到已配置服务的接口的最新观察到的状态。只读。

`Name`	类型	说明	必需
`ID`	字符串	`ID` 是规范上设立的外部标识符，用于配置接口	false
`InterfaceStatus`	字符串	`InterfaceStatus` 是私有端点接口的状态	false
`connectionName`	字符串	`ConnectionName` 是Atlas生成的标签，用于标识Azure私有端点连接	false
`error`	字符串	错误是对配置私有端点时发生的故障的说明	false
`gcpForwardingRules`	[]对象	GCPForwardingRules 是客户数 `GCP` 私有端点（转发规则）的状态	false

AtlasPrivateEndpoint.status.终结点.gcpForwardingRules

GCPForwardingRule 是为接口配置的GCP转发规则的最新观察到的状态。只读。

`Name`	类型	说明	必需
`name`	字符串	人类可读标签，用于标识您创建的 Google Cloud 消费者转发规则。	false
`status`	字符串	`MongoDB` Atlas终结点组的省/市/自治区状态。	false

后退

AtlasOrgSettings

来年

AtlasSearchIndexConfig