Skip to content

OSDOCS-15831: modularize install get ready assembly MicroShift #97534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 14, 2025
Merged

OSDOCS-15831: modularize install get ready assembly MicroShift #97534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 12 additions & 79 deletions microshift_install_get_ready/microshift-install-get-ready.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,91 +6,24 @@ include::_attributes/attributes-microshift.adoc[]

toc::[]

Plan for your {op-system-bundle} by planning your {op-system-base-full} installation type and your {microshift-short} configuration.
To use {op-system-bundle} to compute at the edge, plan your {op-system-base-full} installation type and your {microshift-short} configuration.

include::modules/microshift-install-system-requirements.adoc[leveloffset=+1]

[id="get-ready-install-rhde-compatibility-table_{context}"]
== Compatibility table
include::modules/microshift-install-rhde-compat-table.adoc[leveloffset=+1]

Plan to pair a supported version of {op-system-ostree} with the {microshift-short} version you are using as described in the following compatibility table.
include::modules/microshift-install-tools-intro.adoc[leveloffset=+1]

include::snippets/microshift-rhde-compatibility-table-snip.adoc[leveloffset=+1]
include::modules/microshift-install-rhel-types.adoc[leveloffset=+1]

[id="microshift-get-ready-install-tools-intro_{context}"]
== {microshift-short} installation tools
include::modules/microshift-install-rhel-tools-concepts.adoc[leveloffset=+1]

To use {microshift-short}, you must already have or plan to install a {op-system-base} type, such as on bare metal, or as a virtual machine (VM) that you provision. Although each use case has different details, each installation of {op-system-bundle} uses {op-system-base} tools and the {oc-first}.

You can use RPMs to install {microshift-short} on an existing {op-system-base} machine. See xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-install-rpm[Installing from an RPM package] for more information. No other tools are required unless you are also installing an image-based {op-system-base} system or VM at the same time.

[id="microshift-get-ready-install-rhel-types_{context}"]
== {op-system-base} installation types

Where you want to run your cluster and what your application needs to do determine the {op-system-base} installation type that you choose. For every installation target, you must configure both the operating system and {microshift-short}. Consider your application storage needs, networking for cluster or application access, and your authentication and security requirements.

Understand the differences between the {op-system-base} installation types, including the support scope of each, and the tools used.

[id="microshift-get-ready-install-rpm_{context}"]
=== Using RPMs, or package-based installation

This simple installation type uses a basic command to install {microshift-short} on an existing {op-system-base} machine. See xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-install-rpm[Installing from an RPM package] for more information. No other tools are required unless you are also installing a {op-system-base} system or virtual machine (VM) at the same time.

[id="microshift-get-ready-install-rhel-image-based_{context}"]
=== {op-system-base} image-based installations

Image-based installation types involve creating an `rpm-ostree`-based, immutable version of {op-system-base} that is optimized for edge deployment.

* {op-system-ostree} can be deployed to the edge in production environments. This installation type can be used where network connections are present or completely offline, depending on the local environment.

* Image mode for {op-system-base} is available with the Technology Preview support scope. This image-based installation type is based on OCI container images and bootable containers. See link:https://developers.redhat.com/articles/2024/09/24/bootc-getting-started-bootable-containers[bootc: Getting started with bootable containers] for an introduction to bootc technology.

When choosing an image-based installation, consider whether the installation target is intended to be in an offline or networked state, where you plan to build system images, and how you plan to load your {op-system-bundle}. Use the following scenarios as general guidance:

** If you build either a fully self-contained {op-system-ostree} or an image mode for {op-system-base} ISO outside a disconnected environment, and then install the ISO locally on your edge devices, you likely do not need an RPM repository or a mirror registry.
** If you build an ISO outside a disconnected environment that does not include the container images, but consists of only the RPMs, you need a mirror registry inside your disconnected environment. You use your mirror registry to pull container images.
** If you build images inside a disconnected environment, or use package mode for installations, you need both a mirror registry and a local RPM mirror repository. You can use either the {op-system-base} reposync utility or Red{nbsp}Hat Satellite for advanced use cases. See link:https://access.redhat.com/solutions/7019225[How to create a local mirror of the latest update for Red{nbsp}Hat Enterprise Linux 8 and 9 without using Satellite Server] and link:https://www.redhat.com/en/technologies/management/satellite[Red{nbsp}Hat Satellite] for more information.

[id="microshift-get-ready-install-rhel-tools-concepts_{context}"]
== {op-system-base} installation tools and concepts

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. 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]
** link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/installing-composer_composing-a-customized-rhel-system-image[Installing image builder]
** 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#creating-a-system-image-with-composer-in-the-command-line-interface_creating-system-images-with-composer-command-line-interface[Creating a system image with RHEL image builder in the command-line interface]

* A blueprint file directs {op-system-base} image builder to the items to include in the ISO. An image blueprint provides a persistent definition of image customizations. You can create multiple builds from a single blueprint. You can also edit an existing blueprint to build a new ISO as requirements change. For more information, see 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#creating-a-composer-blueprint-with-command-line-interface_creating-system-images-with-composer-command-line-interface[Creating a blueprint by using the command-line interface] in the {op-system-base} documentation.

