Skip to content

Commit b111c97

Browse files
author
Michael Burke
committed
Changes preload and pin images to pinned images
renaming to pinned images continued
1 parent 395797e commit b111c97

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

_topic_maps/_topic_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2352,7 +2352,7 @@ Topics:
23522352
File: machine-config-node-disruption
23532353
- Name: Configuring MCO-related custom resources
23542354
File: machine-configs-custom
2355-
- Name: About preloading and pinning images
2355+
- Name: About pinned images
23562356
File: machine-config-pin-preload-images-about
23572357
- Name: Updated boot images
23582358
File: mco-update-boot-images

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="machine-config-pin-preload-images-about"]
3-
= About pre-loading and pinning images
3+
= About pinned images
44
include::_attributes/common-attributes.adoc[]
55
:context: machine-config-operator
66

77
toc::[]
88

9-
A slow, unreliable connection to an image registry can interfere with operations that require pulling images, such as updating a cluster or deploying an application. This can include clusters that have low bandwidth, clusters with unreliable internet connectivity, or clusters in a disconnected environment.
9+
A slow, unreliable connection to an image registry can interfere with operations that require pulling images, such as updating a cluster or deploying an application. This can include clusters that have low bandwidth, clusters with unreliable internet connectivity, or clusters in a disconnected environment. For example, a cluster update might require pulling more than one hundred images. Failure to pull those images could cause retries that can interfere with the update process and might cause the update to fail.
1010

11-
For example, a cluster update might require pulling more than one hundred images. Failure to pull those images could cause retries that can interfere with the update process and might cause the update to fail. One way to prevent this is to _pre-load_ the required images by pulling them in advance, before they are actually needed. Then, by _pinning_ them to a machine config pool, you ensure that the images are available when needed. Pre-loading and pinning images can provide a more consistent update, which is important when scheduling updates into maintenance windows.
11+
One way to prevent this is to pull the required images in advance, before they are actually needed, and _pinning_ those images to specific machine config pools. This ensures that the images are available to your nodes when needed. Pinned images can provide a more consistent update, which is important when scheduling updates into maintenance windows.
1212

13-
Pre-loading and pinning images also ensures that the images are available when deploying applications, so that you can deploy in a predictable time. Another benefit to pre-loading and pinning images is that image garbage collection does not remove the pinned images.
13+
Pinned images also ensures that the images are available when deploying applications, so that you can deploy in a predictable time.
1414

15-
You can pre-load and pin images by using a a `PinnedImageSet` custom resource (CR), as described in _Pre-loading and pinning images_. Pinned images are stored on the nodes in the `/etc/crio/crio.conf.d/50-pinned-images` file. The contents of the file appear similar to the following example:
15+
You can pin images to specific nodes by using a `PinnedImageSet` custom resource (CR), as described in _Pinning images_. Pinned images are stored on the nodes in the `/etc/crio/crio.conf.d/50-pinned-images` file on those. The contents of the file appear similar to the following example:
1616

1717
[source,terminal]
1818
----
@@ -21,6 +21,8 @@ You can pre-load and pin images by using a a `PinnedImageSet` custom resource (C
2121
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"]
2222
----
2323

24+
Another benefit to pinned images is that image garbage collection does not remove the pinned images.
25+
2426
Before pulling the images, the Machine Config Operator (MCO) verifies that there is enough storage space available on each affected node. If the node has sufficient space, the MCO creates the pinned image file, pulls the images, and reloads CRI-O. If there is not sufficient space, the MCO does not pull the images and presents an error message.
2527

2628
include::modules/machine-config-pin-preload-images.adoc[leveloffset=+1]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="machine-config-pin-preload-images_{context}"]
7-
= Pre-loading and pinning images
7+
= Pinning images
88

9-
You can pre-load and pin images by using a `PinnedImageSet` custom resource (CR). The pinned image set defines the list of images to pre-load and the machine config pool to which the images should be pinned.
9+
You can pin images to your nodes by using a `PinnedImageSet` custom resource (CR). The pinned image set defines the list of images to pre-load and the machine config pool to which the images should be pinned.
1010

1111
The images are stored in the the `/etc/crio/crio.conf.d/50-pinned-images` file on the nodes.
1212

0 commit comments

Comments
 (0)