Skip to content

Commit

Permalink
Remove infinite loop from parameter update state machine (#283)
Browse files Browse the repository at this point in the history 
Avoid infinite loops in the parameter update state machine and instead synchronize the state machine with the reconcile loops of the instance controller.

b/255642316

Change-Id: Ic5d36c98c8fdb3dea7391fb0145c5f89bbe4034b
  • Loading branch information
@akinfermo
akinfermo committed Nov 23, 2022
1 parent 659f93a commit 5e54bc8
Show file tree
Hide file tree
Showing 5 changed files with 86 additions and 68 deletions.
13 changes: 7 additions & 6 deletions oracle/controllers/common.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,13 @@ const (
RestoreInProgress = "Restore" + StatusInProgress
CreateInProgress = "Create" + StatusInProgress

PITRLabel = "pitr"
IncarnationLabel = "incarnation"
ParentIncarnationLabel = "parent-incarnation"
SCNAnnotation = "scn"
TimestampAnnotation = "timestamp"
DatabaseImageAnnotation = "database-image"
PITRLabel = "pitr"
IncarnationLabel = "incarnation"
ParentIncarnationLabel = "parent-incarnation"
SCNAnnotation = "scn"
TimestampAnnotation = "timestamp"
DatabaseImageAnnotation = "database-image"
ParameterUpdateStateMachine = "ParameterUpdateStateMachine"
)

var (
Expand Down
11 changes: 3 additions & 8 deletions oracle/controllers/instancecontroller/instance_controller.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -166,15 +166,10 @@ func (r *InstanceReconciler) Reconcile(_ context.Context, req ctrl.Request) (_ c
return r.standbyStateMachine(ctx, &inst, log)
}

// If the instance and database is ready, we can set the instance parameters
if k8s.ConditionStatusEquals(instanceReadyCond, v1.ConditionTrue) &&
k8s.ConditionStatusEquals(dbInstanceCond, v1.ConditionTrue) && inst.Spec.Parameters != nil {
log.Info("instance and db is ready, setting instance parameters")

if result, err := r.setInstanceParameterStateMachine(ctx, req, inst, log); err != nil {
return result, err
}
if result, err := r.parameterUpdateStateMachine(ctx, req, inst, log); err != nil {
return result, err
}

// If the instance and database is ready, we can set the instance parameters
if k8s.ConditionStatusEquals(instanceReadyCond, v1.ConditionTrue) &&
k8s.ConditionStatusEquals(dbInstanceCond, v1.ConditionTrue) && (inst.Spec.EnableDnfs != inst.Status.DnfsEnabled) {
Expand Down
123 changes: 72 additions & 51 deletions oracle/controllers/instancecontroller/instance_controller_parameters.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -170,10 +170,14 @@ func (r *InstanceReconciler) setParameters(ctx context.Context, inst v1alpha1.In
return requireDatabaseRestart, nil
}

// setInstanceParameterStateMachine guides the transition of parameter update
// parameterUpdateStateMachine guides the transition of the parameter update
// workflow to the next possible state based on the current state and the outcome
// of the task associated with the current state.
func (r *InstanceReconciler) setInstanceParameterStateMachine(ctx context.Context, req ctrl.Request, inst v1alpha1.Instance, log logr.Logger) (ctrl.Result, error) {
func (r *InstanceReconciler) parameterUpdateStateMachine(ctx context.Context, req ctrl.Request, inst v1alpha1.Instance, log logr.Logger) (ctrl.Result, error) {

if !isParameterUpdateStateMachineEntryCondition(&inst) {
return ctrl.Result{}, nil
}

// If the current parameter state is equal to the requested state skip the update
if eq := reflect.DeepEqual(inst.Spec.Parameters, inst.Status.CurrentParameters); eq {
Expand All @@ -189,60 +193,77 @@ func (r *InstanceReconciler) setInstanceParameterStateMachine(ctx context.Contex
return result, err
}

_, dynamicParamsRollbackState, err := fetchCurrentParameterState(ctx, r, r.DatabaseClientFactory, inst)
if err != nil {
msg := "setInstanceParameterStateMachine: Sanity check failed for instance parameters"
r.recordEventAndUpdateStatus(ctx, &inst, v1.ConditionFalse, k8s.ParameterUpdateRollback, fmt.Sprintf("%s: %v", msg, err), log)
return ctrl.Result{}, err
}
log.Info("parameterUpdateStateMachine: Entered state machine")
instanceReadyCond := k8s.FindCondition(inst.Status.Conditions, k8s.Ready)
switch instanceReadyCond.Reason {
case k8s.CreateComplete:
inst.Status.CurrentActiveStateMachine = controllers.ParameterUpdateStateMachine

log.Info("setInstanceParameterStateMachine: entering state machine")
for true {
instanceReadyCond := k8s.FindCondition(inst.Status.Conditions, k8s.Ready)
switch instanceReadyCond.Reason {
case k8s.CreateComplete:
msg := "setInstanceParameterStateMachine: parameter update in progress"
r.recordEventAndUpdateStatus(ctx, &inst, v1.ConditionFalse, k8s.ParameterUpdateInProgress, msg, log)
log.Info("setInstanceParameterStateMachine: SM CreateComplete -> ParameterUpdateInProgress")
case k8s.ParameterUpdateInProgress:
restartRequired, err := r.setParameters(ctx, inst, log)
if err != nil {
msg := "setInstanceParameterStateMachine: Error while setting instance parameters"
r.recordEventAndUpdateStatus(ctx, &inst, v1.ConditionFalse, k8s.ParameterUpdateRollback, fmt.Sprintf("%s: %v", msg, err), log)
log.Info("setInstanceParameterStateMachine: SM ParameterUpdateInProgress -> ParameterUpdateRollback")
break
}
if restartRequired {
log.Info("setInstanceParameterStateMachine: static parameter specified in config, scheduling restart to activate them")
if err := controllers.BounceDatabase(ctx, r, r.DatabaseClientFactory, inst.Namespace, inst.Name, controllers.BounceDatabaseRequest{
Sid: inst.Spec.CDBName,
}); err != nil {
msg := "setInstanceParameterStateMachine: error while restarting database after setting static parameters"
r.recordEventAndUpdateStatus(ctx, &inst, v1.ConditionFalse, k8s.ParameterUpdateRollback, fmt.Sprintf("%s: %v", msg, err), log)
log.Info("setInstanceParameterStateMachine: SM ParameterUpdateInProgress -> ParameterUpdateRollback")
break
}
}
msg := "setInstanceParameterStateMachine: Parameter update successful"
inst.Status.CurrentParameters = inst.Spec.Parameters
r.recordEventAndUpdateStatus(ctx, &inst, v1.ConditionTrue, k8s.CreateComplete, msg, log)
log.Info("setInstanceParameterStateMachine: SM ParameterUpdateInProgress -> CreateComplete")
return ctrl.Result{}, nil
case k8s.ParameterUpdateRollback:
if err := r.initiateRecovery(ctx, inst, dynamicParamsRollbackState, log); err != nil {
log.Info("setInstanceParameterStateMachine: recovery failed, instance currently in irrecoverable state", "err", err)
return ctrl.Result{}, err
_, dynamicParamsRollbackState, err := fetchCurrentParameterState(ctx, r, r.DatabaseClientFactory, inst)
if err != nil {
msg := "parameterUpdateStateMachine: Sanity check failed for instance parameters"
r.recordEventAndUpdateStatus(ctx, &inst, v1.ConditionFalse, k8s.ParameterUpdateRollbackInProgress, fmt.Sprintf("%s: %v", msg, err), log)
return ctrl.Result{Requeue: true}, err
}
inst.Status.CurrentParameters = dynamicParamsRollbackState

msg := "parameterUpdateStateMachine: parameter update in progress"
r.recordEventAndUpdateStatus(ctx, &inst, v1.ConditionFalse, k8s.ParameterUpdateInProgress, msg, log)
log.Info("parameterUpdateStateMachine: SM CreateComplete -> ParameterUpdateInProgress")

case k8s.ParameterUpdateInProgress:
restartRequired, err := r.setParameters(ctx, inst, log)
if err != nil {
msg := "parameterUpdateStateMachine: Error while setting instance parameters"
r.recordEventAndUpdateStatus(ctx, &inst, v1.ConditionFalse, k8s.ParameterUpdateRollbackInProgress, fmt.Sprintf("%s: %v", msg, err), log)
log.Info("parameterUpdateStateMachine: SM ParameterUpdateInProgress -> ParameterUpdateRollbackInProgress")
return ctrl.Result{Requeue: true}, nil
}
if restartRequired {
log.Info("parameterUpdateStateMachine: static parameter specified in config, scheduling restart to activate them")
if err := controllers.BounceDatabase(ctx, r, r.DatabaseClientFactory, inst.Namespace, inst.Name, controllers.BounceDatabaseRequest{
Sid: inst.Spec.CDBName,
}); err != nil {
msg := "parameterUpdateStateMachine: error while restarting database after setting static parameters"
r.recordEventAndUpdateStatus(ctx, &inst, v1.ConditionFalse, k8s.ParameterUpdateRollbackInProgress, fmt.Sprintf("%s: %v", msg, err), log)
log.Info("parameterUpdateStateMachine: SM ParameterUpdateInProgress -> ParameterUpdateRollbackInProgress")
return ctrl.Result{Requeue: true}, nil
}
inst.Status.LastFailedParameterUpdate = inst.Spec.Parameters
msg := "setInstanceParameterStateMachine: instance recovered after bad parameter update"
r.recordEventAndUpdateStatus(ctx, &inst, v1.ConditionTrue, k8s.CreateComplete, msg, log)
log.Info("setInstanceParameterStateMachine: SM ParameterUpdateRollback -> CreateComplete")
return ctrl.Result{}, nil
}
r.recordEventAndUpdateStatus(ctx, &inst, v1.ConditionFalse, k8s.ParameterUpdateComplete, "", log)
log.Info("parameterUpdateStateMachine: SM ParameterUpdateInProgress -> ParameterUpdateComplete")
return ctrl.Result{Requeue: true}, nil

case k8s.ParameterUpdateComplete:
inst.Status.CurrentParameters = inst.Spec.Parameters
msg := "parameterUpdateStateMachine: Parameter update successful"
r.recordEventAndUpdateStatus(ctx, &inst, v1.ConditionTrue, k8s.CreateComplete, msg, log)
inst.Status.CurrentActiveStateMachine = ""
log.Info("parameterUpdateStateMachine: SM ParameterUpdateComplete -> CreateComplete")
return ctrl.Result{}, nil

case k8s.ParameterUpdateRollbackInProgress:
if err := r.initiateRecovery(ctx, inst, inst.Status.CurrentParameters, log); err != nil {
log.Info("parameterUpdateStateMachine: recovery failed, instance currently in irrecoverable state", "err", err)
return ctrl.Result{}, err
}
inst.Status.LastFailedParameterUpdate = inst.Spec.Parameters
msg := "parameterUpdateStateMachine: instance recovered after bad parameter update"
r.recordEventAndUpdateStatus(ctx, &inst, v1.ConditionTrue, k8s.CreateComplete, msg, log)
inst.Status.CurrentActiveStateMachine = ""
log.Info("parameterUpdateStateMachine: SM ParameterUpdateRollbackInProgress -> CreateComplete")
return ctrl.Result{}, nil
}
return ctrl.Result{}, nil
}

func isParameterUpdateStateMachineEntryCondition(inst *v1alpha1.Instance) bool {
instanceReadyCond := k8s.FindCondition(inst.Status.Conditions, k8s.Ready)
dbInstanceCond := k8s.FindCondition(inst.Status.Conditions, k8s.DatabaseInstanceReady)
return controllers.ParameterUpdateStateMachine == inst.Status.CurrentActiveStateMachine ||
(k8s.ConditionStatusEquals(instanceReadyCond, v1.ConditionTrue) && k8s.ConditionStatusEquals(dbInstanceCond, v1.ConditionTrue) && inst.Spec.Parameters != nil)
}

// initiateRecovery will recover the config file (which contains the static
// parameters) to the last known working copy if the static
// parameter update failed (which caused the database to be non-functional
Expand Down Expand Up @@ -295,8 +316,8 @@ func (r *InstanceReconciler) sanityCheckTimeRange(inst v1alpha1.Instance, log lo

// Otherwise: requeue for processing when the maintenance window opens up.
restartWaitTime := nextStart.Sub(now)
log.Info("setInstanceParameterStateMachine: Wait time before restart ", "restartWaitTime", restartWaitTime.Seconds())
return ctrl.Result{RequeueAfter: restartWaitTime}, errors.New("current time is not within the maintenance time range")
log.Info("parameterUpdateStateMachine: Wait time before restart ", "restartWaitTime", restartWaitTime.Seconds())
return ctrl.Result{RequeueAfter: restartWaitTime}, errors.New("current time is not within the maintenance window")
}

func mapsToStringArray(parameterMap map[string]string) []string {
Expand Down
2 changes: 1 addition & 1 deletion oracle/controllers/inttest/parameterupdatetest/parameter_update_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ var _ = Describe("ParameterUpdate", func() {
})

// Verify the instance transitions to ParameterUpdateRollback state due to database unable to restart.
testhelpers.WaitForInstanceConditionState(k8sEnv, instKey, k8s.Ready, metav1.ConditionFalse, k8s.ParameterUpdateRollback, 5*time.Minute)
testhelpers.WaitForInstanceConditionState(k8sEnv, instKey, k8s.Ready, metav1.ConditionFalse, k8s.ParameterUpdateRollbackInProgress, 5*time.Minute)

// Wait until the instance settles into "Ready" again
testhelpers.WaitForInstanceConditionState(k8sEnv, instKey, k8s.Ready, metav1.ConditionTrue, k8s.CreateComplete, 20*time.Minute)
Expand Down
5 changes: 3 additions & 2 deletions oracle/pkg/k8s/condition.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,9 @@ const (
ExportInProgress = "ExportInProgress"
ExportPending = "ExportPending"

ParameterUpdateInProgress = "ParameterUpdateInProgress"
ParameterUpdateRollback = "ParameterUpdateRollback"
ParameterUpdateInProgress = "ParameterUpdateInProgress"
ParameterUpdateComplete = "ParameterUpdateComplete"
ParameterUpdateRollbackInProgress = "ParameterUpdateRollbackInProgress"

StandbyDRInProgress = "StandbyDRInProgress"
StandbyDRVerifyCompleted = "StandbyDRVerifyCompleted"
Expand Down

0 comments on commit 5e54bc8

Please sign in to comment.