Skip to content

Commit 500bb56

Browse files
committed
OSDOCS-5544: documenting signature digest extraction
1 parent bab79ae commit 500bb56

File tree

3 files changed

+37
-5
lines changed

3 files changed

+37
-5
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * updating/updating-restricted-network-cluster/restricted-network-update.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="update-restricted-image-digests_{context}"]
7+
= Retrieving a release image digest
8+
9+
In order to update a cluster in a disconnected environment using the `oc adm upgrade` command with the `--to-image` option, you must reference the sha256 digest that corresponds to your targeted release image.
10+
11+
.Procedure
12+
13+
. Run the following command on a device that is connected to the internet:
14+
+
15+
[source,terminal]
16+
----
17+
$ oc adm release info -o 'jsonpath={.digest}{"\n"}' quay.io/openshift-release-dev/ocp-release:${OCP_RELEASE_VERSION}-${ARCHITECTURE}
18+
----
19+
+
20+
For `{OCP_RELEASE_VERSION}`, specify the version of {product-title} to which you want to update, such as `4.10.16`.
21+
+
22+
For `{ARCHITECTURE}`, specify the architecture of the cluster, such as `x86_64`, `aarch64`, `s390x`, or `ppc64le`.
23+
+
24+
.Example output
25+
[source,terminal]
26+
----
27+
sha256:a8bfba3b6dddd1a2fbbead7dac65fe4fb8335089e4e7cae327f3bad334add31d
28+
----
29+
30+
. Copy the sha256 digest for use when updating your cluster.

modules/update-restricted.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,19 @@ If you have a local OpenShift Update Service, you can update by using the connec
1919

2020
* You mirrored the images for the new release to your registry.
2121
* You applied the release image signature ConfigMap for the new release to your cluster.
22-
* You obtained the sha256 sum value for the release from the image signature ConfigMap.
23-
* Install the OpenShift CLI (`oc`).
24-
* Pause all `MachineHealthCheck` resources.
22+
* You obtained the sha256 digest for your targeted release image.
23+
* You installed the OpenShift CLI (`oc`).
24+
* You paused all `MachineHealthCheck` resources.
2525
2626
.Procedure
2727

2828
* Update the cluster:
2929
+
3030
[source,terminal]
3131
----
32-
$ oc adm upgrade --allow-explicit-upgrade --to-image ${LOCAL_REGISTRY}/${LOCAL_REPOSITORY}<sha256_sum_value> <1>
32+
$ oc adm upgrade --allow-explicit-upgrade --to-image ${LOCAL_REGISTRY}/${LOCAL_REPOSITORY}@<digest> <1>
3333
----
34-
<1> The `<sha256_sum_value>` value is the sha256 sum value for the release from the image signature ConfigMap, for example, `@sha256:81154f5c03294534e1eaf0319bef7a601134f891689ccede5d705ef659aa8c92`
34+
<1> The `<digest>` value is the sha256 digest for the targeted release image, for example, `sha256:81154f5c03294534e1eaf0319bef7a601134f891689ccede5d705ef659aa8c92`
3535
+
3636
If you use an `ImageContentSourcePolicy` for the mirror registry, you can use the canonical registry name instead of `LOCAL_REGISTRY`.
3737
+

updating/updating-restricted-network-cluster/restricted-network-update.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ If you run an Operator or you have configured any application with the pod disru
2626

2727
include::modules/machine-health-checks-pausing.adoc[leveloffset=+1]
2828

29+
include::modules/update-restricted-image-digests.adoc[leveloffset=+1]
30+
2931
include::modules/update-restricted.adoc[leveloffset=+1]
3032

3133
include::modules/images-configuration-registry-mirror.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)