DBAAS-831: update DBaaSConnection status to conform to the Provisione…

…d Service ducktype defined in the Service Binding Specification for Kubernetes

api/v1alpha1/dbaasprovider.go

@@ -214,11 +214,10 @@ type DBaaSConnectionSpec struct {
 type DBaaSConnectionStatus struct {
 	Conditions []metav1.Condition `json:"conditions,omitempty"`
 
-	// Secret holding the credentials needed for accessing the DB instance
-	CredentialsRef *corev1.LocalObjectReference `json:"credentialsRef,omitempty"`
-
-	// A ConfigMap holding non-sensitive information needed for connecting to the DB instance
-	ConnectionInfoRef *corev1.LocalObjectReference `json:"connectionInfoRef,omitempty"`
+	// Binding exposes a secret containing the binding information for the
+	// instance. It implements the service binding Provisioned Service
+	// duck type. See: https://github.com/servicebinding/spec#provisioned-service
+	Binding *corev1.LocalObjectReference `json:"binding,omitempty"`
 }
 
 // DBaaSProviderConnection is the schema for unmarshalling provider connection object

bundle/manifests/dbaas.redhat.com_dbaasconnections.yaml

@@ -3,9 +3,9 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     controller-gen.kubebuilder.io/version: v0.4.1
-    service.binding/configuration: path={.status.connectionInfoRef.name},objectType=ConfigMap
-    service.binding/credentials: path={.status.credentialsRef.name},objectType=Secret
   creationTimestamp: null
+  labels:
+    servicebinding.io/provisioned-service: "true"
   name: dbaasconnections.dbaas.redhat.com
 spec:
   group: dbaas.redhat.com
@@ -71,6 +71,16 @@ spec:
           status:
             description: DBaaSConnectionStatus defines the observed state of DBaaSConnection
             properties:
+              binding:
+                description: 'Binding exposes a secret containing the binding information
+                  for the instance. It implements the service binding Provisioned
+                  Service duck type. See: https://github.com/servicebinding/spec#provisioned-service'
+                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
               conditions:
                 items:
                   description: "Condition contains details for one aspect of the current
@@ -140,24 +150,6 @@ spec:
                   - type
                   type: object
                 type: array
-              connectionInfoRef:
-                description: A ConfigMap holding non-sensitive information needed
-                  for connecting to the DB instance
-                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
-              credentialsRef:
-                description: Secret holding the credentials needed for accessing the
-                  DB instance
-                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
             type: object
         type: object
     served: true

config/crd/bases/dbaas.redhat.com_dbaasconnections.yaml

@@ -71,6 +71,16 @@ spec:
           status:
             description: DBaaSConnectionStatus defines the observed state of DBaaSConnection
             properties:
+              binding:
+                description: 'Binding exposes a secret containing the binding information
+                  for the instance. It implements the service binding Provisioned
+                  Service duck type. See: https://github.com/servicebinding/spec#provisioned-service'
+                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
               conditions:
                 items:
                   description: "Condition contains details for one aspect of the current
@@ -140,24 +150,6 @@ spec:
                   - type
                   type: object
                 type: array
-              connectionInfoRef:
-                description: A ConfigMap holding non-sensitive information needed
-                  for connecting to the DB instance
-                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
-              credentialsRef:
-                description: Secret holding the credentials needed for accessing the
-                  DB instance
-                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
             type: object
         type: object
     served: true

config/crd/kustomization.yaml

@@ -11,7 +11,7 @@ resources:
 #+kubebuilder:scaffold:crdkustomizeresource
 
 patchesStrategicMerge:
-- patches/service_binding_annotations.yaml
+- patches/service_binding_labels.yaml
 
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix.
 # patches here are for enabling the conversion webhook for each CRD

config/crd/patches/service_binding_labels.yaml

@@ -0,0 +1,6 @@
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: dbaasconnections.dbaas.redhat.com
+  labels:
+    servicebinding.io/provisioned-service: "true"

controllers/dbaasconnection_controller_test.go

@@ -406,12 +406,9 @@ var _ = Describe("DBaaSConnection controller - nominal", func() {
 								LastTransitionTime: metav1.Time{Time: lastTransitionTime},
 							},
 						},
-						CredentialsRef: &v1.LocalObjectReference{
+						Binding: &v1.LocalObjectReference{
 							Name: testSecret.Name,
 						},
-						ConnectionInfoRef: &v1.LocalObjectReference{
-							Name: "testConnectionInfoRef",
-						},
 					}
 					It("should update DBaaSConnection status", assertDBaaSResourceProviderStatusUpdated(createdDBaaSConnection, metav1.ConditionTrue, testConnectionKind, status))
 				})
@@ -601,12 +598,9 @@ var _ = Describe("DBaaSConnection controller - nominal with instance reference",
 									LastTransitionTime: metav1.Time{Time: lastTransitionTime},
 								},
 							},
