Skip to content

Commit 395797e

Browse files
author
Michael Burke
committed
edits per lahinson
1 parent 1dd02bd commit 395797e

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

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

Lines changed: 5 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 pinning and preloading images
3+
= About pre-loading and pinning images
44
include::_attributes/common-attributes.adoc[]
55
:context: machine-config-operator
66

77
toc::[]
88

9-
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.
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 _preload_ 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. Pinning and preloading images can provide a more consistent update, which is important when scheduling updates into maintenance windows.
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.
1212

13-
Pinning and preloading images also ensures that the images are available when deploying applications, which allows you to deploy in a predictable time. Another benefit to pinning and preloading images is that image garbage collection does not remove the pinned images.
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.
1414

15-
You can pin and preload images by using a a `PinnedImageSet` custom resource (CR) as described in the following section. 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 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:
1616

1717
[source,terminal]
1818
----

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

Lines changed: 7 additions & 4 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-
= Pinning and preloading images
7+
= Pre-loading and pinning images
88

9-
You can pin and preload images by using a `PinnedImageSet` custom resource (CR). The pinned image set defines the list of images to preload and the machine config pool to which the images should be pinned.
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.
1010

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

@@ -32,7 +32,7 @@ where:
3232
+
3333
--
3434
`labels`:: Specifies an optional node selector to specify the machine config pool to pin the images to. If not specified, the images are pinned to all nodes in the cluster.
35-
`pinnedImages`:: Specifies a list of one or more images to preload.
35+
`pinnedImages`:: Specifies a list of one or more images to pre-load.
3636
--
3737

3838
. Create the `PinnedImageSet` object by running the following command:
@@ -138,4 +138,7 @@ $ cat /etc/crio/crio.conf.d/50-pinned-images
138138
[crio.image]
139139
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"] <1>
140140
----
141-
<1> Specifies the images that have been pulled and pinned for the affected machine config pool.
141+
+
142+
where:
143+
+
144+
`pinnedImages`:: Specifies the images that have been pulled and pinned for the affected machine config pool.

0 commit comments

Comments
 (0)