config/v1/types_cluster_version: Add conditionalUpdates and friends #1011
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -123,14 +123,26 @@ type ClusterVersionStatus struct { | |
| // +optional | ||
| Conditions []ClusterOperatorStatusCondition `json:"conditions,omitempty"` | ||
|
|
||
| // availableUpdates contains updates recommended for this | ||
| // cluster. Updates which appear in conditionalUpdates but not in | ||
| // availableUpdates may expose this cluster to known issues. This list | ||
| // may be empty if no updates are recommended, if the update service | ||
| // is unavailable, or if an invalid channel has been specified. | ||
| // +nullable | ||
| // +kubebuilder:validation:Required | ||
| // +required | ||
| AvailableUpdates []Release `json:"availableUpdates"` | ||
|
|
||
| // conditionalUpdates contains the list of updates that may be | ||
| // recommended for this cluster if it meets specific required | ||
| // conditions. Consumers interested in the set of updates that are | ||
| // actually recommended for this cluster should use | ||
| // availableUpdates. This list may be empty if no updates are | ||
| // recommended, if the update service is unavailable, or if an empty | ||
| // or invalid channel has been specified. | ||
| // +listType=atomic | ||
| // +optional | ||
| ConditionalUpdates []ConditionalUpdate `json:"conditionalUpdates,omitempty"` | ||
| } | ||
|
|
||
| // UpdateState is a constant representing whether an update was successfully | ||
|
|
@@ -190,6 +202,14 @@ type UpdateHistory struct { | |
| // +kubebuilder:validation:Required | ||
| // +required | ||
| Verified bool `json:"verified"` | ||
|
|
||
| // acceptedRisks records risks which were accepted to initiate the update. | ||
| // For example, it may menition an Upgradeable=False or missing signature | ||
| // that was overriden via desiredUpdate.force, or an update that was | ||
| // initiated despite not being in the availableUpdates set of recommended | ||
| // update targets. | ||
| // +optional | ||
| AcceptedRisks string `json:"acceptedRisks,omitempty"` | ||
| } | ||
|
|
||
| // ClusterID is string RFC4122 uuid. | ||
|
|
@@ -290,6 +310,112 @@ type Release struct { | |
| // availableUpdates field is accurate and recent. | ||
| const RetrievedUpdates ClusterStatusConditionType = "RetrievedUpdates" | ||
|
|
||
| // ConditionalUpdate represents an update which is recommended to some | ||
| // clusters on the version the current cluster is reconciling, but which | ||
| // may not be recommended for the current cluster. | ||
| type ConditionalUpdate struct { | ||
| // release is the target of the update. | ||
| // +kubebuilder:validation:Required | ||
| // +required | ||
| Release Release `json:"release"` | ||
|
|
||
| // risks represents the range of issues associated with | ||
| // updating to the target release. The cluster-version | ||
| // operator will evaluate all entries, and only recommend the | ||
| // update if there is at least one entry and all entries | ||
| // recommend the update. | ||
| // +kubebuilder:validation:Required | ||
| // +kubebuilder:validation:MinItems=1 | ||
| // +patchMergeKey=name | ||
| // +patchStrategy=merge | ||
| // +listType=map | ||
| // +listMapKey=name | ||
| // +required | ||
| Risks []ConditionalUpdateRisk `json:"risks"` | ||
|
Contributor
There was a problem hiding this comment. needs patch/list type keys for SSA
Member
Author
There was a problem hiding this comment. I'm a bit fuzzy on how these work, but I've taken a stab with 37280ee -> 866951f, although now CI is giving me some trouble.
Member
Author
There was a problem hiding this comment. Aha, here we go tucked in the output a hundred or so lines from the end: But $ yaml2json <config/v1/0000_00_cluster-version-operator_01_clusterversion.crd.yaml | jq -r '.spec.versions[].schema.openAPIV3Schema.properties.status.properties.conditionalUpdates.items.properties.
conditions.items.required[]'
lastTransitionTime
message
reason
status
typeBut: $ yaml2json <config/v1/0000_00_cluster-version-operator_01_clusterversion.crd.yaml | jq -r '.spec.versions[].schema.openAPIV3Schema.properties.status.properties.conditionalUpdates.items.properties.risks.items | keys[]'
description
properties
typePerhaps
Member
Author
|
||
|
|
||
| // conditions represents the observations of the conditional update's | ||
| // current status. Known types are: | ||
| // * Evaluating, for whether the cluster-version operator will attempt to evaluate any risks[].matchingRules. | ||
| // * Recommended, for whether the update is recommended for the current cluster. | ||
| // +patchMergeKey=type | ||
| // +patchStrategy=merge | ||
| // +listType=map | ||
| // +listMapKey=type | ||
| Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` | ||
| } | ||
|
|
||
| // ConditionalUpdateRisk represents a reason and cluster-state | ||
| // for not recommending a conditional update. | ||
| // +k8s:deepcopy-gen=true | ||
| type ConditionalUpdateRisk struct { | ||
| // url contains information about this risk. | ||
| // +kubebuilder:validation:Required | ||
| // +kubebuilder:validation:Format=uri | ||
| // +kubebuilder:validation:MinLength=1 | ||
| // +required | ||
| URL string `json:"url"` | ||
|
|
||
| // name is the CamelCase reason for not recommending a | ||
| // conditional update, in the event that matchingRules match the | ||
| // cluster state. | ||
| // +kubebuilder:validation:Required | ||
| // +kubebuilder:validation:MinLength=1 | ||
| // +required | ||
| Name string `json:"name"` | ||
|
|
||
| // message provides additional information about the risk of | ||
| // updating, in the event that matchingRules match the cluster | ||
| // state. This is only to be consumed by humans. It may | ||
| // contain Line Feed characters (U+000A), which should be | ||
| // rendered as new lines. | ||
| // +kubebuilder:validation:Required | ||
| // +kubebuilder:validation:MinLength=1 | ||
| // +required | ||
| Message string `json:"message"` | ||
|
|
||
| // matchingRules is a slice of conditions for deciding which | ||
| // clusters match the risk and which do not. The slice is | ||
| // ordered by decreasing precedence. The cluster-version | ||
| // operator will walk the slice in order, and stop after the | ||
| // first it can successfully evaluate. If no condition can be | ||
| // successfully evaluated, the update will not be recommended. | ||
| // +kubebuilder:validation:Required | ||
| // +kubebuilder:validation:MinItems=1 | ||
| // +listType=atomic | ||
| // +required | ||
| MatchingRules []ClusterCondition `json:"matchingRules"` | ||
wking marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| // ClusterCondition is a union of typed cluster conditions. The 'type' | ||
| // property determines which of the type-specific properties are relevant. | ||
| // When evaluated on a cluster, the condition may match, not match, or | ||
| // fail to evaluate. | ||
| // +k8s:deepcopy-gen=true | ||
| type ClusterCondition struct { | ||
| // type represents the cluster-condition type. This defines | ||
| // the members and semantics of any additional properties. | ||
| // +kubebuilder:validation:Required | ||
| // +kubebuilder:validation:Enum={"Always","PromQL"} | ||
| // +required | ||
| Type string `json:"type"` | ||
wking marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // promQL represents a cluster condition based on PromQL. | ||
| // +optional | ||
| PromQL *PromQLClusterCondition `json:"promql,omitempty"` | ||
| } | ||
|
|
||
| // PromQLClusterCondition represents a cluster condition based on PromQL. | ||
| type PromQLClusterCondition struct { | ||
| // PromQL is a PromQL query classifying clusters. This query | ||
| // query should return a 1 in the match case and a 0 in the | ||
| // does-not-match case case. Queries which return no time | ||
| // series, or which return values besides 0 or 1, are | ||
| // evaluation failures. | ||
| // +kubebuilder:validation:Required | ||
| // +required | ||
| PromQL string `json:"promql"` | ||
| } | ||
|
|
||
| // ClusterVersionList is a list of ClusterVersion resources. | ||
| // | ||
| // Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). | ||
|
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.