interim migrate to MariaDBAccount generation

openstack-k8s-operators · Feb 1, 2024 · a6acfe3 · a6acfe3
1 parent 053fb28
commit a6acfe3
Show file tree

Hide file tree

Showing 28 changed files with 129 additions and 225 deletions.
diff --git a/api/bases/glance.openstack.org_glanceapis.yaml b/api/bases/glance.openstack.org_glanceapis.yaml
@@ -55,10 +55,9 @@ spec:
                 items:
                   type: string
                 type: array
-              databaseHostname:
+              databaseAccount:
                 type: string
-              databaseUser:
-                default: glance
+              databaseHostname:
                 type: string
               debug:
                 properties:
@@ -976,6 +975,7 @@ spec:
                 type: string
             required:
             - containerImage
+            - databaseAccount
             - databaseHostname
             - imageCacheSize
             - secret

diff --git a/api/bases/glance.openstack.org_glances.yaml b/api/bases/glance.openstack.org_glances.yaml
@@ -44,10 +44,9 @@ spec:
                 items:
                   type: string
                 type: array
-              databaseInstance:
+              databaseAccount:
                 type: string
-              databaseUser:
-                default: glance
+              databaseInstance:
                 type: string
               debug:
                 properties:
@@ -1019,6 +1018,7 @@ spec:
                 type: string
             required:
             - containerImage
+            - databaseAccount
             - databaseInstance
             - glanceAPIs
             - imageCacheSize

