update project crd comments

roothorp · roothorp · commit c310bc4004c5 · 2025-11-06T14:30:52.000Z
diff --git a/api/v1/atlasproject_types.go b/api/v1/atlasproject_types.go
@@ -43,12 +43,13 @@ func init() {
 type AtlasProjectSpec struct {
 
 	// Name is the name of the Project that is created in Atlas by the Operator if it doesn't exist yet.
+	// The name length must not exceed 64 characters. The name must contain only letters, numbers, spaces, dashes, and underscores.
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Name cannot be modified after project creation"
 	Name string `json:"name"`
 
 	// RegionUsageRestrictions designate the project's AWS region when using Atlas for Government.
 	// This parameter should not be used with commercial Atlas.
-	// In Atlas for Government, not setting this field (defaulting to NONE) means the project is restricted to COMMERCIAL_FEDRAMP_REGIONS_ONLY
+	// In Atlas for Government, not setting this field (defaulting to NONE) means the project is restricted to COMMERCIAL_FEDRAMP_REGIONS_ONLY.
 	// +kubebuilder:validation:Enum=NONE;GOV_REGIONS_ONLY;COMMERCIAL_FEDRAMP_REGIONS_ONLY
 	// +kubebuilder:default:=NONE
 	// +optional
@@ -59,8 +60,10 @@ type AtlasProjectSpec struct {
 	// +optional
 	ConnectionSecret *common.ResourceRefNamespaced `json:"connectionSecretRef,omitempty"`
 
-	// ProjectIPAccessList allows to enable the IP Access List for the Project. See more information at
+	// ProjectIPAccessList allows the use of the IP Access List for a Project. See more information at
 	// https://docs.atlas.mongodb.com/reference/api/ip-access-list/add-entries-to-access-list/
+	// Deprecated: Migrate to the AtlasIPAccessList Custom Resource in accordance with the migration guide
+	// at https://www.mongodb.com/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
 	// +optional
 	ProjectIPAccessList []project.IPAccessList `json:"projectIpAccessList,omitempty"`
 
@@ -70,61 +73,86 @@ type AtlasProjectSpec struct {
 	MaintenanceWindow project.MaintenanceWindow `json:"maintenanceWindow,omitempty"`
 
 	// PrivateEndpoints is a list of Private Endpoints configured for the current Project.
+	// Deprecated: Migrate to the AtlasPrivateEndpoint Custom Resource in accordance with the migration guide
+	// at https://www.mongodb.com/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
+	// +optional
 	PrivateEndpoints []PrivateEndpoint `json:"privateEndpoints,omitempty"`
 
 	// CloudProviderAccessRoles is a list of Cloud Provider Access Roles configured for the current Project.
 	// Deprecated: This configuration was deprecated in favor of CloudProviderIntegrations
+	// +optional
 	CloudProviderAccessRoles []CloudProviderAccessRole `json:"cloudProviderAccessRoles,omitempty"`
 
 	// CloudProviderIntegrations is a list of Cloud Provider Integration configured for the current Project.
+	// +optional
 	CloudProviderIntegrations []CloudProviderIntegration `json:"cloudProviderIntegrations,omitempty"`
 
 	// AlertConfiguration is a list of Alert Configurations configured for the current Project.
+	// If you use this setting, you must also set spec.alertConfigurationSyncEnabled to true for Atlas Kubernetes
+	// Operator to modify project alert configurations.
+	// If you omit or leave this setting empty, Atlas Kubernetes Operator doesn't alter the project's alert
+	// configurations. If creating a project, Atlas applies the default project alert configurations.
 	AlertConfigurations []AlertConfiguration `json:"alertConfigurations,omitempty"`
 
 	// AlertConfigurationSyncEnabled is a flag that enables/disables Alert Configurations sync for the current Project.
 	// If true - project alert configurations will be synced according to AlertConfigurations.
-	// If not - alert configurations will not be modified by the operator. They can be managed through API, cli, UI.
+	// If not - alert configurations will not be modified by the operator. They can be managed through the API, CLI, and UI.
 	//kubebuilder:default:=false
 	// +optional
 	AlertConfigurationSyncEnabled bool `json:"alertConfigurationSyncEnabled,omitempty"`
 
 	// NetworkPeers is a list of Network Peers configured for the current Project.
+	// Deprecated: Migrate to the AtlasNetworkPeering and AtlasNetworkContainer custom resources in accordance with
+	// the migration guide at https://www.mongodb.com/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
+	// +optional
 	NetworkPeers []NetworkPeer `json:"networkPeers,omitempty"`
 
-	// Flag that indicates whether to create the new project with the default alert settings enabled. This parameter defaults to true
+	// Flag that indicates whether Atlas Kubernetes Operator creates a project with the default alert configurations.
+	// If you use this setting, you must also set spec.alertConfigurationSyncEnabled to true for Atlas Kubernetes
+	// Operator to modify project alert configurations.
+	// If you set this parameter to false when you create a project, Atlas doesn't add the default alert configurations
+	// to your project.
+	// This setting has no effect on existing projects.
 	// +kubebuilder:default:=true
 	// +optional
 	WithDefaultAlertsSettings bool `json:"withDefaultAlertsSettings,omitempty"`
 
-	// X509CertRef is the name of the Kubernetes Secret which contains PEM-encoded CA certificate
+	// X509CertRef is a reference to the Kubernetes Secret which contains PEM-encoded CA certificate.
+	// Atlas Kubernetes Operator watches secrets only with the label atlas.mongodb.com/type=credentials to avoid
+	// watching unnecessary secrets.
+	// +optional
 	X509CertRef *common.ResourceRefNamespaced `json:"x509CertRef,omitempty"`
 
-	// Integrations is a list of MongoDB Atlas integrations for the project
+	// Integrations is a list of MongoDB Atlas integrations for the project.
+	// Deprecated: Migrate to the AtlasThirdPartyIntegration custom resource in accordance with the migration guide
+	// at https://www.mongodb.com/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
 	// +optional
 	Integrations []project.Integration `json:"integrations,omitempty"`
 
-	// EncryptionAtRest allows to set encryption for AWS, Azure and GCP providers
+	// EncryptionAtRest allows to set encryption for AWS, Azure and GCP providers.
 	// +optional
 	EncryptionAtRest *EncryptionAtRest `json:"encryptionAtRest,omitempty"`
 
-	// Auditing represents MongoDB Maintenance Windows
+	// Auditing represents MongoDB Maintenance Windows.
 	// +optional
 	Auditing *Auditing `json:"auditing,omitempty"`
 
-	// Settings allow to set Project Settings for the project
+	// Settings allows the configuration of the Project Settings.
 	// +optional
 	Settings *ProjectSettings `json:"settings,omitempty"`
 
-	// The customRoles lets you create, and change custom roles in your cluster. Use custom roles to specify custom sets of actions that the Atlas built-in roles can't describe.
+	// CustomRoles lets you create and change custom roles in your cluster.
+	// Use custom roles to specify custom sets of actions that the Atlas built-in roles can't describe.
+	// Deprecated: Migrate to the AtlasCustomRoles custom resource in accordance with the migration guide
+	// at https://www.mongodb.com/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
 	// +optional
 	CustomRoles []CustomRole `json:"customRoles,omitempty"`
 
 	// Teams enable you to grant project access roles to multiple users.
 	// +optional
 	Teams []Team `json:"teams,omitempty"`
 
-	// BackupCompliancePolicyRef is a reference to the backup compliance CR.
+	// BackupCompliancePolicyRef is a reference to the backup compliance custom resource.
 	// +optional
 	BackupCompliancePolicyRef *common.ResourceRefNamespaced `json:"backupCompliancePolicyRef,omitempty"`
 }
diff --git a/api/v1/auditing.go b/api/v1/auditing.go
@@ -16,13 +16,14 @@ package v1
 
 // Auditing represents MongoDB Maintenance Windows
 type Auditing struct {
-	// Indicates whether the auditing system captures successful authentication attempts for audit filters using the "atype" : "authCheck" auditing event. For more information, see auditAuthorizationSuccess
+	// Indicates whether the auditing system captures successful authentication attempts for audit filters using the "atype" : "authCheck" auditing event.
+	// For more information, see auditAuthorizationSuccess.
 	// +optional
 	AuditAuthorizationSuccess bool `json:"auditAuthorizationSuccess,omitempty"`
-	// JSON-formatted audit filter used by the project
+	// JSON-formatted audit filter used by the project.
 	// +optional
 	AuditFilter string `json:"auditFilter,omitempty"`
-	// Denotes whether or not the project associated with the {GROUP-ID} has database auditing enabled.
+	// Denotes whether the project associated with the {GROUP-ID} has database auditing enabled.
 	// +optional
 	Enabled bool `json:"enabled,omitempty"`
 }
diff --git a/api/v1/common/common.go b/api/v1/common/common.go
@@ -26,10 +26,10 @@ type ResourceRef struct {
 
 // ResourceRefNamespaced is a reference to a Kubernetes Resource that allows to configure the namespace
 type ResourceRefNamespaced struct {
-	// Name is the name of the Kubernetes Resource
+	// Name of the Kubernetes Resource
 	Name string `json:"name"`
 
-	// Namespace is the namespace of the Kubernetes Resource
+	// Namespace of the Kubernetes Resource
 	// +optional
 	Namespace string `json:"namespace"`
 }
diff --git a/api/v1/custom_roles.go b/api/v1/custom_roles.go
@@ -14,6 +14,10 @@
 
 package v1
 
+// CustomRole lets you create and change a custom role in your cluster.
+// Use custom roles to specify custom sets of actions that the Atlas built-in roles can't describe.
+// Deprecated: Migrate to the AtlasCustomRoles custom resource in accordance with the migration guide
+// at https://www.mongodb.com/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
 type CustomRole struct {
 	// Human-readable label that identifies the role. This name must be unique for this custom role in this project.
 	Name string `json:"name"`
diff --git a/api/v1/encryption_at_rest.go b/api/v1/encryption_at_rest.go
@@ -18,7 +18,7 @@ import (
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/api/v1/common"
 )
 
-// EncryptionAtRest allows to specify the Encryption at Rest for AWS, Azure and GCP providers
+// EncryptionAtRest configures the Encryption at Rest for the AWS, Azure and GCP providers.
 type EncryptionAtRest struct {
 	AwsKms         AwsKms         `json:"awsKms,omitempty"`         // AwsKms specifies AWS KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.
 	AzureKeyVault  AzureKeyVault  `json:"azureKeyVault,omitempty"`  // AzureKeyVault specifies Azure Key Vault configuration details and whether Encryption at Rest is enabled for an Atlas project.
diff --git a/api/v1/networkpeer.go b/api/v1/networkpeer.go
@@ -22,45 +22,49 @@ import (
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/pointer"
 )
 
+// NetworkPeer configured for the current Project.
+// Deprecated: Migrate to the AtlasNetworkPeering and AtlasNetworkContainer custom resources in accordance with
+// the migration guide at https://www.mongodb.com/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
+// +optional
 type NetworkPeer struct {
-	//AccepterRegionName is the provider region name of user's vpc.
+	// AccepterRegionName is the provider region name of user's VPC.
 	// +optional
 	AccepterRegionName string `json:"accepterRegionName"`
 	// ContainerRegion is the provider region name of Atlas network peer container. If not set, AccepterRegionName is used.
 	// +optional
 	ContainerRegion string `json:"containerRegion"`
-	// AccountID of the user's vpc.
+	// AccountID of the user's VPC.
 	// +optional
 	AWSAccountID string `json:"awsAccountId,omitempty"`
 	// ID of the network peer container. If not set, operator will create a new container with ContainerRegion and AtlasCIDRBlock input.
 	// +optional
 	ContainerID string `json:"containerId"`
-	//ProviderName is the name of the provider. If not set, it will be set to "AWS".
+	// ProviderName is the name of the provider. If not set, it will be set to "AWS".
 	// +optional
 	ProviderName provider.ProviderName `json:"providerName,omitempty"`
-	//User VPC CIDR.
+	// User VPC CIDR.
 	// +optional
 	RouteTableCIDRBlock string `json:"routeTableCidrBlock,omitempty"`
-	//AWS VPC ID.
+	// AWS VPC ID.
 	// +optional
 	VpcID string `json:"vpcId,omitempty"`
-	//Atlas CIDR. It needs to be set if ContainerID is not set.
+	// Atlas CIDR. It needs to be set if ContainerID is not set.
 	// +optional
 	AtlasCIDRBlock string `json:"atlasCidrBlock"`
-	//AzureDirectoryID is the unique identifier for an Azure AD directory.
+	// AzureDirectoryID is the unique identifier for an Azure AD directory.
 	// +optional
 	AzureDirectoryID string `json:"azureDirectoryId,omitempty"`
 	// AzureSubscriptionID is the unique identifier of the Azure subscription in which the VNet resides.
 	// +optional
 	AzureSubscriptionID string `json:"azureSubscriptionId,omitempty"`
-	//ResourceGroupName is the name of your Azure resource group.
+	// ResourceGroupName is the name of your Azure resource group.
 	// +optional
 	ResourceGroupName string `json:"resourceGroupName,omitempty"`
 	// VNetName is name of your Azure VNet. Its applicable only for Azure.
 	// +optional
 	VNetName string `json:"vnetName,omitempty"`
-	// +optional
 	// User GCP Project ID. Its applicable only for GCP.
+	// +optional
 	GCPProjectID string `json:"gcpProjectId,omitempty"`
 	// GCP Network Peer Name. Its applicable only for GCP.
 	// +optional
diff --git a/api/v1/privateendpoint.go b/api/v1/privateendpoint.go
@@ -22,13 +22,16 @@ import (
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/pointer"
 )
 
+// PrivateEndpoint is a list of Private Endpoints configured for the current Project.
+// Deprecated: Migrate to the AtlasPrivateEndpoint Custom Resource in accordance with the migration guide
+// at https://www.mongodb.com/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
 type PrivateEndpoint struct {
-	// Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS or AZURE.
+	// Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS, GCP, or AZURE.
 	// +kubebuilder:validation:Enum=AWS;GCP;AZURE;TENANT
 	Provider provider.ProviderName `json:"provider"`
 	// Cloud provider region for which you want to create the private endpoint service.
 	Region string `json:"region"`
-	// Unique identifier of the private endpoint you created in your AWS VPC or Azure Vnet.
+	// Unique identifier of the private endpoint you created in your AWS VPC or Azure VNet.
 	// +optional
 	ID string `json:"id,omitempty"`
 	// Private IP address of the private endpoint network interface you created in your Azure VNet.
@@ -37,7 +40,7 @@ type PrivateEndpoint struct {
 	// Unique identifier of the Google Cloud project in which you created your endpoints.
 	// +optional
 	GCPProjectID string `json:"gcpProjectId,omitempty"`
-	// Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in Google Cloud.
+	// Unique identifier of the endpoint group. The endpoint group encompasses all the endpoints that you created in Google Cloud.
 	// +optional
 	EndpointGroupName string `json:"endpointGroupName,omitempty"`
 	// Collection of individual private endpoints that comprise your endpoint group.
diff --git a/api/v1/project/integration.go b/api/v1/project/integration.go
@@ -18,53 +18,78 @@ import (
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/api/v1/common"
 )
 
+// Integration for the project between Atlas and a third party service.
+// Deprecated: Migrate to the AtlasThirdPartyIntegration custom resource in accordance with the migration guide
+// at https://www.mongodb.com/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
 type Integration struct {
-	// Third Party Integration type such as Slack, New Relic, etc
+	// Third Party Integration type such as Slack, New Relic, etc.
+	// Each integration type requires a distinct set of configuration fields.
+	// For example, if you set type to DATADOG, you must configure only datadog subfields.
 	// +kubebuilder:validation:Enum=PAGER_DUTY;SLACK;DATADOG;NEW_RELIC;OPS_GENIE;VICTOR_OPS;FLOWDOCK;WEBHOOK;MICROSOFT_TEAMS;PROMETHEUS
 	// +optional
 	Type string `json:"type,omitempty"`
+	// Reference to a Kubernetes Secret containing your Unique 40-hexadecimal digit string that identifies your New Relic license.
 	// +optional
 	LicenseKeyRef common.ResourceRefNamespaced `json:"licenseKeyRef,omitempty"`
+	// Unique 40-hexadecimal digit string that identifies your New Relic account.
 	// +optional
 	AccountID string `json:"accountId,omitempty"`
+	// Reference to a Kubernetes Secret containing the insert key associated with your New Relic account.
 	// +optional
 	WriteTokenRef common.ResourceRefNamespaced `json:"writeTokenRef,omitempty"`
+	// Reference to a Kubernetes Secret containing the query key associated with your New Relic account.
 	// +optional
 	ReadTokenRef common.ResourceRefNamespaced `json:"readTokenRef,omitempty"`
+	// Reference to a Kubernetes Secret containing your API Key for Datadog, OpsGenie or Victor Ops.
 	// +optional
 	APIKeyRef common.ResourceRefNamespaced `json:"apiKeyRef,omitempty"`
+	// Region code indicating which regional API Atlas uses to access PagerDuty, Datadog, or OpsGenie.
 	// +optional
 	Region string `json:"region,omitempty"`
+	// Reference to a Kubernetes Secret containing the service key associated with your PagerDuty account.
 	// +optional
 	ServiceKeyRef common.ResourceRefNamespaced `json:"serviceKeyRef,omitempty"`
+	// Reference to a Kubernetes Secret containing the Key that allows Atlas to access your Slack account.
 	// +optional
 	APITokenRef common.ResourceRefNamespaced `json:"apiTokenRef,omitempty"`
+	// Human-readable label that identifies your Slack team.
 	// +optional
 	TeamName string `json:"teamName,omitempty"`
+	// Name of the Slack channel to which Atlas sends alert notifications.
 	// +optional
 	ChannelName string `json:"channelName,omitempty"`
+	// Reference to a Kubernetes Secret containing the Routing key associated with your Splunk On-Call account.
+	// Used for Victor Ops.
 	// +optional
 	RoutingKeyRef common.ResourceRefNamespaced `json:"routingKeyRef,omitempty"`
 	// +optional
 	FlowName string `json:"flowName,omitempty"`
 	// +optional
 	OrgName string `json:"orgName,omitempty"`
+	// Endpoint web address to which Atlas sends notifications.
+	// Used for Webhooks.
 	// +optional
 	URL string `json:"url,omitempty"`
+	// Reference to a Kubernetes Secret containing the secret for your Webhook.
 	// +optional
 	SecretRef common.ResourceRefNamespaced `json:"secretRef,omitempty"`
 	// +optional
 	Name string `json:"name,omitempty"`
+	// Endpoint web address of the Microsoft Teams webhook to which Atlas sends notifications.
 	// +optional
 	MicrosoftTeamsWebhookURL string `json:"microsoftTeamsWebhookUrl,omitempty"`
+	// Human-readable label that identifies your Prometheus incoming webhook.
 	// +optional
 	UserName string `json:"username,omitempty"`
+	// Reference to a Kubernetes Secret containing the password to allow Atlas to access your Prometheus account.
 	// +optional
 	PasswordRef common.ResourceRefNamespaced `json:"passwordRef,omitempty"`
+	// Desired method to discover the Prometheus service.
 	// +optional
 	ServiceDiscovery string `json:"serviceDiscovery,omitempty"`
 	// +optional
 	Scheme string `json:"scheme,omitempty"`
+	//
 	// +optional
 	Enabled bool `json:"enabled,omitempty"`
 }
diff --git a/api/v1/project/ipaccesslist.go b/api/v1/project/ipaccesslist.go
@@ -14,6 +14,10 @@
 
 package project
 
+// IPAccessList allows the use of the IP Access List for a Project. See more information at
+// https://docs.atlas.mongodb.com/reference/api/ip-access-list/add-entries-to-access-list/
+// Deprecated: Migrate to the AtlasIPAccessList Custom Resource in accordance with the migration guide
+// at https://www.mongodb.com/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
 type IPAccessList struct {
 	// Unique identifier of AWS security group in this access list entry.
 	// +optional
diff --git a/api/v1/project/maintenancewindow.go b/api/v1/project/maintenancewindow.go
@@ -16,7 +16,7 @@ package project
 
 type MaintenanceWindow struct {
 	// Day of the week when you would like the maintenance window to start as a 1-based integer.
-	// Sunday 1, Monday 2, Tuesday 3, Wednesday 4, Thursday 5, Friday 6, Saturday 7
+	// Sunday 1, Monday 2, Tuesday 3, Wednesday 4, Thursday 5, Friday 6, Saturday 7.
 	// +optional
 	// +kubebuilder:validation:Minimum=1
 	// +kubebuilder:validation:Maximum=7
diff --git a/api/v1/project_settings.go b/api/v1/project_settings.go
diff --git a/api/v1/project_teams.go b/api/v1/project_teams.go
diff --git a/docs/api-docs.md b/docs/api-docs.md

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ import (`
`18`	`18`	`"github.com/mongodb/mongodb-atlas-kubernetes/v2/api/v1/common"`
`19`	`19`	`)`
`20`	`20`
`21`		`-// EncryptionAtRest allows to specify the Encryption at Rest for AWS, Azure and GCP providers`
	`21`	`+// EncryptionAtRest configures the Encryption at Rest for the AWS, Azure and GCP providers.`
`22`	`22`	`type EncryptionAtRest struct {`
`23`	`23`	AwsKms AwsKms `json:"awsKms,omitempty"` // AwsKms specifies AWS KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.
`24`	`24`	AzureKeyVault AzureKeyVault `json:"azureKeyVault,omitempty"` // AzureKeyVault specifies Azure Key Vault configuration details and whether Encryption at Rest is enabled for an Atlas project.