Fix review comments

- Add singleton documentation
- Remove omitempty,omitzero from spec
- Remove omitempty,omitzero from status
- Add conditions list size documentation
- Change MaxItems from 20 to 5
- Add struct godoc
- Fix grammar: 'will be' changed to 'has been'

Author: pawanpinjarkar

machineconfiguration/v1/types_internalreleaseimage.go

@@ -19,6 +19,7 @@ import (
 // InternalReleaseImage is used to keep track and manage a set
 // of release bundles (OCP and OLM operators images) that are stored
 // into the control planes nodes.
+// This is a singleton resource with 'cluster' as the only valid name. 
 //
 // Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
 // +openshift:compatibility-gen:level=1
@@ -32,11 +33,11 @@ type InternalReleaseImage struct {
 
 	// spec describes the configuration of this internal release image.
 	// +required
-	Spec InternalReleaseImageSpec `json:"spec,omitempty,omitzero"`
+	Spec InternalReleaseImageSpec `json:"spec"`
 
 	// status describes the last observed state of this internal release image.
 	// +optional
-	Status InternalReleaseImageStatus `json:"status,omitempty,omitzero"`
+	Status InternalReleaseImageStatus `json:"status"`
 }
 
 // InternalReleaseImageSpec defines the desired state of a InternalReleaseImage.
@@ -70,10 +71,11 @@ type InternalReleaseImageStatus struct {
 	// conditions represent the observations of the InternalReleaseImage controller current state.
 	// Valid types are: Degraded.
 	// If Degraded is true, that means something has gone wrong in the controller.
+	// The conditions list must contain at most 5 entries.
 	// +listType=map
 	// +listMapKey=type
 	// +kubebuilder:validation:MinItems=1
-	// +kubebuilder:validation:MaxItems=20
+	// +kubebuilder:validation:MaxItems=5
 	// +optional
 	Conditions []metav1.Condition `json:"conditions,omitempty"`
 	// releases is a list of the release bundles currently owned and managed by the
@@ -99,6 +101,7 @@ const (
 	InternalReleaseImageStatusConditionTypeDegraded InternalReleaseImageStatusConditionType = "Degraded"
 )
 
+// InternalReleaseImageBundleStatus describes the observed state of a single release bundle managed by the cluster.
 type InternalReleaseImageBundleStatus struct {
 	// conditions represent the observations of an internal release image current state. Valid types are:
 	// Mounted, Installing, Available, Removing and Degraded.
@@ -129,7 +132,7 @@ type InternalReleaseImageBundleStatus struct {
 	// 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.
+	// The field is optional, and it will be provided after a release has been 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"