|
| 1 | +apiVersion: apiextensions.k8s.io/v1 |
| 2 | +kind: CustomResourceDefinition |
| 3 | +metadata: |
| 4 | + annotations: |
| 5 | + api-approved.openshift.io: https://github.com/openshift/api/pull/2510 |
| 6 | + api.openshift.io/merged-by-featuregates: "true" |
| 7 | + include.release.openshift.io/ibm-cloud-managed: "true" |
| 8 | + release.openshift.io/feature-set: CustomNoUpgrade |
| 9 | + labels: |
| 10 | + openshift.io/operator-managed: "" |
| 11 | + name: internalreleaseimages.machineconfiguration.openshift.io |
| 12 | +spec: |
| 13 | + group: machineconfiguration.openshift.io |
| 14 | + names: |
| 15 | + kind: InternalReleaseImage |
| 16 | + listKind: InternalReleaseImageList |
| 17 | + plural: internalreleaseimages |
| 18 | + singular: internalreleaseimage |
| 19 | + scope: Cluster |
| 20 | + versions: |
| 21 | + - name: v1alpha1 |
| 22 | + schema: |
| 23 | + openAPIV3Schema: |
| 24 | + description: |- |
| 25 | + InternalReleaseImage is used to keep track and manage a set |
| 26 | + of release bundles (OCP and OLM operators images) that are stored |
| 27 | + into the control planes nodes. |
| 28 | +
|
| 29 | + Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. |
| 30 | + properties: |
| 31 | + apiVersion: |
| 32 | + description: |- |
| 33 | + APIVersion defines the versioned schema of this representation of an object. |
| 34 | + Servers should convert recognized schemas to the latest internal value, and |
| 35 | + may reject unrecognized values. |
| 36 | + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
| 37 | + type: string |
| 38 | + kind: |
| 39 | + description: |- |
| 40 | + Kind is a string value representing the REST resource this object represents. |
| 41 | + Servers may infer this from the endpoint the client submits requests to. |
| 42 | + Cannot be updated. |
| 43 | + In CamelCase. |
| 44 | + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| 45 | + type: string |
| 46 | + metadata: |
| 47 | + type: object |
| 48 | + spec: |
| 49 | + description: spec describes the configuration of this internal release |
| 50 | + image. |
| 51 | + properties: |
| 52 | + releases: |
| 53 | + description: |- |
| 54 | + releases is a list of release bundle identifiers that the user wants to |
| 55 | + add/remove to/from the control plane nodes. |
| 56 | + Entries must be unique, keyed on the name field. |
| 57 | + releases must contain at least one entry and must not exceed 16 entries. |
| 58 | + items: |
| 59 | + description: |- |
| 60 | + InternalReleaseImageRef is used to provide a simple reference for a release |
| 61 | + bundle. Currently it contains only the name field. |
| 62 | + properties: |
| 63 | + name: |
| 64 | + description: |- |
| 65 | + name indicates the desired release bundle identifier. This field is required and must be between 1 and 64 characters long. |
| 66 | + The expected name format is ocp-release-bundle-<version>-<arch|stream>. |
| 67 | + maxLength: 64 |
| 68 | + minLength: 1 |
| 69 | + type: string |
| 70 | + x-kubernetes-validations: |
| 71 | + - message: must be ocp-release-bundle-<version>-<arch|stream> |
| 72 | + and <= 64 chars |
| 73 | + rule: self.matches('^ocp-release-bundle-[0-9]+\\.[0-9]+\\.[0-9]+-[A-Za-z0-9._-]+$') |
| 74 | + required: |
| 75 | + - name |
| 76 | + type: object |
| 77 | + maxItems: 16 |
| 78 | + minItems: 1 |
| 79 | + type: array |
| 80 | + x-kubernetes-list-map-keys: |
| 81 | + - name |
| 82 | + x-kubernetes-list-type: map |
| 83 | + required: |
| 84 | + - releases |
| 85 | + type: object |
| 86 | + status: |
| 87 | + description: status describes the last observed state of this internal |
| 88 | + release image. |
| 89 | + properties: |
| 90 | + conditions: |
| 91 | + description: |- |
| 92 | + conditions represent the observations of the InternalReleaseImage controller current state. |
| 93 | + Valid types are: Degraded. |
| 94 | + If Degraded is true, that means something has gone wrong in the controller. |
| 95 | + items: |
| 96 | + description: Condition contains details for one aspect of the current |
| 97 | + state of this API Resource. |
| 98 | + properties: |
| 99 | + lastTransitionTime: |
| 100 | + description: |- |
| 101 | + lastTransitionTime is the last time the condition transitioned from one status to another. |
| 102 | + This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. |
| 103 | + format: date-time |
| 104 | + type: string |
| 105 | + message: |
| 106 | + description: |- |
| 107 | + message is a human readable message indicating details about the transition. |
| 108 | + This may be an empty string. |
| 109 | + maxLength: 32768 |
| 110 | + type: string |
| 111 | + observedGeneration: |
| 112 | + description: |- |
| 113 | + observedGeneration represents the .metadata.generation that the condition was set based upon. |
| 114 | + For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date |
| 115 | + with respect to the current state of the instance. |
| 116 | + format: int64 |
| 117 | + minimum: 0 |
| 118 | + type: integer |
| 119 | + reason: |
| 120 | + description: |- |
| 121 | + reason contains a programmatic identifier indicating the reason for the condition's last transition. |
| 122 | + Producers of specific condition types may define expected values and meanings for this field, |
| 123 | + and whether the values are considered a guaranteed API. |
| 124 | + The value should be a CamelCase string. |
| 125 | + This field may not be empty. |
| 126 | + maxLength: 1024 |
| 127 | + minLength: 1 |
| 128 | + pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$ |
| 129 | + type: string |
| 130 | + status: |
| 131 | + description: status of the condition, one of True, False, Unknown. |
| 132 | + enum: |
| 133 | + - "True" |
| 134 | + - "False" |
| 135 | + - Unknown |
| 136 | + type: string |
| 137 | + type: |
| 138 | + description: type of condition in CamelCase or in foo.example.com/CamelCase. |
| 139 | + maxLength: 316 |
| 140 | + 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])$ |
| 141 | + type: string |
| 142 | + required: |
| 143 | + - lastTransitionTime |
| 144 | + - message |
| 145 | + - reason |
| 146 | + - status |
| 147 | + - type |
| 148 | + type: object |
| 149 | + maxItems: 20 |
| 150 | + minItems: 1 |
| 151 | + type: array |
| 152 | + x-kubernetes-list-map-keys: |
| 153 | + - type |
| 154 | + x-kubernetes-list-type: map |
| 155 | + releases: |
| 156 | + description: |- |
| 157 | + releases is a list of the release bundles currently owned and managed by the |
| 158 | + cluster. |
| 159 | + A release bundle content could be safely pulled only when its Conditions field |
| 160 | + contains at least an Available entry set to "True" and Degraded to "False". |
| 161 | + Entries must be unique, keyed on the name field. |
| 162 | + releases must contain at least one entry and must not exceed 32 entries. |
| 163 | + items: |
| 164 | + properties: |
| 165 | + conditions: |
| 166 | + description: |- |
| 167 | + conditions represent the observations of an internal release image current state. Valid types are: |
| 168 | + Mounted, Installing, Available, Removing and Degraded. |
| 169 | +
|
| 170 | + If Mounted is true, that means that a valid ISO has been discovered and mounted on one of the cluster nodes. |
| 171 | + If Installing is true, that means that a new release bundle is currently being copied on one (or more) cluster nodes, and not yet completed. |
| 172 | + If Available is true, it means that the release has been previously installed on all the cluster nodes, and it can be used. |
| 173 | + If Removing is true, it means that a release deletion is in progress on one (or more) cluster nodes, and not yet completed. |
| 174 | + If Degraded is true, that means something has gone wrong (possibly on one or more cluster nodes). |
| 175 | +
|
| 176 | + In general, after installing a new release bundle, it is required to wait for the Conditions "Available" to become "True" (and all |
| 177 | + the other conditions to be equal to "False") before being able to pull its content. |
| 178 | + items: |
| 179 | + description: Condition contains details for one aspect of |
| 180 | + the current state of this API Resource. |
| 181 | + properties: |
| 182 | + lastTransitionTime: |
| 183 | + description: |- |
| 184 | + lastTransitionTime is the last time the condition transitioned from one status to another. |
| 185 | + This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. |
| 186 | + format: date-time |
| 187 | + type: string |
| 188 | + message: |
| 189 | + description: |- |
| 190 | + message is a human readable message indicating details about the transition. |
| 191 | + This may be an empty string. |
| 192 | + maxLength: 32768 |
| 193 | + type: string |
| 194 | + observedGeneration: |
| 195 | + description: |- |
| 196 | + observedGeneration represents the .metadata.generation that the condition was set based upon. |
| 197 | + For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date |
| 198 | + with respect to the current state of the instance. |
| 199 | + format: int64 |
| 200 | + minimum: 0 |
| 201 | + type: integer |
| 202 | + reason: |
| 203 | + description: |- |
| 204 | + reason contains a programmatic identifier indicating the reason for the condition's last transition. |
| 205 | + Producers of specific condition types may define expected values and meanings for this field, |
| 206 | + and whether the values are considered a guaranteed API. |
| 207 | + The value should be a CamelCase string. |
| 208 | + This field may not be empty. |
| 209 | + maxLength: 1024 |
| 210 | + minLength: 1 |
| 211 | + pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$ |
| 212 | + type: string |
| 213 | + status: |
| 214 | + description: status of the condition, one of True, False, |
| 215 | + Unknown. |
| 216 | + enum: |
| 217 | + - "True" |
| 218 | + - "False" |
| 219 | + - Unknown |
| 220 | + type: string |
| 221 | + type: |
| 222 | + description: type of condition in CamelCase or in foo.example.com/CamelCase. |
| 223 | + maxLength: 316 |
| 224 | + 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])$ |
| 225 | + type: string |
| 226 | + required: |
| 227 | + - lastTransitionTime |
| 228 | + - message |
| 229 | + - reason |
| 230 | + - status |
| 231 | + - type |
| 232 | + type: object |
| 233 | + maxItems: 5 |
| 234 | + minItems: 1 |
| 235 | + type: array |
| 236 | + x-kubernetes-list-map-keys: |
| 237 | + - type |
| 238 | + x-kubernetes-list-type: map |
| 239 | + image: |
| 240 | + description: |- |
| 241 | + image is an OCP release image referenced by digest. |
| 242 | + The format of the image pull spec is: host[:port][/namespace]/name@sha256:<digest>, |
| 243 | + where the digest must be 64 characters long, and consist only of lowercase hexadecimal characters, a-f and 0-9. |
| 244 | + The length of the whole spec must be between 1 to 447 characters. |
| 245 | + The field is optional, and it will be provided after a release will be successfully installed. |
| 246 | + maxLength: 447 |
| 247 | + minLength: 1 |
| 248 | + type: string |
| 249 | + x-kubernetes-validations: |
| 250 | + - message: the OCI Image reference must end with a valid '@sha256:<digest>' |
| 251 | + suffix, where '<digest>' is 64 characters long |
| 252 | + rule: (self.split('@').size() == 2 && self.split('@')[1].matches('^sha256:[a-f0-9]{64}$')) |
| 253 | + - message: the OCI Image name should follow the host[:port][/namespace]/name |
| 254 | + format, resembling a valid URL without the scheme |
| 255 | + rule: (self.split('@')[0].matches('^([a-zA-Z0-9-]+\\.)+[a-zA-Z0-9-]+(:[0-9]{2,5})?/([a-zA-Z0-9-_]{0,61}/)?[a-zA-Z0-9-_.]*?$')) |
| 256 | + name: |
| 257 | + description: |- |
| 258 | + name indicates the desired release bundle identifier. This field is required and must be between 1 and 64 characters long. |
| 259 | + The expected name format is ocp-release-bundle-<version>-<arch|stream>. |
| 260 | + maxLength: 64 |
| 261 | + minLength: 1 |
| 262 | + type: string |
| 263 | + x-kubernetes-validations: |
| 264 | + - message: must be ocp-release-bundle-<version>-<arch|stream> |
| 265 | + and <= 64 chars |
| 266 | + rule: self.matches('^ocp-release-bundle-[0-9]+\\.[0-9]+\\.[0-9]+-[A-Za-z0-9._-]+$') |
| 267 | + required: |
| 268 | + - name |
| 269 | + type: object |
| 270 | + maxItems: 32 |
| 271 | + minItems: 1 |
| 272 | + type: array |
| 273 | + x-kubernetes-list-map-keys: |
| 274 | + - name |
| 275 | + x-kubernetes-list-type: map |
| 276 | + required: |
| 277 | + - releases |
| 278 | + type: object |
| 279 | + required: |
| 280 | + - metadata |
| 281 | + - spec |
| 282 | + type: object |
| 283 | + x-kubernetes-validations: |
| 284 | + - message: internalreleaseimage is a singleton, .metadata.name must be 'cluster' |
| 285 | + rule: self.metadata.name == 'cluster' |
| 286 | + served: true |
| 287 | + storage: true |
| 288 | + subresources: |
| 289 | + status: {} |
0 commit comments