added doc comments describing replicas

dandawg · dandawg · commit 8036ceff03c9 · 2024-12-11T14:14:36.000-07:00
Signed-off-by: dandawg &lt;12484302+dandawg@users.noreply.github.com&gt;
diff --git a/infra/feast-operator/api/v1alpha1/featurestore_types.go b/infra/feast-operator/api/v1alpha1/featurestore_types.go
@@ -297,7 +297,10 @@ type DefaultConfigs struct {
 	Image *string `json:"image,omitempty"`
 }
 
+// StoreServiceConfigs k8s deployment settings
 type StoreServiceConfigs struct {
+	// Replicas determines the number of pods for the feast service.
+	// When Replicas > 1, persistence should be configured to provide central storage
 	Replicas       *int32 `json:"replicas,omitempty"`
 	ServiceConfigs `json:",inline"`
 }
diff --git a/infra/feast-operator/config/crd/bases/feast.dev_featurestores.yaml b/infra/feast-operator/config/crd/bases/feast.dev_featurestores.yaml
@@ -370,6 +370,9 @@ spec:
                         - message: One selection required between file or store.
                           rule: '[has(self.file), has(self.store)].exists_one(c, c)'
                       replicas:
+                        description: |-
+                          Replicas determines the number of pods for the feast service.
+                          When Replicas > 1, persistence should be configured to provide central storage
                         format: int32
                         type: integer
                       resources:
@@ -749,6 +752,9 @@ spec:
                         - message: One selection required between file or store.
                           rule: '[has(self.file), has(self.store)].exists_one(c, c)'
                       replicas:
+                        description: |-
+                          Replicas determines the number of pods for the feast service.
+                          When Replicas > 1, persistence should be configured to provide central storage
                         format: int32
                         type: integer
                       resources:
@@ -1621,6 +1627,9 @@ spec:
                               rule: '[has(self.file), has(self.store)].exists_one(c,
                                 c)'
                           replicas:
+                            description: |-
+                              Replicas determines the number of pods for the feast service.
+                              When Replicas > 1, persistence should be configured to provide central storage
                             format: int32
                             type: integer
                           resources:
@@ -2007,6 +2016,9 @@ spec:
                               rule: '[has(self.file), has(self.store)].exists_one(c,
                                 c)'
                           replicas:
+                            description: |-
+                              Replicas determines the number of pods for the feast service.
+                              When Replicas > 1, persistence should be configured to provide central storage
                             format: int32
                             type: integer
                           resources:
diff --git a/infra/feast-operator/dist/install.yaml b/infra/feast-operator/dist/install.yaml
@@ -378,6 +378,9 @@ spec:
                         - message: One selection required between file or store.
                           rule: '[has(self.file), has(self.store)].exists_one(c, c)'
                       replicas:
+                        description: |-
+                          Replicas determines the number of pods for the feast service.
+                          When Replicas > 1, persistence should be configured to provide central storage
                         format: int32
                         type: integer
                       resources:
@@ -757,6 +760,9 @@ spec:
                         - message: One selection required between file or store.
                           rule: '[has(self.file), has(self.store)].exists_one(c, c)'
                       replicas:
+                        description: |-
+                          Replicas determines the number of pods for the feast service.
+                          When Replicas > 1, persistence should be configured to provide central storage
                         format: int32
                         type: integer
                       resources:
@@ -1629,6 +1635,9 @@ spec:
                               rule: '[has(self.file), has(self.store)].exists_one(c,
                                 c)'
                           replicas:
+                            description: |-
+                              Replicas determines the number of pods for the feast service.
+                              When Replicas > 1, persistence should be configured to provide central storage
                             format: int32
                             type: integer
                           resources:
@@ -2015,6 +2024,9 @@ spec:
                               rule: '[has(self.file), has(self.store)].exists_one(c,
                                 c)'
                           replicas:
+                            description: |-
+                              Replicas determines the number of pods for the feast service.
+                              When Replicas > 1, persistence should be configured to provide central storage
                             format: int32
                             type: integer
                           resources:

Original file line number	Diff line number	Diff line change
`@@ -297,7 +297,10 @@ type DefaultConfigs struct {`
`297`	`297`	Image *string `json:"image,omitempty"`
`298`	`298`	`}`
`299`	`299`
	`300`	`+// StoreServiceConfigs k8s deployment settings`
`300`	`301`	`type StoreServiceConfigs struct {`
	`302`	`+ // Replicas determines the number of pods for the feast service.`
	`303`	`+ // When Replicas > 1, persistence should be configured to provide central storage`
`301`	`304`	Replicas *int32 `json:"replicas,omitempty"`
`302`	`305`	ServiceConfigs `json:",inline"`
`303`	`306`	`}`