diff --git a/config/v1/tests/clusterversions.config.openshift.io/ClusterUpdatePreflight.yaml b/config/v1/tests/clusterversions.config.openshift.io/ClusterUpdatePreflight.yaml
new file mode 100644
index 00000000000..562f9a55cf6
--- /dev/null
+++ b/config/v1/tests/clusterversions.config.openshift.io/ClusterUpdatePreflight.yaml
@@ -0,0 +1,181 @@
+apiVersion: apiextensions.k8s.io/v1 # Hack because controller-gen complains if we don't have this
+name: "ClusterVersion"
+crdName: clusterversions.config.openshift.io
+featureGates:
+ - ClusterUpdatePreflight
+tests:
+ onCreate:
+ - name: Should be able to set mode to Preflight
+ initial: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ version: 4.22.0
+ mode: Preflight
+ expected: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ version: 4.22.0
+ mode: Preflight
+ - name: Should be able to omit mode field (default behavior)
+ initial: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ version: 4.22.0
+ expected: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ version: 4.22.0
+ - name: Should be able to use Preflight mode with image
+ initial: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ image: quay.io/openshift-release-dev/ocp-release@sha256:abc123
+ mode: Preflight
+ expected: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ image: quay.io/openshift-release-dev/ocp-release@sha256:abc123
+ mode: Preflight
+ - name: Should be able to use Preflight mode with architecture
+ initial: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ architecture: Multi
+ version: 4.22.0
+ mode: Preflight
+ expected: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ architecture: Multi
+ version: 4.22.0
+ mode: Preflight
+ - name: Should be able to use Preflight mode with acceptRisks
+ initial: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ version: 4.22.0
+ mode: Preflight
+ acceptRisks:
+ - name: RiskA
+ - name: RiskB
+ expected: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ version: 4.22.0
+ mode: Preflight
+ acceptRisks:
+ - name: RiskA
+ - name: RiskB
+ - name: Invalid mode value should be rejected
+ initial: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ version: 4.22.0
+ mode: InvalidMode
+ expectedError: "Unsupported value: \"InvalidMode\""
+ onUpdate:
+ - name: Should be able to change mode from normal to Preflight
+ initial: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ version: 4.22.0
+ updated: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ version: 4.22.0
+ mode: Preflight
+ expected: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ version: 4.22.0
+ mode: Preflight
+ - name: Should be able to change mode from Preflight to normal
+ initial: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ version: 4.22.0
+ mode: Preflight
+ updated: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ version: 4.22.0
+ expected: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ version: 4.22.0
+ - name: Should be able to change target version while in Preflight mode
+ initial: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ version: 4.22.0
+ mode: Preflight
+ updated: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ version: 4.23.0
+ mode: Preflight
+ expected: |
+ apiVersion: config.openshift.io/v1
+ kind: ClusterVersion
+ spec:
+ clusterID: foo
+ desiredUpdate:
+ version: 4.23.0
+ mode: Preflight
\ No newline at end of file
diff --git a/config/v1/types_cluster_version.go b/config/v1/types_cluster_version.go
index 5f36f693de1..9581068eddd 100644
--- a/config/v1/types_cluster_version.go
+++ b/config/v1/types_cluster_version.go
@@ -283,6 +283,15 @@ type UpdateHistory struct {
// ClusterID is string RFC4122 uuid.
type ClusterID string
+// UpdateModePolicy defines how an update should be processed.
+// +kubebuilder:validation:Enum=Preflight
+type UpdateModePolicy string
+
+const (
+ // UpdateModePolicyPreflight allows an update to be checked for compatibility without committing to updating the cluster.
+ UpdateModePolicyPreflight UpdateModePolicy = "Preflight"
+)
+
// ClusterVersionArchitecture enumerates valid cluster architectures.
// +kubebuilder:validation:Enum="Multi";""
type ClusterVersionArchitecture string
@@ -760,6 +769,15 @@ type Update struct {
// +listMapKey=name
// +optional
AcceptRisks []AcceptRisk `json:"acceptRisks,omitempty"`
+
+ // mode allows an update to be checked for compatibility without committing to updating the cluster.
+ // Allowed values are "Preflight" and omitted.
+ // When omitted, the default mode allows existing clients to request normal updates.
+ // When set to "Preflight", the cluster will run compatibility checks against the target release
+ // without performing an actual update.
+ // +openshift:enable:FeatureGate=ClusterUpdatePreflight
+ // +optional
+ Mode UpdateModePolicy `json:"mode,omitempty"`
}
// AcceptRisk represents a risk that is considered acceptable.
diff --git a/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-CustomNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-CustomNoUpgrade.crd.yaml
index c89d45ddcd1..1f76d707165 100644
--- a/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-CustomNoUpgrade.crd.yaml
+++ b/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-CustomNoUpgrade.crd.yaml
@@ -218,6 +218,16 @@ spec:
When image is set, architecture cannot be specified.
If both version and image are set, the version extracted from the referenced image must match the specified version.
type: string
+ mode:
+ description: |-
+ mode allows an update to be checked for compatibility without committing to updating the cluster.
+ Allowed values are "Preflight" and omitted.
+ When omitted, the default mode allows existing clients to request normal updates.
+ When set to "Preflight", the cluster will run compatibility checks against the target release
+ without performing an actual update.
+ enum:
+ - Preflight
+ type: string
version:
description: |-
version is a semantic version identifying the update version.
diff --git a/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-TechPreviewNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-TechPreviewNoUpgrade.crd.yaml
index ea97687cfc1..621e056b624 100644
--- a/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-TechPreviewNoUpgrade.crd.yaml
+++ b/config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusterversions-TechPreviewNoUpgrade.crd.yaml
@@ -218,6 +218,16 @@ spec:
When image is set, architecture cannot be specified.
If both version and image are set, the version extracted from the referenced image must match the specified version.
type: string
+ mode:
+ description: |-
+ mode allows an update to be checked for compatibility without committing to updating the cluster.
+ Allowed values are "Preflight" and omitted.
+ When omitted, the default mode allows existing clients to request normal updates.
+ When set to "Preflight", the cluster will run compatibility checks against the target release
+ without performing an actual update.
+ enum:
+ - Preflight
+ type: string
version:
description: |-
version is a semantic version identifying the update version.
diff --git a/config/v1/zz_generated.featuregated-crd-manifests.yaml b/config/v1/zz_generated.featuregated-crd-manifests.yaml
index 576fd510c61..4febd3fa88c 100644
--- a/config/v1/zz_generated.featuregated-crd-manifests.yaml
+++ b/config/v1/zz_generated.featuregated-crd-manifests.yaml
@@ -144,6 +144,7 @@ clusterversions.config.openshift.io:
Category: ""
FeatureGates:
- ClusterUpdateAcceptRisks
+ - ClusterUpdatePreflight
- ImageStreamImportMode
- SignatureStores
FilenameOperatorName: cluster-version-operator
diff --git a/config/v1/zz_generated.featuregated-crd-manifests/clusterversions.config.openshift.io/ClusterUpdatePreflight.yaml b/config/v1/zz_generated.featuregated-crd-manifests/clusterversions.config.openshift.io/ClusterUpdatePreflight.yaml
new file mode 100644
index 00000000000..166851f0205
--- /dev/null
+++ b/config/v1/zz_generated.featuregated-crd-manifests/clusterversions.config.openshift.io/ClusterUpdatePreflight.yaml
@@ -0,0 +1,775 @@
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+ annotations:
+ api-approved.openshift.io: https://github.com/openshift/api/pull/495
+ api.openshift.io/filename-cvo-runlevel: "0000_00"
+ api.openshift.io/filename-operator: cluster-version-operator
+ api.openshift.io/filename-ordering: "01"
+ feature-gate.release.openshift.io/ClusterUpdatePreflight: "true"
+ include.release.openshift.io/self-managed-high-availability: "true"
+ name: clusterversions.config.openshift.io
+spec:
+ group: config.openshift.io
+ names:
+ kind: ClusterVersion
+ listKind: ClusterVersionList
+ plural: clusterversions
+ singular: clusterversion
+ scope: Cluster
+ versions:
+ - additionalPrinterColumns:
+ - jsonPath: .status.history[?(@.state=="Completed")].version
+ name: Version
+ type: string
+ - jsonPath: .status.conditions[?(@.type=="Available")].status
+ name: Available
+ type: string
+ - jsonPath: .status.conditions[?(@.type=="Progressing")].status
+ name: Progressing
+ type: string
+ - jsonPath: .status.conditions[?(@.type=="Progressing")].lastTransitionTime
+ name: Since
+ type: date
+ - jsonPath: .status.conditions[?(@.type=="Progressing")].message
+ name: Status
+ type: string
+ name: v1
+ schema:
+ openAPIV3Schema:
+ description: |-
+ ClusterVersion is the configuration for the ClusterVersionOperator. This is where
+ parameters related to automatic updates can be set.
+
+ Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
+ properties:
+ apiVersion:
+ description: |-
+ APIVersion defines the versioned schema of this representation of an object.
+ Servers should convert recognized schemas to the latest internal value, and
+ may reject unrecognized values.
+ More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ type: string
+ kind:
+ description: |-
+ Kind is a string value representing the REST resource this object represents.
+ Servers may infer this from the endpoint the client submits requests to.
+ Cannot be updated.
+ In CamelCase.
+ More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ type: string
+ metadata:
+ type: object
+ spec:
+ description: |-
+ spec is the desired state of the cluster version - the operator will work
+ to ensure that the desired version is applied to the cluster.
+ properties:
+ capabilities:
+ description: |-
+ capabilities configures the installation of optional, core
+ cluster components. A null value here is identical to an
+ empty object; see the child properties for default semantics.
+ properties:
+ additionalEnabledCapabilities:
+ description: |-
+ additionalEnabledCapabilities extends the set of managed
+ capabilities beyond the baseline defined in
+ baselineCapabilitySet. The default is an empty set.
+ items:
+ description: ClusterVersionCapability enumerates optional, core
+ cluster components.
+ enum:
+ - openshift-samples
+ - baremetal
+ - marketplace
+ - Console
+ - Insights
+ - Storage
+ - CSISnapshot
+ - NodeTuning
+ - MachineAPI
+ - Build
+ - DeploymentConfig
+ - ImageRegistry
+ - OperatorLifecycleManager
+ - CloudCredential
+ - Ingress
+ - CloudControllerManager
+ - OperatorLifecycleManagerV1
+ type: string
+ type: array
+ x-kubernetes-list-type: atomic
+ baselineCapabilitySet:
+ description: |-
+ baselineCapabilitySet selects an initial set of
+ optional capabilities to enable, which can be extended via
+ additionalEnabledCapabilities. If unset, the cluster will
+ choose a default, and the default may change over time.
+ The current default is vCurrent.
+ enum:
+ - None
+ - v4.11
+ - v4.12
+ - v4.13
+ - v4.14
+ - v4.15
+ - v4.16
+ - v4.17
+ - v4.18
+ - vCurrent
+ type: string
+ type: object
+ channel:
+ description: |-
+ channel is an identifier for explicitly requesting a non-default set
+ of updates to be applied to this cluster. The default channel will
+ contain stable updates that are appropriate for production clusters.
+ type: string
+ clusterID:
+ description: |-
+ clusterID uniquely identifies this cluster. This is expected to be
+ an RFC4122 UUID value (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx in
+ hexadecimal values). This is a required field.
+ type: string
+ desiredUpdate:
+ description: |-
+ desiredUpdate is an optional field that indicates the desired value of
+ the cluster version. Setting this value will trigger an upgrade (if
+ the current version does not match the desired version). The set of
+ recommended update values is listed as part of available updates in
+ status, and setting values outside that range may cause the upgrade
+ to fail.
+
+ Some of the fields are inter-related with restrictions and meanings described here.
+ 1. image is specified, version is specified, architecture is specified. API validation error.
+ 2. image is specified, version is specified, architecture is not specified. The version extracted from the referenced image must match the specified version.
+ 3. image is specified, version is not specified, architecture is specified. API validation error.
+ 4. image is specified, version is not specified, architecture is not specified. image is used.
+ 5. image is not specified, version is specified, architecture is specified. version and desired architecture are used to select an image.
+ 6. image is not specified, version is specified, architecture is not specified. version and current architecture are used to select an image.
+ 7. image is not specified, version is not specified, architecture is specified. API validation error.
+ 8. image is not specified, version is not specified, architecture is not specified. API validation error.
+
+ If an upgrade fails the operator will halt and report status
+ about the failing component. Setting the desired update value back to
+ the previous version will cause a rollback to be attempted if the
+ previous version is within the current minor version. Not all
+ rollbacks will succeed, and some may unrecoverably break the
+ cluster.
+ properties:
+ architecture:
+ description: |-
+ architecture is an optional field that indicates the desired
+ value of the cluster architecture. In this context cluster
+ architecture means either a single architecture or a multi
+ architecture. architecture can only be set to Multi thereby
+ only allowing updates from single to multi architecture. If
+ architecture is set, image cannot be set and version must be
+ set.
+ Valid values are 'Multi' and empty.
+ enum:
+ - Multi
+ - ""
+ type: string
+ force:
+ description: |-
+ force allows an administrator to update to an image that has failed
+ verification or upgradeable checks that are designed to keep your
+ cluster safe. Only use this if:
+ * you are testing unsigned release images in short-lived test clusters or
+ * you are working around a known bug in the cluster-version
+ operator and you have verified the authenticity of the provided
+ image yourself.
+ The provided image will run with full administrative access
+ to the cluster. Do not use this flag with images that come from unknown
+ or potentially malicious sources.
+ type: boolean
+ image:
+ description: |-
+ image is a container image location that contains the update.
+ image should be used when the desired version does not exist in availableUpdates or history.
+ When image is set, architecture cannot be specified.
+ If both version and image are set, the version extracted from the referenced image must match the specified version.
+ type: string
+ mode:
+ description: |-
+ mode allows an update to be checked for compatibility without committing to updating the cluster.
+ Allowed values are "Preflight" and omitted.
+ When omitted, the default mode allows existing clients to request normal updates.
+ When set to "Preflight", the cluster will run compatibility checks against the target release
+ without performing an actual update.
+ enum:
+ - Preflight
+ type: string
+ version:
+ description: |-
+ version is a semantic version identifying the update version.
+ version is required if architecture is specified.
+ If both version and image are set, the version extracted from the referenced image must match the specified version.
+ type: string
+ type: object
+ x-kubernetes-validations:
+ - message: cannot set both Architecture and Image
+ rule: 'has(self.architecture) && has(self.image) ? (self.architecture
+ == "" || self.image == "") : true'
+ - message: Version must be set if Architecture is set
+ rule: 'has(self.architecture) && self.architecture != "" ? self.version
+ != "" : true'
+ overrides:
+ description: |-
+ overrides is list of overides for components that are managed by
+ cluster version operator. Marking a component unmanaged will prevent
+ the operator from creating or updating the object.
+ items:
+ description: |-
+ ComponentOverride allows overriding cluster version operator's behavior
+ for a component.
+ properties:
+ group:
+ description: group identifies the API group that the kind is
+ in.
+ type: string
+ kind:
+ description: kind indentifies which object to override.
+ type: string
+ name:
+ description: name is the component's name.
+ type: string
+ namespace:
+ description: |-
+ namespace is the component's namespace. If the resource is cluster
+ scoped, the namespace should be empty.
+ type: string
+ unmanaged:
+ description: |-
+ unmanaged controls if cluster version operator should stop managing the
+ resources in this cluster.
+ Default: false
+ type: boolean
+ required:
+ - group
+ - kind
+ - name
+ - namespace
+ - unmanaged
+ type: object
+ type: array
+ x-kubernetes-list-map-keys:
+ - kind
+ - group
+ - namespace
+ - name
+ x-kubernetes-list-type: map
+ upstream:
+ description: |-
+ upstream may be used to specify the preferred update server. By default
+ it will use the appropriate update server for the cluster and region.
+ type: string
+ required:
+ - clusterID
+ type: object
+ status:
+ description: |-
+ status contains information about the available updates and any in-progress
+ updates.
+ properties:
+ availableUpdates:
+ description: |-
+ 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.
+ items:
+ description: Release represents an OpenShift release image and associated
+ metadata.
+ properties:
+ channels:
+ description: |-
+ channels is the set of Cincinnati channels to which the release
+ currently belongs.
+ items:
+ type: string
+ type: array
+ x-kubernetes-list-type: set
+ image:
+ description: |-
+ image is a container image location that contains the update. When this
+ field is part of spec, image is optional if version is specified and the
+ availableUpdates field contains a matching version.
+ type: string
+ url:
+ description: |-
+ url contains information about this release. This URL is set by
+ the 'url' metadata property on a release or the metadata returned by
+ the update API and should be displayed as a link in user
+ interfaces. The URL field may not be set for test or nightly
+ releases.
+ type: string
+ version:
+ description: |-
+ version is a semantic version identifying the update version. When this
+ field is part of spec, version is optional if image is specified.
+ type: string
+ required:
+ - image
+ - version
+ type: object
+ nullable: true
+ type: array
+ x-kubernetes-list-type: atomic
+ capabilities:
+ description: capabilities describes the state of optional, core cluster
+ components.
+ properties:
+ enabledCapabilities:
+ description: enabledCapabilities lists all the capabilities that
+ are currently managed.
+ items:
+ description: ClusterVersionCapability enumerates optional, core
+ cluster components.
+ enum:
+ - openshift-samples
+ - baremetal
+ - marketplace
+ - Console
+ - Insights
+ - Storage
+ - CSISnapshot
+ - NodeTuning
+ - MachineAPI
+ - Build
+ - DeploymentConfig
+ - ImageRegistry
+ - OperatorLifecycleManager
+ - CloudCredential
+ - Ingress
+ - CloudControllerManager
+ - OperatorLifecycleManagerV1
+ type: string
+ type: array
+ x-kubernetes-list-type: atomic
+ knownCapabilities:
+ description: knownCapabilities lists all the capabilities known
+ to the current cluster.
+ items:
+ description: ClusterVersionCapability enumerates optional, core
+ cluster components.
+ enum:
+ - openshift-samples
+ - baremetal
+ - marketplace
+ - Console
+ - Insights
+ - Storage
+ - CSISnapshot
+ - NodeTuning
+ - MachineAPI
+ - Build
+ - DeploymentConfig
+ - ImageRegistry
+ - OperatorLifecycleManager
+ - CloudCredential
+ - Ingress
+ - CloudControllerManager
+ - OperatorLifecycleManagerV1
+ type: string
+ type: array
+ x-kubernetes-list-type: atomic
+ type: object
+ conditionalUpdates:
+ description: |-
+ 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.
+ items:
+ description: |-
+ 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.
+ properties:
+ conditions:
+ description: |-
+ conditions represents the observations of the conditional update's
+ current status. Known types are:
+ * Recommended, for whether the update is recommended for the current cluster.
+ items:
+ description: Condition contains details for one aspect of
+ the current state of this API Resource.
+ properties:
+ lastTransitionTime:
+ description: |-
+ lastTransitionTime is the last time the condition transitioned from one status to another.
+ This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
+ format: date-time
+ type: string
+ message:
+ description: |-
+ message is a human readable message indicating details about the transition.
+ This may be an empty string.
+ maxLength: 32768
+ type: string
+ observedGeneration:
+ description: |-
+ observedGeneration represents the .metadata.generation that the condition was set based upon.
+ For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
+ with respect to the current state of the instance.
+ format: int64
+ minimum: 0
+ type: integer
+ reason:
+ description: |-
+ reason contains a programmatic identifier indicating the reason for the condition's last transition.
+ Producers of specific condition types may define expected values and meanings for this field,
+ and whether the values are considered a guaranteed API.
+ The value should be a CamelCase string.
+ This field may not be empty.
+ maxLength: 1024
+ minLength: 1
+ pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
+ type: string
+ status:
+ description: status of the condition, one of True, False,
+ Unknown.
+ enum:
+ - "True"
+ - "False"
+ - Unknown
+ type: string
+ type:
+ description: type of condition in CamelCase or in foo.example.com/CamelCase.
+ maxLength: 316
+ pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
+ type: string
+ required:
+ - lastTransitionTime
+ - message
+ - reason
+ - status
+ - type
+ type: object
+ type: array
+ x-kubernetes-list-map-keys:
+ - type
+ x-kubernetes-list-type: map
+ release:
+ description: release is the target of the update.
+ properties:
+ channels:
+ description: |-
+ channels is the set of Cincinnati channels to which the release
+ currently belongs.
+ items:
+ type: string
+ type: array
+ x-kubernetes-list-type: set
+ image:
+ description: |-
+ image is a container image location that contains the update. When this
+ field is part of spec, image is optional if version is specified and the
+ availableUpdates field contains a matching version.
+ type: string
+ url:
+ description: |-
+ url contains information about this release. This URL is set by
+ the 'url' metadata property on a release or the metadata returned by
+ the update API and should be displayed as a link in user
+ interfaces. The URL field may not be set for test or nightly
+ releases.
+ type: string
+ version:
+ description: |-
+ version is a semantic version identifying the update version. When this
+ field is part of spec, version is optional if image is specified.
+ type: string
+ required:
+ - image
+ - version
+ type: object
+ risks:
+ description: |-
+ 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.
+ items:
+ description: |-
+ ConditionalUpdateRisk represents a reason and cluster-state
+ for not recommending a conditional update.
+ properties:
+ matchingRules:
+ description: |-
+ 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.
+ items:
+ description: |-
+ 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.
+ properties:
+ promql:
+ description: promql represents a cluster condition
+ based on PromQL.
+ properties:
+ promql:
+ description: |-
+ 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. Queries which return no time
+ series, or which return values besides 0 or 1, are
+ evaluation failures.
+ type: string
+ required:
+ - promql
+ type: object
+ type:
+ description: |-
+ type represents the cluster-condition type. This defines
+ the members and semantics of any additional properties.
+ enum:
+ - Always
+ - PromQL
+ type: string
+ required:
+ - type
+ type: object
+ minItems: 1
+ type: array
+ x-kubernetes-list-type: atomic
+ message:
+ description: |-
+ 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.
+ minLength: 1
+ type: string
+ name:
+ description: |-
+ name is the CamelCase reason for not recommending a
+ conditional update, in the event that matchingRules match the
+ cluster state.
+ minLength: 1
+ type: string
+ url:
+ description: url contains information about this risk.
+ format: uri
+ minLength: 1
+ type: string
+ required:
+ - matchingRules
+ - message
+ - name
+ - url
+ type: object
+ maxItems: 200
+ minItems: 1
+ type: array
+ x-kubernetes-list-map-keys:
+ - name
+ x-kubernetes-list-type: map
+ required:
+ - release
+ - risks
+ type: object
+ maxItems: 500
+ type: array
+ x-kubernetes-list-type: atomic
+ conditions:
+ description: |-
+ conditions provides information about the cluster version. The condition
+ "Available" is set to true if the desiredUpdate has been reached. The
+ condition "Progressing" is set to true if an update is being applied.
+ The condition "Degraded" is set to true if an update is currently blocked
+ by a temporary or permanent error. Conditions are only valid for the
+ current desiredUpdate when metadata.generation is equal to
+ status.generation.
+ items:
+ description: |-
+ ClusterOperatorStatusCondition represents the state of the operator's
+ managed and monitored components.
+ properties:
+ lastTransitionTime:
+ description: lastTransitionTime is the time of the last update
+ to the current status property.
+ format: date-time
+ type: string
+ message:
+ description: |-
+ message provides additional information about the current condition.
+ This is only to be consumed by humans. It may contain Line Feed
+ characters (U+000A), which should be rendered as new lines.
+ type: string
+ reason:
+ description: reason is the CamelCase reason for the condition's
+ current status.
+ type: string
+ status:
+ description: status of the condition, one of True, False, Unknown.
+ type: string
+ type:
+ description: type specifies the aspect reported by this condition.
+ type: string
+ required:
+ - lastTransitionTime
+ - status
+ - type
+ type: object
+ type: array
+ x-kubernetes-list-map-keys:
+ - type
+ x-kubernetes-list-type: map
+ desired:
+ description: |-
+ desired is the version that the cluster is reconciling towards.
+ If the cluster is not yet fully initialized desired will be set
+ with the information available, which may be an image or a tag.
+ properties:
+ channels:
+ description: |-
+ channels is the set of Cincinnati channels to which the release
+ currently belongs.
+ items:
+ type: string
+ type: array
+ x-kubernetes-list-type: set
+ image:
+ description: |-
+ image is a container image location that contains the update. When this
+ field is part of spec, image is optional if version is specified and the
+ availableUpdates field contains a matching version.
+ type: string
+ url:
+ description: |-
+ url contains information about this release. This URL is set by
+ the 'url' metadata property on a release or the metadata returned by
+ the update API and should be displayed as a link in user
+ interfaces. The URL field may not be set for test or nightly
+ releases.
+ type: string
+ version:
+ description: |-
+ version is a semantic version identifying the update version. When this
+ field is part of spec, version is optional if image is specified.
+ type: string
+ required:
+ - image
+ - version
+ type: object
+ history:
+ description: |-
+ history contains a list of the most recent versions applied to the cluster.
+ This value may be empty during cluster startup, and then will be updated
+ when a new update is being applied. The newest update is first in the
+ list and it is ordered by recency. Updates in the history have state
+ Completed if the rollout completed - if an update was failing or halfway
+ applied the state will be Partial. Only a limited amount of update history
+ is preserved.
+ items:
+ description: UpdateHistory is a single attempted update to the cluster.
+ properties:
+ acceptedRisks:
+ description: |-
+ acceptedRisks records risks which were accepted to initiate the update.
+ For example, it may mention an Upgradeable=False or missing signature
+ that was overridden via desiredUpdate.force, or an update that was
+ initiated despite not being in the availableUpdates set of recommended
+ update targets.
+ type: string
+ completionTime:
+ description: |-
+ completionTime, if set, is when the update was fully applied. The update
+ that is currently being applied will have a null completion time.
+ Completion time will always be set for entries that are not the current
+ update (usually to the started time of the next update).
+ format: date-time
+ nullable: true
+ type: string
+ image:
+ description: |-
+ image is a container image location that contains the update. This value
+ is always populated.
+ type: string
+ startedTime:
+ description: startedTime is the time at which the update was
+ started.
+ format: date-time
+ type: string
+ state:
+ description: |-
+ state reflects whether the update was fully applied. The Partial state
+ indicates the update is not fully applied, while the Completed state
+ indicates the update was successfully rolled out at least once (all
+ parts of the update successfully applied).
+ type: string
+ verified:
+ description: |-
+ verified indicates whether the provided update was properly verified
+ before it was installed. If this is false the cluster may not be trusted.
+ Verified does not cover upgradeable checks that depend on the cluster
+ state at the time when the update target was accepted.
+ type: boolean
+ version:
+ description: |-
+ version is a semantic version identifying the update version. If the
+ requested image does not define a version, or if a failure occurs
+ retrieving the image, this value may be empty.
+ type: string
+ required:
+ - completionTime
+ - image
+ - startedTime
+ - state
+ - verified
+ type: object
+ type: array
+ x-kubernetes-list-type: atomic
+ observedGeneration:
+ description: |-
+ observedGeneration reports which version of the spec is being synced.
+ If this value is not equal to metadata.generation, then the desired
+ and conditions fields may represent a previous version.
+ format: int64
+ type: integer
+ versionHash:
+ description: |-
+ versionHash is a fingerprint of the content that the cluster will be
+ updated with. It is used by the operator to avoid unnecessary work
+ and is for internal use only.
+ type: string
+ required:
+ - availableUpdates
+ - desired
+ - observedGeneration
+ - versionHash
+ type: object
+ required:
+ - spec
+ type: object
+ x-kubernetes-validations:
+ - message: the `marketplace` capability requires the `OperatorLifecycleManager`
+ capability, which is neither explicitly or implicitly enabled in this
+ cluster, please enable the `OperatorLifecycleManager` capability
+ rule: 'has(self.spec.capabilities) && has(self.spec.capabilities.additionalEnabledCapabilities)
+ && self.spec.capabilities.baselineCapabilitySet == ''None'' && ''marketplace''
+ in self.spec.capabilities.additionalEnabledCapabilities ? ''OperatorLifecycleManager''
+ in self.spec.capabilities.additionalEnabledCapabilities || (has(self.status)
+ && has(self.status.capabilities) && has(self.status.capabilities.enabledCapabilities)
+ && ''OperatorLifecycleManager'' in self.status.capabilities.enabledCapabilities)
+ : true'
+ served: true
+ storage: true
+ subresources:
+ status: {}
diff --git a/config/v1/zz_generated.swagger_doc_generated.go b/config/v1/zz_generated.swagger_doc_generated.go
index 7f0018950a9..14513fb4fce 100644
--- a/config/v1/zz_generated.swagger_doc_generated.go
+++ b/config/v1/zz_generated.swagger_doc_generated.go
@@ -915,6 +915,7 @@ var map_Update = map[string]string{
"image": "image is a container image location that contains the update. image should be used when the desired version does not exist in availableUpdates or history. When image is set, architecture cannot be specified. If both version and image are set, the version extracted from the referenced image must match the specified version.",
"force": "force allows an administrator to update to an image that has failed verification or upgradeable checks that are designed to keep your cluster safe. Only use this if: * you are testing unsigned release images in short-lived test clusters or * you are working around a known bug in the cluster-version\n operator and you have verified the authenticity of the provided\n image yourself.\nThe provided image will run with full administrative access to the cluster. Do not use this flag with images that come from unknown or potentially malicious sources.",
"acceptRisks": "acceptRisks is an optional set of names of conditional update risks that are considered acceptable. A conditional update is performed only if all of its risks are acceptable. This list may contain entries that apply to current, previous or future updates. The entries therefore may not map directly to a risk in .status.conditionalUpdateRisks. acceptRisks must not contain more than 1000 entries. Entries in this list must be unique.",
+ "mode": "mode allows an update to be checked for compatibility without committing to updating the cluster. Allowed values are \"Preflight\" and omitted. When omitted, the default mode allows existing clients to request normal updates. When set to \"Preflight\", the cluster will run compatibility checks against the target release without performing an actual update.",
}
func (Update) SwaggerDoc() map[string]string {
diff --git a/features.md b/features.md
index afa64782571..c265ffde169 100644
--- a/features.md
+++ b/features.md
@@ -9,6 +9,7 @@
| ClusterAPIComputeInstall| | | Enabled | Enabled | | | | |
| ClusterAPIControlPlaneInstall| | | Enabled | Enabled | | | | |
| ClusterAPIMachineManagementVSphere| | | Enabled | Enabled | | | | |
+| ClusterUpdatePreflight| | | | | | | Enabled | Enabled |
| Example2| | | Enabled | Enabled | | | | |
| ExternalSnapshotMetadata| | | Enabled | Enabled | | | | |
| IngressControllerDynamicConfigurationManager| | | Enabled | Enabled | | | | |
diff --git a/features/features.go b/features/features.go
index 187edb0e164..0861199882f 100644
--- a/features/features.go
+++ b/features/features.go
@@ -699,6 +699,14 @@ var (
enableIn(configv1.DevPreviewNoUpgrade, configv1.TechPreviewNoUpgrade).
mustRegister()
+ FeatureGateClusterUpdatePreflight = newFeatureGate("ClusterUpdatePreflight").
+ reportProblemsToJiraComponent("Cluster Version Operator").
+ contactPerson("fao89").
+ productScope(ocpSpecific).
+ enhancementPR("https://github.com/openshift/enhancements/pull/1930").
+ enableIn(configv1.TechPreviewNoUpgrade).
+ mustRegister()
+
FeatureGateGCPCustomAPIEndpoints = newFeatureGate("GCPCustomAPIEndpoints").
reportProblemsToJiraComponent("Installer").
contactPerson("barbacbd").
diff --git a/openapi/generated_openapi/zz_generated.openapi.go b/openapi/generated_openapi/zz_generated.openapi.go
index 83a9e5b0375..0070b3e54c7 100644
--- a/openapi/generated_openapi/zz_generated.openapi.go
+++ b/openapi/generated_openapi/zz_generated.openapi.go
@@ -21481,6 +21481,13 @@ func schema_openshift_api_config_v1_Update(ref common.ReferenceCallback) common.
},
},
},
+ "mode": {
+ SchemaProps: spec.SchemaProps{
+ Description: "mode allows an update to be checked for compatibility without committing to updating the cluster. Allowed values are \"Preflight\" and omitted. When omitted, the default mode allows existing clients to request normal updates. When set to \"Preflight\", the cluster will run compatibility checks against the target release without performing an actual update.",
+ Type: []string{"string"},
+ Format: "",
+ },
+ },
},
},
},
diff --git a/payload-manifests/featuregates/featureGate-Hypershift-Default.yaml b/payload-manifests/featuregates/featureGate-Hypershift-Default.yaml
index 326d875acd8..cfc852b2c1a 100644
--- a/payload-manifests/featuregates/featureGate-Hypershift-Default.yaml
+++ b/payload-manifests/featuregates/featureGate-Hypershift-Default.yaml
@@ -84,6 +84,9 @@
{
"name": "ClusterUpdateAcceptRisks"
},
+ {
+ "name": "ClusterUpdatePreflight"
+ },
{
"name": "ClusterVersionOperatorConfiguration"
},
diff --git a/payload-manifests/featuregates/featureGate-Hypershift-DevPreviewNoUpgrade.yaml b/payload-manifests/featuregates/featureGate-Hypershift-DevPreviewNoUpgrade.yaml
index 1897be7b3c5..f7ade7a8d43 100644
--- a/payload-manifests/featuregates/featureGate-Hypershift-DevPreviewNoUpgrade.yaml
+++ b/payload-manifests/featuregates/featureGate-Hypershift-DevPreviewNoUpgrade.yaml
@@ -20,6 +20,9 @@
{
"name": "ClusterAPIInstall"
},
+ {
+ "name": "ClusterUpdatePreflight"
+ },
{
"name": "EventedPLEG"
},
diff --git a/payload-manifests/featuregates/featureGate-Hypershift-OKD.yaml b/payload-manifests/featuregates/featureGate-Hypershift-OKD.yaml
index 91f2cd1e720..62b28136dd8 100644
--- a/payload-manifests/featuregates/featureGate-Hypershift-OKD.yaml
+++ b/payload-manifests/featuregates/featureGate-Hypershift-OKD.yaml
@@ -86,6 +86,9 @@
{
"name": "ClusterUpdateAcceptRisks"
},
+ {
+ "name": "ClusterUpdatePreflight"
+ },
{
"name": "ClusterVersionOperatorConfiguration"
},
diff --git a/payload-manifests/featuregates/featureGate-Hypershift-TechPreviewNoUpgrade.yaml b/payload-manifests/featuregates/featureGate-Hypershift-TechPreviewNoUpgrade.yaml
index 5853607c02b..c6c5d5dda02 100644
--- a/payload-manifests/featuregates/featureGate-Hypershift-TechPreviewNoUpgrade.yaml
+++ b/payload-manifests/featuregates/featureGate-Hypershift-TechPreviewNoUpgrade.yaml
@@ -154,6 +154,9 @@
{
"name": "ClusterUpdateAcceptRisks"
},
+ {
+ "name": "ClusterUpdatePreflight"
+ },
{
"name": "ClusterVersionOperatorConfiguration"
},
diff --git a/payload-manifests/featuregates/featureGate-SelfManagedHA-Default.yaml b/payload-manifests/featuregates/featureGate-SelfManagedHA-Default.yaml
index 43c5affe7e2..a41ad731444 100644
--- a/payload-manifests/featuregates/featureGate-SelfManagedHA-Default.yaml
+++ b/payload-manifests/featuregates/featureGate-SelfManagedHA-Default.yaml
@@ -84,6 +84,9 @@
{
"name": "ClusterUpdateAcceptRisks"
},
+ {
+ "name": "ClusterUpdatePreflight"
+ },
{
"name": "ClusterVersionOperatorConfiguration"
},
diff --git a/payload-manifests/featuregates/featureGate-SelfManagedHA-DevPreviewNoUpgrade.yaml b/payload-manifests/featuregates/featureGate-SelfManagedHA-DevPreviewNoUpgrade.yaml
index e9d704c6a35..d640e3d8289 100644
--- a/payload-manifests/featuregates/featureGate-SelfManagedHA-DevPreviewNoUpgrade.yaml
+++ b/payload-manifests/featuregates/featureGate-SelfManagedHA-DevPreviewNoUpgrade.yaml
@@ -20,6 +20,9 @@
{
"name": "ClusterAPIInstall"
},
+ {
+ "name": "ClusterUpdatePreflight"
+ },
{
"name": "EventedPLEG"
},
diff --git a/payload-manifests/featuregates/featureGate-SelfManagedHA-OKD.yaml b/payload-manifests/featuregates/featureGate-SelfManagedHA-OKD.yaml
index 9c72a8df94f..18c37518793 100644
--- a/payload-manifests/featuregates/featureGate-SelfManagedHA-OKD.yaml
+++ b/payload-manifests/featuregates/featureGate-SelfManagedHA-OKD.yaml
@@ -86,6 +86,9 @@
{
"name": "ClusterUpdateAcceptRisks"
},
+ {
+ "name": "ClusterUpdatePreflight"
+ },
{
"name": "ClusterVersionOperatorConfiguration"
},
diff --git a/payload-manifests/featuregates/featureGate-SelfManagedHA-TechPreviewNoUpgrade.yaml b/payload-manifests/featuregates/featureGate-SelfManagedHA-TechPreviewNoUpgrade.yaml
index f3a7e2c225a..c6e080ed7f7 100644
--- a/payload-manifests/featuregates/featureGate-SelfManagedHA-TechPreviewNoUpgrade.yaml
+++ b/payload-manifests/featuregates/featureGate-SelfManagedHA-TechPreviewNoUpgrade.yaml
@@ -136,6 +136,9 @@
{
"name": "ClusterUpdateAcceptRisks"
},
+ {
+ "name": "ClusterUpdatePreflight"
+ },
{
"name": "ClusterVersionOperatorConfiguration"
},