Skip to content

Commit 8c4436f

Browse files
author
Michael Burke
committed
Fix format issues
1 parent 7583bba commit 8c4436f

File tree

2 files changed

+17
-10
lines changed

2 files changed

+17
-10
lines changed

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ toc::[]
88

99
Slow and unreliable connections to an image registry can interfere with operations that require pulling images, such as updating a cluster or deploying an application. This can be helpful in cluster with low bandwidth, unreliable internet connectivity, or in a disconnected environment.
1010

11-
For example, an cluster update might require pulling more than one hundred images. Failure to pull those images causes retries that can interfere with the upgrade process and might cause the update fail. One way to improve that is to _preloand_ the required images by pulling them in advance, before they are actually needed. Then, ensuring that the images are available when needed by _pinning_ them to a machine config pool. Pinning and preloading images can provide a more consistent upgrade, which is important when scheduling upgrades into maintenance windows.
11+
For example, an cluster update might require pulling more than one hundred images. Failure to pull those images causes retries that can interfere with the upgrade process and might cause the update fail. One way to improve that is to _preload_ the required images by pulling them in advance, before they are actually needed. Then, ensuring that the images are available when needed by _pinning_ them to a machine config pool. Pinning and preloading images can provide a more consistent upgrade, which is important when scheduling upgrades into maintenance windows.
1212

1313
Pinning and preloading images can benefit a cluster that has a low bandwidth or an unreliable connection to an image registry server when deploying applications, ensuring that the images are available and application will successfully deploy in a predictable time.
1414

@@ -59,8 +59,11 @@ status:
5959
----
6060

6161

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

64+
////
65+
Add link to machine config nodes when available
6466
[role="_additional-resources"]
6567
.Additional resources
6668
* xref:
69+
////

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

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,15 @@ spec:
2727
- name: quay.io/openshifttest/busybox@sha256:0415f56ccc05526
2828
- name: quay.io/openshifttest/alpine@sha256:be92b18a369e989a
2929
----
30-
<1> Optional: A 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.
31-
<2> A list of one or more images to preload.
30+
+
31+
where:
32+
+
33+
--
34+
`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. the relative path to the downloaded ISO file, for example, `rhcos-live.iso`.
35+
`pinnedImages`:: Specifies a list of one or more images to preload.
36+
--
3237

33-
.. Create the `PinnedImageSet` object by running the following command:
38+
. Create the `PinnedImageSet` object by running the following command:
3439
+
3540
[source,terminal]
3641
----
@@ -39,7 +44,7 @@ $ oc create -f <file_name>.yaml
3944

4045
.Verification
4146

42-
. Check that the pinned image set is reported in the machine config node object for the affected machine config pool by running the following command:
47+
* Check that the pinned image set is reported in the machine config node object for the affected machine config pool by running the following command:
4348
+
4449
[source,terminal]
4550
----
@@ -74,7 +79,7 @@ status
7479
It can take a few moments for the object to be fully updated.
7580
====
7681
77-
. Check that the pinned image file is created and contains the correct images. The contents of the file appear similar to the following example:
82+
* Check that the pinned image file is created and contains the correct images. The contents of the file appear similar to the following example:
7883
7984
.. Start a debug session for a node by running the following command:
8085
+
@@ -96,7 +101,7 @@ sh-5.1# chroot /host
96101
----
97102
$ cat /etc/crio/crio.conf.d/<pinned_image_set_name>
98103
----
99-
104+
+
100105
.Example command
101106
[source,terminal]
102107
----
@@ -115,8 +120,7 @@ pinned_images=[
115120
]
116121
----
117122

118-
. Verify that the that pin and pull was successful by checking the `PinnedImageSet` object status:
119-
+
123+
* Verify that the that pin and pull was successful by checking the `PinnedImageSet` object status:
120124
+
121125
[source,terminal]
122126
----

0 commit comments

Comments
 (0)