edits

Author: Michael Burke

machine_configuration/machine-config-pin-preload-images-about.adoc

@@ -14,50 +14,16 @@ Pinning and preloading images can benefit a cluster that has a low bandwidth or
 
 Preloading and pinning images prevents image garbage collection from removing the pinned images.
 
-You can preload and pin images by using a a `PinnedImageSet` custom resource (CR) as described in the following section. Pinned images are stored in a file inside the `/etc/crio/crio.conf.d` directory. The name of this file is a concatenation of the name of the `PinnedImageSet` object and the UUID assigned to the object. 
-
-For example, the name of a pinned image file would be similar to the following name: `my-pinned-images-550a1d88-2976-4447-9fc7-b65e457a7f42.conf`. The contents of the file appear similar to the following example:
+You can preload and pin images by using a a `PinnedImageSet` custom resource (CR) as described in the following section. Pinned images are stored in the file inside the `/etc/crio/crio.conf.d/50-pinned-iamges` directory. The contents of the file appear similar to the following example:
 
 [source,terminal]
 ----
-pinned_images=[
-  "quay.io/openshift-release-dev/ocp-release@sha256:...",
-  "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:...",
-  "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:...",
-  ...
-]
-----
-
-Before pulling the images, the Machine Config Operator (MCO) verifies that there is enough space available on each affected node to store the images. If the node has sufficient space, the MCO creates the pinned image file, pulls the images, and reloads CRI-O. 
-
-The `PinnedImageSet` object reports if the images have been pinned and pulled successfully or lists error conditions if the pin and pull fails.
-
-.Example successful `PinnedImageSet` status
-[source,yaml]
-----
-status:
-  conditions:
-  - type: Ready
-    status: "True"
-  - type: Failed
-    status: "False"
-----
-
-.Example filaed `PinnedImageSet` status
-[source,yaml]
-----
-
-status:
-  conditions:
-  - type: Ready
-    status: "False"
-  - type: Failed
-    status: "True"
-    message: |
-      Pulling the images in `node12` requires at least 16 GiB of disk
-      space, but there are only 10 GiB available
+[crio]
+  [crio.image]
+    pinned_images = ["quay.io/openshift-release-dev/ocp-release@sha256:4198606580b69c8335ad7ae531c3a74e51aee25db5faaf368234e8c8dae5cbea", "quay.io/openshift-release-dev/ocp-release@sha256:513cf1028aa1a021fa73d0601427a0fbcf6d212b88aaf9d76d4e4841a061e44e", "quay.io/openshift-release-dev/ocp-release@sha256:61eae2d261e54d1b8a0e05f6b5326228b00468364563745eed88460af04f909b"]
 ----
 
+Before pulling the images, the Machine Config Operator (MCO) verifies that there is enough space available on each affected node to store the images. If the node has sufficient space, the MCO creates the pinned image file, pulls the images, and reloads CRI-O.
 
 include::modules/machine-config-pin-preload-images.adoc[leveloffset=+1]
 

modules/machine-config-pin-preload-images.adoc

@@ -24,8 +24,8 @@ metadata:
   name: worker-pinned-images
 spec:
   pinnedImages: <2>
-  - name: quay.io/openshifttest/busybox@sha256:0415f56ccc05526
-  - name: quay.io/openshifttest/alpine@sha256:be92b18a369e989a
+   - name: quay.io/openshift-release-dev/ocp-release@sha256:513cf1028aa1a021fa73d0601427a0fbcf6d212b88aaf9d76d4e4841a061e44e
+   - name: quay.io/openshift-release-dev/ocp-release@sha256:61eae2d261e54d1b8a0e05f6b5326228b00468364563745eed88460af04f909b
 ----
 +
 where:
@@ -66,18 +66,45 @@ kind: MachineConfigNode
 metadata:
   creationTimestamp: "2025-04-28T18:40:29Z"
   generation: 3
-  name: <machine_config_node_name> <1>
+  name: <machine_config_node_name>
 # ...
 status
   pinnedImageSets:
-  - desiredGeneration: 1
+  - currentGeneration: 1
+    desiredGeneration: 1
     name: worker-pinned-images
 ----
 +
-[NOTE]
-====
-It can take a few moments for the object to be fully updated.
-====
+Any failures or error messages would appear in the `MachineConfigNode` object status fields.
++
+.Example output
++
+[source,terminal]
+----
+apiVersion: machineconfiguration.openshift.io/v1
+kind: MachineConfigNode
+metadata:
+  creationTimestamp: "2025-04-28T18:40:29Z"
+  generation: 3
+  name: <machine_config_node_name>
+# ...
+  - lastTransitionTime: "2025-04-29T19:37:23Z"
+    message: One or more PinnedImageSet is experiencing an error. See PinnedImageSet
+      list for more details
+    reason: PrefetchFailed
+    status: "True"
+    type: PinnedImageSetsDegraded
+  configVersion:
+    current: rendered-worker-cef1b52c532e19a20add12e369261fba
+    desired: rendered-worker-cef1b52c532e19a20add12e369261fba
+  observedGeneration: 3
+  pinnedImageSets:
+  - desiredGeneration: 1
+    lastFailedGeneration: 1
+    lastFailedGenerationError: 'failed to execute podman manifest inspect for "quay.io/rh-ee/machine-config-operator@sha256:65d3a308767b1773b6e3499dde6ef085753d7e20e685f78841079":
+      exit status 125'
+    name: worker-pinned-images
+----
 
 * Check that the pinned image file is created and contains the correct images. The contents of the file appear similar to the following example:
 
@@ -105,25 +132,14 @@ $ cat /etc/crio/crio.conf.d/<pinned_image_set_name>
 .Example command
 [source,terminal]
 ----
-$ cat /etc/crio/crio.conf.d/worker-pinned-images-0b38991f-90d4-4d54-b111
+$ cat /etc/crio/crio.conf.d/50-pinned-images
 ----
 +
 .Example output
 +
 [source,terminal]
 ----
-pinned_images=[
-  "quay.io/openshift-release-dev/ocp-release@sha256:...",
-  "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:...",
-  "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:...",
-  ...
-]
+[crio]
+  [crio.image]
+    pinned_images = ["quay.io/openshift-release-dev/ocp-release@sha256:4198606580b69c8335ad7ae531c3a74e51aee25db5faaf368234e8c8dae5cbea", "quay.io/openshift-release-dev/ocp-release@sha256:513cf1028aa1a021fa73d0601427a0fbcf6d212b88aaf9d76d4e4841a061e44e", "quay.io/openshift-release-dev/ocp-release@sha256:61eae2d261e54d1b8a0e05f6b5326228b00468364563745eed88460af04f909b"]
 ----
-
-* Verify that the that pin and pull was successful by checking the `PinnedImageSet` object status:
-+
-[source,terminal]
-----
-$ oc describe PinnedImageSet worker-pinned-images
-----
-