Skip to content

Commit 2c8cbcf

Browse files
authored
CLOUDP-355972: Even more CRD comment updates (#2981)
* more crd comment updates * gen api-docs
1 parent e7d44bb commit 2c8cbcf

26 files changed

+239
-142
lines changed

api/v1/atlasdatafederation_types.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ func init() {
2828
SchemeBuilder.Register(&AtlasDataFederation{}, &AtlasDataFederationList{})
2929
}
3030

31+
// DataFederationSpec defines the desired state of AtlasDataFederation.
3132
type DataFederationSpec struct {
3233
// Project is a reference to AtlasProject resource the deployment belongs to.
3334
Project common.ResourceRefNamespaced `json:"projectRef"`

api/v1/atlasdeployment_types.go

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,8 @@ type AdvancedDeploymentSpec struct {
120120
// MongoDB major version of the cluster. Set to the binary major version.
121121
// +optional
122122
MongoDBMajorVersion string `json:"mongoDBMajorVersion,omitempty"`
123-
MongoDBVersion string `json:"mongoDBVersion,omitempty"`
123+
// Version of MongoDB that the cluster runs.
124+
MongoDBVersion string `json:"mongoDBVersion,omitempty"`
124125
// Name of the advanced deployment as it appears in Atlas.
125126
// After Atlas creates the deployment, you can't change its name.
126127
// Can only contain ASCII letters, numbers, and hyphens.
@@ -323,10 +324,14 @@ type AdvancedReplicationSpec struct {
323324
}
324325

325326
type AdvancedRegionConfig struct {
326-
AnalyticsSpecs *Specs `json:"analyticsSpecs,omitempty"`
327-
ElectableSpecs *Specs `json:"electableSpecs,omitempty"`
328-
ReadOnlySpecs *Specs `json:"readOnlySpecs,omitempty"`
329-
AutoScaling *AdvancedAutoScalingSpec `json:"autoScaling,omitempty"`
327+
// Hardware specifications for analytics nodes deployed in the region.
328+
AnalyticsSpecs *Specs `json:"analyticsSpecs,omitempty"`
329+
// Hardware specifications for nodes deployed in the region.
330+
ElectableSpecs *Specs `json:"electableSpecs,omitempty"`
331+
// Hardware specifications for read only nodes deployed in the region.
332+
ReadOnlySpecs *Specs `json:"readOnlySpecs,omitempty"`
333+
// Options that determine how this cluster handles resource scaling.
334+
AutoScaling *AdvancedAutoScalingSpec `json:"autoScaling,omitempty"`
330335
// Cloud service provider on which the host for a multi-tenant deployment is provisioned.
331336
// This setting only works when "providerName" : "TENANT" and "providerSetting.instanceSizeName" : M2 or M5.
332337
// Otherwise, it should be equal to the "providerName" value.

api/v1/atlasfederatedauth_types.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ func init() {
3232
SchemeBuilder.Register(&AtlasFederatedAuth{}, &AtlasFederatedAuthList{})
3333
}
3434

35+
// AtlasFederatedAuthSpec defines the desired state of AtlasFederatedAuth.
3536
type AtlasFederatedAuthSpec struct {
3637
// +kubebuilder:default:=false
3738
Enabled bool `json:"enabled,omitempty"`

api/v1/atlasorgsettings_types.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ func init() {
2626
SchemeBuilder.Register(&AtlasOrgSettingsList{})
2727
}
2828

29+
// AtlasOrgSettingsSpec defines the desired state of AtlasOrgSettings.
2930
type AtlasOrgSettingsSpec struct {
3031
// OrgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
3132
// +required

api/v1/atlassearchindexconfig_types.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ type AtlasSearchIndexConfigList struct {
4949
Items []AtlasSearchIndexConfig `json:"items"`
5050
}
5151

52+
// AtlasSearchIndexConfigSpec defines the desired state of AtlasSearchIndexConfig.
5253
type AtlasSearchIndexConfigSpec struct {
5354
// Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text.
5455
// These units are called a term or token. This process, known as tokenization, involves a variety of changes made to the text in fields:

api/v1/atlasstreamconnection_types.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import (
2222
"github.com/mongodb/mongodb-atlas-kubernetes/v2/api/v1/status"
2323
)
2424

25+
// AtlasStreamConnectionSpec defines the desired state of AtlasStreamConnection.
2526
type AtlasStreamConnectionSpec struct {
2627
// Human-readable label that uniquely identifies the stream connection.
2728
Name string `json:"name"`

api/v1/atlasstreaminstance_types.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ import (
2424
"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/kube"
2525
)
2626

27+
// AtlasStreamInstanceSpec defines the desired state of AtlasStreamInstance.
2728
type AtlasStreamInstanceSpec struct {
2829
// Human-readable label that identifies the stream connection.
2930
Name string `json:"name"`

api/v1/encryption_at_rest.go

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,13 @@ type EncryptionAtRest struct {
2727

2828
// AwsKms specifies AWS KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.
2929
type AwsKms struct {
30-
Enabled *bool `json:"enabled,omitempty"` // Specifies whether Encryption at Rest is enabled for an Atlas project, To disable Encryption at Rest, pass only this parameter with a value of false, When you disable Encryption at Rest, Atlas also removes the configuration details.
31-
Region string `json:"region,omitempty"` // The AWS region in which the AWS customer master key exists: CA_CENTRAL_1, US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, SA_EAST_1
32-
Valid *bool `json:"valid,omitempty"` // Specifies whether the encryption key set for the provider is valid and may be used to encrypt and decrypt data.
30+
// Specifies whether Encryption at Rest is enabled for an Atlas project.
31+
// To disable Encryption at Rest, pass only this parameter with a value of false. When you disable Encryption at Rest, Atlas also removes the configuration details.
32+
Enabled *bool `json:"enabled,omitempty"`
33+
// The AWS region in which the AWS customer master key exists.
34+
Region string `json:"region,omitempty"`
35+
// Specifies whether the encryption key set for the provider is valid and may be used to encrypt and decrypt data.
36+
Valid *bool `json:"valid,omitempty"`
3337
// A reference to as Secret containing the AccessKeyID, SecretAccessKey, CustomerMasterKeyID and RoleID fields
3438
// +optional
3539
SecretRef common.ResourceRefNamespaced `json:"secretRef,omitempty"`
@@ -41,11 +45,17 @@ func (a *AwsKms) IsEnabled() bool {
4145

4246
// AzureKeyVault specifies Azure Key Vault configuration details and whether Encryption at Rest is enabled for an Atlas project.
4347
type AzureKeyVault struct {
44-
Enabled *bool `json:"enabled,omitempty"` // Specifies whether Encryption at Rest is enabled for an Atlas project. To disable Encryption at Rest, pass only this parameter with a value of false. When you disable Encryption at Rest, Atlas also removes the configuration details.
45-
ClientID string `json:"clientID,omitempty"` // The Client ID, also known as the application ID, for an Azure application associated with the Azure AD tenant.
46-
AzureEnvironment string `json:"azureEnvironment,omitempty"` // The Azure environment where the Azure account credentials reside. Valid values are the following: AZURE, AZURE_CHINA, AZURE_GERMANY
47-
ResourceGroupName string `json:"resourceGroupName,omitempty"` // The name of the Azure Resource group that contains an Azure Key Vault.
48-
TenantID string `json:"tenantID,omitempty"` // The unique identifier for an Azure AD tenant within an Azure subscription.
48+
// Specifies whether Encryption at Rest is enabled for an Atlas project.
49+
// To disable Encryption at Rest, pass only this parameter with a value of false. When you disable Encryption at Rest, Atlas also removes the configuration details.
50+
Enabled *bool `json:"enabled,omitempty"`
51+
// The Client ID, also known as the application ID, for an Azure application associated with the Azure AD tenant.
52+
ClientID string `json:"clientID,omitempty"`
53+
// The Azure environment where the Azure account credentials reside. Valid values are the following: AZURE, AZURE_CHINA, AZURE_GERMANY
54+
AzureEnvironment string `json:"azureEnvironment,omitempty"`
55+
// The name of the Azure Resource group that contains an Azure Key Vault.
56+
ResourceGroupName string `json:"resourceGroupName,omitempty"`
57+
// The unique identifier for an Azure AD tenant within an Azure subscription.
58+
TenantID string `json:"tenantID,omitempty"`
4959
// A reference to as Secret containing the SubscriptionID, KeyVaultName, KeyIdentifier, Secret fields
5060
// +optional
5161
SecretRef common.ResourceRefNamespaced `json:"secretRef,omitempty"`
@@ -57,7 +67,9 @@ func (a *AzureKeyVault) IsEnabled() bool {
5767

5868
// GoogleCloudKms specifies GCP KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.
5969
type GoogleCloudKms struct {
60-
Enabled *bool `json:"enabled,omitempty"` // Specifies whether Encryption at Rest is enabled for an Atlas project. To disable Encryption at Rest, pass only this parameter with a value of false. When you disable Encryption at Rest, Atlas also removes the configuration details.
70+
// Specifies whether Encryption at Rest is enabled for an Atlas project.
71+
// To disable Encryption at Rest, pass only this parameter with a value of false. When you disable Encryption at Rest, Atlas also removes the configuration details.
72+
Enabled *bool `json:"enabled,omitempty"`
6173
// A reference to as Secret containing the ServiceAccountKey, KeyVersionResourceID fields
6274
// +optional
6375
SecretRef common.ResourceRefNamespaced `json:"secretRef,omitempty"`

api/v1/project/integration.go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,12 @@ type Integration struct {
6262
// Used for Victor Ops.
6363
// +optional
6464
RoutingKeyRef common.ResourceRefNamespaced `json:"routingKeyRef,omitempty"`
65+
// DEPRECATED: Flowdock flow name.
66+
// This field has been removed from Atlas, and has no effect.
6567
// +optional
6668
FlowName string `json:"flowName,omitempty"`
69+
// DEPRECATED: Flowdock organization name.
70+
// This field has been removed from Atlas, and has no effect.
6771
// +optional
6872
OrgName string `json:"orgName,omitempty"`
6973
// Endpoint web address to which Atlas sends notifications.
@@ -89,7 +93,7 @@ type Integration struct {
8993
ServiceDiscovery string `json:"serviceDiscovery,omitempty"`
9094
// +optional
9195
Scheme string `json:"scheme,omitempty"`
92-
//
96+
// Flag that indicates whether someone has activated the Prometheus integration.
9397
// +optional
9498
Enabled bool `json:"enabled,omitempty"`
9599
}

api/v1/status/atlasdeployment.go

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,19 +32,25 @@ type AtlasDeploymentStatus struct {
3232
// ConnectionStrings is a set of connection strings that your applications use to connect to this cluster.
3333
ConnectionStrings *ConnectionStrings `json:"connectionStrings,omitempty"`
3434

35+
// Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.
36+
// This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.
3537
ReplicaSets []ReplicaSet `json:"replicaSets,omitempty"`
3638

39+
// ServerlessPrivateEndpoints contains a list of private endpoints configured for the serverless deployment.
3740
ServerlessPrivateEndpoints []ServerlessPrivateEndpoint `json:"serverlessPrivateEndpoints,omitempty"`
3841

42+
// List that contains key value pairs to map zones to geographic regions.
43+
// These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.
3944
CustomZoneMapping *CustomZoneMapping `json:"customZoneMapping,omitempty"`
4045

46+
// List that contains a namespace for a Global Cluster. MongoDB Atlas manages this cluster.
4147
ManagedNamespaces []ManagedNamespace `json:"managedNamespaces,omitempty"`
4248

4349
// MongoURIUpdated is a timestamp in ISO 8601 date and time format in UTC when the connection string was last updated.
4450
// The connection string changes if you update any of the other values.
4551
MongoURIUpdated string `json:"mongoURIUpdated,omitempty"`
4652

47-
// SearchIndexes contains a list of search indexes statuses configured for a project
53+
// SearchIndexes contains a list of search indexes statuses configured for a project.
4854
SearchIndexes []DeploymentSearchIndexStatus `json:"searchIndexes,omitempty"`
4955
}
5056

@@ -58,7 +64,9 @@ const (
5864
)
5965

6066
type ReplicaSet struct {
61-
ID string `json:"id"`
67+
// Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster.
68+
ID string `json:"id"`
69+
// Human-readable label that describes the zone this shard belongs to in a Global Cluster.
6270
ZoneName string `json:"zoneName,omitempty"`
6371
}
6472

@@ -99,6 +107,7 @@ type PrivateEndpoint struct {
99107
// Private-endpoint-aware mongodb+srv:// connection string for this private endpoint.
100108
SRVConnectionString string `json:"srvConnectionString,omitempty"`
101109

110+
// Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint.
102111
SRVShardOptimizedConnectionString string `json:"srvShardOptimizedConnectionString,omitempty"`
103112

104113
// Type of MongoDB process that you connect to with the connection strings

0 commit comments

Comments
 (0)