|
| 1 | +apiVersion: apiextensions.k8s.io/v1 |
| 2 | +kind: CustomResourceDefinition |
| 3 | +metadata: |
| 4 | + annotations: |
| 5 | + controller-gen.kubebuilder.io/version: v0.16.1 |
| 6 | + creationTimestamp: null |
| 7 | + labels: |
| 8 | + app.kubernetes.io/component: controller |
| 9 | + app.kubernetes.io/instance: mongodb-atlas-kubernetes-operator |
| 10 | + app.kubernetes.io/name: mongodb-atlas-kubernetes-operator |
| 11 | + name: atlasprivateendpoints.atlas.mongodb.com |
| 12 | +spec: |
| 13 | + group: atlas.mongodb.com |
| 14 | + names: |
| 15 | + categories: |
| 16 | + - atlas |
| 17 | + kind: AtlasPrivateEndpoint |
| 18 | + listKind: AtlasPrivateEndpointList |
| 19 | + plural: atlasprivateendpoints |
| 20 | + shortNames: |
| 21 | + - pe |
| 22 | + singular: atlasprivateendpoint |
| 23 | + scope: Namespaced |
| 24 | + versions: |
| 25 | + - additionalPrinterColumns: |
| 26 | + - jsonPath: .spec.provider |
| 27 | + name: Provider |
| 28 | + type: string |
| 29 | + - jsonPath: .spec.region |
| 30 | + name: Region |
| 31 | + type: string |
| 32 | + - jsonPath: .status.conditions[?(@.type=="Ready")].status |
| 33 | + name: Ready |
| 34 | + type: string |
| 35 | + name: v1 |
| 36 | + schema: |
| 37 | + openAPIV3Schema: |
| 38 | + description: |- |
| 39 | + The AtlasPrivateEndpoint custom resource definition (CRD) defines a desired [Private Endpoint](https://www.mongodb.com/docs/atlas/security-private-endpoint/#std-label-private-endpoint-overview) configuration for an Atlas project. |
| 40 | + It allows a private connection between your cloud provider and Atlas that doesn't send information through a public network. |
| 41 | +
|
| 42 | + You can use private endpoints to create a unidirectional connection to Atlas clusters from your virtual network. |
| 43 | + properties: |
| 44 | + apiVersion: |
| 45 | + description: |- |
| 46 | + APIVersion defines the versioned schema of this representation of an object. |
| 47 | + Servers should convert recognized schemas to the latest internal value, and |
| 48 | + may reject unrecognized values. |
| 49 | + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
| 50 | + type: string |
| 51 | + kind: |
| 52 | + description: |- |
| 53 | + Kind is a string value representing the REST resource this object represents. |
| 54 | + Servers may infer this from the endpoint the client submits requests to. |
| 55 | + Cannot be updated. |
| 56 | + In CamelCase. |
| 57 | + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| 58 | + type: string |
| 59 | + metadata: |
| 60 | + type: object |
| 61 | + spec: |
| 62 | + description: AtlasPrivateEndpointSpec is the specification of the desired |
| 63 | + configuration of a project private endpoint |
| 64 | + properties: |
| 65 | + awsConfiguration: |
| 66 | + description: AWSConfiguration is the specific AWS settings for the |
| 67 | + private endpoint |
| 68 | + items: |
| 69 | + description: AWSPrivateEndpointConfiguration holds the AWS configuration |
| 70 | + done on customer network |
| 71 | + properties: |
| 72 | + id: |
| 73 | + description: ID that identifies the private endpoint's network |
| 74 | + interface that someone added to this private endpoint service. |
| 75 | + type: string |
| 76 | + required: |
| 77 | + - id |
| 78 | + type: object |
| 79 | + type: array |
| 80 | + azureConfiguration: |
| 81 | + description: AzureConfiguration is the specific Azure settings for |
| 82 | + the private endpoint |
| 83 | + items: |
| 84 | + description: AzurePrivateEndpointConfiguration holds the Azure configuration |
| 85 | + done on customer network |
| 86 | + properties: |
| 87 | + id: |
| 88 | + description: ID that identifies the private endpoint's network |
| 89 | + interface that someone added to this private endpoint service. |
| 90 | + type: string |
| 91 | + ipAddress: |
| 92 | + description: IP address of the private endpoint in your Azure |
| 93 | + VNet that someone added to this private endpoint service. |
| 94 | + type: string |
| 95 | + required: |
| 96 | + - id |
| 97 | + - ipAddress |
| 98 | + type: object |
| 99 | + type: array |
| 100 | + connectionSecret: |
| 101 | + description: LocalObjectReference is a reference to an object in the |
| 102 | + same namespace as the referent |
| 103 | + properties: |
| 104 | + name: |
| 105 | + description: |- |
| 106 | + Name of the resource being referred to |
| 107 | + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| 108 | + type: string |
| 109 | + required: |
| 110 | + - name |
| 111 | + type: object |
| 112 | + externalProjectRef: |
| 113 | + description: ExternalProject holds the Atlas project ID the user belongs |
| 114 | + to |
| 115 | + properties: |
| 116 | + id: |
| 117 | + description: ID is the Atlas project ID |
| 118 | + type: string |
| 119 | + required: |
| 120 | + - id |
| 121 | + type: object |
| 122 | + gcpConfiguration: |
| 123 | + description: GCPConfiguration is the specific Google Cloud settings |
| 124 | + for the private endpoint |
| 125 | + items: |
| 126 | + description: GCPPrivateEndpointConfiguration holds the GCP configuration |
| 127 | + done on customer network |
| 128 | + properties: |
| 129 | + endpoints: |
| 130 | + description: Endpoints is the list of individual private endpoints |
| 131 | + that comprise this endpoint group. |
| 132 | + items: |
| 133 | + description: GCPPrivateEndpoint holds the GCP forwarding rules |
| 134 | + configured on customer network |
| 135 | + properties: |
| 136 | + ipAddress: |
| 137 | + description: IP address to which this Google Cloud consumer |
| 138 | + forwarding rule resolves. |
| 139 | + type: string |
| 140 | + name: |
| 141 | + description: Name that identifies the Google Cloud consumer |
| 142 | + forwarding rule that you created. |
| 143 | + type: string |
| 144 | + required: |
| 145 | + - ipAddress |
| 146 | + - name |
| 147 | + type: object |
| 148 | + type: array |
| 149 | + groupName: |
| 150 | + description: GroupName is the label that identifies a set of |
| 151 | + endpoints. |
| 152 | + type: string |
| 153 | + projectId: |
| 154 | + description: ProjectID that identifies the Google Cloud project |
| 155 | + in which you created the endpoints. |
| 156 | + type: string |
| 157 | + required: |
| 158 | + - endpoints |
| 159 | + - groupName |
| 160 | + - projectId |
| 161 | + type: object |
| 162 | + type: array |
| 163 | + projectRef: |
| 164 | + description: Project is a reference to AtlasProject resource the user |
| 165 | + belongs to |
| 166 | + properties: |
| 167 | + name: |
| 168 | + description: Name is the name of the Kubernetes Resource |
| 169 | + type: string |
| 170 | + namespace: |
| 171 | + description: Namespace is the namespace of the Kubernetes Resource |
| 172 | + type: string |
| 173 | + required: |
| 174 | + - name |
| 175 | + type: object |
| 176 | + provider: |
| 177 | + description: Name of the cloud service provider for which you want |
| 178 | + to create the private endpoint service. |
| 179 | + enum: |
| 180 | + - AWS |
| 181 | + - GCP |
| 182 | + - AZURE |
| 183 | + type: string |
| 184 | + region: |
| 185 | + description: Region of the chosen cloud provider in which you want |
| 186 | + to create the private endpoint service. |
| 187 | + type: string |
| 188 | + required: |
| 189 | + - provider |
| 190 | + - region |
| 191 | + type: object |
| 192 | + x-kubernetes-validations: |
| 193 | + - message: must define only one project reference through externalProjectRef |
| 194 | + or projectRef |
| 195 | + rule: (has(self.externalProjectRef) && !has(self.projectRef)) || (!has(self.externalProjectRef) |
| 196 | + && has(self.projectRef)) |
| 197 | + - message: must define a local connection secret when referencing an external |
| 198 | + project |
| 199 | + rule: (has(self.externalProjectRef) && has(self.connectionSecret)) || |
| 200 | + !has(self.externalProjectRef) |
| 201 | + status: |
| 202 | + description: AtlasPrivateEndpointStatus is the most recent observed status |
| 203 | + of the AtlasPrivateEndpoint cluster. Read-only. |
| 204 | + properties: |
| 205 | + conditions: |
| 206 | + description: Conditions is the list of statuses showing the current |
| 207 | + state of the Atlas Custom Resource |
| 208 | + items: |
| 209 | + description: Condition describes the state of an Atlas Custom Resource |
| 210 | + at a certain point. |
| 211 | + properties: |
| 212 | + lastTransitionTime: |
| 213 | + description: Last time the condition transitioned from one status |
| 214 | + to another. |
| 215 | + format: date-time |
| 216 | + type: string |
| 217 | + message: |
| 218 | + description: A human readable message indicating details about |
| 219 | + the transition. |
| 220 | + type: string |
| 221 | + reason: |
| 222 | + description: The reason for the condition's last transition. |
| 223 | + type: string |
| 224 | + status: |
| 225 | + description: Status of the condition, one of True, False, Unknown. |
| 226 | + type: string |
| 227 | + type: |
| 228 | + description: Type of Atlas Custom Resource condition. |
| 229 | + type: string |
| 230 | + required: |
| 231 | + - status |
| 232 | + - type |
| 233 | + type: object |
| 234 | + type: array |
| 235 | + endpoints: |
| 236 | + description: Endpoints are the status of the endpoints connected to |
| 237 | + the service |
| 238 | + items: |
| 239 | + description: EndpointInterfaceStatus is the most recent observed |
| 240 | + status the interfaces attached to the configured service. Read-only. |
| 241 | + properties: |
| 242 | + ID: |
| 243 | + description: ID is the external identifier set on the specification |
| 244 | + to configure the interface |
| 245 | + type: string |
| 246 | + InterfaceStatus: |
| 247 | + description: InterfaceStatus is the state of the private endpoint |
| 248 | + interface |
| 249 | + type: string |
| 250 | + connectionName: |
| 251 | + description: ConnectionName is the label that Atlas generates |
| 252 | + that identifies the Azure private endpoint connection |
| 253 | + type: string |
| 254 | + error: |
| 255 | + description: Error is the description of the failure occurred |
| 256 | + when configuring the private endpoint |
| 257 | + type: string |
| 258 | + gcpForwardingRules: |
| 259 | + description: GCPForwardingRules is the status of the customer |
| 260 | + GCP private endpoint(forwarding rules) |
| 261 | + items: |
| 262 | + description: GCPForwardingRule is the most recent observed |
| 263 | + status the GCP forwarding rules configured for an interface. |
| 264 | + Read-only. |
| 265 | + properties: |
| 266 | + name: |
| 267 | + type: string |
| 268 | + status: |
| 269 | + type: string |
| 270 | + type: object |
| 271 | + type: array |
| 272 | + type: object |
| 273 | + type: array |
| 274 | + error: |
| 275 | + description: Error is the description of the failure occurred when |
| 276 | + configuring the private endpoint |
| 277 | + type: string |
| 278 | + observedGeneration: |
| 279 | + description: |- |
| 280 | + ObservedGeneration indicates the generation of the resource specification that the Atlas Operator is aware of. |
| 281 | + The Atlas Operator updates this field to the 'metadata.generation' as soon as it starts reconciliation of the resource. |
| 282 | + format: int64 |
| 283 | + type: integer |
| 284 | + resourceId: |
| 285 | + description: ResourceID is the root-relative path that identifies |
| 286 | + of the Atlas Azure Private Link Service |
| 287 | + type: string |
| 288 | + serviceAttachmentNames: |
| 289 | + description: ServiceAttachmentNames is the list of URLs that identifies |
| 290 | + endpoints that Atlas can use to access one service across the private |
| 291 | + connection |
| 292 | + items: |
| 293 | + type: string |
| 294 | + type: array |
| 295 | + serviceId: |
| 296 | + description: ServiceID is the unique identifier of the private endpoint |
| 297 | + service in Atlas |
| 298 | + type: string |
| 299 | + serviceName: |
| 300 | + description: ServiceName is the unique identifier of the Amazon Web |
| 301 | + Services (AWS) PrivateLink endpoint service or Azure Private Link |
| 302 | + Service managed by Atlas |
| 303 | + type: string |
| 304 | + serviceStatus: |
| 305 | + description: ServiceStatus is the state of the private endpoint service |
| 306 | + type: string |
| 307 | + required: |
| 308 | + - conditions |
| 309 | + type: object |
| 310 | + type: object |
| 311 | + served: true |
| 312 | + storage: true |
| 313 | + subresources: |
| 314 | + status: {} |
| 315 | +status: |
| 316 | + acceptedNames: |
| 317 | + kind: "" |
| 318 | + plural: "" |
| 319 | + conditions: null |
| 320 | + storedVersions: null |
0 commit comments