Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable status subresource for instance CRD #1044

Merged
merged 1 commit into from
Nov 19, 2019
Merged

Enable status subresource for instance CRD #1044

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions config/crds/kudo_v1beta1_instance.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ spec:
plural: instances
singular: instance
scope: Namespaced
subresources:
status: {}
validation:
openAPIV3Schema:
properties:
Expand Down
1 change: 1 addition & 0 deletions pkg/apis/kudo/v1beta1/instance_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@ func (i *Instance) EnsurePlanStatusInitialized(ov *OperatorVersion) {
}

// StartPlanExecution mark plan as to be executed
// this modifies the instance.Status as well as instance.Metadata.Annotation (to save snapshot if needed)
func (i *Instance) StartPlanExecution(planName string, ov *OperatorVersion) error {
if i.NoPlanEverExecuted() || isUpgradePlan(planName) {
i.EnsurePlanStatusInitialized(ov)
Expand Down
35 changes: 28 additions & 7 deletions pkg/controller/instance/instance_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
"errors"
"fmt"
"log"
"reflect"
"time"

"github.com/kudobuilder/kudo/pkg/engine/renderer"
Expand Down Expand Up @@ -126,6 +127,7 @@ func (r *Reconciler) Reconcile(request ctrl.Request) (ctrl.Result, error) {

log.Printf("InstanceController: Received Reconcile request for instance \"%+v\"", request.Name)
instance, err := r.getInstance(request)
oldInstance := instance.DeepCopy()
if err != nil {
if apierrors.IsNotFound(err) { // not retrying if instance not found, probably someone manually removed it?
log.Printf("Instances in namespace %s not found, not retrying reconcile since this error is usually not recoverable (without manual intervention).", request.NamespacedName)
Expand All @@ -149,7 +151,7 @@ func (r *Reconciler) Reconcile(request ctrl.Request) (ctrl.Result, error) {
log.Printf("InstanceController: Going to start execution of plan %s on instance %s/%s", kudo.StringValue(planToBeExecuted), instance.Namespace, instance.Name)
err = instance.StartPlanExecution(kudo.StringValue(planToBeExecuted), ov)
if err != nil {
return reconcile.Result{}, r.handleError(err, instance)
return reconcile.Result{}, r.handleError(err, instance, oldInstance)
}
r.Recorder.Event(instance, "Normal", "PlanStarted", fmt.Sprintf("Execution of plan %s started", kudo.StringValue(planToBeExecuted)))
}
Expand All @@ -174,7 +176,7 @@ func (r *Reconciler) Reconcile(request ctrl.Request) (ctrl.Result, error) {

activePlan, err := preparePlanExecution(instance, ov, activePlanStatus)
if err != nil {
err = r.handleError(err, instance)
err = r.handleError(err, instance, oldInstance)
return reconcile.Result{}, err
}
log.Printf("InstanceController: Going to proceed in execution of active plan %s on instance %s/%s", activePlan.Name, instance.Namespace, instance.Name)
Expand All @@ -185,13 +187,13 @@ func (r *Reconciler) Reconcile(request ctrl.Request) (ctrl.Result, error) {
instance.UpdateInstanceStatus(newStatus)
}
if err != nil {
err = r.handleError(err, instance)
err = r.handleError(err, instance, oldInstance)
return reconcile.Result{}, err
}

err = r.Client.Update(context.TODO(), instance)
err = updateInstance(instance, oldInstance, r.Client)
if err != nil {
log.Printf("InstanceController: Error when updating instance state. %v", err)
log.Printf("InstanceController: Error when updating instance. %v", err)
return reconcile.Result{}, err
}

Expand All @@ -202,6 +204,25 @@ func (r *Reconciler) Reconcile(request ctrl.Request) (ctrl.Result, error) {
return reconcile.Result{}, nil
}

func updateInstance(instance *kudov1beta1.Instance, oldInstance *kudov1beta1.Instance, client client.Client) error {
if !reflect.DeepEqual(instance.Spec, oldInstance.Spec) || !reflect.DeepEqual(instance.ObjectMeta.Annotations, oldInstance.ObjectMeta.Annotations) {
instanceStatus := instance.Status.DeepCopy()
err := client.Update(context.TODO(), instance)
if err != nil {
log.Printf("InstanceController: Error when updating instance spec. %v", err)
return err
}
instance.Status = *instanceStatus
}

err := client.Status().Update(context.TODO(), instance)
if err != nil {
log.Printf("InstanceController: Error when updating instance status. %v", err)
return err
}
return nil
}

func preparePlanExecution(instance *kudov1beta1.Instance, ov *kudov1beta1.OperatorVersion, activePlanStatus *kudov1beta1.PlanStatus) (*workflow.ActivePlan, error) {
params := getParameters(instance, ov)

Expand All @@ -223,11 +244,11 @@ func preparePlanExecution(instance *kudov1beta1.Instance, ov *kudov1beta1.Operat
// handleError handles execution error by logging, updating the plan status and optionally publishing an event
// specify eventReason as nil if you don't wish to publish a warning event
// returns err if this err should be retried, nil otherwise
func (r *Reconciler) handleError(err error, instance *kudov1beta1.Instance) error {
func (r *Reconciler) handleError(err error, instance *kudov1beta1.Instance, oldInstance *kudov1beta1.Instance) error {
log.Printf("InstanceController: %v", err)

// first update instance as we want to propagate errors also to the `Instance.Status.PlanStatus`
clientErr := r.Client.Update(context.TODO(), instance)
clientErr := updateInstance(instance, oldInstance, r.Client)
if clientErr != nil {
log.Printf("InstanceController: Error when updating instance state. %v", clientErr)
return clientErr
Expand Down
2 changes: 2 additions & 0 deletions pkg/kudoctl/cmd/init/crds.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,8 @@ func instanceCrd() *apiextv1beta1.CustomResourceDefinition {
Properties: validationProps,
},
}

crd.Spec.Subresources = &apiextv1beta1.CustomResourceSubresources{Status: &apiextv1beta1.CustomResourceSubresourceStatus{}}
return crd
}

Expand Down
2 changes: 2 additions & 0 deletions pkg/kudoctl/cmd/testdata/deploy-kudo-ns-default.yaml.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,8 @@ spec:
plural: instances
singular: instance
scope: Namespaced
subresources:
status: {}
validation:
openAPIV3Schema:
properties:
Expand Down
2 changes: 2 additions & 0 deletions pkg/kudoctl/cmd/testdata/deploy-kudo-ns.yaml.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,8 @@ spec:
plural: instances
singular: instance
scope: Namespaced
subresources:
status: {}
validation:
openAPIV3Schema:
properties:
Expand Down
2 changes: 2 additions & 0 deletions pkg/kudoctl/cmd/testdata/deploy-kudo.yaml.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,8 @@ spec:
plural: instances
singular: instance
scope: Namespaced
subresources:
status: {}
validation:
openAPIV3Schema:
properties:
Expand Down