Skip to content

Commit ededa97

Browse files
committed
OSDOCS-11354: corrects blueprint file reference
1 parent 6117656 commit ededa97

File tree

1 file changed

+27
-28
lines changed

1 file changed

+27
-28
lines changed

modules/microshift-embed-microshift-image-offline-deploy.adoc

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
[id="microshift-embed-microshift-image-offline-deployment_{context}"]
88
= Embedding {microshift-short} containers for offline deployments
99

10-
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.
10+
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.
1111

1212
.Prerequisites
1313

1414
* You have root-user access to your build host.
1515
* Your build host meets the image builder system requirements.
16-
* You have installed and set up image builder and the `composer-cli` tool.
17-
* You have created a {op-system-ostree} image blueprint.
18-
* You have installed jq.
16+
* You installed and set up image builder and the `composer-cli` tool.
17+
* You created a {op-system-ostree} image blueprint.
18+
* You installed jq.
1919
2020
.Procedure
2121

@@ -35,7 +35,7 @@ Replace `<release_version>` with the numerical value of the release you are depl
3535
+
3636
[source,terminal]
3737
----
38-
$ ls /usr/share/microshift/release
38+
$ sudo ls /usr/share/microshift/release
3939
----
4040
+
4141
.Example output
@@ -45,50 +45,49 @@ release-x86_64.json
4545
release-aarch64.json
4646
----
4747
+
48-
If you installed the `microshift-release-info` RPM, you can proceed to step 4.
48+
If you installed the `microshift-release-info` RPM, proceed to step 4.
4949

5050
. If you did not complete step 2, download and unpack the `microshift-release-info` RPM without installing it:
5151

5252
.. Download the RPM package by running the following command:
5353
+
54-
[source,terminal]
54+
[source,terminal,subs="+quotes"]
5555
----
56-
$ sudo dnf download microshift-release-info-<release_version>
56+
$ sudo dnf download microshift-release-info-_<release_version>_ # <1>
5757
----
58-
Replace `<release_version>` with the numerical value of the release you are deploying, using the entire version number, such as `4.18.1`.
58+
<1> Replace `_<release_version>_` with the numerical value of the release you are deploying, using the entire version number, such as `4.18.1`.
5959
+
60-
.Example rpm
61-
[source,terminal]
60+
.Example RPM output
61+
[source,terminal,subs="+quotes"]
6262
----
63-
microshift-release-info-4.18.1.*.el9.noarch.rpm <1>
63+
microshift-release-info-4.18.1.-202511101230.p0.g7dc6a00.assembly.4.18.1.el9.noarch.rpm
6464
----
65-
<1> The `*` represents the date and commit ID. Your output should contain both, for example `-202511101230.p0.g7dc6a00.assembly.4.18.1`.
6665

6766
.. Unpack the RPM package without installing it by running the following command:
6867
+
69-
[source,terminal]
68+
[source,terminal,subs="+quotes"]
7069
----
71-
$ rpm2cpio <my_microshift_release_info> | cpio -idmv <1>
70+
$ rpm2cpio _<my_microshift_release_info>_ | cpio -idmv # <1>
7271
./usr/share/microshift/release/release-aarch64.json
7372
./usr/share/microshift/release/release-x86_64.json
7473
----
75-
<1> Replace `<my_microshift_release_info>` with the name of the RPM package from the previous step.
74+
<1> Replace `_<my_microshift_release_info>_` with the name of the RPM package from the previous step.
7675

7776
. Define the location of your JSON file, which contains the container reference information, by running the following command:
7877
+
79-
[source,terminal]
78+
[source,terminal,subs="+quotes"]
8079
----
81-
$ RELEASE_FILE=</path/to/your/release-$(uname -m).json>
80+
$ RELEASE_FILE=_</path/to/your/release-$(uname -m).json>_ # <1>
8281
----
83-
Replace `</path/to/your/release-$(uname -m).json>` with the full path to your JSON file. Be sure to use the file needed for your architecture.
82+
<1> Replace `_</path/to/your/release-$(uname -m).json>_` with the full path to your JSON file. Be sure to use the file needed for your architecture.
8483

8584
. Define the location of your TOML file, which contains instructions for building the image, by running the following command:
8685
+
87-
[source,terminal]
86+
[source,terminal,subs="+quotes"]
8887
----
89-
$ BLUEPRINT_FILE=</path/to/your/blueprint.toml>
88+
$ BLUEPRINT_FILE=_</path/to/your/blueprint.toml>_ # <1>
9089
----
91-
Replace `</path/to/your/blueprint.toml>` with the full path to your JSON file.
90+
<1> Replace `_</path/to/your/blueprint.toml>_` with the full path to your TOML file.
9291

9392
. Generate and then embed the container image references in your blueprint TOML file by running the following command:
9493
+
@@ -97,7 +96,7 @@ Replace `</path/to/your/blueprint.toml>` with the full path to your JSON file.
9796
$ jq -r '.images | .[] | ("[[containers]]\nsource = \"" + . + "\"\n")' "${RELEASE_FILE}" >> "${BLUEPRINT_FILE}"
9897
----
9998
+
100-
.Example resulting `<my_blueprint.toml>` fragment showing container references
99+
.Example resulting TOML fragment showing container references
101100
[source,terminal]
102101
----
103102
[[containers]]
@@ -107,12 +106,12 @@ source = "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:82cfef91557f9a70
107106
source = "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:82cfef91557f9a70cff5a90accba45841a37524e9b93f98a97b20f6b2b69e5db"
108107
----
109108

110-
. You can manually embed any container image by adding it to the image builder blueprint using the following example:
109+
. You can manually embed any container image by adding it to an image builder blueprint file using the following example:
111110
+
112-
.Example section for manually embedding container image to image builder
113-
[source,terminal]
111+
.Example section for manually embedding container image to a blueprint
112+
[source,text,subs="+quotes"]
114113
----
115114
[[containers]]
116-
source = "<my_image_pullspec_with_tag_or_digest>"
115+
source = "_<my_image_pullspec_with_tag_or_digest>_"
117116
----
118-
Replace `<my_image_pullspec_with_tag_or_digest>` with the exact reference to a container image used by the {microshift-short} version you are deploying.
117+
Replace `_<my_image_pullspec_with_tag_or_digest>_` with the exact reference to a container image used by the {microshift-short} version you are deploying.

0 commit comments

Comments
 (0)