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

Simplify DataScienceCluster conditions #1501

Closed
wants to merge 1 commit into from
Closed

Simplify DataScienceCluster conditions #1501

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
4 changes: 2 additions & 2 deletions controllers/components/modelcontroller/modelcontroller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@
dscv1 "github.com/opendatahub-io/opendatahub-operator/v2/apis/datasciencecluster/v1"
"github.com/opendatahub-io/opendatahub-operator/v2/controllers/status"
"github.com/opendatahub-io/opendatahub-operator/v2/pkg/cluster"
"github.com/opendatahub-io/opendatahub-operator/v2/pkg/componentsregistry"
cr "github.com/opendatahub-io/opendatahub-operator/v2/pkg/componentsregistry"
odhdeploy "github.com/opendatahub-io/opendatahub-operator/v2/pkg/deploy"
"github.com/opendatahub-io/opendatahub-operator/v2/pkg/metadata/annotations"
)

type componentHandler struct{}

func init() { //nolint:gochecknoinits
componentsregistry.Add(&componentHandler{})
cr.Add(&componentHandler{})
}

func (s *componentHandler) GetName() string {
Expand Down
4 changes: 2 additions & 2 deletions controllers/components/modelmeshserving/modelmeshserving.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@
dscv1 "github.com/opendatahub-io/opendatahub-operator/v2/apis/datasciencecluster/v1"
"github.com/opendatahub-io/opendatahub-operator/v2/controllers/status"
"github.com/opendatahub-io/opendatahub-operator/v2/pkg/cluster"
"github.com/opendatahub-io/opendatahub-operator/v2/pkg/componentsregistry"
cr "github.com/opendatahub-io/opendatahub-operator/v2/pkg/componentsregistry"
odhdeploy "github.com/opendatahub-io/opendatahub-operator/v2/pkg/deploy"
"github.com/opendatahub-io/opendatahub-operator/v2/pkg/metadata/annotations"
)

type componentHandler struct{}

func init() { //nolint:gochecknoinits
componentsregistry.Add(&componentHandler{})
cr.Add(&componentHandler{})
}

