Skip to content

Commit

Permalink
migrate from databaseUsername to databaseAccount and fully use MariaD…
Browse files Browse the repository at this point in the history 
…BAccount
  • Loading branch information
@zzzeek
zzzeek committed Mar 8, 2024
1 parent 89626df commit 046f1aa
Show file tree
Hide file tree
Showing 30 changed files with 268 additions and 168 deletions.
1 change: 1 addition & 0 deletions Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ $(GINKGO): $(LOCALBIN)
test: manifests generate fmt vet envtest ginkgo ## Run tests.
go test -v ./pkg/.. ./controllers/.. ./api/.. -coverprofile cover.out
KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" \
OPERATOR_TEMPLATES="$(shell pwd)/templates" \
$(GINKGO) --trace --cover --coverprofile cover.out --covermode=atomic --randomize-all ${PROC_CMD} $(GINKGO_ARGS) ./test/functional/...
.PHONY: gowork
gowork: export GOWORK=
Expand Down
10 changes: 3 additions & 7 deletions api/bases/manila.openstack.org_manilaapis.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ spec:
items:
type: string
type: array
databaseHostname:
type: string
databaseUser:
databaseAccount:
default: manila
type: string
databaseHostname:
type: string
extraMounts:
items:
properties:
Expand Down Expand Up @@ -871,12 +871,8 @@ spec:
type: object
passwordSelectors:
default:
database: ManilaDatabasePassword
service: ManilaPassword
properties:
database:
default: ManilaDatabasePassword
type: string
service:
default: ManilaPassword
type: string
Expand Down
10 changes: 3 additions & 7 deletions api/bases/manila.openstack.org_manilas.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ spec:
customServiceConfig:
default: '# add your customization here'
type: string
databaseInstance:
type: string
databaseUser:
databaseAccount:
default: manila
type: string
databaseInstance:
type: string
dbPurge:
properties:
age:
Expand Down Expand Up @@ -1072,12 +1072,8 @@ spec:
type: object
passwordSelectors:
default:
database: ManilaDatabasePassword
service: ManilaPassword
properties:
database:
default: ManilaDatabasePassword
type: string
service:
default: ManilaPassword
type: string
Expand Down
10 changes: 3 additions & 7 deletions api/bases/manila.openstack.org_manilaschedulers.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ spec:
items:
type: string
type: array
databaseHostname:
type: string
databaseUser:
databaseAccount:
default: manila
type: string
databaseHostname:
type: string
extraMounts:
items:
properties:
Expand Down Expand Up @@ -820,12 +820,8 @@ spec:
type: object
passwordSelectors:
default:
database: ManilaDatabasePassword
service: ManilaPassword
properties:
database:
default: ManilaDatabasePassword
type: string
service:
default: ManilaPassword
type: string
Expand Down
10 changes: 3 additions & 7 deletions api/bases/manila.openstack.org_manilashares.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ spec:
items:
type: string
type: array
databaseHostname:
type: string
databaseUser:
databaseAccount:
default: manila
type: string
databaseHostname:
type: string
extraMounts:
items:
properties:
Expand Down Expand Up @@ -820,12 +820,8 @@ spec:
type: object
passwordSelectors:
default:
database: ManilaDatabasePassword
service: ManilaPassword
properties:
database:
default: ManilaDatabasePassword
type: string
service:
default: ManilaPassword
type: string
Expand Down
16 changes: 5 additions & 11 deletions api/v1beta1/common_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,17 +45,16 @@ type ManilaTemplate struct {

// +kubebuilder:validation:Optional
// +kubebuilder:default=manila
// DatabaseUser - optional username used for manila DB, defaults to manila
// TODO: -> implement needs work in mariadb-operator, right now only manila
DatabaseUser string `json:"databaseUser,omitempty"`
// DatabaseAccount - optional MariaDBAccount CR name used for manila DB, defaults to manila
DatabaseAccount string `json:"databaseAccount"`

// +kubebuilder:validation:Optional
// Secret containing OpenStack password information for ManilaDatabasePassword, AdminPassword
// Secret containing OpenStack password information for AdminPassword
Secret string `json:"secret,omitempty"`

// +kubebuilder:validation:Optional
// +kubebuilder:default={database: ManilaDatabasePassword, service: ManilaPassword}
// PasswordSelectors - Selectors to identify the DB and ServiceUser password from the Secret
// +kubebuilder:default={service: ManilaPassword}
// PasswordSelectors - Selectors to identify the ServiceUser password from the Secret
PasswordSelectors PasswordSelector `json:"passwordSelectors,omitempty"`
}

