renamed SecretConfigmap type to Bindable

- because OperandConfig will be extended to handle more than just Secrets and Configmaps Signed-off-by: Henry H Li <[email protected]>
IBM · ibm-ci-bot · Nov 3, 2023 · Oct 31, 2023 · Nov 2, 2023 · Nov 2, 2023
commit bd9f6542ca12e7749cc9fb99f52c466e861bd62e
diff --git a/Makefile b/Makefile
@@ -209,7 +209,7 @@ bundle-manifests:
 	-q --overwrite --version $(OPERATOR_VERSION) $(BUNDLE_METADATA_OPTS)
 	$(OPERATOR_SDK) bundle validate ./bundle
 	$(YQ) eval-all -i '.spec.relatedImages = load("config/manifests/bases/operand-deployment-lifecycle-manager.clusterserviceversion.yaml").spec.relatedImages' bundle/manifests/operand-deployment-lifecycle-manager.clusterserviceversion.yaml
-	# Need to replace fields this way to avoid changing PROJECT name and CSV file name, which may or may not impact CICD automation
+	@# Need to replace fields this way to avoid changing PROJECT name and CSV file name, which may or may not impact CICD automation
 	$(YQ) e -i '.annotations["operators.operatorframework.io.bundle.package.v1"] = "ibm-odlm"' bundle/metadata/annotations.yaml
 	sed -i'' s/operand-deployment-lifecycle-manager/ibm-odlm/ bundle.Dockerfile
 

diff --git a/api/v1alpha1/operandbindinfo_types.go b/api/v1alpha1/operandbindinfo_types.go
@@ -56,11 +56,16 @@ type OperandBindInfoSpec struct {
 	Description string `json:"description,omitempty"`
 	// The bindings section is used to specify information about the access/configuration data that is to be shared.
 	// +optional
-	Bindings map[string]SecretConfigmap `json:"bindings,omitempty"`
+	Bindings map[string]Bindable `json:"bindings,omitempty"`
 }
 
