Update kuttl tests and config/samples

This patch updates the kuttl tests related references to match the new data structure, and, at the same time, all the documentation has been updated to reflect the last changes introduced in the previous commits. Signed-off-by: Francesco Pantano <[email protected]>
openstack-k8s-operators · Oct 24, 2023 · b750f93 · b750f93
1 parent 7219776
commit b750f93
Show file tree

Hide file tree

Showing 27 changed files with 78 additions and 126 deletions.
diff --git a/README.md b/README.md
@@ -258,12 +258,7 @@ spec:
     rbd_store_user = openstack
   databaseInstance: openstack
   databaseUser: glance
-  glanceAPIInternal:
-    debug:
-      service: false
-    preserveJobs: false
-    replicas: 1
-  glanceAPIExternal:
+  glanceAPI:
     debug:
       service: false
     preserveJobs: false
@@ -336,11 +331,7 @@ metadata:
   name: glance
 spec:
   ...
-  glanceAPIInternal:
-    ...
-    networkAttachents:
-    - storage
-  glanceAPIExternal:
+  glanceAPI:
     ...
     networkAttachents:
     - storage
@@ -411,7 +402,7 @@ metadata:
   name: glance
 spec:
   ...
-  glanceAPIInternal:
+  glanceAPI:
     ...
     override:
       service:

diff --git a/config/manager/kustomization.yaml b/config/manager/kustomization.yaml
@@ -12,4 +12,5 @@ apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 images:
 - name: controller
-  newName: quay.io/fpantano/glance-operator
+  newName: quay.io/openstack-k8s-operators/glance-operator
+  newTag: latest
diff --git a/config/samples/backends/ceph/ceph.yaml b/config/samples/backends/ceph/ceph.yaml
@@ -20,12 +20,7 @@ spec:
     rbd_store_user = openstack
   databaseInstance: openstack
   databaseUser: glance
-  glanceAPIInternal:
-    debug:
-      service: false
-    preserveJobs: false
-    replicas: 1
-  glanceAPIExternal:
+  glanceAPI:
     debug:
       service: false
     preserveJobs: false

diff --git a/config/samples/backends/cinder/glance-common/glance.yaml b/config/samples/backends/cinder/glance-common/glance.yaml
@@ -22,12 +22,7 @@ spec:
       customServiceConfigSecrets:
         - osp-glance-cinder-secret
       databaseInstance: openstack
-      glanceAPIInternal:
-        debug:
-          service: false
-        preserveJobs: false
-        replicas: 1
-      glanceAPIExternal:
+      glanceAPI:
         debug:
           service: false
         preserveJobs: false

diff --git a/config/samples/backends/multibackends/multibackend.yaml b/config/samples/backends/multibackends/multibackend.yaml
@@ -23,12 +23,7 @@ spec:
     filesystem_store_datadir = /var/lib/glance/images/
   databaseInstance: openstack
   databaseUser: glance
-  glanceAPIInternal:
-    debug:
-      service: false
-    preserveJobs: false
-    replicas: 1
-  glanceAPIExternal:
+  glanceAPI:
     debug:
       service: false
     preserveJobs: false

diff --git a/config/samples/backends/nfs/nfs.yaml b/config/samples/backends/nfs/nfs.yaml
@@ -16,12 +16,7 @@ spec:
     filesystem_store_datadir = /var/lib/glance/images/
   databaseInstance: openstack
   databaseUser: glance
-  glanceAPIInternal:
-    debug:
-      service: false
-    preserveJobs: false
-    replicas: 1
-  glanceAPIExternal:
+  glanceAPI:
     debug:
       service: false
     preserveJobs: false

diff --git a/config/samples/backends/swift/glance.yaml b/config/samples/backends/swift/glance.yaml
@@ -20,12 +20,7 @@ spec:
       customServiceConfigSecrets:
         - osp-glance-swift-secret
       databaseInstance: openstack
-      glanceAPIInternal:
-        debug:
-          service: false
-        preserveJobs: false
-        replicas: 1
-      glanceAPIExternal:
+      glanceAPI:
         debug:
           service: false
         preserveJobs: false

diff --git a/config/samples/glance_v1beta1_glance_single_instance.yaml b/config/samples/glance_v1beta1_glance_single_instance.yaml
@@ -10,11 +10,11 @@ spec:
   databaseUser: glance
   glanceAPI:
     containerImage: quay.io/podified-antelope-centos9/openstack-glance-api:current-podified
