update deployment crd comments

Author: roothorp

api/v1/atlasdeployment_types.go

@@ -20,59 +20,59 @@ import (
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/api/v1/common"
 )
 
-// SearchIndex is the CRD to configure part of the Atlas Search Index
+// SearchIndex is the CRD to configure part of the Atlas Search Index.
 type SearchIndex struct {
-	// Human-readable label that identifies this index. Must be unique for a deployment
+	// Human-readable label that identifies this index. Must be unique for a deployment.
 	// +required
 	Name string `json:"name"`
-	// Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes
+	// Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.
 	// +required
 	DBName string `json:"DBName"`
-	// Human-readable label that identifies the collection that contains one or more Atlas Search indexes
+	// Human-readable label that identifies the collection that contains one or more Atlas Search indexes.
 	// +required
 	CollectionName string `json:"collectionName"`
-	// Type of the index
+	// Type of the index.
 	// +kubebuilder:validation:Enum:=search;vectorSearch
 	// +required
 	Type string `json:"type,omitempty"`
+	// Atlas search index configuration.
 	// +optional
-	// Atlas search index configuration
 	Search *Search `json:"search,omitempty"`
+	// Atlas vector search index configuration.
 	// +optional
-	// Atlas vector search index configuration
 	VectorSearch *VectorSearch `json:"vectorSearch,omitempty"`
 }
 
-// Search represents "search" type of Atlas Search Index
+// Search represents "search" type of Atlas Search Index.
 type Search struct {
-	// Rule sets that map words to their synonyms in this index
+	// Rule sets that map words to their synonyms in this index.
 	// +optional
 	Synonyms *[]Synonym `json:"synonyms,omitempty"`
-	// Index specifications for the collection's fields
+	// Index specifications for the collection's fields.
 	// +required
 	Mappings *Mappings `json:"mappings,omitempty"`
+	// A reference to the AtlasSearchIndexConfig custom resource.
 	// +required
-	// A reference to the AtlasSearchIndexConfig custom resource
 	SearchConfigurationRef common.ResourceRefNamespaced `json:"searchConfigurationRef"`
 }
 
-// Synonym represents "Synonym" type of Atlas Search Index
+// Synonym represents "Synonym" type of Atlas Search Index.
 type Synonym struct {
-	// Human-readable label that identifies the synonym definition. Each name must be unique within the same index definition
+	// Human-readable label that identifies the synonym definition. Each name must be unique within the same index definition.
 	// +required
 	Name string `json:"name"`
-	// Specific pre-defined method chosen to apply to the synonyms to be searched
+	// Specific pre-defined method chosen to apply to the synonyms to be searched.
 	// +kubebuilder:validation:Enum:=lucene.standard;lucene.simple;lucene.whitespace;lucene.keyword;lucene.arabic;lucene.armenian;lucene.basque;lucene.bengali;lucene.brazilian;lucene.bulgarian;lucene.catalan;lucene.chinese;lucene.cjk;lucene.czech;lucene.danish;lucene.dutch;lucene.english;lucene.finnish;lucene.french;lucene.galician;lucene.german;lucene.greek;lucene.hindi;lucene.hungarian;lucene.indonesian;lucene.irish;lucene.italian;lucene.japanese;lucene.korean;lucene.kuromoji;lucene.latvian;lucene.lithuanian;lucene.morfologik;lucene.nori;lucene.norwegian;lucene.persian;lucene.portuguese;lucene.romanian;lucene.russian;lucene.smartcn;lucene.sorani;lucene.spanish;lucene.swedish;lucene.thai;lucene.turkish;lucene.ukrainian
 	// +required
 	Analyzer string `json:"analyzer"`
-	// Data set that stores the mapping one or more words map to one or more synonyms of those words
+	// Data set that stores the mapping one or more words map to one or more synonyms of those words.
 	// +required
 	Source Source `json:"source"`
 }
 
 // Source represents "Source" type of Atlas Search Index
 type Source struct {
-	// Human-readable label that identifies the MongoDB collection that stores words and their applicable synonyms
+	// Human-readable label that identifies the MongoDB collection that stores words and their applicable synonyms.
 	Collection string `json:"collection"`
 }
 

