diff --git a/modules/microshift-embed-microshift-image-offline-deploy.adoc b/modules/microshift-embed-microshift-image-offline-deploy.adoc index 8141f2e5d4..653a88dce9 100644 --- a/modules/microshift-embed-microshift-image-offline-deploy.adoc +++ b/modules/microshift-embed-microshift-image-offline-deploy.adoc @@ -7,15 +7,15 @@ [id="microshift-embed-microshift-image-offline-deployment_{context}"] = Embedding {microshift-short} containers for offline deployments -You can use image builder to create `rpm-ostree` system images with embedded {microshift-short} container images. To embed container images, you must add the image references to your image builder blueprint. +You can use image builder to create {op-system-ostree} images with embedded {microshift-short} container images. To embed container images, you must add the image references to your image builder blueprint file. .Prerequisites * You have root-user access to your build host. * Your build host meets the image builder system requirements. -* You have installed and set up image builder and the `composer-cli` tool. -* You have created a {op-system-ostree} image blueprint. -* You have installed jq. +* You installed and set up image builder and the `composer-cli` tool. +* You created a {op-system-ostree} image blueprint. +* You installed jq. .Procedure @@ -35,7 +35,7 @@ Replace `` with the numerical value of the release you are depl + [source,terminal] ---- -$ ls /usr/share/microshift/release +$ sudo ls /usr/share/microshift/release ---- + .Example output @@ -45,50 +45,49 @@ release-x86_64.json release-aarch64.json ---- + -If you installed the `microshift-release-info` RPM, you can proceed to step 4. +If you installed the `microshift-release-info` RPM, proceed to step 4. . If you did not complete step 2, download and unpack the `microshift-release-info` RPM without installing it: .. Download the RPM package by running the following command: + -[source,terminal] +[source,terminal,subs="+quotes"] ---- -$ sudo dnf download microshift-release-info- +$ sudo dnf download microshift-release-info-__ # <1> ---- -Replace `` with the numerical value of the release you are deploying, using the entire version number, such as `4.18.1`. +<1> Replace `__` with the numerical value of the release you are deploying, using the entire version number, such as `4.18.1`. + -.Example rpm -[source,terminal] +.Example RPM output +[source,terminal,subs="+quotes"] ---- -microshift-release-info-4.18.1.*.el9.noarch.rpm <1> +microshift-release-info-4.18.1.-202511101230.p0.g7dc6a00.assembly.4.18.1.el9.noarch.rpm ---- -<1> The `*` represents the date and commit ID. Your output should contain both, for example `-202511101230.p0.g7dc6a00.assembly.4.18.1`. .. Unpack the RPM package without installing it by running the following command: + -[source,terminal] +[source,terminal,subs="+quotes"] ---- -$ rpm2cpio | cpio -idmv <1> +$ rpm2cpio __ | cpio -idmv # <1> ./usr/share/microshift/release/release-aarch64.json ./usr/share/microshift/release/release-x86_64.json ---- -<1> Replace `` with the name of the RPM package from the previous step. +<1> Replace `__` with the name of the RPM package from the previous step. . Define the location of your JSON file, which contains the container reference information, by running the following command: + -[source,terminal] +[source,terminal,subs="+quotes"] ---- -$ RELEASE_FILE= +$ RELEASE_FILE=__ # <1> ---- -Replace `` with the full path to your JSON file. Be sure to use the file needed for your architecture. +<1> Replace `__` with the full path to your JSON file. Be sure to use the file needed for your architecture. . Define the location of your TOML file, which contains instructions for building the image, by running the following command: + -[source,terminal] +[source,terminal,subs="+quotes"] ---- -$ BLUEPRINT_FILE= +$ BLUEPRINT_FILE=__ # <1> ---- -Replace `` with the full path to your JSON file. +<1> Replace `__` with the full path to your TOML file. . Generate and then embed the container image references in your blueprint TOML file by running the following command: + @@ -97,7 +96,7 @@ Replace `` with the full path to your JSON file. $ jq -r '.images | .[] | ("[[containers]]\nsource = \"" + . + "\"\n")' "${RELEASE_FILE}" >> "${BLUEPRINT_FILE}" ---- + -.Example resulting `` fragment showing container references +.Example resulting TOML fragment showing container references [source,terminal] ---- [[containers]] @@ -107,12 +106,12 @@ source = "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:82cfef91557f9a70 source = "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:82cfef91557f9a70cff5a90accba45841a37524e9b93f98a97b20f6b2b69e5db" ---- -. You can manually embed any container image by adding it to the image builder blueprint using the following example: +. You can manually embed any container image by adding it to an image builder blueprint file using the following example: + -.Example section for manually embedding container image to image builder -[source,terminal] +.Example section for manually embedding container image to a blueprint +[source,text,subs="+quotes"] ---- [[containers]] -source = "" +source = "__" ---- -Replace `` with the exact reference to a container image used by the {microshift-short} version you are deploying. +Replace `__` with the exact reference to a container image used by the {microshift-short} version you are deploying.