modified v1alpha1 internalreleaseimage status to use the same structure adopted for the MCN status field

Author: andfasano

hack/update-payload-crds.sh

@@ -24,6 +24,7 @@ crd_globs="\
     config/v1/zz_generated.crd-manifests/0000_10_openshift-controller-manager_01_builds*.crd.yaml
     operator/v1/zz_generated.crd-manifests/0000_50_openshift-controller-manager_02_openshiftcontrollermanagers*.crd.yaml
     machineconfiguration/v1/zz_generated.crd-manifests/*.crd.yaml
+    machineconfiguration/v1alpha1/zz_generated.crd-manifests/0000_80_machine-config_01_internalreleaseimages-*.crd.yaml
     operator/v1/zz_generated.crd-manifests/0000_80_machine-config_01_machineconfigurations*.crd.yaml
     config/v1alpha1/zz_generated.crd-manifests/0000_10_config-operator_01_clustermonitoring*.crd.yaml
     operator/v1/zz_generated.crd-manifests/*_storage_01_storages*.crd.yaml

…hift.io/NoRegistryClusterOperations.yaml …enshift.io/NoRegistryClusterInstall.yamlmachineconfiguration/v1/tests/machineconfignodes.machineconfiguration.openshift.io/NoRegistryClusterOperations.yaml renamed to machineconfiguration/v1/tests/machineconfignodes.machineconfiguration.openshift.io/NoRegistryClusterInstall.yaml machineconfiguration/v1/tests/machineconfignodes.machineconfiguration.openshift.io/NoRegistryClusterOperations.yaml renamed to machineconfiguration/v1/tests/machineconfignodes.machineconfiguration.openshift.io/NoRegistryClusterInstall.yaml

@@ -3,7 +3,7 @@ name: "[TechPreview] InternalReleaseImage"
 crdName: machineconfignodes.machineconfiguration.openshift.io
 featureGates:
 - MachineConfigNodes
-- NoRegistryClusterOperations
+- NoRegistryClusterInstall
 tests:
   onUpdate:
     - name: Should be able to update a MachineConfigNode with a minimal internalReleaseImage status field.

machineconfiguration/v1/types_machineconfignode.go

@@ -161,7 +161,7 @@ type MachineConfigNodeStatus struct {
 	// internalReleaseImage describes the status of the release payloads stored in the node.
 	// When specified, an internalReleaseImage custom resource exists on the cluster, and the specified images will be made available on the control plane nodes.
 	// This field will reflect the actual on-disk state of those release images.
-	// +openshift:enable:FeatureGate=NoRegistryClusterOperations
+	// +openshift:enable:FeatureGate=NoRegistryClusterInstall
 	// +optional
 	InternalReleaseImage MachineConfigNodeStatusInternalReleaseImage `json:"internalReleaseImage,omitzero,omitempty"`
 }
@@ -170,47 +170,58 @@ type MachineConfigNodeStatus struct {
 // config node.
 type MachineConfigNodeStatusInternalReleaseImage struct {
 	// releases is a list of the release bundles currently owned and managed by the
-	// cluster, indicating that their images can be safely pulled by any cluster entity
-	// requiring them.
-	// This field can contain between 1 and 5 entries.
+	// cluster.
+	// A release bundle content could be safely pulled only when its Conditions field
+	// contains at least an Available entry set to "True" and Degraded to "False".
+	// Entries must be unique, keyed on the name field.
+	// releases must contain at least one entry and must not exceed 32 entries.
 	// +listType=map
 	// +listMapKey=name
 	// +kubebuilder:validation:MinItems=1
-	// +kubebuilder:validation:MaxItems=5
+	// +kubebuilder:validation:MaxItems=32
 	// +required
 	Releases []MachineConfigNodeStatusInternalReleaseImageRef `json:"releases,omitempty"`
 }
 
 // MachineConfigNodeStatusInternalReleaseImageRef is used to provide a more detailed reference for
 // a release bundle.
-// +openshift:enable:FeatureGate=NoRegistryClusterOperations
 type MachineConfigNodeStatusInternalReleaseImageRef struct {
-	// conditions represent the observations of an internal release image current state. See InternalReleaseImageConditionType for the possible
-	// type values.
+	// conditions represent the observations of an internal release image current state. Valid types are:
+	// Mounted, Installing, Available, Removing and Degraded.
+	//
+	// If Mounted is true, that means that a valid ISO has been mounted on the current node.
+	// If Installing is true, that means that a new release bundle is currently being copied on the current node, and not yet completed.
+	// If Available is true, it means that the release has been previously installed on the current node, and it can be used.
+	// If Removing is true, it means that a release deletion is in progress on the current node, and not yet completed.
+	// If Degraded is true, that means something has gone wrong in the current node.
+	//
 	// +listType=map
 	// +listMapKey=type
 	// +kubebuilder:validation:MinItems=1
 	// +kubebuilder:validation:MaxItems=5
 	// +optional
 	Conditions []metav1.Condition `json:"conditions,omitempty"`
 	// name indicates the desired release bundle identifier. This field is required and must be between 1 and 64 characters long.
+	// The expected name format is ocp-release-bundle-<version>-<arch|stream>.
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=64
+	// +kubebuilder:validation:XValidation:rule=`self.matches('^ocp-release-bundle-[0-9]+\\.[0-9]+\\.[0-9]+-[A-Za-z0-9_-]+$')`,message="must be ocp-release-bundle-<version>-<arch|stream> and <= 64 chars"
 	// +required
 	Name string `json:"name,omitempty"`
 	// image is an OCP release image referenced by digest.
 	// The format of the image pull spec is: host[:port][/namespace]/name@sha256:<digest>,
 	// where the digest must be 64 characters long, and consist only of lowercase hexadecimal characters, a-f and 0-9.
 	// The length of the whole spec must be between 1 to 447 characters.
+	// The field is optional, and it will be provided after a release will be successfully installed.
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=447
 	// +kubebuilder:validation:XValidation:rule=`(self.split('@').size() == 2 && self.split('@')[1].matches('^sha256:[a-f0-9]{64}$'))`,message="the OCI Image reference must end with a valid '@sha256:<digest>' suffix, where '<digest>' is 64 characters long"
 	// +kubebuilder:validation:XValidation: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-_.]*?$'))`,message="the OCI Image name should follow the host[:port][/namespace]/name format, resembling a valid URL without the scheme"
-	// +required
+	// +optional
 	Image string `json:"image,omitempty"`
 }
 
-// InternalReleaseImageConditionType is each possible state for each possible MachineConfigNodeStatusInternalReleaseImageRef
+// InternalReleaseImageConditionType is each possible state for each possible InternalReleaseImageBundleStatus
 // conditions type.
 // +enum
 type InternalReleaseImageConditionType string

machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_machineconfignodes-Hypershift-CustomNoUpgrade.crd.yaml

@@ -361,18 +361,26 @@ spec:
                   releases:
                     description: |-
                       releases is a list of the release bundles currently owned and managed by the
-                      cluster, indicating that their images can be safely pulled by any cluster entity
-                      requiring them.
-                      This field can contain between 1 and 5 entries.
+                      cluster.
+                      A release bundle content could be safely pulled only when its Conditions field
+                      contains at least an Available entry set to "True" and Degraded to "False".
+                      Entries must be unique, keyed on the name field.
+                      releases must contain at least one entry and must not exceed 32 entries.
                     items:
                       description: |-
                         MachineConfigNodeStatusInternalReleaseImageRef is used to provide a more detailed reference for
                         a release bundle.
                       properties:
                         conditions:
                           description: |-
-                            conditions represent the observations of an internal release image current state. See InternalReleaseImageConditionType for the possible
-                            type values.
+                            conditions represent the observations of an internal release image current state. Valid types are:
+                            Mounted, Installing, Available, Removing and Degraded.
+
+                            If Mounted is true, that means that a valid ISO has been mounted on the current node.
+                            If Installing is true, that means that a new release bundle is currently being copied on the current node, and not yet completed.
+                            If Available is true, it means that the release has been previously installed on the current node, and it can be used.
+                            If Removing is true, it means that a release deletion is in progress on the current node, and not yet completed.
+                            If Degraded is true, that means something has gone wrong in the current node.
                           items:
                             description: Condition contains details for one aspect
                               of the current state of this API Resource.
@@ -441,6 +449,7 @@ spec:
                             The format of the image pull spec is: host[:port][/namespace]/name@sha256:<digest>,
                             where the digest must be 64 characters long, and consist only of lowercase hexadecimal characters, a-f and 0-9.
                             The length of the whole spec must be between 1 to 447 characters.
+                            The field is optional, and it will be provided after a release will be successfully installed.
                           maxLength: 447
                           minLength: 1
                           type: string
@@ -453,17 +462,20 @@ spec:
                               format, resembling a valid URL without the scheme
                             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-_.]*?$'))
                         name:
-                          description: name indicates the desired release bundle identifier.
-                            This field is required and must be between 1 and 64 characters
-                            long.
+                          description: |-
+                            name indicates the desired release bundle identifier. This field is required and must be between 1 and 64 characters long.
+                            The expected name format is ocp-release-bundle-<version>-<arch|stream>.
                           maxLength: 64
                           minLength: 1
                           type: string
+                          x-kubernetes-validations:
+                          - message: must be ocp-release-bundle-<version>-<arch|stream>
+                              and <= 64 chars
+                            rule: self.matches('^ocp-release-bundle-[0-9]+\\.[0-9]+\\.[0-9]+-[A-Za-z0-9_-]+$')
                       required:
-                      - image
                       - name
                       type: object
-                    maxItems: 5
+                    maxItems: 32
                     minItems: 1
                     type: array
                     x-kubernetes-list-map-keys:

machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_machineconfignodes-SelfManagedHA-CustomNoUpgrade.crd.yaml

@@ -361,18 +361,26 @@ spec:
                   releases:
                     description: |-
                       releases is a list of the release bundles currently owned and managed by the
-                      cluster, indicating that their images can be safely pulled by any cluster entity
-                      requiring them.
-                      This field can contain between 1 and 5 entries.
+                      cluster.
+                      A release bundle content could be safely pulled only when its Conditions field
+                      contains at least an Available entry set to "True" and Degraded to "False".
+                      Entries must be unique, keyed on the name field.
+                      releases must contain at least one entry and must not exceed 32 entries.
                     items:
                       description: |-
                         MachineConfigNodeStatusInternalReleaseImageRef is used to provide a more detailed reference for
                         a release bundle.
                       properties:
                         conditions:
                           description: |-
-                            conditions represent the observations of an internal release image current state. See InternalReleaseImageConditionType for the possible
-                            type values.
+                            conditions represent the observations of an internal release image current state. Valid types are:
+                            Mounted, Installing, Available, Removing and Degraded.
+
+                            If Mounted is true, that means that a valid ISO has been mounted on the current node.
+                            If Installing is true, that means that a new release bundle is currently being copied on the current node, and not yet completed.
+                            If Available is true, it means that the release has been previously installed on the current node, and it can be used.
+                            If Removing is true, it means that a release deletion is in progress on the current node, and not yet completed.
+                            If Degraded is true, that means something has gone wrong in the current node.
                           items:
                             description: Condition contains details for one aspect
                               of the current state of this API Resource.
@@ -441,6 +449,7 @@ spec:
                             The format of the image pull spec is: host[:port][/namespace]/name@sha256:<digest>,
                             where the digest must be 64 characters long, and consist only of lowercase hexadecimal characters, a-f and 0-9.
                             The length of the whole spec must be between 1 to 447 characters.
+                            The field is optional, and it will be provided after a release will be successfully installed.
                           maxLength: 447
                           minLength: 1
                           type: string
@@ -453,17 +462,20 @@ spec:
                               format, resembling a valid URL without the scheme
                             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-_.]*?$'))
                         name:
-                          description: name indicates the desired release bundle identifier.
-                            This field is required and must be between 1 and 64 characters
-                            long.
+                          description: |-
+                            name indicates the desired release bundle identifier. This field is required and must be between 1 and 64 characters long.
+                            The expected name format is ocp-release-bundle-<version>-<arch|stream>.
                           maxLength: 64
                           minLength: 1
                           type: string
+                          x-kubernetes-validations:
+                          - message: must be ocp-release-bundle-<version>-<arch|stream>
+                              and <= 64 chars
+                            rule: self.matches('^ocp-release-bundle-[0-9]+\\.[0-9]+\\.[0-9]+-[A-Za-z0-9_-]+$')
                       required:
-                      - image
                       - name
                       type: object
-                    maxItems: 5
+                    maxItems: 32
                     minItems: 1
                     type: array
                     x-kubernetes-list-map-keys:

machineconfiguration/v1/zz_generated.crd-manifests/0000_80_machine-config_01_machineconfignodes-SelfManagedHA-DevPreviewNoUpgrade.crd.yaml

@@ -361,18 +361,26 @@ spec:
                   releases:
                     description: |-
                       releases is a list of the release bundles currently owned and managed by the
-                      cluster, indicating that their images can be safely pulled by any cluster entity
-                      requiring them.
-                      This field can contain between 1 and 5 entries.
+                      cluster.
+                      A release bundle content could be safely pulled only when its Conditions field
+                      contains at least an Available entry set to "True" and Degraded to "False".
+                      Entries must be unique, keyed on the name field.
+                      releases must contain at least one entry and must not exceed 32 entries.
                     items:
                       description: |-
                         MachineConfigNodeStatusInternalReleaseImageRef is used to provide a more detailed reference for
                         a release bundle.
                       properties:
                         conditions:
                           description: |-
-                            conditions represent the observations of an internal release image current state. See InternalReleaseImageConditionType for the possible
-                            type values.
+                            conditions represent the observations of an internal release image current state. Valid types are:
+                            Mounted, Installing, Available, Removing and Degraded.
+
+                            If Mounted is true, that means that a valid ISO has been mounted on the current node.
+                            If Installing is true, that means that a new release bundle is currently being copied on the current node, and not yet completed.
+                            If Available is true, it means that the release has been previously installed on the current node, and it can be used.
+                            If Removing is true, it means that a release deletion is in progress on the current node, and not yet completed.
+                            If Degraded is true, that means something has gone wrong in the current node.
                           items:
                             description: Condition contains details for one aspect
                               of the current state of this API Resource.
@@ -441,6 +449,7 @@ spec:
                             The format of the image pull spec is: host[:port][/namespace]/name@sha256:<digest>,
                             where the digest must be 64 characters long, and consist only of lowercase hexadecimal characters, a-f and 0-9.
                             The length of the whole spec must be between 1 to 447 characters.
+                            The field is optional, and it will be provided after a release will be successfully installed.
                           maxLength: 447
                           minLength: 1
                           type: string
@@ -453,17 +462,20 @@ spec:
                               format, resembling a valid URL without the scheme
                             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-_.]*?$'))
                         name:
-                          description: name indicates the desired release bundle identifier.
-                            This field is required and must be between 1 and 64 characters
-                            long.
+                          description: |-
+                            name indicates the desired release bundle identifier. This field is required and must be between 1 and 64 characters long.
+                            The expected name format is ocp-release-bundle-<version>-<arch|stream>.
                           maxLength: 64
                           minLength: 1
                           type: string
+                          x-kubernetes-validations:
+                          - message: must be ocp-release-bundle-<version>-<arch|stream>
+                              and <= 64 chars
+                            rule: self.matches('^ocp-release-bundle-[0-9]+\\.[0-9]+\\.[0-9]+-[A-Za-z0-9_-]+$')
                       required:
-                      - image
                       - name
                       type: object
-                    maxItems: 5
+                    maxItems: 32
                     minItems: 1
                     type: array
                     x-kubernetes-list-map-keys: