CSPL-4358 Adding more validations

Author: kasiakoziol

api/v4/bus_types.go

@@ -36,6 +36,7 @@ type BusSpec struct {
 	// Provider of queue resources
 	Provider string `json:"provider"`
 
+	// +kubebuilder:validation:Required
 	// sqs specific inputs
 	SQS SQSSpec `json:"sqs"`
 }

api/v4/indexercluster_types.go

@@ -34,6 +34,7 @@ const (
 	IndexerClusterPausedAnnotation = "indexercluster.enterprise.splunk.com/paused"
 )
 
+// +kubebuilder:validation:XValidation:rule="has(self.busRef) == has(self.largeMessageStoreRef)",message="busRef and largeMessageStoreRef must both be set or both be empty"
 // IndexerClusterSpec defines the desired state of a Splunk Enterprise indexer cluster
 type IndexerClusterSpec struct {
 	CommonSplunkSpec `json:",inline"`

api/v4/ingestorcluster_types.go

@@ -39,9 +39,11 @@ type IngestorClusterSpec struct {
 	// Splunk Enterprise app repository that specifies remote app location and scope for Splunk app management
 	AppFrameworkConfig AppFrameworkSpec `json:"appRepo,omitempty"`
 
+	// +kubebuilder:validation:Required
 	// Bus reference
 	BusRef corev1.ObjectReference `json:"busRef"`
 
+	// +kubebuilder:validation:Required
 	// Large Message Store reference
 	LargeMessageStoreRef corev1.ObjectReference `json:"largeMessageStoreRef"`
 }

api/v4/largemessagestore.go

@@ -36,6 +36,7 @@ type LargeMessageStoreSpec struct {
 	// Provider of queue resources
 	Provider string `json:"provider"`
 
+	// +kubebuilder:validation:Required
 	// s3 specific inputs
 	S3 S3Spec `json:"s3"`
 }

config/crd/bases/enterprise.splunk.com_buses.yaml

@@ -85,6 +85,7 @@ spec:
                 type: object
             required:
             - provider
+            - sqs
             type: object
             x-kubernetes-validations:
             - message: sqs must be provided when provider is sqs

config/crd/bases/enterprise.splunk.com_indexerclusters.yaml

@@ -8328,6 +8328,10 @@ spec:
                   type: object
                 type: array
             type: object
+            x-kubernetes-validations:
+            - message: busRef and largeMessageStoreRef must both be set or both be
+                empty
+              rule: has(self.busRef) == has(self.largeMessageStoreRef)
           status:
             description: IndexerClusterStatus defines the observed state of a Splunk
               Enterprise indexer cluster
@@ -8371,6 +8375,7 @@ spec:
                     type: object
                 required:
                 - provider
+                - sqs
                 type: object
                 x-kubernetes-validations:
                 - message: sqs must be provided when provider is sqs
@@ -8433,6 +8438,7 @@ spec:
                     type: object
                 required:
                 - provider
+                - s3
                 type: object
                 x-kubernetes-validations:
                 - message: s3 must be provided when provider is s3

config/crd/bases/enterprise.splunk.com_ingestorclusters.yaml

@@ -4302,6 +4302,9 @@ spec:
                   - name
                   type: object
                 type: array
+            required:
+            - busRef
+            - largeMessageStoreRef
             type: object
           status:
             description: IngestorClusterStatus defines the observed state of Ingestor
@@ -4622,6 +4625,7 @@ spec:
                     type: object
                 required:
                 - provider
+                - sqs
                 type: object
                 x-kubernetes-validations:
                 - message: sqs must be provided when provider is sqs
@@ -4650,6 +4654,7 @@ spec:
                     type: object
                 required:
                 - provider
+                - s3
                 type: object
                 x-kubernetes-validations:
                 - message: s3 must be provided when provider is s3

config/crd/bases/enterprise.splunk.com_largemessagestores.yaml

@@ -75,6 +75,7 @@ spec:
                 type: object
             required:
             - provider
+            - s3
             type: object
             x-kubernetes-validations:
             - message: s3 must be provided when provider is s3

pkg/splunk/enterprise/indexercluster.go

@@ -261,6 +261,14 @@ func ApplyIndexerClusterManager(ctx context.Context, client splcommon.Controller
 			}
 		}
 
+		// Can not override original bus spec due to comparison in the later code
+		busCopy := bus
+		if busCopy.Spec.Provider == "sqs" {
+			if busCopy.Spec.SQS.Endpoint == "" {
+				busCopy.Spec.SQS.Endpoint = fmt.Sprintf("https://sqs.%s.amazonaws.com", busCopy.Spec.SQS.Region)
+			}
+		}
+
 		// Large Message Store
 		lms := enterpriseApi.LargeMessageStore{}
 		if cr.Spec.LargeMessageStoreRef.Name != "" {
@@ -277,12 +285,20 @@ func ApplyIndexerClusterManager(ctx context.Context, client splcommon.Controller
 			}
 		}
 