func (s *componentHandler) GetName() string {
Expand Down
138 changes: 9 additions & 129 deletions controllers/datasciencecluster/datasciencecluster_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,9 @@
"slices"
"strings"

operatorv1 "github.com/openshift/api/operator/v1"
conditionsv1 "github.com/openshift/custom-resource-status/conditions/v1"
corev1 "k8s.io/api/core/v1"
k8serr "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/tools/record"
Expand All @@ -39,12 +36,10 @@
logf "sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/reconcile"

"github.com/opendatahub-io/opendatahub-operator/v2/apis/common"
componentApi "github.com/opendatahub-io/opendatahub-operator/v2/apis/components/v1alpha1"
dscv1 "github.com/opendatahub-io/opendatahub-operator/v2/apis/datasciencecluster/v1"
dsciv1 "github.com/opendatahub-io/opendatahub-operator/v2/apis/dscinitialization/v1"
"github.com/opendatahub-io/opendatahub-operator/v2/controllers/status"
"github.com/opendatahub-io/opendatahub-operator/v2/pkg/cluster"
cr "github.com/opendatahub-io/opendatahub-operator/v2/pkg/componentsregistry"
odhClient "github.com/opendatahub-io/opendatahub-operator/v2/pkg/controller/client"
"github.com/opendatahub-io/opendatahub-operator/v2/pkg/controller/handlers"
Expand Down Expand Up @@ -97,14 +92,18 @@
// validate pre-requisites
if err := r.validate(ctx, instance); err != nil {
log.Info(err.Error())
status.SetCondition(&instance.Status.Conditions, "Degraded", status.ReconcileFailed, err.Error(), corev1.ConditionTrue)

status.SetCondition(
&instance.Status.Conditions,
string(conditionsv1.ConditionAvailable),
status.DegradedReason,
err.Error(),
corev1.ConditionFalse,
)
}

// deploy components
if err := r.reconcileComponents(ctx, instance, cr.DefaultRegistry()); err != nil {
log.Info(err.Error())
status.SetCondition(&instance.Status.Conditions, "Degraded", status.ReconcileFailed, err.Error(), corev1.ConditionTrue)
}
reconcileComponents(ctx, r.Client, instance, cr.DefaultRegistry())

// keep conditions sorted
slices.SortFunc(instance.Status.Conditions, func(a, b conditionsv1.Condition) int {
Expand Down Expand Up @@ -150,125 +149,6 @@
return nil
}

func (r *DataScienceClusterReconciler) reconcileComponents(
ctx context.Context,
instance *dscv1.DataScienceCluster,
reg *cr.Registry) error {
log := logf.FromContext(ctx).WithName("DataScienceCluster")

notReadyComponents := make([]string, 0)

// all DSC defined components
componentErrors := reg.ForEach(func(component cr.ComponentHandler) error {
ci, err := r.reconcileComponent(ctx, instance, component)
if err != nil {
return err
}

if !cr.IsManaged(component, instance) {
return nil
}

if !meta.IsStatusConditionTrue(ci.GetStatus().Conditions, status.ConditionTypeReady) {
notReadyComponents = append(notReadyComponents, component.GetName())
}

return nil
})

// Process errors for components
if componentErrors != nil {
log.Info("DataScienceCluster Deployment Incomplete.")

status.SetCompleteCondition(
&instance.Status.Conditions,
status.ReconcileCompletedWithComponentErrors,
fmt.Sprintf("DataScienceCluster resource reconciled with component errors: %v", componentErrors),
)

r.Recorder.Eventf(instance, corev1.EventTypeNormal,
"DataScienceClusterComponentFailures",
"DataScienceCluster instance %s created, but have some failures in component %v", instance.Name, componentErrors)
} else {
log.Info("DataScienceCluster Deployment Completed.")

// finalize reconciliation
status.SetCompleteCondition(
&instance.Status.Conditions,
status.ReconcileCompleted,
"DataScienceCluster resource reconciled successfully",
)
}

if len(notReadyComponents) != 0 {
instance.Status.Phase = status.PhaseNotReady

conditionsv1.SetStatusCondition(&instance.Status.Conditions, conditionsv1.Condition{
Type: conditionsv1.ConditionType(status.ConditionTypeReady),
Status: corev1.ConditionFalse,
Reason: "NotReady",
Message: fmt.Sprintf("Some components are not ready: %s", strings.Join(notReadyComponents, ",")),
})
} else {
instance.Status.Phase = status.PhaseReady

conditionsv1.SetStatusCondition(&instance.Status.Conditions, conditionsv1.Condition{
Type: conditionsv1.ConditionType(status.ConditionTypeReady),
Status: corev1.ConditionTrue,
Reason: "Ready",
Message: "Ready",
})
}

instance.Status.Release = cluster.GetRelease()
instance.Status.ObservedGeneration = instance.Generation

if componentErrors != nil {
return componentErrors
}

return nil
}

func (r *DataScienceClusterReconciler) reconcileComponent(
ctx context.Context,
instance *dscv1.DataScienceCluster,
component cr.ComponentHandler,
) (common.PlatformObject, error) {
ms := component.GetManagementState(instance)
componentCR := component.NewCRObject(instance)

switch ms {
case operatorv1.Managed:
err := ctrl.SetControllerReference(instance, componentCR, r.Scheme)
if err != nil {
return nil, err
}
err = r.Client.Apply(ctx, componentCR, client.FieldOwner(fieldOwner), client.ForceOwnership)
if err != nil {
return nil, err
}
case operatorv1.Removed:
err := r.Client.Delete(ctx, componentCR, client.PropagationPolicy(metav1.DeletePropagationForeground))
if err != nil && !k8serr.IsNotFound(err) {
return nil, err
}
default:
return nil, fmt.Errorf("unsupported management state: %s", ms)
}

if instance.Status.InstalledComponents == nil {
instance.Status.InstalledComponents = make(map[string]bool)
}

err := component.UpdateDSCStatus(instance, componentCR)
if err != nil {
return nil, fmt.Errorf("failed to update status of DataScienceCluster component %s: %w", component.GetName(), err)
}

return componentCR, nil
}

func (r *DataScienceClusterReconciler) reportError(ctx context.Context, err error, instance *dscv1.DataScienceCluster, message string) {
logf.FromContext(ctx).Error(err, message, "instance.Name", instance.Name)
r.Recorder.Eventf(instance, corev1.EventTypeWarning, "DataScienceClusterReconcileError",
Expand Down
Loading