issue-522,implementation for OpenSearch Egress Rules lifecycle on APIv2

PROJECT

@@ -323,6 +323,18 @@ resources:
   webhooks:
     validation: true
     webhookVersion: v1
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: instaclustr.com
+  group: clusterresources
+  kind: OpenSearchEgressRules
+  path: github.com/instaclustr/operator/apis/clusterresources/v1beta1
+  version: v1beta1
+  webhooks:
+    validation: true
+    webhookVersion: v1
 - api:
     crdVersion: v1
     namespaced: true

apis/clusterresources/v1beta1/opensearchegressrules_types.go

@@ -0,0 +1,63 @@
+/*
+Copyright 2022.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1beta1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+type OpenSearchEgressRulesSpec struct {
+	ClusterID           string `json:"clusterId"`
+	OpenSearchBindingID string `json:"openSearchBindingId"`
+	Source              string `json:"source"`
+	Type                string `json:"type,omitempty"`
+}
+
+type OpenSearchEgressRulesStatus struct {
+	ID string `json:"id,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+//+kubebuilder:subresource:status
+
+// OpenSearchEgressRules is the Schema for the opensearchegressrules API
+type OpenSearchEgressRules struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   OpenSearchEgressRulesSpec   `json:"spec,omitempty"`
+	Status OpenSearchEgressRulesStatus `json:"status,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+
+// OpenSearchEgressRulesList contains a list of OpenSearchEgressRules
+type OpenSearchEgressRulesList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []OpenSearchEgressRules `json:"items"`
+}
+
+func (er *OpenSearchEgressRules) NewPatch() client.Patch {
+	old := er.DeepCopy()
+	return client.MergeFrom(old)
+}
+
+func init() {
+	SchemeBuilder.Register(&OpenSearchEgressRules{}, &OpenSearchEgressRulesList{})
+}

apis/clusterresources/v1beta1/opensearchegressrules_webhook.go

@@ -0,0 +1,93 @@
+/*
+Copyright 2022.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1beta1
+
+import (
+	"fmt"
+	"regexp"
+
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/utils/strings/slices"
+	ctrl "sigs.k8s.io/controller-runtime"
+	logf "sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/webhook"
+
+	"github.com/instaclustr/operator/pkg/models"
+)
+
+// log is for logging in this package.
+
+var opensearchegressruleslog = logf.Log.WithName("opensearchegressrules-resource")
+
+var destinationTypes = []string{"SLACK", "WEBHOOK", "CUSTOM_WEBHOOK", "CHIME"}
+var sourcePlugins = []string{"NOTIFICATIONS", "ALERTING"}
+
+func (r *OpenSearchEgressRules) SetupWebhookWithManager(mgr ctrl.Manager) error {
+	return ctrl.NewWebhookManagedBy(mgr).
+		For(r).
+		Complete()
+}
+
+//+kubebuilder:webhook:path=/validate-clusterresources-instaclustr-com-v1beta1-opensearchegressrules,mutating=false,failurePolicy=fail,sideEffects=None,groups=clusterresources.instaclustr.com,resources=opensearchegressrules,verbs=create;update,versions=v1beta1,name=vopensearchegressrules.kb.io,admissionReviewVersions=v1
+
+var _ webhook.Validator = &OpenSearchEgressRules{}
+
+// ValidateCreate implements webhook.Validator so a webhook will be registered for the type
+func (r *OpenSearchEgressRules) ValidateCreate() error {
+	opensearchegressruleslog.Info("validate create", "name", r.Name)
+	matched, err := regexp.MatchString(models.OpenSearchBindingIDPattern, r.Spec.OpenSearchBindingID)
+	if err != nil {
+		return fmt.Errorf("can`t match openSearchBindingId to pattern: %s, error: %w", models.OpenSearchBindingIDPattern, err)
+	}
+	if !matched {
+		return fmt.Errorf("mismatching openSearchBindingId to pattern: %s", models.OpenSearchBindingIDPattern)
+	}
+
+	if !slices.Contains(sourcePlugins, r.Spec.Source) {
+		return fmt.Errorf("the source should be equal to one of the options: %q , got: %q", sourcePlugins, r.Spec.Source)
+	}
+
+	if !slices.Contains(destinationTypes, r.Spec.Type) {
+		return fmt.Errorf("the type should be equal to one of the options: %q , got: %q", destinationTypes, r.Spec.Type)
+	}
+
+	return nil
+}
+
+// ValidateUpdate implements webhook.Validator so a webhook will be registered for the type
+func (r *OpenSearchEgressRules) ValidateUpdate(old runtime.Object) error {
+	opensearchegressruleslog.Info("validate update", "name", r.Name)
+
+	oldRules := old.(*OpenSearchEgressRules)
+
+	if r.Status.ID == "" {
+		return r.ValidateCreate()
+	}
+
+	if r.Spec != oldRules.Spec {
+		return models.ErrImmutableSpec
+	}
+
+	return nil
+}
+
+// ValidateDelete implements webhook.Validator so a webhook will be registered for the type
+func (r *OpenSearchEgressRules) ValidateDelete() error {
+	opensearchegressruleslog.Info("validate delete", "name", r.Name)
+
+	return nil
+}

apis/clusterresources/v1beta1/webhook_suite_test.go

@@ -129,6 +129,9 @@ var _ = BeforeSuite(func() {
 	err = (&RedisUser{}).SetupWebhookWithManager(mgr)
 	Expect(err).NotTo(HaveOccurred())
 
+	err = (&OpenSearchEgressRules{}).SetupWebhookWithManager(mgr)
+	Expect(err).NotTo(HaveOccurred())
+
 	err = (&AWSEndpointServicePrincipal{}).SetupWebhookWithManager(mgr)
 	Expect(err).NotTo(HaveOccurred())
 

apis/clusters/v1beta1/opensearch_types.go

@@ -43,7 +43,7 @@ type OpenSearchSpec struct {
 	ICUPlugin                bool                    `json:"icuPlugin,omitempty"`
 	AsynchronousSearchPlugin bool                    `json:"asynchronousSearchPlugin,omitempty"`
 	KNNPlugin                bool                    `json:"knnPlugin,omitempty"`
-	Dashboards               []*OpenSearchDashboards `json:"dashboards,omitempty"`
+	Dashboards               []*OpenSearchDashboards `json:"opensearchDashboards,omitempty"`
 	ReportingPlugin          bool                    `json:"reportingPlugin,omitempty"`
 	SQLPlugin                bool                    `json:"sqlPlugin,omitempty"`
 	NotificationsPlugin      bool                    `json:"notificationsPlugin,omitempty"`

config/crd/bases/clusterresources.instaclustr.com_opensearchegressrules.yaml

@@ -0,0 +1,60 @@
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.9.2
+  creationTimestamp: null
+  name: opensearchegressrules.clusterresources.instaclustr.com
+spec:
+  group: clusterresources.instaclustr.com
+  names:
+    kind: OpenSearchEgressRules
+    listKind: OpenSearchEgressRulesList
+    plural: opensearchegressrules
+    singular: opensearchegressrules
+  scope: Namespaced
+  versions:
+  - name: v1beta1
+    schema:
+      openAPIV3Schema:
+        description: OpenSearchEgressRules is the Schema for the opensearchegressrules
+          API
+        properties:
+          apiVersion:
+            description: 'APIVersion defines the versioned schema of this representation
+              of an object. Servers should convert recognized schemas to the latest
+              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            type: string
+          kind:
+            description: 'Kind is a string value representing the REST resource this
+              object represents. Servers may infer this from the endpoint the client
+              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            type: string
+          metadata:
+            type: object
+          spec:
+            properties:
+              clusterId:
+                type: string
+              openSearchBindingId:
+                type: string
+              source:
+                type: string
+              type:
+                type: string
+            required:
+            - clusterId
+            - openSearchBindingId
+            - source
+            type: object
+          status:
+            properties:
+              id:
+                type: string
+            type: object
+        type: object
+    served: true
+    storage: true
+    subresources:
+      status: {}

config/crd/bases/clusters.instaclustr.com_opensearches.yaml

@@ -68,20 +68,6 @@ spec:
                   - nodeSize
                   type: object
                 type: array
-              dashboards:
-                items:
-                  properties:
-                    nodeSize:
-                      type: string
-                    oidcProvider:
-                      type: string
-                    version:
-                      type: string
-                  required:
-                  - nodeSize
-                  - version
-                  type: object
-                type: array
               dataCentres:
                 items:
                   properties:
@@ -150,6 +136,20 @@ spec:
                 type: string
               notificationsPlugin:
                 type: boolean
+              opensearchDashboards:
+                items:
+                  properties:
+                    nodeSize:
+                      type: string
+                    oidcProvider:
+                      type: string
+                    version:
+                      type: string
+                  required:
+                  - nodeSize
+                  - version
+                  type: object
+                type: array
               pciCompliance:
                 description: The PCI compliance standards relate to the security of
                   user data and transactional information. Can only be applied clusters