updates to documentation

Author: naseerahkani

machineconfiguration/v1/tests/machineconfignodes.machineconfiguration.openshift.io/ImageModeStatusReporting.yaml

@@ -185,4 +185,3 @@ tests:
           configImage: 
             currentImage: image-registry.openshift-image-registry.svc:5000/openshift-machine-config-operator/ocb-image@sha256:c47856f56e1fdb7c9d10a1658e4ea85fbea44d71fb0e82898d152b47e0f894c6
             desiredImage: image-registry.openshift-image-registry.svc:5000/openshift-machine-config-operator/ocb-image@sha256:7a539f562d8d5d3b6bd7338ac014e34dabc9626cf344d30e412ef98a55cc1bf6
- 

machineconfiguration/v1/types_machineconfignode.go

@@ -99,7 +99,7 @@ type MachineConfigNodeSpec struct {
 	// +required
 	ConfigVersion MachineConfigNodeSpecMachineConfigVersion `json:"configVersion"`
 
-	// configImage is an optional field for configuring the image in the referenced node.
+	// configImage is an optional field for configuring the OS image to be used for this node. This field will only exist if the node belongs to a pool opted into on-cluster image builds, and will override any MachineConfig referenced OSImageURL fields
 	// When omitted, Image Mode is not be enabled and the node will follow the standard update process of creating a rendered MachineConfig and updating to its specifications.
 	// When specified, Image Mode is enabled and will attempt to update the node to use the desired image. Following this, the node will follow the standard update process of creating a rendered MachineConfig and updating to its specifications.
 	// +openshift:enable:FeatureGate=ImageModeStatusReporting
@@ -129,7 +129,7 @@ type MachineConfigNodeStatus struct {
 	// configVersion describes the current and desired machine config version for this node.
 	// +optional
 	ConfigVersion *MachineConfigNodeStatusMachineConfigVersion `json:"configVersion,omitempty"`
-	// configImage is an optional field that reflects the current state of the image used by the node.
+	// configImage is an optional field for configuring the OS image to be used for this node. This field will only exist if the node belongs to a pool opted into on-cluster image builds, and will override any MachineConfig referenced OSImageURL fields.
 	// When omitted, this means that the Image Mode feature is not being used and the node will be up to date with the specific current rendered config version for the nodes MachinePool.
 	// When specified, the Image Mode feature is enabled and the contents of this field show the observed state of the node image.
 	// When Image Mode is enabled and a new MachineConfig is applied such that a new OS image build is not created, only the configVersion field will change.

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

@@ -101,7 +101,7 @@ spec:
             properties:
               configImage:
                 description: |-
-                  configImage is an optional field for configuring the image in the referenced node.
+                  configImage is an optional field for configuring the OS image to be used for this node. This field will only exist if the node belongs to a pool opted into on-cluster image builds, and will override any MachineConfig referenced OSImageURL fields
                   When omitted, Image Mode is not be enabled and the node will follow the standard update process of creating a rendered MachineConfig and updating to its specifications.
                   When specified, Image Mode is enabled and will attempt to update the node to use the desired image. Following this, the node will follow the standard update process of creating a rendered MachineConfig and updating to its specifications.
                 properties:
@@ -269,7 +269,7 @@ spec:
                 x-kubernetes-list-type: map
               configImage:
                 description: |-
-                  configImage is an optional field that reflects the current state of the image used by the node.
+                  configImage is an optional field for configuring the OS image to be used for this node. This field will only exist if the node belongs to a pool opted into on-cluster image builds, and will override any MachineConfig referenced OSImageURL fields
                   When omitted, this means that the Image Mode feature is not being used and the node will be up to date with the specific current rendered config version for the nodes MachinePool.
                   When specified, the Image Mode feature is enabled and the contents of this field show the observed state of the node image.
                   When Image Mode is enabled and a new MachineConfig is applied such that a new OS image build is not created, only the configVersion field will change.

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

@@ -101,7 +101,7 @@ spec:
             properties:
               configImage:
                 description: |-
-                  configImage is an optional field for configuring the image in the referenced node.
+                  configImage is an optional field for configuring the OS image to be used for this node. This field will only exist if the node belongs to a pool opted into on-cluster image builds, and will override any MachineConfig referenced OSImageURL fields
                   When omitted, Image Mode is not be enabled and the node will follow the standard update process of creating a rendered MachineConfig and updating to its specifications.
                   When specified, Image Mode is enabled and will attempt to update the node to use the desired image. Following this, the node will follow the standard update process of creating a rendered MachineConfig and updating to its specifications.
                 properties:
@@ -269,7 +269,7 @@ spec:
                 x-kubernetes-list-type: map
               configImage:
                 description: |-
-                  configImage is an optional field that reflects the current state of the image used by the node.
+                  configImage is an optional field for configuring the OS image to be used for this node. This field will only exist if the node belongs to a pool opted into on-cluster image builds, and will override any MachineConfig referenced OSImageURL fields
                   When omitted, this means that the Image Mode feature is not being used and the node will be up to date with the specific current rendered config version for the nodes MachinePool.
                   When specified, the Image Mode feature is enabled and the contents of this field show the observed state of the node image.
                   When Image Mode is enabled and a new MachineConfig is applied such that a new OS image build is not created, only the configVersion field will change.

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

@@ -101,7 +101,7 @@ spec:
             properties:
               configImage:
                 description: |-
-                  configImage is an optional field for configuring the image in the referenced node.
+                  configImage is an optional field for configuring the OS image to be used for this node. This field will only exist if the node belongs to a pool opted into on-cluster image builds, and will override any MachineConfig referenced OSImageURL fields
                   When omitted, Image Mode is not be enabled and the node will follow the standard update process of creating a rendered MachineConfig and updating to its specifications.
                   When specified, Image Mode is enabled and will attempt to update the node to use the desired image. Following this, the node will follow the standard update process of creating a rendered MachineConfig and updating to its specifications.
                 properties:
@@ -269,7 +269,7 @@ spec:
                 x-kubernetes-list-type: map
               configImage:
                 description: |-
-                  configImage is an optional field that reflects the current state of the image used by the node.
+                  configImage is an optional field for configuring the OS image to be used for this node. This field will only exist if the node belongs to a pool opted into on-cluster image builds, and will override any MachineConfig referenced OSImageURL fields
                   When omitted, this means that the Image Mode feature is not being used and the node will be up to date with the specific current rendered config version for the nodes MachinePool.
                   When specified, the Image Mode feature is enabled and the contents of this field show the observed state of the node image.
                   When Image Mode is enabled and a new MachineConfig is applied such that a new OS image build is not created, only the configVersion field will change.

machineconfiguration/v1/zz_generated.featuregated-crd-manifests/machineconfignodes.machineconfiguration.openshift.io/ImageModeStatusReporting.yaml

@@ -101,7 +101,7 @@ spec:
             properties:
               configImage:
                 description: |-
-                  configImage is an optional field for configuring the image in the referenced node.
+                  configImage is an optional field for configuring the OS image to be used for this node. This field will only exist if the node belongs to a pool opted into on-cluster image builds, and will override any MachineConfig referenced OSImageURL fields
                   When omitted, Image Mode is not be enabled and the node will follow the standard update process of creating a rendered MachineConfig and updating to its specifications.
                   When specified, Image Mode is enabled and will attempt to update the node to use the desired image. Following this, the node will follow the standard update process of creating a rendered MachineConfig and updating to its specifications.
                 properties:
@@ -269,7 +269,7 @@ spec:
                 x-kubernetes-list-type: map
               configImage:
                 description: |-
-                  configImage is an optional field that reflects the current state of the image used by the node.
+                  configImage is an optional field for configuring the OS image to be used for this node. This field will only exist if the node belongs to a pool opted into on-cluster image builds, and will override any MachineConfig referenced OSImageURL fields
                   When omitted, this means that the Image Mode feature is not being used and the node will be up to date with the specific current rendered config version for the nodes MachinePool.
                   When specified, the Image Mode feature is enabled and the contents of this field show the observed state of the node image.
                   When Image Mode is enabled and a new MachineConfig is applied such that a new OS image build is not created, only the configVersion field will change.

machineconfiguration/v1/zz_generated.swagger_doc_generated.go

@@ -101,7 +101,7 @@ spec:
             properties:
               configImage:
                 description: |-
-                  configImage is an optional field for configuring the image in the referenced node.
+                  configImage is an optional field for configuring the OS image to be used for this node. This field will only exist if the node belongs to a pool opted into on-cluster image builds, and will override any MachineConfig referenced OSImageURL fields
                   When omitted, Image Mode is not be enabled and the node will follow the standard update process of creating a rendered MachineConfig and updating to its specifications.
                   When specified, Image Mode is enabled and will attempt to update the node to use the desired image. Following this, the node will follow the standard update process of creating a rendered MachineConfig and updating to its specifications.
                 properties:
@@ -269,7 +269,7 @@ spec:
                 x-kubernetes-list-type: map
               configImage:
                 description: |-
-                  configImage is an optional field that reflects the current state of the image used by the node.
+                  configImage is an optional field for configuring the OS image to be used for this node. This field will only exist if the node belongs to a pool opted into on-cluster image builds, and will override any MachineConfig referenced OSImageURL fields
                   When omitted, this means that the Image Mode feature is not being used and the node will be up to date with the specific current rendered config version for the nodes MachinePool.
                   When specified, the Image Mode feature is enabled and the contents of this field show the observed state of the node image.
                   When Image Mode is enabled and a new MachineConfig is applied such that a new OS image build is not created, only the configVersion field will change.

payload-manifests/crds/0000_80_machine-config_01_machineconfignodes-CustomNoUpgrade.crd.yaml

@@ -101,7 +101,7 @@ spec:
             properties:
               configImage:
                 description: |-
-                  configImage is an optional field for configuring the image in the referenced node.
+                  configImage is an optional field for configuring the OS image to be used for this node. This field will only exist if the node belongs to a pool opted into on-cluster image builds, and will override any MachineConfig referenced OSImageURL fields
                   When omitted, Image Mode is not be enabled and the node will follow the standard update process of creating a rendered MachineConfig and updating to its specifications.
                   When specified, Image Mode is enabled and will attempt to update the node to use the desired image. Following this, the node will follow the standard update process of creating a rendered MachineConfig and updating to its specifications.
                 properties:
@@ -269,7 +269,7 @@ spec:
                 x-kubernetes-list-type: map
               configImage:
                 description: |-
-                  configImage is an optional field that reflects the current state of the image used by the node.
+                  configImage is an optional field for configuring the OS image to be used for this node. This field will only exist if the node belongs to a pool opted into on-cluster image builds, and will override any MachineConfig referenced OSImageURL fields
                   When omitted, this means that the Image Mode feature is not being used and the node will be up to date with the specific current rendered config version for the nodes MachinePool.
                   When specified, the Image Mode feature is enabled and the contents of this field show the observed state of the node image.
                   When Image Mode is enabled and a new MachineConfig is applied such that a new OS image build is not created, only the configVersion field will change.