Allow redis instance name to be parameterized

Allow the redis instance name to be unique to the designate service.
Defaults to designate-redis.

Depends-On: openstack-k8s-operators/install_yamls#946

Author: beagles

api/bases/designate.openstack.org_designates.yaml

@@ -1440,6 +1440,11 @@ spec:
                 description: RabbitMQ instance name Needed to request a transportURL
                   that is created and used in Designate
                 type: string
+              redisServiceName:
+                default: designate-redis
+                description: RedisServiceName is the name of the Redis instance to
+                  be used (must be in the same namespace as designate)
+                type: string
               resources:
                 description: Resources - Compute Resources required by this service
                   (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
@@ -1507,6 +1512,7 @@ spec:
             - designateProducer
             - designateWorker
             - rabbitMqClusterName
+            - redisServiceName
             - secret
             type: object
           status:

api/v1beta1/designate_types.go

@@ -181,6 +181,11 @@ type DesignateSpecBase struct {
 	// +kubebuilder:default=designate
 	// DesignateNetworkAttachment is a NetworkAttachment resource name for the Designate Control Network
 	DesignateNetworkAttachment string `json:"designateNetworkAttachment"`
+
+	// +kubebuilder:validation:Required
+	// +kubebuilder:default="designate-redis"
+	// RedisServiceName is the name of the Redis instance to be used (must be in the same namespace as designate)
+	RedisServiceName string `json:"redisServiceName"`
 }
 
 // DesignateStatus defines the observed state of Designate

config/crd/bases/designate.openstack.org_designates.yaml

@@ -1440,6 +1440,11 @@ spec:
                 description: RabbitMQ instance name Needed to request a transportURL
                   that is created and used in Designate
                 type: string
+              redisServiceName:
+                default: designate-redis
+                description: RedisServiceName is the name of the Redis instance to
+                  be used (must be in the same namespace as designate)
+                type: string
               resources:
                 description: Resources - Compute Resources required by this service
                   (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
@@ -1507,6 +1512,7 @@ spec:
             - designateProducer
             - designateWorker
             - rabbitMqClusterName
+            - redisServiceName
             - secret
             type: object
           status:

config/samples/designate_redis.yaml

@@ -0,0 +1,6 @@
+apiVersion: redis.openstack.org/v1beta1
+kind: Redis
+metadata:
+  name: designate-redis
+spec:
+  replicas: 1

config/samples/designate_redis_tls.yaml

@@ -0,0 +1,9 @@
+apiVersion: redis.openstack.org/v1beta1
+kind: Redis
+metadata:
+  name: designate-redis
+spec:
+  replicas: 1
+  tls:
+    secretName: redis-tls
+    caBundleSecretName: redis-tls

config/samples/kustomization.yaml

@@ -1,4 +1,5 @@
 ## Append samples you want in your CSV to this file as resources ##
 resources:
 - designate_v1beta1_designate.yaml
+- designate_redis.yaml
 #+kubebuilder:scaffold:manifestskustomizesamples

controllers/designate_controller.go

@@ -592,17 +592,18 @@ func (r *DesignateReconciler) reconcileNormal(ctx context.Context, instance *des
 		return ctrl.Result{RequeueAfter: time.Duration(10) * time.Second}, nil
 	}
 
-	instance.Status.Conditions.MarkTrue(designatev1beta1.DesignateRabbitMqTransportURLReadyCondition, designatev1beta1.DesignateRabbitMqTransportURLReadyMessage)
+	instance.Status.Conditions.MarkTrue(
+		designatev1beta1.DesignateRabbitMqTransportURLReadyCondition,
+		designatev1beta1.DesignateRabbitMqTransportURLReadyMessage)
 
 	// end transportURL
-
-	redis, op, err := r.redisCreateOrUpdate(ctx, instance, helper)
+	hostIPs, err := getRedisServiceIPs(ctx, instance, helper)
 	if err != nil {
 		return ctrl.Result{}, err
 	}
-	if op != controllerutil.OperationResultNone {
-		Log.Info(fmt.Sprintf("Redis %s successfully reconciled - operation: %s", redis.Name, string(op)))
-	}
+
+	sort.Strings(hostIPs)
+	instance.Status.RedisHostIPs = hostIPs
 
 	instance.Status.Conditions.MarkTrue(condition.InputReadyCondition, condition.InputReadyMessage)
 
@@ -1874,47 +1875,12 @@ func getRedisServiceIPs(
 	ctx context.Context,
 	instance *designatev1beta1.Designate,
 	helper *helper.Helper,
-	redis *redisv1.Redis,
 ) ([]string, error) {
 	getOptions := metav1.GetOptions{}
-	service, err := helper.GetKClient().CoreV1().Services(instance.Namespace).Get(ctx, "redis", getOptions)
+	service, err := helper.GetKClient().CoreV1().Services(instance.Namespace).Get(ctx, instance.Spec.RedisServiceName, getOptions)
 	if err != nil {
 		return []string{}, err
 	}
-	// TODO Ensure that the correct port is exposed
+	// TODO: Ensure that the correct port is exposed
 	return service.Spec.ClusterIPs, nil
 }
-
-func (r *DesignateReconciler) redisCreateOrUpdate(
-	ctx context.Context,
-	instance *designatev1beta1.Designate,
-	helper *helper.Helper,
-) (*redisv1.Redis, controllerutil.OperationResult, error) {
-	redis := &redisv1.Redis{
-		// Use the "global" redis instance.
-		ObjectMeta: metav1.ObjectMeta{
-			Name:      "redis",
-			Namespace: instance.Namespace,
-		},
-	}
-
-	op, err := controllerutil.CreateOrUpdate(context.TODO(), r.Client, redis, func() error {
-		// We probably don't want to own the redis instance.
-		//err := controllerutil.SetControllerReference(instance, redis, r.Scheme)
-		//return err
-		return nil
-	})
-	if err != nil {
-		return nil, op, err
-	}
-
-	hostIPs, err := getRedisServiceIPs(ctx, instance, helper, redis)
-	if err != nil {
-		return redis, op, err
-	}
-
-	sort.Strings(hostIPs)
-	instance.Status.RedisHostIPs = hostIPs
-
-	return redis, op, err
-}

tests/kuttl/tests/basic/01-deploy-designate.yaml

@@ -3,6 +3,7 @@ kind: TestStep
 commands:
   - script: |
       cp ../../../../config/samples/designate_v1beta1_designate.yaml deploy
+      cp ../../../../config/samples/designate_redis.yaml deploy
       # Do not modify the designate network attachment if it already
       # exists.
       if ! (oc get -n $NAMESPACE net-attach-def | grep designate);

tests/kuttl/tests/basic/deploy/kustomization.yaml

@@ -3,3 +3,4 @@ kind: Kustomization
 resources:
 - ./designate_nad.yaml
 - ./designate_v1beta1_designate.yaml
+- ./designate_redis.yaml

tests/kuttl/tests/designate_tls/01-redis-tls-certs.yaml

@@ -0,0 +1,45 @@
+# hardcode the secret generated by the certificate CR below,
+# to avoid kuttl from depending on cert-manager at runtime
+# the ca.crt key has been renamed to tls-ca-bundle.pem
+# ---
+# apiVersion: cert-manager.io/v1
+# kind: Certificate
+# metadata:
+#   name: kuttl-redis-cert
+# spec:
+#   secretName: kuttl-redis-tls
+#   duration: 12720h
+#   renewBefore: 1h
+#   subject:
+#     organizations:
+#       - cluster.local
+#   commonName: openstack-redis
+#   isCA: false
+#   privateKey:
+#     algorithm: RSA
+#     encoding: PKCS8
+#     size: 2048
+#   usages:
+#     - server auth
+#     - client auth
+#   dnsNames:
+#     - "redis.openstack.svc"
+#     - "redis.openstack.svc.cluster.local"
+#     - "*.redis-redis"
+#     - "*.redis-redis.openstack"
+#     - "*.redis-redis.openstack.svc"
+#     - "*.redis-redis.openstack.svc.cluster"
+#     - "*.redis-redis.openstack.svc.cluster.local"
+#   issuerRef:
+#     name: kuttl-ca-issuer
+#     group: cert-manager.io
+#     kind: Issuer
+# ---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: kuttl-redis-tls
+data:
+  tls-ca-bundle.pem: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUJmRENDQVNLZ0F3SUJBZ0lRSlUrQTRBYUpDRFowRDYzbDF5UXNFVEFLQmdncWhrak9QUVFEQWpBZU1Sd3cKR2dZRFZRUURFeE5yZFhSMGJDMXpaV3htYzJsbmJtVmtMV05oTUI0WERUSTBNREV4T0RFek1UazBNbG9YRFRJMQpNRGN3TVRFek1UazBNbG93SGpFY01Cb0dBMVVFQXhNVGEzVjBkR3d0YzJWc1puTnBaMjVsWkMxallUQlpNQk1HCkJ5cUdTTTQ5QWdFR0NDcUdTTTQ5QXdFSEEwSUFCSTJKUWdYME1oZUNHSjQ2OHFSNE9wMGJYWGFuTWZSMWRpd3EKR1VtcXlrM20vdHVNZ2hxZlJNNmdWYXFpekNLMjQyNjJUL2dIamdsaDNJTEQ4UnByQXFlalFqQkFNQTRHQTFVZApEd0VCL3dRRUF3SUNwREFQQmdOVkhSTUJBZjhFQlRBREFRSC9NQjBHQTFVZERnUVdCQlFMbThjamY3dmc5ZjRxCjdsMzVmN1YxUXNsRDlqQUtCZ2dxaGtqT1BRUURBZ05JQURCRkFpQUZkdEhUbkdiMWtQVlJlZmcvbmNHaThoR2UKVlh5UVZycFJjRStNSXZMeUpRSWhBS2VLZHNleE9LUElQSDVOT0VBUHNxOTQ5cWlFVHU4ZlJEVUdkanozSkZSKwotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
+  tls.crt: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURTVENDQXUrZ0F3SUJBZ0lSQVBDL0JSbFZNQ1VKTW52WFZRVittc0V3Q2dZSUtvWkl6ajBFQXdJd0hqRWMKTUJvR0ExVUVBeE1UYTNWMGRHd3RjMlZzWm5OcFoyNWxaQzFqWVRBZUZ3MHlOREF4TXpFd09USTFNRFZhRncweQpOVEEzTVRRd09USTFNRFZhTURJeEZqQVVCZ05WQkFvVERXTnNkWE4wWlhJdWJHOWpZV3d4R0RBV0JnTlZCQU1UCkQyOXdaVzV6ZEdGamF5MXlaV1JwY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUIKQUwrU29pVWZ5eldmRjhxdURGcGFqS1NVR2hNS0I3dGJkRU9tNWpPWWtLL0VZV3d0K3dTN3ZJbU0rZUVBS3FvcApoQVFkOUQrL0I0ZFY0QkhjUjBGdVg0eXhBZWxEc05hNWN0UEswUGcwdkpqZ1JJeUZ5a29MSEtrQVIvM1RqYUR3CmxuUk5ZRDVjSUc0YUxkdkcwSkF4elhDZ1k0bkFPdVJObzQ0MXNsTDJtZkRXdi9FbFdTZFlvU0lQUk40Ly83K0YKcEdOcHkxUzkyY0ZxNVRaRFgwSlFFU20vcmRNWko5TGwrdlBJd0RFU2VpQm85bE5MWkhlVnEwcVRHM1h6QVVWUQp2aHY1ekNIc052bklxZ1BlNC9RQlk3VFFSUDNML215bUNSNEo1ZUFoUDE0N2RxRUVaY0hrQWhIdkFvUVcvTXNRCnhCMFVDMzRBUGdZZ3F0bGdPSGxuSTM4Q0F3RUFBYU9DQVMwd2dnRXBNQjBHQTFVZEpRUVdNQlFHQ0NzR0FRVUYKQndNQkJnZ3JCZ0VGQlFjREFqQU1CZ05WSFJNQkFmOEVBakFBTUI4R0ExVWRJd1FZTUJhQUZBdWJ4eU4vdStEMQovaXJ1WGZsL3RYVkN5VVAyTUlIWUJnTlZIUkVFZ2RBd2djMkNFM0psWkdsekxtOXdaVzV6ZEdGamF5NXpkbU9DCklYSmxaR2x6TG05d1pXNXpkR0ZqYXk1emRtTXVZMngxYzNSbGNpNXNiMk5oYklJTktpNXlaV1JwY3kxeVpXUnAKYzRJWEtpNXlaV1JwY3kxeVpXUnBjeTV2Y0dWdWMzUmhZMnVDR3lvdWNtVmthWE10Y21Wa2FYTXViM0JsYm5OMApZV05yTG5OMlk0SWpLaTV5WldScGN5MXlaV1JwY3k1dmNHVnVjM1JoWTJzdWMzWmpMbU5zZFhOMFpYS0NLU291CmNtVmthWE10Y21Wa2FYTXViM0JsYm5OMFlXTnJMbk4yWXk1amJIVnpkR1Z5TG14dlkyRnNNQW9HQ0NxR1NNNDkKQkFNQ0EwZ0FNRVVDSVFDbXQ1R2VuWVNWZllxYUE5dVkrUjZkbi9GUG83N0x6ZmhJaE5TMS9HbzB6d0lnTG5FaQpOQkpwRmg3YkZkcmpnY0xETE5SRm1RTkllaGR6Qm5NRnVSa0ZXMHc9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K
+  tls.key: LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1JSUV2Z0lCQURBTkJna3Foa2lHOXcwQkFRRUZBQVNDQktnd2dnU2tBZ0VBQW9JQkFRQy9rcUlsSDhzMW54ZksKcmd4YVdveWtsQm9UQ2dlN1czUkRwdVl6bUpDdnhHRnNMZnNFdTd5SmpQbmhBQ3FxS1lRRUhmUS92d2VIVmVBUgozRWRCYmwrTXNRSHBRN0RXdVhMVHl0RDROTHlZNEVTTWhjcEtDeHlwQUVmOTA0Mmc4SlowVFdBK1hDQnVHaTNiCnh0Q1FNYzF3b0dPSndEcmtUYU9PTmJKUzlwbncxci94SlZrbldLRWlEMFRlUC8rL2hhUmphY3RVdmRuQmF1VTIKUTE5Q1VCRXB2NjNUR1NmUzVmcnp5TUF4RW5vZ2FQWlRTMlIzbGF0S2t4dDE4d0ZGVUw0Yitjd2g3RGI1eUtvRAozdVAwQVdPMDBFVDl5LzVzcGdrZUNlWGdJVDllTzNhaEJHWEI1QUlSN3dLRUZ2ekxFTVFkRkF0K0FENEdJS3JaCllEaDVaeU4vQWdNQkFBRUNnZ0VBVkwzS1Y5MnVpRE90MUl3VkRzckxOK29EZHJTVEl2K2JlR21WbnZFMzMyaGgKSi9kVytJc0xKVlZsRzNCMWJ2d2FWNi9nWVdwaExDNkNoYVFKS1JwbnpkWm00QVovYlJ4dmZOeFVmOWJrTGtQVwpUc3JINXVUdmNwcWJQZDZjNGJwSzgzdGV2WGNIS1cwUEtBN1VKMVRBYWJlcEVFQW1UT05ESEI4SW1NWlk1ajF6CithNXVocm91akROSG16Q3lna3JKQWVNRjgyZkh2RStFOFBxM3JxTjg2YWxuSkZhNTgyRmZsbmhya3hhcG9XQmEKT1VIR0hWRFlpSkJlbm52K0ZqZWVvZDhYbEk3VlhnVlpuRjNWeHBrQThwRmF1SER5R2xKU2lKMUMzbHRpc01xcQpvSmJvSFBsNWZGRGtJSDVNQzA1NkxIVEp1bTVGM3gzSGllVG81Ym01RVFLQmdRRE0yRU1TeGd4bVRpRmxsR3FxCjJ3MHdwQVFEVWUyVCtEQUNYK01vQVNMaFNZeGMxR01KZGl3WWQvM2h5cE5Iamh5Uy9aZnVGQy85WlFRREZ6dkIKU0lXb3NQYlhEazNnNGYraklhTDJXTlMzcTVkd3N2dGFId0VvWWVyVWtCUHJ3VUhNODZVQ05RUnprM0N2TVJUOAozLzdmQmRwdm0vVXJwWHBZKzdubUViWXRXd0tCZ1FEdmFlUjdFaS9OTTNYaUlMS1RyK3ExZ3lNWUEwSHBxZ0x4CkduSURObWtVajdLWUVQQmhhOHdSTjNZQmlIQ1JVdVVGS3hvaUIwa0VNZUlLS2F4ME1UdHY1cklnWng0SEk3ZksKOGFPOVl4ZlY4ekliU3RYcTcrbDNkeWZycFFTbFM0SnZ6czg3UDVMVS8rMzFXcWJCd1F5VlhBcmdKcEdsMzBRdwpJcnlSYnJjSHJRS0JnUURKOTAvcWFxby9GRG1KVmRQMXNSUklLTzVyOTVNdW1UMThtZDMxeTJrQWh1dUZlMEpLClNlRWdIdTZLZUpqTnJDZ3dKU2h1N0NpRXhkdzJ6K2x5b0habjVGTDdwbmJTaXdEcGJuaW1PdDlBV0Vad0w0ZnoKU3k1eENsbm1Ta2ZaNGlsbVViTVhnZjVwbGEwOGprQUxNeTZ2NWEyQTdWdkZOTnAwY1h6UWdoWUVrUUtCZ0JTbQpxS3VvL1BDUlVNakprejNEL2RYY1V1bWVWbEFtZHd4L0FIaWdkOTNyS3plTXRuOWd3Z0IyTFRxaW56c1owR0ZxCnYxMVNEWTFNRkRoV01lYnYzRFdoeTVtWjYzQW9ONUZNMkpmY2RWRGlJbDlTVEROd3NFMjZ2SG5LQ1NXTTV0cG8KRjEzLzlOVmtvZ3o0M2N0MnNIUXR0VTV5WlR2T2oxNHJrT0ptajJrZEFvR0JBS05tK2RjZUlGWDI4OHpzc1FGZgpWK1d3c0RDUzVKOGs2eEFlNVJ6OXNQZ2hXbzVvYUJDRkNZQVZ2dkhiZm1tTmMrQVBOSjlMeTI5R1c1N0ZtN0haCmF5YkkrY3dPS2hOQXJlWGlnQTBTVmx2SUNSeDhyYWpXYVFMY3JBMFR0ODl2aEg1SjcvVVJOcFVwcXpzZDhySFUKZTR5RHFTdHhraXJUa2ZZY3lZSlFjUDRaCi0tLS0tRU5EIFBSSVZBVEUgS0VZLS0tLS0K