* An ISO, which is the bootable operating system on which {microshift-short} runs.
** See link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-a-boot-iso-installer-image-with-image-builder_composing-a-customized-rhel-system-image#creating-a-boot-iso-installer-image-with-image-builder-in-the-command-line-interface_creating-a-boot-iso-installer-image-with-image-builder[Creating a boot ISO installer image using the RHEL image builder CLI], link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-a-boot-iso-installer-image-with-image-builder_composing-a-customized-rhel-system-image#installing-the-iso-to-a-bare-metal-system_creating-a-boot-iso-installer-image-with-image-builder[Installing a bootable ISO to a media and booting it], and xref:../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#microshift-embed-in-rpm-ostree[Embedding in a {op-system-ostree} image using image builder].

[id="microshift-get-ready-install-rhde-steps_{context}"]
== {op-system-bundle} installation steps

For most installation types, you must also take the following steps:

* Download the link:https://console.redhat.com/openshift/install/pull-secret[pull secret] from the Red{nbsp}Hat Hybrid Cloud Console.

* 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://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#[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.
** For more information about {microshift-short} networking options, see xref:../microshift_networking/microshift-networking-settings.adoc#microshift-networking[Understanding networking settings].

* Install the {oc-first} to access your cluster, see xref:../microshift_cli_ref/microshift-oc-cli-install.adoc#microshift-oc-cli-install[Getting started with the OpenShift CLI].

[NOTE]
====
{op-system-rt-kernel} can be used where predictable latency is critical. Workload partitioning is also required for low-latency applications. For more information about low latency and the {op-system-rtk}, see xref:../microshift_configuring/microshift_low_latency/microshift-low-latency.adoc#microshift-low-latency[Configuring low latency].
====
include::modules/microshift-install-rhde-steps.adoc[leveloffset=+1]

[id="additional-resources_microshift-install-get-ready_{context}"]
[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].
== Additional resources

* xref:../microshift_cli_ref/microshift-oc-cli-install.adoc#microshift-oc-cli-install[Getting started with the OpenShift CLI]
* link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/latest/html/installing_with_an_rpm_package/index[Installing from an RPM package]
* xref:../microshift_networking/microshift-networking-settings.adoc#microshift-networking[Understanding networking settings]
11 changes: 11 additions & 0 deletions modules/microshift-install-rhde-compat-table.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
// Module included in the following assemblies:
//
// * microshift_install_get_ready/microshift-install-get-ready.adoc

:_mod-docs-content-type: REFERENCE
[id="microshift-install-rhde-compat-table_{context}"]
= Compatibility table

You must pair a supported version of {op-system-full} with the {microshift-short} version you are using as described in the following compatibility table.

include::snippets/microshift-rhde-compatibility-table-snip.adoc[leveloffset=+1]
32 changes: 32 additions & 0 deletions modules/microshift-install-rhde-steps.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// Module included in the following assemblies:
//
// * microshift_install_get_ready/microshift-install-get-ready.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-install-rhde-steps_{context}"]
= {op-system-bundle} installation steps

For most installation types, you must also take the following steps:

* Download the pull secret from the Red{nbsp}Hat Hybrid Cloud Console using the following link:

This comment was marked as off-topic.

Sign in to view

Copy link
Contributor Author

@ShaunaDiaz ShaunaDiaz Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MicroShift does not have this attribute.


** link:https://console.redhat.com/openshift/install/pull-secret[Pull secret]

* Be ready to configure {microshift-short} by adding parameters and values to the {microshift-short} YAML configuration file. For more information, see the following link:

** link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/configuring/using-the-microshift-configuration-file[Using the {microshift-short} configuration file]

* 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 the following link:

** 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]

* 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.
+
[NOTE]
====
You can use the {op-system-rt-kernel} where predictable latency is critical. Workload partitioning is also required for low-latency applications. For more information about low latency and the {op-system-rtk}, see the following link:

* link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/configuring/configuring-low-latency#microshift-low-latency[Configuring low latency]
====
29 changes: 29 additions & 0 deletions modules/microshift-install-rhel-tools-concepts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// Module included in the following assemblies:
//
// * microshift_install_get_ready/microshift-install-get-ready.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-install-rhel-tools-concepts_{context}"]
= {op-system-base} installation tools and concepts

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. For more information, see the following link:

** link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/latest/html/using_rhel_kickstarts/microshift-rhel-kickstarts[Using Kickstart files for installing {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]
** link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/installing-composer_composing-a-customized-rhel-system-image[Installing image builder]
** 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#creating-a-system-image-with-composer-in-the-command-line-interface_creating-system-images-with-composer-command-line-interface[Creating a system image with RHEL image builder in the command-line interface]

* A blueprint file directs {op-system-base} image builder to the items to include in the ISO. An image blueprint provides a persistent definition of image customizations. You can create multiple builds from a single blueprint. You can also edit an existing blueprint to build a new ISO as requirements change. See the following link for more information:

** 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#creating-a-composer-blueprint-with-command-line-interface_creating-system-images-with-composer-command-line-interface[Creating a blueprint by using the command-line interface]

* An ISO, which is the bootable operating system on which {microshift-short} runs. See the following links for more information:

** link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-a-boot-iso-installer-image-with-image-builder_composing-a-customized-rhel-system-image#creating-a-boot-iso-installer-image-with-image-builder-in-the-command-line-interface_creating-a-boot-iso-installer-image-with-image-builder[Creating a boot ISO installer image using the RHEL image builder CLI]
** link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-a-boot-iso-installer-image-with-image-builder_composing-a-customized-rhel-system-image#installing-the-iso-to-a-bare-metal-system_creating-a-boot-iso-installer-image-with-image-builder[Installing a bootable ISO to a media and booting it]
** link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/latest/html/embedding_in_a_rhel_for_edge_image/microshift-embed-in-rpm-ostree[Embedding in a {op-system-ostree} image using image builder]
Loading