diff --git a/api/v1beta1/glance_types.go b/api/v1beta1/glance_types.go
@@ -50,14 +50,17 @@ type GlanceSpec struct {
 	// Might not be required in future
 	DatabaseInstance string `json:"databaseInstance"`
 
-	// +kubebuilder:validation:Optional
-	// +kubebuilder:default=glance
-	// DatabaseUser - optional username used for glance DB, defaults to glance
-	// TODO: -> implement needs work in mariadb-operator, right now only glance
-	DatabaseUser string `json:"databaseUser"`
+	// +kubebuilder:validation:Required
+	// DatabaseAccount - name of MariaDBAccount which will be used to connect.
+	// As an interim solution, glance-controller will
+	// generate the MariaDBAccount object of the given name if it's not
+	// present in the cluster.  Later, openstack-operator will perform this
+	// generation and also populate this field for the Glance objects it creates
+	DatabaseAccount string `json:"databaseAccount"`
 
 	// +kubebuilder:validation:Required
-	// Secret containing OpenStack password information for glance GlanceDatabasePassword
+	// Secret containing OpenStack password information for glance's keystone
+	// password; no longer used for database password
 	Secret string `json:"secret"`
 
 	// +kubebuilder:validation:Optional

diff --git a/api/v1beta1/glanceapi_types.go b/api/v1beta1/glanceapi_types.go
@@ -53,11 +53,13 @@ type GlanceAPISpec struct {
 	// DatabaseHostname - Glance Database Hostname
 	DatabaseHostname string `json:"databaseHostname"`
 
-	// +kubebuilder:validation:Optional
-	// +kubebuilder:default=glance
-	// DatabaseUser - optional username used for glance DB, defaults to glance
-	// TODO: -> implement needs work in mariadb-operator, right now only glance
-	DatabaseUser string `json:"databaseUser"`
+	// +kubebuilder:validation:Required
+	// DatabaseAccount - name of MariaDBAccount which will be used to connect.
+	// As an interim solution, glance-controller will
+	// generate the MariaDBAccount object of the given name if it's not
+	// present in the cluster.  Later, openstack-operator will perform this
+	// generation and also populate this field for the Glance objects it creates
+	DatabaseAccount string `json:"databaseAccount"`
 
 	// +kubebuilder:validation:Required
 	// Secret containing OpenStack password information for glance AdminPassword

diff --git a/config/crd/bases/glance.openstack.org_glanceapis.yaml b/config/crd/bases/glance.openstack.org_glanceapis.yaml
@@ -55,10 +55,9 @@ spec:
                 items:
                   type: string
                 type: array
-              databaseHostname:
+              databaseAccount:
                 type: string
-              databaseUser:
-                default: glance
+              databaseHostname:
                 type: string
               debug:
                 properties:
@@ -976,6 +975,7 @@ spec:
                 type: string
             required:
             - containerImage
+            - databaseAccount
             - databaseHostname
             - imageCacheSize
             - secret

diff --git a/config/crd/bases/glance.openstack.org_glances.yaml b/config/crd/bases/glance.openstack.org_glances.yaml
@@ -44,10 +44,9 @@ spec:
                 items:
                   type: string
                 type: array
-              databaseInstance:
+              databaseAccount:
                 type: string
-              databaseUser:
-                default: glance
+              databaseInstance:
                 type: string
               debug:
                 properties:
@@ -1019,6 +1018,7 @@ spec:
                 type: string
             required:
             - containerImage
+            - databaseAccount
             - databaseInstance
             - glanceAPIs
             - imageCacheSize

diff --git a/config/samples/backends/ceph/ceph.yaml b/config/samples/backends/ceph/ceph.yaml
@@ -19,7 +19,7 @@ spec:
         rbd_store_pool = images
         rbd_store_user = openstack
       databaseInstance: openstack
-      databaseUser: glance
+      databaseAccount: glance
       secret: osp-secret
       storageClass: ""
       storageRequest: 1G

diff --git a/config/samples/backends/multistore/multistore.yaml b/config/samples/backends/multistore/multistore.yaml
@@ -30,7 +30,7 @@ spec:
         swift_store_user = service:glance
         swift_store_endpoint_type = internalURL
       databaseInstance: openstack
-      databaseUser: glance
+      databaseAccount: glance
       glanceAPIs:
         default:
           debug:

diff --git a/config/samples/glance_v1beta1_glance.yaml b/config/samples/glance_v1beta1_glance.yaml
@@ -9,7 +9,7 @@ spec:
     debug = true
     enabled_backends=foo:bar,foo1:bar1
   databaseInstance: openstack
-  databaseUser: glance
+  databaseAccount: glance
   secret: osp-secret
   storageClass: local-storage
   storageRequest: 10G
diff --git a/config/samples/glance_v1beta1_glanceapi.yaml b/config/samples/glance_v1beta1_glanceapi.yaml
@@ -15,7 +15,7 @@ spec:
     here-foo-config
     [foo1]
     here-foo1-config
-  databaseUser: glance
+  databaseAccount: glance
   databaseHostname: glance
   debug:
     dbSync: false
@@ -34,3 +34,24 @@ spec:
   #      secretName: cert-public-svc
   #  # secret holding the tls-ca-bundle.pem to be used as a deploymend env CA bundle
   #  caBundleSecretName: combined-ca-bundle
+
+---
+
+apiVersion: mariadb.openstack.org/v1beta1
+kind: MariaDBAccount
+metadata:
+  name: glance
+spec:
+  userName: glance
+  secret: glancedb-secret
+
+---
+
+apiVersion: v1
+data:
+  # neutron123
+  DatabasePassword: bmV1dHJvbjEyMw==
+kind: Secret
+metadata:
+  name: glancedb-secret
+type: Opaque
diff --git a/config/samples/image_cache/image-cache.yaml b/config/samples/image_cache/image-cache.yaml
@@ -21,7 +21,7 @@ spec:
         store_description = "RBD backend"
         rbd_store_pool = images
         rbd_store_user = openstack
-      databaseUser: glance
+      databaseAccount: glance
       glanceAPIs:
         default:
           debug:

diff --git a/config/samples/import_plugins/image_conversion/image_conversion.yaml b/config/samples/import_plugins/image_conversion/image_conversion.yaml
@@ -24,7 +24,7 @@ spec:
     [image_conversion]
     output_format = raw
   databaseInstance: openstack
-  databaseUser: glance
+  databaseAccount: glance
   glanceAPI:
     debug:
       service: false

diff --git a/config/samples/import_plugins/image_decompression/image_decompression.yaml b/config/samples/import_plugins/image_decompression/image_decompression.yaml
@@ -21,7 +21,7 @@ spec:
     [image_import_opts]
     image_import_plugins = [image_decompression]
   databaseInstance: openstack
-  databaseUser: glance
+  databaseAccount: glance
   glanceAPI:
     debug:
       service: false

diff --git a/config/samples/import_plugins/inject_metadata/inject_metadata.yaml b/config/samples/import_plugins/inject_metadata/inject_metadata.yaml
@@ -24,7 +24,7 @@ spec:
     ignore_user_roles = admin,user1
     inject = "property1":"value1","property2":"value2"
   databaseInstance: openstack
-  databaseUser: glance
+  databaseAccount: glance
   glanceAPI:
     debug:
       service: false

diff --git a/config/samples/layout/base/glance_v1beta1_glance.yaml b/config/samples/layout/base/glance_v1beta1_glance.yaml
@@ -9,7 +9,7 @@ spec:
     debug = true
     enabled_backends=foo:bar
   databaseInstance: openstack
-  databaseUser: glance
+  databaseAccount: glance
   secret: osp-secret
   storageClass: local-storage
   storageRequest: 10G
diff --git a/config/samples/layout/edge/glance_v1beta1_glance.yaml b/config/samples/layout/edge/glance_v1beta1_glance.yaml
@@ -8,7 +8,7 @@ spec:
     [DEFAULT]
     debug = true
   databaseInstance: openstack
-  databaseUser: glance
+  databaseAccount: glance
   keystoneEndpoint: central
   glanceAPIs:
     central:

diff --git a/config/samples/layout/multiple/glance_v1beta1_glance.yaml b/config/samples/layout/multiple/glance_v1beta1_glance.yaml
@@ -8,7 +8,7 @@ spec:
     [DEFAULT]
     debug = true
   databaseInstance: openstack
-  databaseUser: glance
+  databaseAccount: glance
   keystoneEndpoint: api1
   glanceAPIs:
     api1:

diff --git a/config/samples/layout/single/glance_v1beta1_glance.yaml b/config/samples/layout/single/glance_v1beta1_glance.yaml
@@ -5,7 +5,7 @@ metadata:
 spec:
   serviceUser: glance
   databaseInstance: openstack
-  databaseUser: glance
+  databaseAccount: glance
   keystoneEndpoint: default
   customServiceConfig: |
     [DEFAULT]

diff --git a/config/samples/layout/single_tls/glance_v1beta1_glance.yaml b/config/samples/layout/single_tls/glance_v1beta1_glance.yaml
@@ -5,7 +5,7 @@ metadata:
 spec:
   serviceUser: glance
   databaseInstance: openstack
-  databaseUser: glance
+  databaseAccount: glance
   keystoneEndpoint: default
   customServiceConfig: |
     [DEFAULT]

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

diff --git a/config/samples/quotas/glance_v1beta1_glance_quota.yaml b/config/samples/quotas/glance_v1beta1_glance_quota.yaml
@@ -6,7 +6,7 @@ metadata:
 spec:
   serviceUser: glance
   databaseInstance: openstack
-  databaseUser: glance
+  databaseAccount: glance
   keystoneEndpoint: default
   glanceAPIs:
     default:

diff --git a/controllers/glance_controller.go b/controllers/glance_controller.go
@@ -210,6 +210,7 @@ func (r *GlanceReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		For(&glancev1.Glance{}).
 		Owns(&glancev1.GlanceAPI{}).
 		Owns(&mariadbv1.MariaDBDatabase{}).
+		Owns(&mariadbv1.MariaDBAccount{}).
 		Owns(&keystonev1.KeystoneService{}).
 		Owns(&corev1.PersistentVolumeClaim{}).
 		Owns(&batchv1.Job{}).
@@ -263,7 +264,7 @@ func (r *GlanceReconciler) reconcileDelete(ctx context.Context, instance *glance
 	r.Log.Info(fmt.Sprintf("Reconciling Service '%s' delete", instance.Name))
 
 	// remove db finalizer first
-	db, err := mariadbv1.GetDatabaseByName(ctx, helper, instance.Name)
+	db, err := mariadbv1.GetDatabaseByNameAndAccount(ctx, helper, instance.Name, instance.Spec.DatabaseAccount, instance.Namespace)
 	if err != nil && !k8s_errors.IsNotFound(err) {
 		return ctrl.Result{}, err
 	}
@@ -364,19 +365,23 @@ func (r *GlanceReconciler) reconcileInit(
 	//
 	// create service DB instance
 	//
-	db := mariadbv1.NewDatabase(
+	db := mariadbv1.NewDatabaseForAccount(
 		instance.Name,
-		instance.Spec.DatabaseUser,
-		instance.Spec.Secret,
 		map[string]string{
 			"dbName": instance.Spec.DatabaseInstance,
 		},
+		instance.Name,
+		instance.Spec.DatabaseAccount,
+		instance.Namespace,
 	)
+
 	// create or patch the DB
-	ctrlResult, err := db.CreateOrPatchDB(
+	ctrlResult, err := db.CreateOrPatchDBByName(
 		ctx,
 		helper,
+		instance.Spec.DatabaseInstance,
 	)
+
 	if err != nil {
 		instance.Status.Conditions.Set(condition.FalseCondition(
 			condition.DBReadyCondition,
@@ -806,7 +811,7 @@ func (r *GlanceReconciler) apiDeploymentCreateOrUpdate(
 		GlanceAPITemplate: apiTemplate,
 		APIType:           apiType,
 		DatabaseHostname:  instance.Status.DatabaseHostname,
-		DatabaseUser:      instance.Spec.DatabaseUser,
+		DatabaseAccount:   instance.Spec.DatabaseAccount,
 		Secret:            instance.Spec.Secret,
 		ExtraMounts:       instance.Spec.ExtraMounts,
 		PasswordSelectors: instance.Spec.PasswordSelectors,
@@ -886,7 +891,34 @@ func (r *GlanceReconciler) generateServiceConfig(
 ) error {
 	labels := labels.GetLabels(instance, labels.GetGroupLabel(glance.ServiceName), serviceLabels)
 
-	ospSecret, _, err := secret.GetSecret(ctx, h, instance.Spec.Secret, instance.Namespace)
+	// create a new MariaDBAccount CR to be populated here.
+	//
+	// Note that we are only looking for a MariaDBAccount CR with a name
+	// and associated Secret, but **not** an actual mariadb username in a galera
+	// database.  The account
+	// has not yet been linked to a MariaDBDatabase, so it will only exist as a
+	// CR in the cluster.  Once linked to a MariaDBDatabase, the mariadb-operator
+	// will ensure it exists with rights for that database.
+	//
+	// This is an **interim** step, where later openstack-operator will
+	// ensure that MariaDBAccounts are created for all the services it
+	// initializes, and this block would no longer be present here.
+	// At that point the DatabaseAccount field can be set to be required.
+	err := mariadbv1.InterimCreateNewAccount(
+		ctx, h, instance.Spec.DatabaseAccount, "glance", instance.Namespace,
+	)
+
+	if err != nil {
+		return err
+	}
+	// end section that would be done by openstack-operator eventually
+
+	databaseAccount, err := mariadbv1.GetAccount(ctx, h, instance.Spec.DatabaseAccount, instance.Namespace)
+	if err != nil {
+		return err
+	}
+
+	dbSecret, _, err := secret.GetSecret(ctx, h, databaseAccount.Spec.Secret, instance.Namespace)
 	if err != nil {
 		return err
 	}
@@ -896,8 +928,8 @@ func (r *GlanceReconciler) generateServiceConfig(
 	templateParameters := map[string]interface{}{
 		"MinimalConfig": true, // This tells the template to generate a minimal config
 		"DatabaseConnection": fmt.Sprintf("mysql+pymysql://%s:%s@%s/%s",
-			instance.Spec.DatabaseUser,
-			string(ospSecret.Data[instance.Spec.PasswordSelectors.Database]),
+			databaseAccount.Spec.UserName,
+			string(dbSecret.Data["DatabasePassword"]),
 			instance.Status.DatabaseHostname,
 			glance.DatabaseName,
 		),