Custom policies added to the CRD

apis/apps/v1alpha1/apicast_types.go

@@ -17,6 +17,8 @@ limitations under the License.
 package v1alpha1
 
 import (
+	"fmt"
+
 	appscommon "github.com/3scale/apicast-operator/apis/apps"
 
 	v1 "k8s.io/api/core/v1"
@@ -28,6 +30,21 @@ import (
 // EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
 // NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
 
+// CustomPolicySpec contains or has reference to an APIcast custom policy
+type CustomPolicySpec struct {
+	// Name specifies the name of the custom policy
+	Name string `json:"name"`
+	// Version specifies the name of the custom policy
+	Version string `json:"version"`
+
+	// SecretRef specifies the secret holding the custom policy metadata and lua code
+	SecretRef *v1.LocalObjectReference `json:"secretRef"`
+}
+
+func (c *CustomPolicySpec) VersionName() string {
+	return fmt.Sprintf("%s%s", c.Name, c.Version)
+}
+
 // APIcastSpec defines the desired state of APIcast.
 type APIcastSpec struct {
 	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
@@ -145,6 +162,10 @@ type APIcastSpec struct {
 	// Timezone specifies the local timezone of the APIcast deployment pods. A timezone value available in the TZ database must be set.
 	// +optional
 	Timezone *string `json:"timezone,omitempty"` // TZ
+
+	// CustomPolicies specifies an array of defined custome policies to be loaded
+	// +optional
+	CustomPolicies []CustomPolicySpec `json:"customPolicies,omitempty"`
 }
 
 type DeploymentEnvironmentType string
@@ -250,6 +271,29 @@ func (a *APIcast) Validate() field.ErrorList {
 		errors = append(errors, field.Invalid(httpsPortFldPath, a.Spec.HTTPSPort, "HTTPS port conflicts with HTTP port"))
 	}
 
+	customPoliciesFldPath := specFldPath.Child("customPolicies")
+	// check custom policy secret is set
+	for idx, customPolicySpec := range a.Spec.CustomPolicies {
+		if customPolicySpec.SecretRef == nil {
+			customPoliciesIdxFldPath := customPoliciesFldPath.Index(idx)
+			errors = append(errors, field.Invalid(customPoliciesIdxFldPath, customPolicySpec, "custom policy secret is mandatory"))
+		} else if customPolicySpec.SecretRef.Name == "" {
+			customPoliciesIdxFldPath := customPoliciesFldPath.Index(idx)
+			errors = append(errors, field.Invalid(customPoliciesIdxFldPath, customPolicySpec, "custom policy secret name is empty"))
+		}
+	}
+
+	// check duplicated custom policy version name
+	duplicateMap := make(map[string]int)
+	for idx, customPolicySpec := range a.Spec.CustomPolicies {
+		if _, ok := duplicateMap[customPolicySpec.VersionName()]; ok {
+			customPoliciesIdxFldPath := customPoliciesFldPath.Index(idx)
+			errors = append(errors, field.Invalid(customPoliciesIdxFldPath, customPolicySpec, "custom policy secret name version tuple is duplicated"))
+			break
+		}
+		duplicateMap[customPolicySpec.VersionName()] = 0
+	}
+
 	return errors
 }
 

bundle/manifests/apps.3scale.net_apicasts.yaml

@@ -60,6 +60,30 @@ spec:
                 - boot
                 - lazy
                 type: string
+              customPolicies:
+                description: CustomPolicies specifies an array of defined custome policies to be loaded
+                items:
+                  description: CustomPolicySpec contains or has reference to an APIcast custom policy
+                  properties:
+                    name:
+                      description: Name specifies the name of the custom policy
+                      type: string
+                    secretRef:
+                      description: SecretRef specifies the secret holding the custom policy metadata and lua code
+                      properties:
+                        name:
+                          description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+                          type: string
+                      type: object
+                    version:
+                      description: Version specifies the name of the custom policy
+                      type: string
+                  required:
+                  - name
+                  - secretRef
+                  - version
+                  type: object
+                type: array
               deploymentEnvironment:
                 description: DeploymentEnvironment is the environment for which the configuration will be downloaded from 3scale (Staging or Production), when using APIcast. The value will also be used in the header X-3scale-User-Agent in the authorize/report requests made to 3scale Service Management API. It is used by 3scale for statistics.
                 type: string

config/crd/bases/apps.3scale.net_apicasts.yaml

@@ -67,6 +67,34 @@ spec:
                 - boot
                 - lazy
                 type: string
+              customPolicies:
+                description: CustomPolicies specifies an array of defined custome
+                  policies to be loaded
+                items:
+                  description: CustomPolicySpec contains or has reference to an APIcast
+                    custom policy
+                  properties:
+                    name:
+                      description: Name specifies the name of the custom policy
+                      type: string
+                    secretRef:
+                      description: SecretRef specifies the secret holding the custom
+                        policy metadata and lua code
+                      properties:
+                        name:
+                          description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+                            TODO: Add other useful fields. apiVersion, kind, uid?'
+                          type: string
+                      type: object
+                    version:
+                      description: Version specifies the name of the custom policy
+                      type: string
+                  required:
+                  - name
+                  - secretRef
+                  - version
+                  type: object
+                type: array
               deploymentEnvironment:
                 description: DeploymentEnvironment is the environment for which the
                   configuration will be downloaded from 3scale (Staging or Production),

controllers/apps/apicast_controller.go

@@ -130,7 +130,6 @@ func (r *APIcastReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
 			return ctrl.Result{Requeue: true}, nil
 		}
 
-		log.Error(err, "Main reconciler")
 		return result, err
 	}
 	if result.Requeue {