+    type: "single"
     debug:
       service: false
     preserveJobs: false
     replicas: 1
-  type: "single"
   secret: osp-secret
   storageClass: local-storage
   storageRequest: 10G
diff --git a/config/samples/image-cache/README.md b/config/samples/image-cache/README.md
@@ -25,9 +25,7 @@ parameter:
       storageClass: ""
       imageCacheSize: 10G
       storageRequest: 10G
-      glanceAPIInternal:
-        ...
-      glanceAPIExternal:
+      glanceAPI:
         ...
 ...
 ...

diff --git a/config/samples/image-cache/image-cache.yaml b/config/samples/image-cache/image-cache.yaml
@@ -22,12 +22,7 @@ spec:
         rbd_store_pool = images
         rbd_store_user = openstack
       databaseUser: glance
-      glanceAPIInternal:
-        debug:
-          service: false
-        preserveJobs: false
-        replicas: 1
-      glanceAPIExternal:
+      glanceAPI:
         debug:
           service: false
         preserveJobs: false

diff --git a/config/samples/import_plugins/image_conversion/image_conversion.yaml b/config/samples/import_plugins/image_conversion/image_conversion.yaml
@@ -25,12 +25,7 @@ spec:
     output_format = raw
   databaseInstance: openstack
   databaseUser: glance
-  glanceAPIInternal:
-    debug:
-      service: false
-    preserveJobs: false
-    replicas: 1
-  glanceAPIExternal:
+  glanceAPI:
     debug:
       service: false
     preserveJobs: false

diff --git a/config/samples/import_plugins/image_decompression/image_decompression.yaml b/config/samples/import_plugins/image_decompression/image_decompression.yaml
@@ -22,12 +22,7 @@ spec:
     image_import_plugins = [image_decompression]
   databaseInstance: openstack
   databaseUser: glance
-  glanceAPIInternal:
-    debug:
-      service: false
-    preserveJobs: false
-    replicas: 1
-  glanceAPIExternal:
+  glanceAPI:
     debug:
       service: false
     preserveJobs: false

diff --git a/config/samples/import_plugins/inject_metadata/inject_metadata.yaml b/config/samples/import_plugins/inject_metadata/inject_metadata.yaml
@@ -25,12 +25,7 @@ spec:
     inject = "property1":"value1","property2":"value2"
   databaseInstance: openstack
   databaseUser: glance
-  glanceAPIInternal:
-    debug:
-      service: false
-    preserveJobs: false
-    replicas: 1
-  glanceAPIExternal:
+  glanceAPI:
     debug:
       service: false
     preserveJobs: false

diff --git a/config/samples/policy/glance_v1beta_glance_apply_policy.yaml b/config/samples/policy/glance_v1beta_glance_apply_policy.yaml
@@ -11,10 +11,7 @@ spec:
     enforce_new_defaults=true
   databaseInstance: openstack
   databaseUser: glance
-  glanceAPIInternal:
-    preserveJobs: false
-    replicas: 1
-  glanceAPIExternal:
+  glanceAPI:
     preserveJobs: false
     replicas: 1
   secret: osp-secret

diff --git a/config/samples/quotas/glance_v1beta1_glance_quota.yaml b/config/samples/quotas/glance_v1beta1_glance_quota.yaml
@@ -7,12 +7,7 @@ spec:
   serviceUser: glance
   databaseInstance: openstack
   databaseUser: glance
-  glanceAPIInternal:
-    debug:
-      service: false
-    preserveJobs: false
-    replicas: 1
-  glanceAPIExternal:
+  glanceAPI:
     debug:
       service: false
     preserveJobs: false