Expand Down Expand Up @@ -92,11 +91,6 @@ type ManilaServiceTemplate struct {

// PasswordSelector to identify the DB and AdminUser password from the Secret
type PasswordSelector struct {
// +kubebuilder:validation:Optional
// +kubebuilder:default="ManilaDatabasePassword"
// Database - Selector to get the manila database user password from the Secret
// TODO: not used, need change in mariadb-operator
Database string `json:"database,omitempty"`
// +kubebuilder:validation:Optional
// +kubebuilder:default="ManilaPassword"
// Service - Selector to get the manila service password from the Secret
Expand Down
10 changes: 3 additions & 7 deletions config/crd/bases/manila.openstack.org_manilaapis.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ spec:
items:
type: string
type: array
databaseHostname:
type: string
databaseUser:
databaseAccount:
default: manila
type: string
databaseHostname:
type: string
extraMounts:
items:
properties:
Expand Down Expand Up @@ -871,12 +871,8 @@ spec:
type: object
passwordSelectors:
default:
database: ManilaDatabasePassword
service: ManilaPassword
properties:
database:
default: ManilaDatabasePassword
type: string
service:
default: ManilaPassword
type: string
Expand Down
10 changes: 3 additions & 7 deletions config/crd/bases/manila.openstack.org_manilas.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ spec:
customServiceConfig:
default: '# add your customization here'
type: string
databaseInstance:
type: string
databaseUser:
databaseAccount:
default: manila
type: string
databaseInstance:
type: string
dbPurge:
properties:
age:
Expand Down Expand Up @@ -1072,12 +1072,8 @@ spec:
type: object
passwordSelectors:
default:
database: ManilaDatabasePassword
service: ManilaPassword
properties:
database:
default: ManilaDatabasePassword
type: string
service:
default: ManilaPassword
type: string
Expand Down
10 changes: 3 additions & 7 deletions config/crd/bases/manila.openstack.org_manilaschedulers.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ spec:
items:
type: string
type: array
databaseHostname:
type: string
databaseUser:
databaseAccount:
default: manila
type: string
databaseHostname:
type: string
extraMounts:
items:
properties:
Expand Down Expand Up @@ -820,12 +820,8 @@ spec:
type: object
passwordSelectors:
default:
database: ManilaDatabasePassword
service: ManilaPassword
properties:
database:
default: ManilaDatabasePassword
type: string
service:
default: ManilaPassword
type: string
Expand Down
10 changes: 3 additions & 7 deletions config/crd/bases/manila.openstack.org_manilashares.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ spec:
items:
type: string
type: array
databaseHostname:
type: string
databaseUser:
databaseAccount:
default: manila
type: string
databaseHostname:
type: string
extraMounts:
items:
properties:
Expand Down Expand Up @@ -820,12 +820,8 @@ spec:
type: object
passwordSelectors:
default:
database: ManilaDatabasePassword
service: ManilaPassword
properties:
database:
default: ManilaDatabasePassword
type: string
service:
default: ManilaPassword
type: string
Expand Down
64 changes: 48 additions & 16 deletions controllers/manila_controller.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ func (r *ManilaReconciler) reconcileDelete(ctx context.Context, instance *manila
r.Log.Info(fmt.Sprintf("Reconciling Service '%s' delete", instance.Name))

// remove db finalizer first
db, err := mariadbv1.GetDatabaseByName(ctx, helper, manila.DatabaseName)
db, err := mariadbv1.GetDatabaseByNameAndAccount(ctx, helper, manila.DatabaseCRName, instance.Spec.DatabaseAccount, instance.Namespace)
if err != nil && !k8s_errors.IsNotFound(err) {
return ctrl.Result{}, err
}
Expand Down Expand Up @@ -664,6 +664,14 @@ func (r *ManilaReconciler) reconcileNormal(ctx context.Context, instance *manila
r.Log.Info(fmt.Sprintf("Deployment %s successfully reconciled - operation: %s", instance.Name, string(op)))
}

// remove finalizers from unused MariaDBAccount records
err = mariadbv1.DeleteUnusedMariaDBAccountFinalizers(
ctx, helper, manila.DatabaseCRName,
instance.Spec.DatabaseAccount, instance.Namespace)
if err != nil {
return ctrl.Result{}, err
}

// Mirror ManilaAPI status' ReadyCount to this parent CR
instance.Status.ManilaAPIReadyCount = manilaAPI.Status.ReadyCount

Expand Down Expand Up @@ -843,6 +851,9 @@ func (r *ManilaReconciler) generateServiceConfig(
return err
}

databaseAccount := db.GetAccount()
databaseSecret := db.GetSecret()

// templateParameters := make(map[string]interface{})
templateParameters := map[string]interface{}{
"ServiceUser": instance.Spec.ServiceUser,
Expand All @@ -851,10 +862,10 @@ func (r *ManilaReconciler) generateServiceConfig(
"KeystoneInternalURL": keystoneInternalURL,
"TransportURL": string(transportURLSecret.Data["transport_url"]),
"DatabaseConnection": fmt.Sprintf("mysql+pymysql://%s:%s@%s/%s?read_default_file=/etc/my.cnf",
instance.Spec.DatabaseUser,
string(ospSecret.Data[instance.Spec.PasswordSelectors.Database]),
databaseAccount.Spec.UserName,
string(databaseSecret.Data[mariadbv1.DatabasePasswordSelector]),
instance.Status.DatabaseHostname,
manila.DatabaseName),
manila.DatabaseCRName),
"MemcachedServersWithInet": strings.Join(memcached.Status.ServerListWithInet, ","),
}

Expand Down Expand Up @@ -1073,24 +1084,45 @@ func (r *ManilaReconciler) ensureDB(
h *helper.Helper,
instance *manilav1beta1.Manila,
) (*mariadbv1.Database, ctrl.Result, error) {
// ensure MariaDBAccount exists. This account record may be created by
// openstack-operator or the cloud operator up front without a specific
// MariaDBDatabase configured yet. Otherwise, a MariaDBAccount CR is
// created here with a generated username as well as a secret with
// generated password. The MariaDBAccount is created without being
// yet associated with any MariaDBDatabase.
_, _, err := mariadbv1.EnsureMariaDBAccount(
ctx, h, instance.Spec.DatabaseAccount,
instance.Namespace, false, manila.DatabaseUsernamePrefix,
)

if err != nil {
instance.Status.Conditions.Set(condition.FalseCondition(
mariadbv1.MariaDBAccountReadyCondition,
condition.ErrorReason,
condition.SeverityWarning,
mariadbv1.MariaDBAccountNotReadyMessage,
err.Error()))

return nil, ctrl.Result{}, err
}
instance.Status.Conditions.MarkTrue(
mariadbv1.MariaDBAccountReadyCondition,
mariadbv1.MariaDBAccountReadyMessage)

//
// create service DB instance
//
db := mariadbv1.NewDatabase(
manila.DatabaseName,
instance.Spec.DatabaseUser,
instance.Spec.Secret,
map[string]string{
"dbName": instance.Spec.DatabaseInstance,
},
db := mariadbv1.NewDatabaseForAccount(
instance.Spec.DatabaseInstance, // mariadb/galera service to target
manila.DatabaseName, // name used in CREATE DATABASE in mariadb
manila.DatabaseCRName, // CR name for MariaDBDatabase
instance.Spec.DatabaseAccount, // CR name for MariaDBAccount
instance.Namespace, // namespace
)

// create or patch the DB
ctrlResult, err := db.CreateOrPatchDBByName(
ctx,
h,
instance.Spec.DatabaseInstance,
)
ctrlResult, err := db.CreateOrPatchAll(ctx, h)

if err != nil {
instance.Status.Conditions.Set(condition.FalseCondition(
condition.DBReadyCondition,
Expand Down
2 changes: 1 addition & 1 deletion controllers/manilaapi_controller.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -941,7 +941,7 @@ func (r *ManilaAPIReconciler) generateServiceConfig(

labels := labels.GetLabels(instance, labels.GetGroupLabel(manila.ServiceName), serviceLabels)

db, err := mariadbv1.GetDatabaseByName(ctx, h, manila.DatabaseName)
db, err := mariadbv1.GetDatabaseByNameAndAccount(ctx, h, manila.DatabaseCRName, instance.Spec.DatabaseAccount, instance.Namespace)
if err != nil {
return err
}
Expand Down
2 changes: 1 addition & 1 deletion controllers/manilascheduler_controller.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -647,7 +647,7 @@ func (r *ManilaSchedulerReconciler) generateServiceConfig(

labels := labels.GetLabels(instance, labels.GetGroupLabel(manila.ServiceName), serviceLabels)

db, err := mariadbv1.GetDatabaseByName(ctx, h, manila.DatabaseName)
db, err := mariadbv1.GetDatabaseByNameAndAccount(ctx, h, manila.DatabaseCRName, instance.Spec.DatabaseAccount, instance.Namespace)
if err != nil {
return err
}
Expand Down
2 changes: 1 addition & 1 deletion controllers/manilashare_controller.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -644,7 +644,7 @@ func (r *ManilaShareReconciler) generateServiceConfig(

labels := labels.GetLabels(instance, labels.GetGroupLabel(manila.ServiceName), serviceLabels)

db, err := mariadbv1.GetDatabaseByName(ctx, h, manila.DatabaseName)
db, err := mariadbv1.GetDatabaseByNameAndAccount(ctx, h, manila.DatabaseCRName, instance.Spec.DatabaseAccount, instance.Namespace)
if err != nil {
return err
}
Expand Down
Loading

0 comments on commit 046f1aa

Please sign in to comment.