1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
|
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
name: clusterversions.config.openshift.io
spec:
group: config.openshift.io
versions:
- name: v1
served: true
storage: true
scope: Cluster
subresources:
status: {}
names:
plural: clusterversions
singular: clusterversion
kind: ClusterVersion
preserveUnknownFields: false
additionalPrinterColumns:
- name: Version
type: string
JSONPath: .status.history[?(@.state=="Completed")].version
- name: Available
type: string
JSONPath: .status.conditions[?(@.type=="Available")].status
- name: Progressing
type: string
JSONPath: .status.conditions[?(@.type=="Progressing")].status
- name: Since
type: date
JSONPath: .status.conditions[?(@.type=="Progressing")].lastTransitionTime
- name: Status
type: string
JSONPath: .status.conditions[?(@.type=="Progressing")].message
validation:
openAPIV3Schema:
description: ClusterVersion is the configuration for the ClusterVersionOperator.
This is where parameters related to automatic updates can be set.
type: object
required:
- spec
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.
type: object
required:
- clusterID
properties:
channel:
description: 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.
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. You may specify the version field without setting
image if an update exists with that version in the availableUpdates
or history. \n 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
properties:
force:
description: "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. \n This flag does not override other forms
of consistency checking that are required before a new update
is deployed."
type: boolean
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
version:
description: version is a semantic versioning identifying the update
version. When this field is part of spec, version is optional
if image is specified.
type: string
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
items:
description: ComponentOverride allows overriding cluster version operator's
behavior for a component.
type: object
required:
- group
- kind
- name
- namespace
- unmanaged
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
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
status:
description: status contains information about the available updates and
any in-progress updates.
type: object
required:
- availableUpdates
- desired
- observedGeneration
- versionHash
properties:
availableUpdates:
description: 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.
type: array
items:
description: Update represents a release of the ClusterVersionOperator,
referenced by the Image member.
type: object
properties:
force:
description: "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. \n This flag
does not override other forms of consistency checking that are
required before a new update is deployed."
type: boolean
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
version:
description: version is a semantic versioning identifying the
update version. When this field is part of spec, version is
optional if image is specified.
type: string
nullable: true
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
items:
description: ClusterOperatorStatusCondition represents the state of
the operator's managed and monitored components.
type: object
required:
- lastTransitionTime
- status
- type
properties:
lastTransitionTime:
description: lastTransitionTime is the time of the last update
to the current status property.
type: string
format: date-time
message:
description: message provides additional information about the
current condition. This is only to be consumed by humans.
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
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
properties:
force:
description: "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. \n This flag does not override other forms
of consistency checking that are required before a new update
is deployed."
type: boolean
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
version:
description: version is a semantic versioning identifying the update
version. When this field is part of spec, version is optional
if image is specified.
type: string
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
items:
description: UpdateHistory is a single attempted update to the cluster.
type: object
required:
- completionTime
- image
- startedTime
- state
- verified
properties:
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).
type: string
format: date-time
nullable: true
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.
type: string
format: date-time
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.
type: boolean
version:
description: 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.
type: string
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.
type: integer
format: int64
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
versions:
- name: v1
served: true
storage: true
|
