Skip to content

Commit ac78181

Browse files
authored
Small documentation fixes for Atlas Deployments (#619)
* Fix documentation * Update atlas.mongodb.com_atlasdeployments.yaml
1 parent 8114e18 commit ac78181

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

config/crd/bases/atlas.mongodb.com_atlasdeployments.yaml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,12 @@ spec:
3535
type: object
3636
spec:
3737
description: AtlasDeploymentSpec defines the desired state of AtlasDeployment
38+
Only one of DeploymentSpec, AdvancedDeploymentSpec and ServerlessSpec
39+
should be defined
3840
properties:
3941
advancedDeploymentSpec:
40-
description: Configuration for the advanced deployment API. https://docs.atlas.mongodb.com/reference/api/clusters-advanced/
42+
description: Configuration for the advanced (v1.5) deployment API
43+
https://www.mongodb.com/docs/atlas/reference/api/clusters-advanced/
4144
properties:
4245
backupEnabled:
4346
type: boolean
@@ -270,7 +273,7 @@ spec:
270273
- name
271274
type: object
272275
deploymentSpec:
273-
description: Configuration for the advanced deployment API
276+
description: Configuration for the normal (v1) deployment API https://www.mongodb.com/docs/atlas/reference/api/clusters/
274277
properties:
275278
autoScaling:
276279
description: Collection of settings that configures auto-scaling
@@ -602,7 +605,7 @@ spec:
602605
- name
603606
type: object
604607
serverlessSpec:
605-
description: Configuration for the advanced deployment API. https://docs.atlas.mongodb.com/reference/api/clusters-advanced/
608+
description: Configuration for the serverless deployment API. https://www.mongodb.com/docs/atlas/reference/api/serverless-instances/
606609
properties:
607610
name:
608611
description: Name of the serverless deployment as it appears in

pkg/api/v1/atlasdeployment_types.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,23 +44,24 @@ const (
4444
)
4545

4646
// AtlasDeploymentSpec defines the desired state of AtlasDeployment
47+
// Only one of DeploymentSpec, AdvancedDeploymentSpec and ServerlessSpec should be defined
4748
type AtlasDeploymentSpec struct {
4849
// Project is a reference to AtlasProject resource the deployment belongs to
4950
Project common.ResourceRefNamespaced `json:"projectRef"`
5051

51-
// Configuration for the advanced deployment API
52+
// Configuration for the normal (v1) deployment API https://www.mongodb.com/docs/atlas/reference/api/clusters/
5253
// +optional
5354
DeploymentSpec *DeploymentSpec `json:"deploymentSpec,omitempty"`
5455

55-
// Configuration for the advanced deployment API. https://docs.atlas.mongodb.com/reference/api/clusters-advanced/
56+
// Configuration for the advanced (v1.5) deployment API https://www.mongodb.com/docs/atlas/reference/api/clusters-advanced/
5657
// +optional
5758
AdvancedDeploymentSpec *AdvancedDeploymentSpec `json:"advancedDeploymentSpec,omitempty"`
5859

5960
// Backup schedule for the AtlasDeployment
6061
// +optional
6162
BackupScheduleRef common.ResourceRefNamespaced `json:"backupRef"`
6263

63-
// Configuration for the advanced deployment API. https://docs.atlas.mongodb.com/reference/api/clusters-advanced/
64+
// Configuration for the serverless deployment API. https://www.mongodb.com/docs/atlas/reference/api/serverless-instances/
6465
// +optional
6566
ServerlessSpec *ServerlessSpec `json:"serverlessSpec,omitempty"`
6667

0 commit comments

Comments
 (0)