Skip to content

Commit a8deace

Browse files
authored
Merge pull request #92407 from ShaunaDiaz/OSDOCS-13305
OSDOCS-13305: update image mode docs for GA MicroShift
2 parents d347332 + db4f860 commit a8deace

7 files changed

+12
-29
lines changed

microshift_install_bootc/microshift-about-rhel-image-mode.adoc

-4
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ toc::[]
88

99
You can embed {microshift-short} into an operating system image using image mode for {op-system-base-full}.
1010

11-
:FeatureName: Image mode for {op-system-base}
12-
13-
include::snippets/technology-preview.adoc[]
14-
1511
include::modules/microshift-install-bootc-conc.adoc[leveloffset=+1]
1612

1713
[id="_additional-resources_microshift-install-rhel-image-mode_{context}"]

microshift_install_bootc/microshift-install-bootc-image.adoc

-4
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ toc::[]
88

99
{microshift-short} is built and published as image mode containers. When installing a {op-system-base-full} bootable container image with {microshift-short}, use either a prebuilt bootable container image or build your own custom bootable container image.
1010

11-
:FeatureName: Image mode for {op-system-base}
12-
13-
include::snippets/technology-preview.adoc[]
14-
1511
include::modules/microshift-install-bootc-workflow.adoc[leveloffset=+1]
1612

1713
[id="microshift-get-build-bootc-image_{context}"]

microshift_install_bootc/microshift-install-running-bootc-image-vm.adoc

-4
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ toc::[]
88

99
Use the bootable container image as an installation source to set up a {op-system-base-full} virtual machine.
1010

11-
:FeatureName: Image mode for {op-system-base}
12-
13-
include::snippets/technology-preview.adoc[]
14-
1511
include::modules/microshift-install-bootc-prepare-kickstart.adoc[leveloffset=+1]
1612

1713
include::modules/microshift-install-bootc-creating-vm.adoc[leveloffset=+1]

modules/microshift-install-bootc-build-image.adoc

-5
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,6 @@
88

99
Build your {op-system-base-full} that contains {microshift-short} as a bootable container image by using a Containerfile.
1010

11-
[IMPORTANT]
12-
====
13-
Image mode for {op-system-base} is Technology Preview. Using a bootc image in production environments is not supported.
14-
====
15-
1611
.Prerequisites
1712

1813
* A {op-system-base} {op-system-version} host with an active Red{nbsp}Hat subscription for building {microshift-short} bootc images and running containers.

modules/microshift-install-bootc-conc.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
[id="microshift-bootc-conc_{context}"]
77
= About image mode for {op-system-base-full}
88

9-
Image mode for {op-system-base-full} is a Technology Preview deployment method that uses a container-native approach to build, deploy, and manage the operating system as a bootc image. By using bootc, you can build, deploy, and manage the operating system as if it is any other container.
9+
By using image mode for {op-system-base}, you can use the same tools and techniques for the operating system that you use with application containers. Image mode for {op-system-base} is a deployment method that uses a container-native approach to build, deploy, and manage the operating system as a `rhel-bootc` image.
1010

1111
* This container image uses standard OCI or Docker containers as a transport and delivery format for base operating system updates.
1212
* A bootc image includes a Linux kernel that is used to start the operating system.
1313
* By using bootc containers, developers, operations administrators, and solution providers can all use the same container-native tools and techniques.
1414
15-
Image mode splits the creation and installation of software changes into two steps: one on a build system and one on a running target system.
15+
Image mode for {op-system-base} splits the creation and installation of software changes into two steps: one on a build system and one on a running target system.
1616

17-
* In the build-system step, a Podman build inspects the RPM files available for installation, determines any dependencies, and creates an ordered list of chained steps to complete, with the end result being a new operating system available to install.
17+
* In the build-system step, a Podman build inspects the RPM files available for installation, determines any dependencies, and creates an ordered list of chained steps to complete. Along with any other system configuration steps taking place, the end result is a new operating system available to install.
1818
19-
* In the running-target-system step, a bootc update downloads, unpacks, and makes the new operating system bootable alongside the currently running system. Local configuration changes are carried forward to the new operating system, but do not take effect until the system is rebooted and the new operating system image replaces the running image.
19+
* In the running-target-system step, a bootc update downloads, unpacks, and prepares the new operating system to be started alongside the currently running system. Local configuration changes are carried forward to the new operating system. These changes take effect only when the system is restarted and the new operating system image replaces the previously running one.

modules/microshift-install-bootc-get-published-image.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="microshift-install-bootc-get-published-image_{context}"]
77
= Getting the published bootc image for {microshift-short}
88

9-
You can find and use the {microshift-short} container images to install {op-system-base-full}.
9+
You can find and use the {microshift-short} container images to install {op-system-image}.
1010

1111
.Prerequisites
1212

modules/microshift-install-bootc-workflow.adoc

+7-7
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@
66
[id="microshift-install-rhel-image-mode-conc_{context}"]
77
= The image mode for {op-system-base} with {microshift-short} workflow
88

9-
To use image mode for {op-system-base}, ensure that the following resources are available:
9+
Before you use {op-system-image}, ensure that the following resources are available:
1010

1111
* A {op-system-base} {op-system-version} host with an active Red{nbsp}Hat subscription for building {microshift-short} bootc images.
12-
* A remote registry for storing and accessing bootc images.
13-
* You can use image mode for RHEL with a {microshift-short} cluster on AArch64 or x86_64 system architectures.
12+
* A remote registry for storing and accessing `rhel-bootc` images.
13+
* An AArch64 or x86_64 system architecture.
1414
15-
The workflow for using image mode with {microshift-short} includes the following steps:
15+
The workflow for using {op-system-image} with {microshift-short} includes the following steps:
1616

17-
. Find and use a prebuilt {microshift-short} container image to install {op-system-base-full}.
18-
. Build a custom {microshift-short} container image if the prebuilt {microshift-short} container image requires customization.
17+
. Find and use a prebuilt {microshift-short} container image to install {op-system-base}.
18+
. If the prebuilt {microshift-short} container image requires customization, build a custom {microshift-short} container image.
1919
. Run the container image.
2020

2121
[IMPORTANT]
2222
====
23-
The `rpm-ostree` file system is not supported in image mode. Do not use the `rpm-ostree` file system to modify deployments that use image mode.
23+
The `rpm-ostree` file system used by {op-system-ostree} is not supported in {op-system-image}. Do not use the `rpm-ostree` file system to modify deployments that use {op-system-image}.
2424
====

0 commit comments

Comments
 (0)