Skip to content

config/v1/types_cluster_operator: Tighten up Upgradeable docs #995

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

Merged
openshift-merge-robot merged 1 commit into from
Sep 13, 2021
Merged

config/v1/types_cluster_operator: Tighten up Upgradeable docs #995

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
14 changes: 10 additions & 4 deletions config/v1/types_cluster_operator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,10 +176,16 @@ const (
// unexpected errors are handled as operators mature.
OperatorDegraded ClusterStatusConditionType = "Degraded"

// Upgradeable indicates whether the operator safe to upgrade based on the current cluster state. When status is `False`
// administrators should not upgrade their cluster and the message field should contain a human readable description
// of what the administrator should do to allow the operator to successfully update. A missing condition, True,
// and Unknown are all treated by the CVO as allowing an upgrade.
// Upgradeable indicates whether the operator is safe to upgrade based on the
// current cluster state. When status is False, the cluster-version operator
// will prevent the cluster from performing impacted updates unless forced.
// When set on ClusterVersion, the message will explain which updates (minor
// or patch) are impacted. When set on ClusterOperator, False will block
Copy link
Contributor

@sadasu sadasu Sep 14, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there an implicit hierarchy here that needs to be called out? For example, if minor version updates are not allowed, are patch version updates also automatically disallowed ?

Copy link
Member Author

@wking wking Sep 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For example, if minor version updates are not allowed, are patch version updates also automatically disallowed ?

SemVer is MAJOR.MINOR.PATCH, so the two cases we have today are "blocks minor bumps, patch bumps are fine" and "blocks all bumps". So could have been minor or all here. The .spec.overrides-is-set message is:

Disabling ownership via cluster version overrides prevents upgrades. Please remove overrides before continuing.

So the actual user experience should be unambiguous.

// minor OpenShift updates. The message field should contain a human
// readable description of what the administrator should do to allow the
// cluster or operator to successfully update. The cluster-version operator
// will allow updates when this condition is not False, including when it is
// missing, True, or Unknown.
OperatorUpgradeable ClusterStatusConditionType = "Upgradeable"
)

Expand Down