ClusterVersion [config.openshift.io/v1]

Description

ClusterVersion is the configuration for the ClusterVersionOperator. This is where parameters related to automatic updates can be set.

Type

object

Required

  • spec

Specification

PropertyTypeDescription

apiVersion

string

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

kind

string

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

metadata

ObjectMeta_v2 meta/v1

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

spec is the desired state of the cluster version - the operator will work to ensure that the desired version is applied to the cluster.

status

object

status contains information about the available updates and any in-progress updates.

.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.

Type

object

Required

  • clusterID
PropertyTypeDescription

channel

string

channel is an identifier for explicitly requesting that a non-default set of updates be applied to this cluster. The default channel will be contain stable updates that are appropriate for production clusters.

clusterID

string

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.

desiredUpdate

object

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. You may specify the version field without setting image if an update exists with that version in the availableUpdates or history. 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. Not all rollbacks will succeed.

overrides

array

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.

overrides[]

object

ComponentOverride allows overriding cluster version operator’s behavior for a component.

upstream

string

upstream may be used to specify the preferred update server. By default it will use the appropriate update server for the cluster and region.

.spec.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. You may specify the version field without setting image if an update exists with that version in the availableUpdates or history. 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. Not all rollbacks will succeed.

Type

object

PropertyTypeDescription

force

boolean

force allows an administrator to update to an image that has failed verification, does not appear in the availableUpdates list, or otherwise would be blocked by normal protections on update. This option should only be used when the authenticity of the provided image has been verified out of band because the provided image will run with full administrative access to the cluster. Do not use this flag with images that comes from unknown or potentially malicious sources. This flag does not override other forms of consistency checking that are required before a new update is deployed.

image

string

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.

version

string

version is a semantic versioning identifying the update version. When this field is part of spec, version is optional if image is specified.

.spec.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.

Type

array

.spec.overrides[]

Description

ComponentOverride allows overriding cluster version operator’s behavior for a component.

Type

object

Required

  • group

  • kind

  • name

  • namespace

  • unmanaged

PropertyTypeDescription

group

string

group identifies the API group that the kind is in.

kind

string

kind indentifies which object to override.

name

string

name is the component’s name.

namespace

string

namespace is the component’s namespace. If the resource is cluster scoped, the namespace should be empty.

unmanaged

boolean

unmanaged controls if cluster version operator should stop managing the resources in this cluster. Default: false

.status

Description

status contains information about the available updates and any in-progress updates.

Type

object

Required

  • desired

  • observedGeneration

  • versionHash

PropertyTypeDescription

availableUpdates

``

availableUpdates contains the list of updates that are appropriate for this cluster. This list may be empty if no updates are recommended, if the update service is unavailable, or if an invalid channel has been specified.

conditions

array

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.

conditions[]

object

ClusterOperatorStatusCondition represents the state of the operator’s managed and monitored components.

desired

object

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.

history

array

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.

history[]

object

UpdateHistory is a single attempted update to the cluster.

observedGeneration

integer

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.

versionHash

string

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.

.status.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.

Type

array

.status.conditions[]

Description

ClusterOperatorStatusCondition represents the state of the operator’s managed and monitored components.

Type

object

Required

  • lastTransitionTime

  • status

  • type

PropertyTypeDescription

lastTransitionTime

string

lastTransitionTime is the time of the last update to the current status property.

message

string

message provides additional information about the current condition. This is only to be consumed by humans.

reason

string

reason is the CamelCase reason for the condition’s current status.

status

string

status of the condition, one of True, False, Unknown.

type

string

type specifies the aspect reported by this condition.

.status.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.

Type

object

PropertyTypeDescription

channels

array (string)

channels is the set of Cincinnati channels to which the release currently belongs.

image

string

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.

url

string

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.

version

string

version is a semantic versioning identifying the update version. When this field is part of spec, version is optional if image is specified.

.status.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.

Type

array

.status.history[]

Description

UpdateHistory is a single attempted update to the cluster.

Type

object

Required

  • image

  • startedTime

  • state

  • verified

PropertyTypeDescription

completionTime

``

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).

image

string

image is a container image location that contains the update. This value is always populated.

startedTime

string

startedTime is the time at which the update was started.

state

string

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).

verified

boolean

verified indicates whether the provided update was properly verified before it was installed. If this is false the cluster may not be trusted.