-// SecretConfigmap is a pair of Secret and/or Configmap.
-type SecretConfigmap struct {
+// Bindable is a Kubernetes resources to be shared from one namespace to another.
+// List of supported resources are Secrets, Configmaps, Services, and Routes.
+// Secrets and Configmaps will be copied such that a new Secret/Configmap with
+// exactly the same data will be created in the target namespace.
+// Services and Routes data will be copied into a configmap in the target
+// namespace.
+type Bindable struct {
 	// The secret identifies an existing secret. if it exists, the ODLM will share to the namespace of the OperandRequest.
 	// +optional
 	Secret string `json:"secret,omitempty"`

diff --git a/api/v1alpha1/operandrequest_types.go b/api/v1alpha1/operandrequest_types.go
@@ -63,7 +63,7 @@ type Operand struct {
 	Name string `json:"name"`
 	// The bindings section is used to specify names of secret and/or configmap.
 	// +optional
-	Bindings map[string]SecretConfigmap `json:"bindings,omitempty"`
+	Bindings map[string]Bindable `json:"bindings,omitempty"`
 	// Kind is used when users want to deploy multiple custom resources.
 	// Kind identifies the kind of the custom resource.
 	// +optional

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/bundle/manifests/operator.ibm.com_operandbindinfos.yaml b/bundle/manifests/operator.ibm.com_operandbindinfos.yaml
@@ -53,7 +53,12 @@ spec:
             properties:
               bindings:
                 additionalProperties:
-                  description: SecretConfigmap is a pair of Secret and/or Configmap.
+                  description: Bindable is a Kubernetes resources to be shared from
+                    one namespace to another. List of supported resources are Secrets,
+                    Configmaps, Services, and Routes. Secrets and Configmaps will
+                    be copied such that a new Secret/Configmap with exactly the same
+                    data will be created in the target namespace. Services and Routes
+                    data will be copied into a configmap in the target namespace.
                   properties:
                     configmap:
                       description: The configmap identifies an existing configmap

diff --git a/bundle/manifests/operator.ibm.com_operandrequests.yaml b/bundle/manifests/operator.ibm.com_operandrequests.yaml
@@ -74,8 +74,14 @@ spec:
                             type: string
                           bindings:
                             additionalProperties:
-                              description: SecretConfigmap is a pair of Secret and/or
-                                Configmap.
+                              description: Bindable is a Kubernetes resources to be
+                                shared from one namespace to another. List of supported
+                                resources are Secrets, Configmaps, Services, and Routes.
+                                Secrets and Configmaps will be copied such that a
+                                new Secret/Configmap with exactly the same data will
+                                be created in the target namespace. Services and Routes
+                                data will be copied into a configmap in the target
+                                namespace.
                               properties:
                                 configmap:
                                   description: The configmap identifies an existing

diff --git a/config/crd/bases/operator.ibm.com_operandbindinfos.yaml b/config/crd/bases/operator.ibm.com_operandbindinfos.yaml
@@ -51,7 +51,12 @@ spec:
             properties:
               bindings:
                 additionalProperties:
-                  description: SecretConfigmap is a pair of Secret and/or Configmap.
+                  description: Bindable is a Kubernetes resources to be shared from
+                    one namespace to another. List of supported resources are Secrets,
+                    Configmaps, Services, and Routes. Secrets and Configmaps will
+                    be copied such that a new Secret/Configmap with exactly the same
+                    data will be created in the target namespace. Services and Routes
+                    data will be copied into a configmap in the target namespace.
                   properties:
                     configmap:
                       description: The configmap identifies an existing configmap

diff --git a/config/crd/bases/operator.ibm.com_operandrequests.yaml b/config/crd/bases/operator.ibm.com_operandrequests.yaml
@@ -72,8 +72,14 @@ spec:
                             type: string
                           bindings:
                             additionalProperties:
-                              description: SecretConfigmap is a pair of Secret and/or
-                                Configmap.
+                              description: Bindable is a Kubernetes resources to be
+                                shared from one namespace to another. List of supported
+                                resources are Secrets, Configmaps, Services, and Routes.
+                                Secrets and Configmaps will be copied such that a
+                                new Secret/Configmap with exactly the same data will
+                                be created in the target namespace. Services and Routes
+                                data will be copied into a configmap in the target
+                                namespace.
                               properties:
                                 configmap:
                                   description: The configmap identifies an existing

diff --git a/config/e2e/crd/bases/operator.ibm.com_operandbindinfos.yaml b/config/e2e/crd/bases/operator.ibm.com_operandbindinfos.yaml
@@ -56,7 +56,7 @@ spec:
             properties:
               bindings:
                 additionalProperties:
-                  description: SecretConfigmap is a pair of Secret and/or Configmap.
+                  description: Bindable is a pair of Secret and/or Configmap.
                   properties:
                     configmap:
                       description: The configmap identifies an existing configmap

diff --git a/config/e2e/crd/bases/operator.ibm.com_operandrequests.yaml b/config/e2e/crd/bases/operator.ibm.com_operandrequests.yaml
@@ -77,7 +77,7 @@ spec:
                             type: string
                           bindings:
                             additionalProperties:
-                              description: SecretConfigmap is a pair of Secret and/or
+                              description: Bindable is a pair of Secret and/or
                                 Configmap.
                               properties:
                                 configmap:

diff --git a/controllers/testutil/test_util.go b/controllers/testutil/test_util.go
@@ -238,7 +238,7 @@ func OperandRequestObj(registryName, registryNamespace, requestName, requestName
 						},
 						{
 							Name: "mongodb-atlas-kubernetes",
-							Bindings: map[string]apiv1alpha1.SecretConfigmap{
+							Bindings: map[string]apiv1alpha1.Bindable{
 								"public": {
 									Secret:    "secret4",
 									Configmap: "cm4",
@@ -331,7 +331,7 @@ func OperandRequestObjWithProtected(registryName, registryNamespace, requestName
 						},
 						{
 							Name: "mongodb-atlas-kubernetes",
-							Bindings: map[string]apiv1alpha1.SecretConfigmap{
+							Bindings: map[string]apiv1alpha1.Bindable{
 								"protected": {
 									Secret:    "secret5",
 									Configmap: "cm5",
@@ -356,7 +356,7 @@ func OperandBindInfoObj(name, namespace, registryName, registryNamespace string)
 			Operand:           "mongodb-atlas-kubernetes",
 			Registry:          registryName,
 			RegistryNamespace: registryNamespace,
-			Bindings: map[string]apiv1alpha1.SecretConfigmap{
+			Bindings: map[string]apiv1alpha1.Bindable{
 				"public": {
 					Secret:    "secret1",
 					Configmap: "cm1",

diff --git a/test/e2e/helpers_test.go b/test/e2e/helpers_test.go
@@ -791,7 +791,7 @@ func newOperandRequestWithBindinfo(name, namespace, RegistryNamespace string) *v
 					Operands: []v1alpha1.Operand{
 						{
 							Name: "mongodb-atlas-kubernetes",
-							Bindings: map[string]v1alpha1.SecretConfigmap{
+							Bindings: map[string]v1alpha1.Bindable{
 								"public": {
 									Secret:    "mongodb-secret",
 									Configmap: "mongodb-configmap",
@@ -817,7 +817,7 @@ func newOperandBindInfoCR(name, namespace, RegistryNamespace string) *v1alpha1.O
 			Registry:          OperandRegistryCrName,
 			RegistryNamespace: RegistryNamespace,
 
-			Bindings: map[string]v1alpha1.SecretConfigmap{
+			Bindings: map[string]v1alpha1.Bindable{
 				"public": {
 					Secret:    "mongodb-secret",
 					Configmap: "mongodb-configmap",