Report reconciliation errors as part of the component' status (pt1) #1684
+1,368
−476
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
lburgazzoli
force-pushed
the
conditions-manager
branch
from
6480990 to
806a697
Compare
|
/test opendatahub-operator-e2e |
2 similar comments
|
/test opendatahub-operator-e2e |
|
/test opendatahub-operator-e2e |
|
/test all |
|
/test opendatahub-operator-e2e |
lburgazzoli
force-pushed
the
conditions-manager
branch
from
86f903e to
6f3ab48
Compare
zdtsw
reviewed
Feb 26, 2025
| if err := cli.Get(ctx, client.ObjectKey{Name: kserveConfigMapName, Namespace: dscispec.ApplicationsNamespace}, &kserveConfigMap); err != nil { | ||
| err := cli.Get(ctx, client.ObjectKey{Name: kserveConfigMapName, Namespace: dscispec.ApplicationsNamespace}, &kserveConfigMap) | ||
| if errors.IsNotFound(err) { | ||
| return "", nil |
There was a problem hiding this comment.
this will set k.Statu.sDefaultDeploymentMode to "" ?
or should it return string(Serverless), nil
There was a problem hiding this comment.
This is something not introduced by this PR, I've only added the IsNotFound check to avoid swallowing an error
@grdryn should know more
controllers/components/modelregistry/modelregistry_controller_actions.go
Outdated
Show resolved
Hide resolved
controllers/components/modelregistry/modelregistry_controller_actions.go
Outdated
Show resolved
Hide resolved
controllers/components/modelregistry/modelregistry_controller_actions.go
Outdated
Show resolved
Hide resolved
controllers/components/datasciencepipelines/datasciencepipelines_controller_actions.go
Show resolved
Hide resolved
lburgazzoli
force-pushed
the
conditions-manager
branch
from
763187b to
d1697d7
Compare
|
/test opendatahub-operator-e2e |
|
/retest |
This commit introduces some enhancement to what and how components are
reporting theirs status by:
- Includes a `Ready` top-level condition which summarizes more detailed
conditions
- Includes a `ProvisioningSucceeded` condition that reports any
provisioning error, i.e. a deployment fails to be provisioned because
of any invalid fields, some pre-requisites are not met
```yaml
apiVersion: components.platform.opendatahub.io/v1alpha1
kind: ModelRegistry
metadata:
name: default-modelregistry
spec:
registriesNamespace: odh-model-registries
status:
conditions:
- lastTransitionTime: "2025-02-03T13:10:32Z"
message: 0/1 deployments ready
reason: DeploymentsNotReady
status: "False"
type: Ready
- lastTransitionTime: "2025-02-03T12:55:45Z"
status: "True"
type: ProvisioningSucceeded
- lastTransitionTime: "2025-02-03T13:10:32Z"
message: 0/1 deployments ready
reason: DeploymentsNotReady
status: "False"
type: DeploymentsAvailable
- lastTransitionTime: "2025-02-03T12:55:32Z"
status: "True"
type: ServerlessAvailable
```
> [!NOTE]
> in the case we want a condition to be set to `False`, but that should not affect
> the top level condition, it is possible to set the `severity` field as `Info`.
> The default is `Error` and it is being represented by an empty value.
>
>```yaml
> - lastTransitionTime: "2025-02-03T13:10:42Z"
> reason: FooReasin
> severity: Info
> status: "True"
> type: Foo
>```
If needed, additional conditions can be added by individual component or
services:
```go
_, err := reconciler.ReconcilerFor(mgr, &componentApi.ModelRegistry{}).
// ...
WithConditions(
status.ConditionDeploymentsAvailable,
status.ConditionServerlessAvailable).
Build(ctx)
```
To help managing conditions, a `conditions.Manager` type has been
inrtoduced, largely inspired by Knative's conditions set code [1], but
improved to handle our specific use cases.
[1] https://github.com/knative/pkg/blob/main/apis/condition_set.go
Co-authored-by: Wen Zhou <wenzhou@redhat.com>
…actions.go Co-authored-by: Wen Zhou <wenzhou@redhat.com>
…actions.go Co-authored-by: Wen Zhou <wenzhou@redhat.com>
lburgazzoli
force-pushed
the
conditions-manager
branch
from
156d904 to
25374d6
Compare
|
PR needs rebase. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This commit introduces some enhancement to what and how components are
reporting theirs status by:
Readytop-level condition which summarizes more detailedconditions
ProvisioningSucceededcondition that reports anyprovisioning error, i.e. a deployment fails to be provisioned because
of any invalid fields, some pre-requisites are not met
Note
in the case we want a condition to be set to
False, but that should not affect the top level condition, it is possible to set theseverityfield asInfo(the default isErrorand it is being represented by an empty value):If needed, additional conditions can be added by individual component or
services:
To help managing conditions, a
conditions.Managertype has beeninrtoduced, largely inspired by Knative's conditions set code [1], but
improved to handle our specific use cases.
[1] https://github.com/knative/pkg/blob/main/apis/condition_set.go
https://issues.redhat.com/browse/RHOAIENG-18216
How Has This Been Tested?
Screenshot or short clip
Merge criteria