Skip to content

[enterprise-4.17] OSDOCS-11918: creates rpm ostree install title MicroShift #81644

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 11 additions & 6 deletions _topic_maps/_topic_map_ms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,6 @@ Distros: microshift
Topics:
- Name: Installing from an RPM package
File: microshift-install-rpm
- Name: Mirroring container images for disconnected installations
File: microshift-deploy-with-mirror-registry
- Name: Embedding in a RHEL for Edge image
File: microshift-embed-in-rpm-ostree
- Name: Embedding in a RHEL for Edge image for offline use
File: microshift-embed-in-rpm-ostree-offline-use
- Name: Troubleshooting installation issues
File: microshift-installing-troubleshooting
---
Expand All @@ -69,6 +63,17 @@ Topics:
- Name: Understanding system health checks
File: microshift-greenboot
---
Name: Embedding in a RHEL for Edge image
Dir: microshift_install_rpm_ostree
Distros: microshift
Topics:
- Name: Embedding in a RHEL for Edge image using image builder
File: microshift-embed-in-rpm-ostree
- Name: Mirroring container images for disconnected installations
File: microshift-deploy-with-mirror-registry
- Name: Embedding in a RHEL for Edge image for offline use
File: microshift-embed-in-rpm-ostree-offline-use
---
Name: Updating
Dir: microshift_updating
Distros: microshift
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ include::modules/microshift-low-latency-install-kernelrt-rhel-edge.adoc[leveloff

Complete the build process by starting with the following procedure to embed {microshift-short}in a {op-system-ostree} image. Then complete the remaining steps in the installation documentation for installing {microshift-short} in a {op-system-ostree} image:

* xref:../../microshift_install/microshift-embed-in-rpm-ostree.adoc#microshift-creating-ostree-iso_microshift-embed-in-rpm-ostree[Embedding in a {op-system-ostree} image]
* xref:../../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#microshift-creating-ostree-iso_microshift-embed-in-rpm-ostree[Embedding in a {op-system-ostree} image]

//additional resources for real-time kernel
[role="_additional-resources"]
Expand All @@ -71,7 +71,7 @@ Complete the build process by starting with the following procedure to embed {mi
* link:https://osbuild.org/docs/on-premises/installation/managing-repositories/#using-repositories-that-require-subscription[Using repositories that require subscription] (osbuild documentation)
* 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#building-rhel-images-by-using-the-real-time-kernel_creating-system-images-with-composer-command-line-interface[Building RHEL images by using the real-time kernel] for more information.
* 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/microshift-embed-in-rpm-ostree.adoc#microshift-embed-in-rpm-ostree[Embedding in a {op-system-ostree} image]
* 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 RHEL for Real Time (kernel-rt)]
//Can likely remove KCS after 2024 as it may go out of date
Expand Down
1 change: 1 addition & 0 deletions microshift_install_rpm_ostree/_attributes
1 change: 1 addition & 0 deletions microshift_install_rpm_ostree/images
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ toc::[]

Embedding {microshift-short} containers in an `rpm-ostree` commit means that you can run a cluster in air-gapped, disconnected, or offline environments. You can embed {product-title} containers in a {op-system-ostree-first} image so that container engines do not need to pull images over a network from a container registry. Workloads can start up immediately without network connectivity.

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

[id="embed-offline-rhde-compatibility-table"]
== Compatibility table

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::snippets/microshift-rhde-compatibility-table-snip.adoc[leveloffset=+1]

include::modules/microshift-embed-microshift-image-offline-deploy.adoc[leveloffset=+1]

include::modules/microshift-embed-microshift-update-osbuilder-worker.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,24 +1,13 @@
:_mod-docs-content-type: ASSEMBLY
[id="microshift-embed-in-rpm-ostree"]
= Embedding in a {op-system-ostree} image
= Embedding in a {op-system-ostree} image using image builder
include::_attributes/attributes-microshift.adoc[]
:context: microshift-embed-in-rpm-ostree

toc::[]

You can embed {microshift-short} into a {op-system-ostree-first} image. Use this guide to build a {op-system} image containing {microshift-short}.

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

Plan to use a supported version of {op-system} paired with your version of {microshift-short} as described in the following table.

[id="embed-ostree-rhde-compatibility-table"]
== Compatibility table

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::snippets/microshift-rhde-compatibility-table-snip.adoc[leveloffset=+1]

include::modules/microshift-preparing-for-image-building.adoc[leveloffset=+1]

include::modules/microshift-adding-repos-to-image-builder.adoc[leveloffset=+1]
Expand Down Expand Up @@ -46,7 +35,7 @@ include::modules/microshift-ca-adding-bundle-ostree.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources
* xref:../microshift_install/microshift-embed-in-rpm-ostree.adoc#microshift-creating-ostree-iso_microshift-embed-in-rpm-ostree[Creating the {op-system-ostree} image]
* xref:../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#microshift-creating-ostree-iso_microshift-embed-in-rpm-ostree[Creating the {op-system-ostree} image]
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/securing_networks/using-shared-system-certificates_securing-networks[Using Shared System Certificates ({op-system-base} 9)]
* link:https://access.redhat.com/documentation/en-us/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#image-customizations_creating-system-images-with-composer-command-line-interface[Supported image customizations ({op-system-base} 9)]
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/creating-and-managing-ostree-image-updates_composing-installing-managing-rhel-for-edge-images[Creating and managing OSTree image updates]
Expand Down
1 change: 1 addition & 0 deletions microshift_install_rpm_ostree/modules
1 change: 1 addition & 0 deletions microshift_install_rpm_ostree/snippets
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ include::modules/microshift-embed-images-offline-use.adoc[leveloffset=+1]

* xref:../microshift_running_apps/microshift-embedded-apps-on-rhel-edge.adoc#microshift-embedded-apps-on-rhel-edge[Options for embedding {product-title} applications in a {op-system-ostree} image]

* xref:../microshift_install/microshift-embed-in-rpm-ostree.adoc#microshift-creating-ostree-iso_microshift-embed-in-rpm-ostree[Creating the {op-system-ostree} image]
* xref:../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#microshift-creating-ostree-iso_microshift-embed-in-rpm-ostree[Creating the {op-system-ostree} image]

* xref:../microshift_install/microshift-embed-in-rpm-ostree.adoc#microshift-add-blueprint-build-iso_microshift-embed-in-rpm-ostree[Add the blueprint to image builder and build the ISO]
* xref:../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#microshift-add-blueprint-build-iso_microshift-embed-in-rpm-ostree[Add the blueprint to Image Builder and build the ISO]

* xref:../microshift_install/microshift-embed-in-rpm-ostree.adoc#microshift-download-iso-prep-for-use_microshift-embed-in-rpm-ostree[Download the ISO and prepare it for use]
* xref:../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#microshift-download-iso-prep-for-use_microshift-embed-in-rpm-ostree[Download the ISO and prepare it for use]

* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/composing_installing_and_managing_rhel_for_edge_images/index#upgrading_rhel_for_edge_systems[Upgrading {op-system-ostree} systems]
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ If you have an application that includes more than a few files, you can embed th
[id="additional-resources_microshift-embed-apps-on-rhel-edge_{context}"]
[role="_additional-resources"]
== Additional resources
* xref:../microshift_install/microshift-embed-in-rpm-ostree.adoc#microshift-embed-in-rpm-ostree[Embedding {product-title} in an RPM-OSTree image]
* xref:../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#microshift-embed-in-rpm-ostree[Embedding {product-title} in an RPM-OSTree image]

* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/{op-system-version-major}/html/composing_installing_and_managing_rhel_for_edge_images/index[Composing, installing, and managing {op-system-ostree} images]

* xref:../microshift_install/microshift-embed-in-rpm-ostree.adoc#preparing-for-image-building_microshift-embed-in-rpm-ostree[Preparing for image building]
* xref:../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#preparing-for-image-building_microshift-embed-in-rpm-ostree[Preparing for image building]

* link:https://cloud.redhat.com/blog/meet-red-hat-device-edge-with-microshift[Meet Red Hat Device Edge]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: ASSEMBLY
[id="microshift-embedding-apps-tutorial"]
= Embedding {product-title} applications tutorial
= Embedding {microshift-short} applications tutorial
include::_attributes/attributes-microshift.adoc[]
:context: microshift-embedding-apps-tutorial

Expand Down Expand Up @@ -29,11 +29,11 @@ include::modules/microshift-adding-app-rpms-to-blueprint.adoc[leveloffset=+2]
== Additional resources
* xref:../microshift_running_apps/microshift-embed-apps-offline-use.adoc#microshift-embed-apps-offline-use[Embedding applications for offline use]

* xref:../microshift_install/microshift-embed-in-rpm-ostree.adoc#microshift-embed-in-rpm-ostree[Embedding {product-title} in an RPM-OSTree image]
* xref:../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#microshift-embed-in-rpm-ostree[Embedding {product-title} in an RPM-OSTree image]

* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/{op-system-version-major}/html/composing_installing_and_managing_rhel_for_edge_images/index[Composing, installing, and managing {op-system-ostree} images]

* xref:../microshift_install/microshift-embed-in-rpm-ostree.adoc#preparing-for-image-building_microshift-embed-in-rpm-ostree[Preparing for image building]
* xref:../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#preparing-for-image-building_microshift-embed-in-rpm-ostree[Preparing for image building]

* link:https://cloud.redhat.com/blog/meet-red-hat-device-edge-with-microshift[Meet Red Hat Device Edge with {product-title}]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ include::modules/microshift-olm-deploy-op-disconnected-con.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* link:https://access.redhat.com/documentation/en-us/red_hat_build_of_microshift/{ocp-version}/html/installing/microshift-embed-in-rpm-ostree-for-offline-use#microshift-creating-ostree-iso_microshift-embed-rpm-ostree-offline-use[Creating the RHEL for Edge image]
* xref:../../microshift_install/microshift-embed-in-rpm-ostree-offline-use.adoc#microshift-embed-rpm-ostree-offline-use[Embedding in a {op-system-ostree} image for offline use]
* xref:../../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc#microshift-embed-rpm-ostree-offline-use[Embedding in a {op-system-ostree} image for offline use]
* xref:../../microshift_networking/microshift-disconnected-network-config.adoc#microshift-networking-disconnected-hosts[Configuring network settings for fully disconnected hosts]

//OCP module, edit with conditionals and care
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ You can filter and prune catalogs to get specific Operators and mirror them by u
[role="_additional-resources"]
.Additional resources
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
* xref:../../microshift_install/microshift-deploy-with-mirror-registry.adoc#microshift-configuring-hosts-for-mirror_microshift-deployment-mirror[Configuring hosts for mirror registry access]
* xref:../../microshift_install_rpm_ostree/microshift-deploy-with-mirror-registry.adoc#microshift-configuring-hosts-for-mirror_microshift-deployment-mirror[Configuring hosts for mirror registry access]
* xref:../../microshift_networking/microshift-disconnected-network-config.adoc#microshift-disconnected-network-config[Configuring network settings for fully disconnected hosts]
* xref:../../microshift_install/microshift-deploy-with-mirror-registry.adoc#microshift-get-mirror-reg-container-image-list_microshift-deploy-with-mirror-registry[Getting the mirror registry container image list]
* xref:../../microshift_install/microshift-embed-in-rpm-ostree-offline-use.adoc#microshift-embed-in-rpm-ostree-offline-use[Embedding in a {op-system-ostree} image for offline use]
* xref:../../microshift_install_rpm_ostree/microshift-deploy-with-mirror-registry.adoc#microshift-get-mirror-reg-container-image-list_microshift-deploy-with-mirror-registry[Getting the mirror registry container image list]
* xref:../../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc#microshift-embed-in-rpm-ostree-offline-use[Embedding in a {op-system-ostree} image for offline use]

include::modules/microshift-oc-mirror-about-con.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can install the OLM package manager for use with {microshift-short} 4.15 or
* You can install the `microshift-olm` RPM at the same time you install the {microshift-short} RPM on {op-system-base-full}.
* You can install the `microshift-olm` on an existing {microshift-short} {product-version}. Restart the {microshift-short} service after installing OLM for the changes to apply.
See xref:../../microshift_install/microshift-install-rpm.adoc#microshift-install-rpms-olm_microshift-install-rpm[Installing the Operator Lifecycle Manager (OLM) from an RPM package].
* You can embed OLM in a {op-system-ostree-first} image. See xref:../../microshift_install/microshift-embed-in-rpm-ostree.adoc#microshift-adding-olm-to-blueprint_microshift-embed-in-rpm-ostree[Adding the Operator Lifecycle Manager (OLM) service to a blueprint].
* You can embed OLM in a {op-system-ostree-first} image. See xref:../../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#microshift-adding-olm-to-blueprint_microshift-embed-in-rpm-ostree[Adding the Operator Lifecycle Manager (OLM) service to a blueprint].

include::modules/microshift-olm-namespaces.adoc[leveloffset=+1]

Expand Down
6 changes: 3 additions & 3 deletions modules/microshift-accessing-cluster-locally.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// Module included in the following assemblies:
//
// microshift/microshift_install/microshift-install-rpm.adoc
// microshift/microshift_install/microshift-embed-in-rpm-ostree.adoc
// microshift/microshift_configuring/microshift-cluster-access-kubeconfig.adoc
// microshift_install_rpm/microshift-install-rpm.adoc
// microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc
// microshift_configuring/microshift-cluster-access-kubeconfig.adoc

:_mod-docs-content-type: PROCEDURE
[id="accessing-microshift-cluster-locally_{context}"]
Expand Down
6 changes: 3 additions & 3 deletions modules/microshift-accessing-cluster-open-firewall.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// Module included in the following assemblies:
//
// microshift/microshift_install/microshift-install-rpm.adoc
// microshift/microshift_install/microshift-embed-in-rpm-ostree.adoc
// microshift/microshift_configuring/microshift-cluster-access-kubeconfig.adoc
// microshift_install_rpm/microshift-install-rpm.adoc
// microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc
// microshift_configuring/microshift-cluster-access-kubeconfig.adoc

:_mod-docs-content-type: PROCEDURE
[id="microshift-accessing-cluster-open-firewall_{context}"]
Expand Down
6 changes: 3 additions & 3 deletions modules/microshift-accessing-cluster-remotely.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// Module included in the following assemblies:
//
// microshift/microshift_install/microshift-install-rpm.adoc
// microshift/microshift_install/microshift-embed-in-rpm-ostree.adoc
// microshift/microshift_configuring/microshift-cluster-access-kubeconfig.adoc
// microshift_install_rpm/microshift-install-rpm.adoc
// microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc
// microshift_configuring/microshift-cluster-access-kubeconfig.adoc

:_mod-docs-content-type: PROCEDURE
[id="accessing-microshift-cluster-remotely_{context}"]
Expand Down
4 changes: 2 additions & 2 deletions modules/microshift-accessing.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Module included in the following assemblies:
//
// microshift/microshift_install/microshift-install-rpm.adoc
// microshift/microshift_install/microshift-embed-in-rpm-ostree.adoc
// microshift_install_rpm/microshift-install-rpm.adoc
// microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc

:_mod-docs-content-type: CONCEPT
[id="accessing-microshift-cluster_{context}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-add-blueprint-build-iso.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// microshift/microshift-embed-into-rpm-ostree.adoc
// microshift_install_rpm_ostree/microshift-embed-into-rpm-ostree.adoc

:_mod-docs-content-type: PROCEDURE
[id="microshift-add-blueprint-build-iso_{context}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-adding-other-packages-to-blueprint.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * microshift/microshift-update-rpms-ostree.adoc
// * microshift_install_rpm/microshift-update-rpms-ostree.adoc

:_mod-docs-content-type: PROCEDURE
[id="microshift-adding-other-services-to-blueprint_{context}"]
Expand Down
4 changes: 2 additions & 2 deletions modules/microshift-adding-repos-to-image-builder.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Module included in the following assemblies:
//
// * microshift/microshift-embed-into-rpm-ostree.adoc
// * microshift/microshift-update-rpms-ostree.adoc
// * microshift_install_rpm_ostree/microshift-embed-into-rpm-ostree.adoc
// * microshift_install_rpm/microshift-update-rpms-ostree.adoc

:_mod-docs-content-type: PROCEDURE
[id="adding-microshift-repos-image-builder_{context}"]
Expand Down
4 changes: 2 additions & 2 deletions modules/microshift-adding-service-to-blueprint.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Module included in the following assemblies:
//
// * microshift/microshift-embed-into-rpm-ostree.adoc
// * microshift/microshift-update-rpms-ostree.adoc
// * microshift_install_rpm_ostree/microshift-embed-into-rpm-ostree.adoc
// * microshift_install_rpm/microshift-update-rpms-ostree.adoc

:_mod-docs-content-type: PROCEDURE
[id="adding-microshift-service-to-blueprint_{context}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-ca-adding-bundle-ostree.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//Module included in the following assemblies:
//
//* microshift_install/microshift-embed-in-rpm-ostree.adoc
//* microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc


:_mod-docs-content-type: PROCEDURE
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-ca-adding-bundle.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//Module included in the following assemblies:
//
//* microshift_install/microshift-embed-in-rpm-ostree.adoc
//* microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-ca-adding-bundle_{context}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// microshift_running_applications/embed-microshift-offline-deploy.adoc
// microshift_install_rpm_ostree/microshift-embed-rpm-ostree-offline-use.adoc

:_mod-docs-content-type: PROCEDURE
[id="microshift-embed-microshift-image-offline-deployment_{context}"]
Expand Down
Loading