-							CredentialsRef: &v1.LocalObjectReference{
+							Binding: &v1.LocalObjectReference{
 								Name: testSecret.Name,
 							},
-							ConnectionInfoRef: &v1.LocalObjectReference{
-								Name: "testConnectionInfoRef",
-							},
 						}
 						It("should update DBaaSConnection status", assertDBaaSResourceProviderStatusUpdated(createdDBaaSConnection, metav1.ConditionTrue, testConnectionKind, status))
 					})
@@ -702,12 +696,9 @@ var _ = Describe("DBaaSConnection controller - valid dev namespaces", func() {
 								LastTransitionTime: metav1.Time{Time: lastTransitionTime},
 							},
 						},
-						CredentialsRef: &v1.LocalObjectReference{
+						Binding: &v1.LocalObjectReference{
 							Name: testSecret.Name,
 						},
-						ConnectionInfoRef: &v1.LocalObjectReference{
-							Name: "testConnectionInfoRef",
-						},
 					}
 					It("should update DBaaSConnection status", assertDBaaSResourceProviderStatusUpdated(createdDBaaSConnection, metav1.ConditionTrue, testConnectionKind, status))
 				})
@@ -809,12 +800,9 @@ var _ = Describe("DBaaSConnection controller - valid dev namespaces", func() {
 								LastTransitionTime: metav1.Time{Time: lastTransitionTime},
 							},
 						},
-						CredentialsRef: &v1.LocalObjectReference{
+						Binding: &v1.LocalObjectReference{
 							Name: testSecret.Name,
 						},
-						ConnectionInfoRef: &v1.LocalObjectReference{
-							Name: "testConnectionInfoRef",
-						},
 					}
 					It("should update DBaaSConnection status", assertDBaaSResourceProviderStatusUpdated(createdDBaaSConnection, metav1.ConditionTrue, testConnectionKind, status))
 				})
@@ -934,12 +922,9 @@ var _ = Describe("DBaaSConnection controller - valid dev namespaces", func() {
 								LastTransitionTime: metav1.Time{Time: lastTransitionTime},
 							},
 						},
-						CredentialsRef: &v1.LocalObjectReference{
+						Binding: &v1.LocalObjectReference{
 							Name: testSecret.Name,
 						},
-						ConnectionInfoRef: &v1.LocalObjectReference{
-							Name: "testConnectionInfoRef",
-						},
 					}
 					It("should update DBaaSConnection status", assertDBaaSResourceProviderStatusUpdated(createdDBaaSConnection, metav1.ConditionTrue, testConnectionKind, status))
 				})
@@ -1045,12 +1030,9 @@ var _ = Describe("DBaaSConnection controller - valid dev namespaces", func() {
 								LastTransitionTime: metav1.Time{Time: lastTransitionTime},
 							},
 						},
-						CredentialsRef: &v1.LocalObjectReference{
+						Binding: &v1.LocalObjectReference{
 							Name: testSecret.Name,
 						},
-						ConnectionInfoRef: &v1.LocalObjectReference{
-							Name: "testConnectionInfoRef",
-						},
 					}
 					It("should update DBaaSConnection status", assertDBaaSResourceProviderStatusUpdated(createdDBaaSConnection, metav1.ConditionTrue, testConnectionKind, status))
 				})

test/crd/dbaas.redhat.com_crunchybridgeconnections.yaml

@@ -70,6 +70,16 @@ spec:
             status:
               description: DBaaSConnectionStatus defines the observed state of DBaaSConnection
               properties:
+                binding:
+                  description: 'Binding exposes a secret containing the binding information
+                    for the instance. It implements the service binding Provisioned
+                    Service duck type. See: https://github.com/servicebinding/spec#provisioned-service'
+                  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
                 conditions:
                   items:
                     description: "Condition contains details for one aspect of the current
@@ -139,16 +149,6 @@ spec:
                       - type
                     type: object
                   type: array
-                connectionInfoRef:
-                  properties:
-                    name:
-                      type: string
-                  type: object
-                credentialsRef:
-                  properties:
-                    name:
-                      type: string
-                  type: object
               type: object
           type: object
       served: true

test/crd/dbaas.redhat.com_mongodbatlasconnections.yaml

@@ -74,6 +74,16 @@ spec:
             status:
               description: DBaaSConnectionStatus defines the observed state of DBaaSConnection
               properties:
+                binding:
+                  description: 'Binding exposes a secret containing the binding information
+                    for the instance. It implements the service binding Provisioned
+                    Service duck type. See: https://github.com/servicebinding/spec#provisioned-service'
+                  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
                 conditions:
                   items:
                     description: "Condition contains details for one aspect of the current
@@ -143,16 +153,6 @@ spec:
                       - type
                     type: object
                   type: array
-                connectionInfoRef:
-                  properties:
-                    name:
-                      type: string
-                  type: object
-                credentialsRef:
-                  properties:
-                    name:
-                      type: string
-                  type: object
               type: object
           type: object
       served: true