diff --git a/controllers/glance_controller.go b/controllers/glance_controller.go
@@ -620,7 +620,7 @@ func (r *GlanceReconciler) reconcileNormal(ctx context.Context, instance *glance
 func (r *GlanceReconciler) apiDeployment(ctx context.Context, instance *glancev1.Glance, current glancev1.GlanceAPITemplate, helper *helper.Helper) error {
 
 	// By default internal and external points to diff instances, but we might
-	// want to override "external" in case of single instance and skip the
+	// want to override "external" in case of a "single" instance and skip the
 	// internal one
 	var internal string = glancev1.APIInternal
 	var external string = glancev1.APIExternal
@@ -646,9 +646,13 @@ func (r *GlanceReconciler) apiDeployment(ctx context.Context, instance *glancev1
 		r.Log.Info(fmt.Sprintf("Deployment %s successfully reconciled - operation: %s", instance.Name, string(op)))
 	}
 
-	// Mirror external GlanceAPI status' APIEndpoints and ReadyCount to this parent CR
+	// Mirror single/external GlanceAPI status' APIEndpoints and ReadyCount to this parent CR
 	if glanceAPI.Status.APIEndpoints != nil {
 		instance.Status.APIEndpoints[string(endpoint.EndpointPublic)] = glanceAPI.Status.APIEndpoints[string(endpoint.EndpointPublic)]
+		// if we don't split, update apiEndpoint to include the internal service
+		if current.Type == "single" {
+			instance.Status.APIEndpoints[string(endpoint.EndpointInternal)] = glanceAPI.Status.APIEndpoints[string(endpoint.EndpointInternal)]
+		}
 	}
 	instance.Status.GlanceAPIExternalReadyCount = glanceAPI.Status.ReadyCount
 
@@ -681,7 +685,7 @@ func (r *GlanceReconciler) apiDeployment(ctx context.Context, instance *glancev1
 
 		// Mirror internal GlanceAPI status' APIEndpoints and ReadyCount to this parent CR
 		if glanceAPI.Status.APIEndpoints != nil {
-			instance.Status.APIEndpoints = glanceAPI.Status.APIEndpoints
+			instance.Status.APIEndpoints[string(endpoint.EndpointInternal)] = glanceAPI.Status.APIEndpoints[string(endpoint.EndpointInternal)]
 		}
 		instance.Status.GlanceAPIInternalReadyCount = glanceAPI.Status.ReadyCount
 

diff --git a/docs/dev/debug.md b/docs/dev/debug.md
@@ -210,7 +210,7 @@ here we want to launch a user facing container (External) in debug mode.
 ```
 (path to file: install_yamls/out/openstack/glance/cr/glance_v1beta1_glance.yaml)
 
-glanceAPIExternal:
+glanceAPI:
 	debug:
   	service: true # Change it to true if it is false
 	preserveJobs: false

diff --git a/docs/dev/design-decisions.md b/docs/dev/design-decisions.md
@@ -109,9 +109,10 @@ or symlinked. In our case we instruct kolla to use the copying mechanism in
 To be able to use `nsenter` the pod needs to share the PID namespace with the
 host.
 
+
 ## GlanceAPI deployment
 
-When a Glance CR is created, at last two `GlanceAPI` deployments are triggered:
+When a Glance CR is created, by default two `GlanceAPI` deployments are triggered:
 
 ```
 ...
@@ -120,9 +121,7 @@ spec:
   serviceUser: glance
   databaseInstance: openstack
   databaseUser: glance
-  glanceAPIInternal:
-    ..
-  glanceAPIExternal:
+  glanceAPI:
     ..
   secret: osp-secret
   storageClass: ""
@@ -149,8 +148,38 @@ glance-internal                        True     Setup complete
 ```
 
 and they can be inspected as regular k8s objects.
-Each GlanceAPI deployment resulting from the process above will deploy three
-containers within the same Pod:
+However, it's possible to not split the deployment between internal and external
+API deployment, and reduce everything to a single API instance.
+To do that, a Glance CR spec like the following should be created:
+
+```
+...
+...
+spec:
+  serviceUser: glance
+  databaseInstance: openstack
+  databaseUser: glance
+  glanceAPI:
+    replicas=1
+    type: "single"
+  secret: osp-secret
+  storageClass: ""
+...
+...
+```
+
+By passing `type: single` to the `glanceAPI` section, the main Glance controller
+will only generate a single deployment. Both internal and external `Services`
+will point to the single instance.
+
+```
+$ oc get glanceapi
+NAME            NETWORKATTACHMENTS   STATUS   MESSAGE
+glance-single                        True     Setup complete
+```
+
+In general, a `GlanceAPI` deployment resulting from one of the processes above
+will deploy three containers within the same Pod:
 
 ```
 +-------------------------------------+

diff --git a/test/functional/base_test.go b/test/functional/base_test.go
@@ -89,24 +89,21 @@ func GetGlanceDefaultSpec() map[string]interface{} {
 		"databaseUser":     glanceTest.GlanceDatabaseUser,
 		"serviceUser":      glanceName.Name,
 		"secret":           SecretName,
-		//"glanceAPIInternal": GetGlanceAPIDefaultSpec(GlanceAPITypeInternal),
-		//"glanceAPIExternal": GetGlanceAPIDefaultSpec(GlanceAPITypeExternal),
-		"glances":        GetGlanceAPIDefaultSpec(GlanceAPITypeExternal),
-		"type":           "split",
-		"storageRequest": glanceTest.GlancePVCSize,
+		"glanceAPI":        GetGlanceAPIDefaultSpec(GlanceAPITypeSingle),
+		"type":             "split",
+		"storageRequest":   glanceTest.GlancePVCSize,
 	}
 }
 
 func GetGlanceDefaultSpecWithQuota() map[string]interface{} {
 	return map[string]interface{}{
-		"databaseInstance":  "openstack",
-		"databaseUser":      glanceTest.GlanceDatabaseUser,
-		"serviceUser":       glanceName.Name,
-		"secret":            SecretName,
-		"glanceAPIInternal": GetGlanceAPIDefaultSpec(GlanceAPITypeInternal),
-		"glanceAPIExternal": GetGlanceAPIDefaultSpec(GlanceAPITypeExternal),
-		"storageRequest":    glanceTest.GlancePVCSize,
-		"quotas":            glanceTest.GlanceQuotas,
+		"databaseInstance": "openstack",
+		"databaseUser":     glanceTest.GlanceDatabaseUser,
+		"serviceUser":      glanceName.Name,
+		"secret":           SecretName,
+		"glanceAPI":        GetGlanceAPIDefaultSpec(GlanceAPITypeSingle),
+		"storageRequest":   glanceTest.GlancePVCSize,
+		"quotas":           glanceTest.GlanceQuotas,
 	}
 }
 

diff --git a/test/functional/glance_controller_test.go b/test/functional/glance_controller_test.go
@@ -111,7 +111,6 @@ var _ = Describe("Glance controller", func() {
 			glance := GetGlance(glanceName)
 			Expect(glance.Spec.ContainerImage).To(Equal(glancev1.GlanceAPIContainerImage))
 			Expect(glance.Spec.GlanceAPI.ContainerImage).To(Equal(glancev1.GlanceAPIContainerImage))
-			//Expect(glance.Spec.GlanceAPIs.GlanceAPIExternal.ContainerImage).To(Equal(glancev1.GlanceAPIContainerImage))
 		})
 		It("should not have a pvc yet", func() {
 			AssertPVCDoesNotExist(glanceTest.Instance)

diff --git a/test/kuttl/tests/glance_scale/01-assert.yaml b/test/kuttl/tests/glance_scale/01-assert.yaml
@@ -23,12 +23,7 @@ spec:
     debug = true
   databaseInstance: openstack
   databaseUser: glance
-  glanceAPIInternal:
-    containerImage: quay.io/podified-antelope-centos9/openstack-glance-api:current-podified
-    debug:
-      service: false
-    replicas: 1
-  glanceAPIExternal:
+  glanceAPI:
     containerImage: quay.io/podified-antelope-centos9/openstack-glance-api:current-podified
     debug:
       service: false

diff --git a/test/kuttl/tests/glance_scale/02-assert.yaml b/test/kuttl/tests/glance_scale/02-assert.yaml
@@ -10,9 +10,7 @@ kind: Glance
 metadata:
   name: glance
 spec:
-  glanceAPIInternal:
-    replicas: 2
-  glanceAPIExternal:
+  glanceAPI:
     replicas: 2
 status:
   glanceAPIExternalReadyCount: 2

diff --git a/test/kuttl/tests/glance_scale/02-scale-glanceapis.yaml b/test/kuttl/tests/glance_scale/02-scale-glanceapis.yaml
@@ -2,5 +2,4 @@ apiVersion: kuttl.dev/v1beta1
 kind: TestStep
 commands:
     - script: |
-            oc patch Glance -n $NAMESPACE glance --type='json' -p='[{"op": "replace", "path": "/spec/glanceAPIInternal/replicas", "value":2}]'
-            oc patch Glance -n $NAMESPACE glance --type='json' -p='[{"op": "replace", "path": "/spec/glanceAPIExternal/replicas", "value":2}]'
+            oc patch Glance -n $NAMESPACE glance --type='json' -p='[{"op": "replace", "path": "/spec/glanceAPI/replicas", "value":2}]'