version

string

version is a semantic versioning 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.

API endpoints

The following API endpoints are available:

  • /apis/config.openshift.io/v1/clusterversions

    • DELETE: delete collection of ClusterVersion

    • GET: list objects of kind ClusterVersion

    • POST: create a ClusterVersion

  • /apis/config.openshift.io/v1/clusterversions/{name}

    • DELETE: delete a ClusterVersion

    • GET: read the specified ClusterVersion

    • PATCH: partially update the specified ClusterVersion

    • PUT: replace the specified ClusterVersion

  • /apis/config.openshift.io/v1/clusterversions/{name}/status

    • GET: read status of the specified ClusterVersion

    • PATCH: partially update status of the specified ClusterVersion

    • PUT: replace status of the specified ClusterVersion

/apis/config.openshift.io/v1/clusterversions

Table 1. Global query parameters
ParameterTypeDescription

pretty

string

If ‘true’, then the output is pretty printed.

HTTP method

DELETE

Description

delete collection of ClusterVersion

Table 2. Query parameters
ParameterTypeDescription

allowWatchBookmarks

boolean

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 3. HTTP responses
HTTP codeReponse body

200 - OK

Status_v2 meta/v1

HTTP method

GET

Description

list objects of kind ClusterVersion

Table 4. Query parameters
ParameterTypeDescription

allowWatchBookmarks

boolean

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 5. HTTP responses
HTTP codeReponse body

200 - OK

ClusterVersionList config.openshift.io/v1

HTTP method

POST

Description

create a ClusterVersion

Table 6. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 7. Body parameters
ParameterTypeDescription

body

ClusterVersion config.openshift.io/v1

Table 8. HTTP responses
HTTP codeReponse body

200 - OK

ClusterVersion config.openshift.io/v1

/apis/config.openshift.io/v1/clusterversions/{name}

Table 9. Global path parameters
ParameterTypeDescription

name

string

name of the ClusterVersion

Table 10. Global query parameters
ParameterTypeDescription

pretty

string

If ‘true’, then the output is pretty printed.

HTTP method

DELETE

Description

delete a ClusterVersion

Table 11. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

gracePeriodSeconds

integer

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents

boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy

string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

Table 12. Body parameters
ParameterTypeDescription

body

DeleteOptions_v2 meta/v1

Table 13. HTTP responses
HTTP codeReponse body

200 - OK

Status_v2 meta/v1

HTTP method

GET

Description

read the specified ClusterVersion

Table 14. Query parameters
ParameterTypeDescription

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

Table 15. HTTP responses
HTTP codeReponse body

200 - OK

ClusterVersion config.openshift.io/v1

HTTP method

PATCH

Description

partially update the specified ClusterVersion

Table 16. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 17. Body parameters
ParameterTypeDescription

body

Patch meta/v1

Table 18. HTTP responses
HTTP codeReponse body

200 - OK

ClusterVersion config.openshift.io/v1

HTTP method

PUT

Description

replace the specified ClusterVersion

Table 19. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 20. Body parameters
ParameterTypeDescription

body

ClusterVersion config.openshift.io/v1

Table 21. HTTP responses
HTTP codeReponse body

200 - OK

ClusterVersion config.openshift.io/v1

/apis/config.openshift.io/v1/clusterversions/{name}/status

Table 22. Global path parameters
ParameterTypeDescription

name

string

name of the ClusterVersion

Table 23. Global query parameters
ParameterTypeDescription

pretty

string

If ‘true’, then the output is pretty printed.

HTTP method

GET

Description

read status of the specified ClusterVersion

Table 24. Query parameters
ParameterTypeDescription

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

Table 25. HTTP responses
HTTP codeReponse body

200 - OK

ClusterVersion config.openshift.io/v1

HTTP method

PATCH

Description

partially update status of the specified ClusterVersion

Table 26. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 27. Body parameters
ParameterTypeDescription

body

Patch meta/v1

Table 28. HTTP responses
HTTP codeReponse body

200 - OK

ClusterVersion config.openshift.io/v1

HTTP method

PUT

Description

replace status of the specified ClusterVersion

Table 29. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 30. Body parameters
ParameterTypeDescription

body

ClusterVersion config.openshift.io/v1

Table 31. HTTP responses
HTTP codeReponse body

200 - OK

ClusterVersion config.openshift.io/v1