api/v1/atlassearchindex_types.go

@@ -44,8 +44,10 @@ func (rn ResourceRefNamespaced) Key() string {
 
 // LabelSpec contains key-value pairs that tag and categorize the Cluster/DBUser
 type LabelSpec struct {
+	// Key applied to tag and categorize this component.
 	// +kubebuilder:validation:MaxLength:=255
-	Key   string `json:"key"`
+	Key string `json:"key"`
+	// Value set to the Key applied to tag and categorize this component.
 	Value string `json:"value"`
 }
 

api/v1/common/common.go

@@ -19,19 +19,34 @@ import (
 )
 
 type CustomZoneMapping struct {
+	// Code that represents a location that maps to a zone in your global cluster.
+	// MongoDB Atlas represents this location with a ISO 3166-2 location and subdivision codes when possible.
 	Location string `json:"location"`
-	Zone     string `json:"zone"`
+	// Human-readable label that identifies the zone in your global cluster. This zone maps to a location code.
+	Zone string `json:"zone"`
 }
 
 // ManagedNamespace represents the information about managed namespace configuration.
 type ManagedNamespace struct {
-	Db                     string `json:"db"` // not changing this as is a breaking change
-	Collection             string `json:"collection"`
-	CustomShardKey         string `json:"customShardKey,omitempty"`
-	NumInitialChunks       int    `json:"numInitialChunks,omitempty"`
-	PresplitHashedZones    *bool  `json:"presplitHashedZones,omitempty"`
-	IsCustomShardKeyHashed *bool  `json:"isCustomShardKeyHashed,omitempty"` // Flag that specifies whether the custom shard key for the collection is hashed.
-	IsShardKeyUnique       *bool  `json:"isShardKeyUnique,omitempty"`       // Flag that specifies whether the underlying index enforces a unique constraint.
+	// Human-readable label of the database to manage for this Global Cluster.
+	Db string `json:"db"` // not changing this as is a breaking change
+	// Human-readable label of the collection to manage for this Global Cluster.
+	Collection string `json:"collection"`
+	// Database parameter used to divide the collection into shards. Global clusters require a compound shard key.
+	// This compound shard key combines the location parameter and the user-selected custom key.
+	CustomShardKey string `json:"customShardKey,omitempty"`
+	// Minimum number of chunks to create initially when sharding an empty collection with a hashed shard key.
+	// Maximum value is 8192.
+	NumInitialChunks int `json:"numInitialChunks,omitempty"`
+	// Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection.
+	// MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection.
+	PresplitHashedZones *bool `json:"presplitHashedZones,omitempty"`
+	// Flag that indicates whether someone hashed the custom shard key for the specified collection.
+	// If you set this value to false, MongoDB Cloud uses ranged sharding.
+	IsCustomShardKeyHashed *bool `json:"isCustomShardKeyHashed,omitempty"`
+	// Flag that indicates whether someone hashed the custom shard key.
+	// If this parameter returns false, this cluster uses ranged sharding.
+	IsShardKeyUnique *bool `json:"isShardKeyUnique,omitempty"`
 }
 
 func NewFailedToCreateManagedNamespaceStatus(namespace ManagedNamespace, err error) status.ManagedNamespace {

api/v1/global_deployment.go

@@ -14,6 +14,8 @@
 
 package v1
 
+// ServerlessPrivateEndpoint configures private endpoints for the Serverless instances.
+// DEPRECATED: Serverless private endpoints are deprecated. See https://dochub.mongodb.org/core/atlas-flex-migration for details.
 type ServerlessPrivateEndpoint struct {
 	// Name is the name of the Serverless PrivateLink Service. Should be unique.
 	Name string `json:"name,omitempty"`