+		// Can not override original large message store spec due to comparison in the later code
+		lmsCopy := lms
+		if lmsCopy.Spec.Provider == "s3" {
+			if lmsCopy.Spec.S3.Endpoint == "" {
+				lmsCopy.Spec.S3.Endpoint = fmt.Sprintf("https://s3.%s.amazonaws.com", busCopy.Spec.SQS.Region)
+			}
+		}
+
 		// If bus is updated
 		if cr.Spec.BusRef.Name != "" {
 			if !reflect.DeepEqual(cr.Status.Bus, bus.Spec) {
 				mgr := newIndexerClusterPodManager(scopedLog, cr, namespaceScopedSecret, splclient.NewSplunkClient)
 
-				err = mgr.handlePullBusChange(ctx, cr, bus, lms, client)
+				err = mgr.handlePullBusChange(ctx, cr, busCopy, lmsCopy, client)
 				if err != nil {
 					eventPublisher.Warning(ctx, "ApplyIndexerClusterManager", fmt.Sprintf("Failed to update conf file for Bus/Pipeline config change after pod creation: %s", err.Error()))
 					scopedLog.Error(err, "Failed to update conf file for Bus/Pipeline config change after pod creation")
@@ -568,6 +584,14 @@ func ApplyIndexerCluster(ctx context.Context, client splcommon.ControllerClient,
 			}
 		}
 
+		// Can not override original bus spec due to comparison in the later code
+		busCopy := bus
+		if busCopy.Spec.Provider == "sqs" {
+			if busCopy.Spec.SQS.Endpoint == "" {
+				busCopy.Spec.SQS.Endpoint = fmt.Sprintf("https://sqs.%s.amazonaws.com", busCopy.Spec.SQS.Region)
+			}
+		}
+
 		// Large Message Store
 		lms := enterpriseApi.LargeMessageStore{}
 		if cr.Spec.LargeMessageStoreRef.Name != "" {
@@ -584,12 +608,20 @@ func ApplyIndexerCluster(ctx context.Context, client splcommon.ControllerClient,
 			}
 		}
 
+		// Can not override original bus spec due to comparison in the later code
+		lmsCopy := lms
+		if lmsCopy.Spec.Provider == "s3" {
+			if lmsCopy.Spec.S3.Endpoint == "" {
+				lmsCopy.Spec.S3.Endpoint = fmt.Sprintf("https://s3.%s.amazonaws.com", busCopy.Spec.SQS.Region)
+			}
+		}
+
 		// If bus is updated
 		if cr.Spec.BusRef.Name != "" {
 			if !reflect.DeepEqual(cr.Status.Bus, bus.Spec) {
 				mgr := newIndexerClusterPodManager(scopedLog, cr, namespaceScopedSecret, splclient.NewSplunkClient)
 
-				err = mgr.handlePullBusChange(ctx, cr, bus, lms, client)
+				err = mgr.handlePullBusChange(ctx, cr, busCopy, lmsCopy, client)
 				if err != nil {
 					eventPublisher.Warning(ctx, "ApplyIndexerClusterManager", fmt.Sprintf("Failed to update conf file for Bus/Pipeline config change after pod creation: %s", err.Error()))
 					scopedLog.Error(err, "Failed to update conf file for Bus/Pipeline config change after pod creation")

pkg/splunk/enterprise/ingestorcluster.go

@@ -226,6 +226,14 @@ func ApplyIngestorCluster(ctx context.Context, client client.Client, cr *enterpr
 			}
 		}
 
+		// Can not override original bus spec due to comparison in the later code
+		busCopy := bus
+		if busCopy.Spec.Provider == "sqs" {
+			if busCopy.Spec.SQS.Endpoint == "" {
+				busCopy.Spec.SQS.Endpoint = fmt.Sprintf("https://sqs.%s.amazonaws.com", busCopy.Spec.SQS.Region)
+			}
+		}
+
 		// Large Message Store
 		lms := enterpriseApi.LargeMessageStore{}
 		if cr.Spec.LargeMessageStoreRef.Name != "" {
@@ -242,11 +250,19 @@ func ApplyIngestorCluster(ctx context.Context, client client.Client, cr *enterpr
 			}
 		}
 
+		// Can not override original bus spec due to comparison in the later code
+		lmsCopy := lms
+		if lmsCopy.Spec.Provider == "s3" {
+			if lmsCopy.Spec.S3.Endpoint == "" {
+				lmsCopy.Spec.S3.Endpoint = fmt.Sprintf("https://s3.%s.amazonaws.com", bus.Spec.SQS.Region)
+			}
+		}
+
 		// If bus is updated
 		if !reflect.DeepEqual(cr.Status.Bus, bus.Spec) {
 			mgr := newIngestorClusterPodManager(scopedLog, cr, namespaceScopedSecret, splclient.NewSplunkClient)
 
-			err = mgr.handlePushBusChange(ctx, cr, bus, lms, client)
+			err = mgr.handlePushBusChange(ctx, cr, busCopy, lmsCopy, client)
 			if err != nil {
 				eventPublisher.Warning(ctx, "ApplyIngestorCluster", fmt.Sprintf("Failed to update conf file for Bus/Pipeline config change after pod creation: %s", err.Error()))
 				scopedLog.Error(err, "Failed to update conf file for Bus/Pipeline config change after pod creation")
@@ -377,7 +393,7 @@ func (mgr *ingestorClusterPodManager) handlePushBusChange(ctx context.Context, n
 func getChangedBusFieldsForIngestor(bus *enterpriseApi.Bus, lms *enterpriseApi.LargeMessageStore, busIngestorStatus *enterpriseApi.IngestorCluster, afterDelete bool) (busChangedFields, pipelineChangedFields [][]string) {
 	oldPB := busIngestorStatus.Status.Bus
 	if oldPB == nil {
-		oldPB = &enterpriseApi.BusSpec{} 
+		oldPB = &enterpriseApi.BusSpec{}
 	}
 	newPB := &bus.Spec