diff --git a/microshift_configuring/microshift_low_latency/microshift-low-latency.adoc b/microshift_configuring/microshift_low_latency/microshift-low-latency.adoc index 3de8b7ace2..afc622b345 100644 --- a/microshift_configuring/microshift_low_latency/microshift-low-latency.adoc +++ b/microshift_configuring/microshift_low_latency/microshift-low-latency.adoc @@ -73,9 +73,6 @@ Complete the build process by starting with the following procedure to embed {mi * link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux_for_real_time/9/html/installing_rhel_9_for_real_time/assembly_installing-rhel-for-real-time_installing-rhel-9-for-real-time#post-installation-instructions_assembly_installing-rhel-for-real-time[Post installation instructions] (RHEL for Real Time documentation) * xref:../../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#microshift-embed-in-rpm-ostree[Embedding in a {op-system-ostree} image] -* link:https://access.redhat.com/solutions/4096521[FAQ about {op-system-base} for Real Time (kernel-rt)] -//Can likely remove KCS after 2024 as it may go out of date - include::modules/microshift-low-latency-prepare-workload.adoc[leveloffset=+1] //additional resources for preparing the workload diff --git a/microshift_install_get_ready/microshift-install-get-ready.adoc b/microshift_install_get_ready/microshift-install-get-ready.adoc index 7cbda60a6d..373444be82 100644 --- a/microshift_install_get_ready/microshift-install-get-ready.adoc +++ b/microshift_install_get_ready/microshift-install-get-ready.adoc @@ -56,8 +56,7 @@ When choosing an image-based installation, consider whether the installation tar Familiarize yourself with the following {op-system-base} tools and concepts: -* A Kickstart file, which contains the configuration and instructions used during the installation of your specific operating system. -//xref:../microshift_install_kickstarts/microshift-rhel-kickstarts.adoc#microshift-rhel-kickstarts[Using Kickstart files for installting {microshift-short} in {op-system-base}] +* A Kickstart file, which contains the configuration and instructions used during the installation of your specific operating system. For more information, see xref:../microshift_install_kickstarts/microshift-rhel-kickstarts.adoc#microshift-rhel-kickstarts[Using Kickstart files for installting {microshift-short} in {op-system-base}]. * {op-system-base} image builder is a tool for creating deployment-ready customized system images. {op-system-base} image builder uses a blueprint that you create to make the ISO. {op-system-base} image builder is best installed on a {op-system-base} VM and is built with the `composer-cli` tool. To set up these tools and review the workflow, see the following {op-system-base} documentation links: ** link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-system-images-with-composer-command-line-interface_composing-a-customized-rhel-system-image#composer-command-line-interface_creating-system-images-with-composer-command-line-interface[Introducing the RHEL image builder command-line interface] @@ -79,7 +78,7 @@ For most installation types, you must also take the following steps: * Be ready to configure {microshift-short} by adding parameters and values to the {microshift-short} YAML configuration file. See xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-configuring[Using the {microshift-short} configuration file] for more information. * Decide whether you need to configure storage for the application and tasks you are using in your {microshift-short} cluster, or disable the {microshift-short} storage plug-in completely. -** For more information about creating volume groups and persistent volumes on {op-system-base}, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/overview-of-logical-volume-management_configuring-and-managing-logical-volumes[Overview of logical volume management]. +** For more information about creating volume groups and persistent volumes on {op-system-base}, see link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/overview-of-logical-volume-management_configuring-and-managing-logical-volumes[Overview of logical volume management]. ** For more information about the {microshift-short} plug-in, see xref:../microshift_storage/microshift-storage-plugin-overview.adoc#microshift-storage-plugin-overview[Dynamic storage using the LVMS plugin]. * Configure networking settings according to the access needs you plan for your {microshift-short} cluster and applications. Consider whether you want to use single or dual-stack networks, configure a firewall, or configure routes. @@ -95,4 +94,3 @@ For most installation types, you must also take the following steps: [role="_additional-resources"] .Additional resources * xref:../microshift_install_rpm_ostree/microshift-deploy-with-mirror-registry.adoc#microshift-deployment-mirror[Mirroring container images for disconnected installations]. -//To learn about provisioning a VM, booting the ISO, and starting {microshift-short}, see xref TBD \ No newline at end of file diff --git a/microshift_install_rpm/microshift-install-rpm.adoc b/microshift_install_rpm/microshift-install-rpm.adoc index 628522cb02..4ad0495574 100644 --- a/microshift_install_rpm/microshift-install-rpm.adoc +++ b/microshift_install_rpm/microshift-install-rpm.adoc @@ -23,8 +23,8 @@ include::modules/microshift-install-rpm-preparing.adoc[leveloffset=+1] * Download the link:https://console.redhat.com/openshift/install/pull-secret[pull secret] from the Red Hat Hybrid Cloud Console. * xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-using-config-yaml[Configuring MicroShift]. * For more options on partition configuration, read link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/performing_a_standard_rhel_9_installation/index#manual-partitioning_graphical-installation[Configuring Manual Partitioning]. -* For more information about resizing your existing LVs to free up capacity in your VGs, read link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/configuring_and_managing_logical_volumes/index#managing-lvm-volume-groups_configuring-and-managing-logical-volumes[Managing LVM Volume Groups]. -* For more information about creating VGs and PVs, read link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/overview-of-logical-volume-management_configuring-and-managing-logical-volumes[Overview of logical volume management]. +* For more information about resizing your existing LVs to free up capacity in your VGs, read link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html-single/configuring_and_managing_logical_volumes/index#managing-lvm-volume-groups_configuring-and-managing-logical-volumes[Managing LVM Volume Groups]. +* For more information about creating VGs and PVs, read link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/overview-of-logical-volume-management_configuring-and-managing-logical-volumes[Overview of logical volume management]. include::modules/microshift-install-rpms.adoc[leveloffset=+1] diff --git a/microshift_install_rpm_opt/microshift-install-optional-rpms.adoc b/microshift_install_rpm_opt/microshift-install-optional-rpms.adoc index d9b085736f..0d81396ea8 100644 --- a/microshift_install_rpm_opt/microshift-install-optional-rpms.adoc +++ b/microshift_install_rpm_opt/microshift-install-optional-rpms.adoc @@ -13,13 +13,6 @@ You can install optional RPM packages with {microshift-short} to provide additio When you install {microshift-short}, optional RPM packages can be added. Examples of optional RPMs include those designed to expand your network, add and manage operators, and manage applications. Use the following procedures to add the packages that you need. -include::modules/microshift-install-rpms-olm.adoc[leveloffset=+2] - -//additional resources for installing OLM -[role="_additional-resources"] -.Additional resources -* xref:../microshift_running_apps/microshift_operators/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}] - include::modules/microshift-install-rpms-gitops.adoc[leveloffset=+2] //additional resources for installing GitOps @@ -34,3 +27,18 @@ include::modules/microshift-install-multus-rpm.adoc[leveloffset=+2] .Additional resources * xref:../microshift_networking/microshift_multiple_networks/microshift-cni-multus.adoc#microshift-cni-multus[About using multiple networks] +include::modules/microshift-install-rpms-olm.adoc[leveloffset=+2] + +//additional resources for installing OLM +[role="_additional-resources"] +.Additional resources +* xref:../microshift_running_apps/microshift_operators/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}] + + +//include::modules/microshift-install-rhoai.adoc[leveloffset=+2] + +//additional resources for installing RHOAI +//[role="_additional-resources"] +//.Additional resources +//* xref:../microshift_ai/microshift-ai.adoc#microshift-ai[Using Red{nbsp}Hat OpenShift AI with {microshift-short}] +//should be an attribute for rhoai by the time this merges \ No newline at end of file diff --git a/microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc b/microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc index f474ed5b52..e758758641 100644 --- a/microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc +++ b/microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc @@ -58,7 +58,7 @@ include::modules/microshift-embed-kickstart-in-iso.adoc[leveloffset=+2] * xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-install-system-requirements_microshift-install-rpm[System requirements for installing {microshift-short}] * link:https://console.redhat.com/openshift/install/pull-secret[Red Hat Hybrid Cloud Console pull secret] * xref:../microshift_networking/microshift-firewall.adoc#microshift-firewall-req-settings_microshift-firewall[Required firewall settings] -//* xref:../microshift_install_kickstarts/microshift-rhel-kickstarts.adoc#microshift-rhel-kickstarts[Using Kickstart files for embedding {microshift-short} in {op-system-base} installation] +* xref:../microshift_install_kickstarts/microshift-rhel-kickstarts.adoc#microshift-rhel-kickstarts[Using Kickstart files for embedding {microshift-short} in {op-system-base} installation] * link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/automatically_installing_rhel/creating-kickstart-files_rhel-installer[Creating Kickstart files] * link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/automatically_installing_rhel/kickstart-script-file-format-reference_rhel-installer#kickstart-file-format_kickstart-script-file-format-reference[A.1. Kickstart file format] * link:https://access.redhat.com/solutions/60959[How to embed a Kickstart file into an ISO image] diff --git a/modules/microshift-accessing-cluster-locally.adoc b/modules/microshift-accessing-cluster-locally.adoc index 46f683f394..8a86286ee0 100644 --- a/modules/microshift-accessing-cluster-locally.adoc +++ b/modules/microshift-accessing-cluster-locally.adoc @@ -12,7 +12,7 @@ Use the following procedure to access the {microshift-short} cluster locally by .Prerequisites -* You have installed the `oc` binary. +* You installed {oc-first}. .Procedure @@ -41,7 +41,6 @@ $ chmod go-r ~/.kube/config * Verify that {microshift-short} is running by entering the following command: + -[source,terminal] ----- -$ oc get all -A ----- +-- +include::snippets/microshift-healthy-pods-snip.adoc[leveloffset=+2] +-- diff --git a/modules/microshift-accessing-cluster-open-firewall.adoc b/modules/microshift-accessing-cluster-open-firewall.adoc index 24f20068e8..a716e5b420 100644 --- a/modules/microshift-accessing-cluster-open-firewall.adoc +++ b/modules/microshift-accessing-cluster-open-firewall.adoc @@ -14,7 +14,7 @@ For this procedure, `user@microshift` is the user on the {microshift-short} host .Prerequisites -* You have installed the `oc` binary. +* You installed {oc-first}. * Your account has cluster administration privileges. @@ -31,7 +31,6 @@ For this procedure, `user@microshift` is the user on the {microshift-short} host * As `user@microshift`, verify that {microshift-short} is running by entering the following command: + -[source,terminal] ----- -[user@microshift]$ oc get all -A ----- +-- +include::snippets/microshift-healthy-pods-snip.adoc[leveloffset=+2] +-- \ No newline at end of file diff --git a/modules/microshift-accessing-cluster-remotely.adoc b/modules/microshift-accessing-cluster-remotely.adoc index 3848f2dda6..d0bbcdb3d7 100644 --- a/modules/microshift-accessing-cluster-remotely.adoc +++ b/modules/microshift-accessing-cluster-remotely.adoc @@ -14,7 +14,7 @@ The `user@workstation` login is used to access the host machine remotely. The `< .Prerequisites -* You have installed the `oc` binary. +* You installed {oc-first}. * The `user@microshift` has opened the firewall from the local host. @@ -22,29 +22,33 @@ The `user@workstation` login is used to access the host machine remotely. The `< . As `user@workstation`, create a `~/.kube/` folder if your {op-system-base-full} machine does not have one by running the following command: + -[source,terminal,subs="attributes+"] +[source,terminal] ---- [user@workstation]$ mkdir -p ~/.kube/ ---- . As `user@workstation`, set a variable for the hostname of your {microshift-short} host by running the following command: + -[source,terminal,subs="attributes+"] +[source,terminal,subs="+quotes"] ---- -[user@workstation]$ MICROSHIFT_MACHINE= +[user@workstation]$ MICROSHIFT_MACHINE=__ # <1> ---- +<1> Replace the value, _<{microshift-short}_hostname>_, with the either the name or the IP address of the host running {microshift}. . As `user@workstation`, copy the generated `kubeconfig` file that contains the host name or IP address you want to connect with from the {op-system-base} machine running {microshift-short} to your local machine by running the following command: + -[source,terminal] +[source,terminal,subs="+quotes"] ---- -[user@workstation]$ ssh @$MICROSHIFT_MACHINE "sudo cat /var/lib/microshift/resources/kubeadmin/$MICROSHIFT_MACHINE/kubeconfig" > ~/.kube/config +[user@workstation]$ ssh __@$MICROSHIFT_MACHINE "sudo cat /var/lib/microshift/resources/kubeadmin/$MICROSHIFT_MACHINE/kubeconfig" > ~/.kube/config # <1> ---- +<1> Replace __ with your SSH login credentials. + +-- [NOTE] ==== -To generate the `kubeconfig` files for this step, see link:https://access.redhat.com/documentation/en-us/red_hat_build_of_microshift/{product-version}/html/configuring/microshift-kubeconfig#generating-additional-kubeconfig-files_microshift-kubeconfig[Generating additional kubeconfig files for remote access]. +To generate the `kubeconfig` files for this step, see link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{product-version}/html/configuring/microshift-kubeconfig#generating-additional-kubeconfig-files_microshift-kubeconfig[Generating additional kubeconfig files for remote access]. ==== +-- . As `user@workstation`, update the permissions on your `~/.kube/config` file by running the following command: + @@ -57,7 +61,6 @@ $ chmod go-r ~/.kube/config * As `user@workstation`, verify that {microshift-short} is running by entering the following command: + -[source,terminal] ----- -[user@workstation]$ oc get all -A ----- +-- +include::snippets/microshift-healthy-pods-snip.adoc[leveloffset=+2] +-- \ No newline at end of file diff --git a/modules/microshift-embed-ostree-enable-eus-repos.adoc b/modules/microshift-embed-ostree-enable-eus-repos.adoc index 627c8ac94d..d45b4573dd 100644 --- a/modules/microshift-embed-ostree-enable-eus-repos.adoc +++ b/modules/microshift-embed-ostree-enable-eus-repos.adoc @@ -25,50 +25,50 @@ include::snippets/microshift-unsupported-config-warn.adoc[leveloffset=+1] $ sudo mkdir -p /etc/osbuild-composer/repositories ---- -. Copy the `/usr/share/osbuild-composer/repositories/rhel-9.4.json` file into the `/etc/osbuild-composer/repositories` directory by running the following command: +. Copy the `/usr/share/osbuild-composer/repositories/rhel-{op-system-version}.json` file into the `/etc/osbuild-composer/repositories` directory by running the following command: + -[source,terminal] +[source,terminal,subs="attributes+"] ---- -$ sudo cp /usr/share/osbuild-composer/repositories/rhel-9.4.json /etc/osbuild-composer/repositories/rhel-9.4.json +$ sudo cp /usr/share/osbuild-composer/repositories/rhel-{op-system-version}.json /etc/osbuild-composer/repositories/rhel-{op-system-version}.json ---- -. Update the `baseos` source by modifying the `/etc/osbuild-composer/repositories/rhel-9.4.json` file with the following values: +. Update the `baseos` source by modifying the `/etc/osbuild-composer/repositories/rhel-{op-system-version}.json` file with the following values: + -[source,terminal] +[source,terminal,subs="attributes+"] ---- # ... -"baseurl": "https://cdn.redhat.com/content/eus/rhel<9>/<9.4>//baseos/os", # <1> +"baseurl": "https://cdn.redhat.com/content/eus/rhel{op-system-version-major}/{op-system-version}//baseos/os", # <1> # ... ---- -<1> Replace _<9>_ with the major {op-system-base} version you are using, and replace _<9.4>_ with the __ version. Be certain that the {op-system-base} version you choose is compatible with the {microshift-short} version you are using. +<1> You can replace _{op-system-version-major}_ with the major {op-system-base} version you are using if different from the value in this example, and replace _{op-system-version}_ with the __ version. Be certain that the {op-system-base} version you choose is compatible with the {microshift-short} version you are using. -. Optional. Apply the `baseos` update by running the following command: +. Optional: Apply the `baseos` update by running the following command: + -[source,terminal] +[source,terminal,subs="attributes+"] ---- -$ sudo sed -i "s,dist/rhel<9>/<9.4>/$(uname -m)/baseos/,eus/rhel<9>/<9.4>/$(uname -m)/baseos/,g" \ -/etc/osbuild-composer/repositories/rhel-<9.4>.json # <1> +$ sudo sed -i "s,dist/rhel{op-system-version-major}/{op-system-version}/$(uname -m)/baseos/,eus/rhel{op-system-version-major}/{op-system-version}/$(uname -m)/baseos/,g" \ +/etc/osbuild-composer/repositories/rhel-{op-system-version}.json # <1> ---- -<1> Replace _<9>_ with the major {op-system-base} version you are using, and replace _<9.4>_ with the __ version. Be certain that the {op-system-base} version you choose is compatible with the {microshift-short} version you are using. +<1> You can replace _{op-system-version-major}_ with the major {op-system-base} version you are using if different from the value in this example, and replace _{op-system-version}_ with the __ version. Be certain that the {op-system-base} version you choose is compatible with the {microshift-short} version you are using. . Update the `appstream` source by modifying the `/etc/osbuild-composer/repositories/rhel-.json` file with the following values: + -[source,terminal] +[source,terminal,subs="attributes+"] ---- # ... -"baseurl": "https://cdn.redhat.com/content/eus/rhel<9>/<9.4>//appstream/os", # <1> +"baseurl": "https://cdn.redhat.com/content/eus/rhel{op-system-version-major}/{op-system-version}//appstream/os", # <1> # ... ---- -<1> Replace _<9>_ with the major {op-system-base} version you are using, and replace _<9.4>_ with the __ version. Be certain that the {op-system-base} version you choose is compatible with the {microshift-short} version you are using. +<1> You can replace _{op-system-version-major}_ with the major {op-system-base} version you are using if different from the value in this example, and replace _{op-system-version}_ with the __ version. Be certain that the {op-system-base} version you choose is compatible with the {microshift-short} version you are using. . Optional. Apply the `appstream` update by running the following command: + -[source,terminal] +[source,terminal,subs="attributes+"] ---- -$ sudo sed -i "s,dist/rhel<9>/<9.4>/$(uname -m)/appstream/,eus/rhel<9>/<9.4>/$(uname -m)/appstream/,g" \ -/etc/osbuild-composer/repositories/rhel-<9.4>.json # <1> +$ sudo sed -i "s,dist/rhel{op-system-version-major}/{op-system-version}/$(uname -m)/appstream/,eus/rhel{op-system-version-major}/{op-system-version}/$(uname -m)/appstream/,g" \ +/etc/osbuild-composer/repositories/rhel-{op-system-version}.json # <1> ---- -<1> Replace _<9>_ with the major {op-system-base} version you are using, and replace _<9.4>_ with the __ version. Be certain that the {op-system-base} version you choose is compatible with the {microshift-short} version you are using. +<1> You can replace _{op-system-version-major}_ with the major {op-system-base} version you are using if different from the value in this example, and replace _{op-system-version}_ with the __ version. Be certain that the {op-system-base} version you choose is compatible with the {microshift-short} version you are using. .Verification @@ -82,9 +82,9 @@ $ sudo composer-cli sources info baseos | grep 'url =' ---- .Example output + -[source,text] +[source,text,subs="attributes+"] ---- -url = "https://cdn.redhat.com/content/eus/rhel9/9.4/x86_64/baseos/os" +url = "https://cdn.redhat.com/content/eus/rhel{op-system-version-major}/{op-system-version}/x86_64/baseos/os" ---- . Verify the `appstream` source by running the following command: @@ -95,7 +95,7 @@ $ sudo composer-cli sources info appstream | grep 'url =' ---- .Example output + -[source,text] +[source,text,subs="attributes+"] ---- -url = "https://cdn.redhat.com/content/eus/rhel9/9.4/x86_64/appstream/os" +url = "https://cdn.redhat.com/content/eus/rhel{op-system-version-major}/{op-system-version}/x86_64/appstream/os" ---- \ No newline at end of file diff --git a/modules/microshift-get-rpm-release-info.adoc b/modules/microshift-get-rpm-release-info.adoc index e85f06a2c1..f480fa726f 100644 --- a/modules/microshift-get-rpm-release-info.adoc +++ b/modules/microshift-get-rpm-release-info.adoc @@ -42,8 +42,7 @@ microshift-release-info-0:4.17.9-202408220842.p0.gefa92a2.assembly.4.17.9.el9.no . Download the RPM package you want by running the following command: + -- -[subs="+quotes"] -[source,terminal] +[source,terminal,subs="+quotes"] ---- $ sudo dnf download microshift-release-info-__ # <1> ---- @@ -52,18 +51,16 @@ $ sudo dnf download microshift-release-info-__ # <1> + -- .Example output -[subs="+quotes"] -[source,terminal] +[source,terminal,subs="+quotes"] ---- -microshift-release-info-4.17.1.-202311101230.p0.g7dc6a00.assembly.4.17.1.el9.noarch.rpm # <1> +microshift-release-info-4.17.1.-202411101230.p0.g7dc6a00.assembly.4.17.1.el9.noarch.rpm # <1> ---- <1> Your output should contain the date and commit ID. -- . Unpack the RPM package without installing it by running the following command: + -[subs="+quotes"] -[source,terminal] +[source,terminal,subs="+quotes"] ---- $ rpm2cpio __ | cpio -idmv # <1> ---- diff --git a/modules/microshift-greenboot-prerollback-log.adoc b/modules/microshift-greenboot-prerollback-log.adoc index 4fe41dbe7f..e7beb9c314 100644 --- a/modules/microshift-greenboot-prerollback-log.adoc +++ b/modules/microshift-greenboot-prerollback-log.adoc @@ -31,10 +31,10 @@ boot_indeterminate=0 boot_counter=0 The ostree status: * rhel c0baa75d9b585f3dd989a9cf05f647eb7ca27ee0dbd4b94fe8c93ed3a4b9e4a5.0 - Version: 9.1 + Version: 9.6 origin: rhel 6869c1347b0e0ba1bbf0be750cdf32da5138a1fcbc5a4c6325ab9eb647b64663.0 (rollback) - Version: 9.1 + Version: 9.6 origin refspec: edge:rhel/9/x86_64/edge System rollback imminent - preparing MicroShift for a clean start Stopping MicroShift services diff --git a/modules/microshift-install-rhel-image-mode-build-image.adoc b/modules/microshift-install-rhel-image-mode-build-image.adoc index 0c5ab0a5b9..e6af4b6d31 100644 --- a/modules/microshift-install-rhel-image-mode-build-image.adoc +++ b/modules/microshift-install-rhel-image-mode-build-image.adoc @@ -14,8 +14,8 @@ Image mode for {op-system-base} is Technology Preview. Using a bootc image in pr ==== .Prerequisites -* A {op-system-base-full} 9.4 host with an active Red Hat subscription for building {microshift-short} bootc images and running containers. -* You are logged into the {op-system-base} 9.4 host using the user credentials that have `sudo` permissions. +* A {op-system-base-full} {op-system-version} host with an active Red Hat subscription for building {microshift-short} bootc images and running containers. +* You are logged into the {op-system-base} {op-system-version} host using the user credentials that have `sudo` permissions. * The `rhocp` and `fast-datapath` repositories are accessible in the host subscription. The repositories do not necessarily need to be enabled on the host. * You have a remote registry such as link:https://quay.io[Red Hat quay] for storing and accessing bootc images. @@ -24,14 +24,14 @@ Image mode for {op-system-base} is Technology Preview. Using a bootc image in pr . Create a Containerfile that includes the following instructions: + .Example Containerfile for {op-system-base} image mode -[source,text] +[source,text,subs="attributes+"] ---- -FROM registry.redhat.io/rhel9/rhel-bootc:9.4 +FROM registry.redhat.io/rhel{op-system-version-major}/rhel-bootc:{op-system-version} -ARG USHIFT_VER=4.17 +ARG USHIFT_VER={product-version} RUN dnf config-manager \ - --set-enabled rhocp-${USHIFT_VER}-for-rhel-9-$(uname -m)-rpms \ - --set-enabled fast-datapath-for-rhel-9-$(uname -m)-rpms + --set-enabled rhocp-${USHIFT_VER}-for-rhel-{op-system-version-major}-$(uname -m)-rpms \ + --set-enabled fast-datapath-for-rhel-{op-system-version-major}-$(uname -m)-rpms RUN dnf install -y firewalld microshift && \ systemctl enable microshift && \ dnf clean all @@ -73,11 +73,11 @@ Podman uses the host subscription information and repositories inside the contai . Create a local bootc image by running the following image build command: + -[source,terminal] +[source,terminal,subs="+quotes"] ---- PULL_SECRET=~/.pull-secret.json -USER_PASSWD= # <1> -IMAGE_NAME=microshift-4.17-bootc +USER_PASSWD=__ # <1> +IMAGE_NAME=microshift-{product-version}-bootc $ sudo podman build --authfile "${PULL_SECRET}" -t "${IMAGE_NAME}" \ --build-arg USER_PASSWD="${USER_PASSWD}" \ @@ -89,7 +89,7 @@ $ sudo podman build --authfile "${PULL_SECRET}" -t "${IMAGE_NAME}" \ ==== How secrets are used during the image build: -* The podman `--authfile` argument is required to pull the base `rhel-bootc:9.4` image from the `registry.redhat.io` registry. +* The podman `--authfile` argument is required to pull the base `rhel-bootc:{op-system-version}` image from the `registry.redhat.io` registry. * The build `USER_PASSWD` argument is used to set a password for the `redhat` user. ==== @@ -106,5 +106,5 @@ $ sudo podman images "${IMAGE_NAME}" [source,text] ---- REPOSITORY TAG IMAGE ID CREATED SIZE -localhost/microshift-4.17-bootc latest 193425283c00 2 minutes ago 2.31 GB +localhost/microshift-4.19-bootc latest 193425283c00 2 minutes ago 2.31 GB ---- diff --git a/modules/microshift-install-rhel-image-mode-conc.adoc b/modules/microshift-install-rhel-image-mode-conc.adoc index d91384fd1f..c6b0406ef2 100644 --- a/modules/microshift-install-rhel-image-mode-conc.adoc +++ b/modules/microshift-install-rhel-image-mode-conc.adoc @@ -23,7 +23,7 @@ Image mode splits the creation and installation of software changes into two ste To use image mode for {op-system-base}, ensure that the following resources are available: -* A {op-system-base} 9.4 host with an active Red Hat subscription for building {microshift-short} bootc images. +* A {op-system-base} {op-system-version} host with an active Red Hat subscription for building {microshift-short} bootc images. * A remote registry for storing and accessing bootc images. * You can use image mode for RHEL with a {microshift-short} cluster on AArch64 or x86_64 system architectures. diff --git a/modules/microshift-install-rhel-image-mode-publish-image.adoc b/modules/microshift-install-rhel-image-mode-publish-image.adoc index 0ac51b1579..1a42521862 100644 --- a/modules/microshift-install-rhel-image-mode-publish-image.adoc +++ b/modules/microshift-install-rhel-image-mode-publish-image.adoc @@ -16,27 +16,43 @@ Publish your bootc image to the remote registry so that the image can be used fo .Procedure +. Set the `REGISTRY_URL` variable for the image by running the following command: ++ +[source,terminal,subs="+quotes"] +---- +$ REGISTRY_URL=__ # <1> +---- +<1> Replace __ with the URL for your image registry. + . Log in to your remote registry by running the following command: + -[source,terminal] +[source,terminal,subs="+quotes"] +---- +$ sudo podman login "${REGISTRY-URL}" ---- -REGISTRY_URL=quay.io -$ sudo podman login "${REGISTRY_URL}" # <1> +. Set the `IMAGE_NAME` variable for the image by running the following command: ++ +[source,terminal,subs="+quotes"] ---- -<1> Replace _REGISTRY_URL_ with the URL for your registry. +$ IMAGE_NAME=__ # <1> +---- +<1> Replace __ with the name of the image you want to publish. + +. Set the `REGISTRY_IMG` variable for the image by running the following command: ++ +[source,terminal,subs="+quotes"] +---- +$ REGISTRY_IMG=__/"${IMAGE_NAME}" # <1> +---- +<1> Replace __ with your remote registry organization name and path. . Publish the image by running the following command: + -[source,terminal] +[source,terminal,subs="+quotes"] ---- -REGISTRY_IMG=/"${IMAGE_NAME}" # <1> <2> -IMAGE_NAME= # <3> - $ sudo podman push localhost/"${IMAGE_NAME}" "${REGISTRY_URL}/${REGISTRY_IMG}" ---- -<1> Replace __ with your remote registry organization name and path. -<2> Replace __ with the name of the image you want to publish. .Verification diff --git a/modules/microshift-kickstart-bootc-install.adoc b/modules/microshift-kickstart-bootc-install.adoc index d18a66c8a8..3d36ddc946 100644 --- a/modules/microshift-kickstart-bootc-install.adoc +++ b/modules/microshift-kickstart-bootc-install.adoc @@ -17,9 +17,9 @@ You can use the Kickstart file provided with {microshift-short} for an image mod . Set the required `BOOTC_IMAGE_URL` variable value to point to an image used in the RHEL Kickstart file installation process by running the following command: + -[source,terminal] +[source,terminal,subs="+quotes"] ---- -$ export BOOTC_IMAGE_URL=///microshift-image:tag # <1> +$ export BOOTC_IMAGE_URL=_//_/microshift-image:tag # <1> ---- <1> Replace __,__, and __ with your information. diff --git a/modules/microshift-kickstart-ostree-install.adoc b/modules/microshift-kickstart-ostree-install.adoc index 13acbadf7c..b129e1b2ae 100644 --- a/modules/microshift-kickstart-ostree-install.adoc +++ b/modules/microshift-kickstart-ostree-install.adoc @@ -21,17 +21,17 @@ Use the Kickstart file provided with {microshift-short} to provision a {op-syste + * The `OSTREE_SERVER_URL` variable contains an `rpm-ostree` server URL that is passed to the `ostreesetup` Kickstart command. + -[source,terminal] +[source,terminal,subs="+quotes"] ---- -$ export OSTREE_SERVER_URL="" # <1> +$ export OSTREE_SERVER_URL="__" # <1> ---- <1> Replace __ with your server URL. + * The `OSTREE_COMMIT_REF` variable contains an `rpm-ostree` commit reference that is installed from the server. + -[source,terminal] +[source,terminal,subs="+quotes"] ---- -$ export OSTREE_COMMIT_REF="" # <1> +$ export OSTREE_COMMIT_REF="__" # <1> ---- <1> Replace __ with the `rpm-ostree` commit reference. diff --git a/modules/microshift-kickstart-prep.adoc b/modules/microshift-kickstart-prep.adoc index f34a0c0843..37e70958de 100644 --- a/modules/microshift-kickstart-prep.adoc +++ b/modules/microshift-kickstart-prep.adoc @@ -42,11 +42,11 @@ $ export PULL_SECRET="$(cat ~/.pull-secret.json)" * Set a password in the `PASSWD_TEXT` variable to use in the`USER_PASSWD` setting by running the following command: + .Example command setting the `PASSWD_TEXT` variable. -[source,terminal] +[source,terminal,subs="+quotes"] ---- -$ PASSWD_TEXT= <1> +$ PASSWD_TEXT=__ <1> ---- -<1> Replace __ with the password you want to use. +<1> Replace __ with the password you want to use. * The `USER_PASSWD` setting is used as an encrypted password for the `redhat` user for logging into the host. Encrypt your password string using the SHA-512 encryption standard. + @@ -58,6 +58,7 @@ $ export USER_PASSWD="$(openssl passwd -6 "${PASSWD_TEXT}")" # <1> <1> Only the encrypted password is included in the Kickstart file. The plain text password is not. .Next steps -. Follow the instructions for your installation type to create a working Kickstart file from the provided template. Instructions for RPM-based, {op-system-ostree}, and {op-system-image} installations follow this procedure. -. Optional. Create a virtual machine (VM) using the Kickstart file. Creating a VM allows you to test and validate the values in your Kickstart file. +* Follow the instructions for your installation type to create a working Kickstart file from the provided template. Instructions for RPM-based, {op-system-ostree}, and {op-system-image} installations follow this procedure. + +* Optional. Create a virtual machine (VM) using the Kickstart file. Creating a VM allows you to test and validate the values in your Kickstart file. diff --git a/modules/microshift-kickstart-rpm-install.adoc b/modules/microshift-kickstart-rpm-install.adoc index ed9b3492f9..5ee1519723 100644 --- a/modules/microshift-kickstart-rpm-install.adoc +++ b/modules/microshift-kickstart-rpm-install.adoc @@ -11,12 +11,12 @@ Use the Kickstart file provided with {microshift-short} to provision an RPM-base .Prerequisites * You set up the {microshift-short} Kickstart file. -* You know the [Activation Keys](https://console.redhat.com/insights/connector/activation-keys) and organization ID to activate your Red Hat subscription. -* You have the information needed to set the `BOOTC_IMAGE_URL`, `AUTH_CONFIG`, and `REGISTRY_CONFIG` variables. +* You know the link:https://console.redhat.com/insights/connector/activation-keys[Activation Keys] and organization ID to activate your Red{nbsp}Hat subscription. +* You have the information needed to set the `BOOTC_IMAGE_URL`, `AUTH_CONFIG`, and `REGISTRY_CONFIG` required variables. [IMPORTANT] ==== -The subscription must include access to the `rhocp-4.x-for-rhel-9-$(uname -m)-rpms` and `fast-datapath-for-rhel-9-$(uname -m)-rpms` RPM repositories. +The subscription must include access to the `rhocp-4.x-for-rhel-{op-system-version-major}-$(uname -m)-rpms` and `fast-datapath-for-rhel-{op-system-version-major}-$(uname -m)-rpms` RPM repositories. ==== .Procedure @@ -25,14 +25,14 @@ The subscription must include access to the `rhocp-4.x-for-rhel-9-$(uname -m)-rp + .Example commands setting the Kickstart file variables. + -* The `RHSM_ORG` variable contains a Red Hat Subscription Manager organization ID for the subscription registration command in the Kickstart file. +* The `RHSM_ORG` variable contains a Red{nbsp}Hat Subscription Manager organization ID for the subscription registration command in the Kickstart file. + [source,terminal] ---- $ export RHSM_ORG="$(cat ~/.rhsm-activation-org)" ---- + -* The `RHSM_KEY` variable contains a Red Hat Subscription Manager activation key for the subscription registration command in the Kickstart file. +* The `RHSM_KEY` variable contains a Red{nbsp}Hat Subscription Manager activation key for the subscription registration command in the Kickstart file. + [source,terminal] ---- @@ -43,9 +43,9 @@ $ export RHSM_KEY="$(cat ~/.rhsm-activation-key)" + [source,terminal] ---- -$ export MICROSHIFT_VER=4.17 # <1> +$ export MICROSHIFT_VER={product-version} # <1> ---- -<1> For the minor version you set, the latest z-stream of that version is installed. +<1> The latest `.z` of the minor version that you set is installed. . Run the following command to create the `kickstart.ks` file to be used during the virtual machine installation: +