From 4794c310f603859a23f3dbc78a4eaeea9e741dc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CShauna=20Diaz=E2=80=9D?= Date: Mon, 9 Sep 2024 11:13:59 -0400 Subject: [PATCH] OSDOCS-11919: updates RPM install content MicroShift --- _topic_maps/_topic_map_ms.yml | 32 +++++++++---------- .../microshift-backup-and-restore.adoc | 8 ++--- .../_attributes | 0 .../images | 0 .../microshift-install-rpm.adoc | 9 ------ .../modules | 0 .../snippets | 0 .../microshift-embed-in-rpm-ostree.adoc | 2 +- .../microshift-gitops.adoc | 4 +-- .../microshift-operators-olm.adoc | 2 +- ...microshift-installing-troubleshooting.adoc | 0 .../microshift-troubleshoot-updates.adoc | 4 +-- microshift_welcome/index.adoc | 2 +- 13 files changed, 27 insertions(+), 36 deletions(-) rename {microshift_install => microshift_install_rpm}/_attributes (100%) rename {microshift_install => microshift_install_rpm}/images (100%) rename {microshift_install => microshift_install_rpm}/microshift-install-rpm.adoc (91%) rename {microshift_install => microshift_install_rpm}/modules (100%) rename {microshift_install => microshift_install_rpm}/snippets (100%) rename {microshift_install => microshift_troubleshooting}/microshift-installing-troubleshooting.adoc (100%) diff --git a/_topic_maps/_topic_map_ms.yml b/_topic_maps/_topic_map_ms.yml index 6893127b1c3f..9fb3c433a4a2 100644 --- a/_topic_maps/_topic_map_ms.yml +++ b/_topic_maps/_topic_map_ms.yml @@ -36,22 +36,6 @@ Topics: - Name: Red Hat build of MicroShift 4.17 release notes File: microshift-4-17-release-notes --- -Name: Installing -Dir: microshift_install -Distros: microshift -Topics: -- Name: Installing from an RPM package - File: microshift-install-rpm -- Name: Troubleshooting installation issues - File: microshift-installing-troubleshooting ---- -Name: Installing with RHEL image mode -Dir: microshift_install_bootc -Distros: microshift -Topics: -- Name: Installing with RHEL image mode - File: microshift-install-rhel-image-mode ---- Name: Getting ready to install MicroShift Dir: microshift_install_get_ready Distros: microshift @@ -63,6 +47,13 @@ Topics: - Name: Understanding system health checks File: microshift-greenboot --- +Name: Installing with RPMs +Dir: microshift_install_rpm +Distros: microshift +Topics: +- Name: Installing from an RPM package + File: microshift-install-rpm +--- Name: Embedding in a RHEL for Edge image Dir: microshift_install_rpm_ostree Distros: microshift @@ -74,6 +65,13 @@ Topics: - Name: Embedding in a RHEL for Edge image for offline use File: microshift-embed-in-rpm-ostree-offline-use --- +Name: Installing with RHEL image mode +Dir: microshift_install_bootc +Distros: microshift +Topics: +- Name: Installing with RHEL image mode + File: microshift-install-rhel-image-mode +--- Name: Updating Dir: microshift_updating Distros: microshift @@ -522,6 +520,8 @@ Topics: File: microshift-version - Name: Troubleshoot the cluster File: microshift-troubleshoot-cluster +- Name: Troubleshoot installation issues + File: microshift-installing-troubleshooting - Name: Troubleshoot backup and restore File: microshift-troubleshoot-backup-restore - Name: Troubleshoot updates diff --git a/microshift_backup_and_restore/microshift-backup-and-restore.adoc b/microshift_backup_and_restore/microshift-backup-and-restore.adoc index 3af862c2ddc5..c741be205246 100644 --- a/microshift_backup_and_restore/microshift-backup-and-restore.adoc +++ b/microshift_backup_and_restore/microshift-backup-and-restore.adoc @@ -24,8 +24,8 @@ include::modules/microshift-backing-up-manually.adoc[leveloffset=+1] //additional resources for backing-up module [role="_additional-resources"] .Additional resources -* xref:../microshift_install/microshift-install-rpm.adoc#microshift-service-stopping_microshift-install-rpm[Stopping the MicroShift service] -* xref:../microshift_install/microshift-install-rpm.adoc#microshift-service-starting_microshift-install-rpm[Starting the MicroShift service] +* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-service-stopping_microshift-install-rpm[Stopping the MicroShift service] +* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-service-starting_microshift-install-rpm[Starting the MicroShift service] include::modules/microshift-restoring-data-backups.adoc[leveloffset=+1] @@ -34,5 +34,5 @@ include::modules/microshift-restoring-data-backups.adoc[leveloffset=+1] //additional resources for restoring-data module [role="_additional-resources"] .Additional resources -* xref:../microshift_install/microshift-install-rpm.adoc#microshift-service-stopping_microshift-install-rpm[Stopping the MicroShift service] -* xref:../microshift_install/microshift-install-rpm.adoc#microshift-service-starting_microshift-install-rpm[Starting the MicroShift service] \ No newline at end of file +* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-service-stopping_microshift-install-rpm[Stopping the MicroShift service] +* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-service-starting_microshift-install-rpm[Starting the MicroShift service] \ No newline at end of file diff --git a/microshift_install/_attributes b/microshift_install_rpm/_attributes similarity index 100% rename from microshift_install/_attributes rename to microshift_install_rpm/_attributes diff --git a/microshift_install/images b/microshift_install_rpm/images similarity index 100% rename from microshift_install/images rename to microshift_install_rpm/images diff --git a/microshift_install/microshift-install-rpm.adoc b/microshift_install_rpm/microshift-install-rpm.adoc similarity index 91% rename from microshift_install/microshift-install-rpm.adoc rename to microshift_install_rpm/microshift-install-rpm.adoc index 53b163f14b8a..701d921f99e2 100644 --- a/microshift_install/microshift-install-rpm.adoc +++ b/microshift_install_rpm/microshift-install-rpm.adoc @@ -8,15 +8,6 @@ toc::[] You can install {microshift-short} from an RPM package on a machine with a supported version of {op-system-base-full}. -include::modules/microshift-install-system-requirements.adoc[leveloffset=+1] - -[id="microshift-install-rpm-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-install-rpm-before.adoc[leveloffset=+1] //additional resources for install rpm before module diff --git a/microshift_install/modules b/microshift_install_rpm/modules similarity index 100% rename from microshift_install/modules rename to microshift_install_rpm/modules diff --git a/microshift_install/snippets b/microshift_install_rpm/snippets similarity index 100% rename from microshift_install/snippets rename to microshift_install_rpm/snippets 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 a93a7984304b..25ddd419e253 100644 --- a/microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc +++ b/microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc @@ -53,7 +53,7 @@ include::modules/microshift-provisioning-ostree.adoc[leveloffset=+1] .Additional resources * link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/composing_installing_and_managing_rhel_for_edge_images/index[{op-system-ostree} documentation] -* xref:../microshift_install/microshift-install-rpm.adoc#microshift-install-system-requirements_microshift-install-rpm[System requirements for installing MicroShift] +* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-install-system-requirements_microshift-install-rpm[System requirements for installing MicroShift] * 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] * link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/performing_an_advanced_rhel_9_installation/creating-kickstart-files_installing-rhel-as-an-experienced-user[Creating a Kickstart file] diff --git a/microshift_running_apps/microshift-gitops.adoc b/microshift_running_apps/microshift-gitops.adoc index b14d9a1d974c..a6f3b72972c7 100644 --- a/microshift_running_apps/microshift-gitops.adoc +++ b/microshift_running_apps/microshift-gitops.adoc @@ -23,7 +23,7 @@ include::modules/microshift-gitops-adding-apps.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../microshift_install/microshift-install-rpm.adoc#microshift-installing-rpms-for-gitops_microshift-install-rpm[Installing the GitOps Argo CD manifests from an RPM package] +* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-installing-rpms-for-gitops_microshift-install-rpm[Installing the GitOps Argo CD manifests from an RPM package] [id="microshift-gitops-cannot-do_{context}"] == Limitations of using the GitOps agent with {microshift-short} @@ -43,7 +43,7 @@ include::modules/microshift-gitops-debug.adoc[leveloffset=+2] [id="additional-resources_microshift-gitops_{context}"] [role="_additional-resources"] == Additional resources -* xref:../microshift_install/microshift-install-rpm.adoc#microshift-installing-rpms-for-gitops_microshift-install-rpm[Installing the GitOps Argo CD manifests from an RPM package] +* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-installing-rpms-for-gitops_microshift-install-rpm[Installing the GitOps Argo CD manifests from an RPM package] * xref:../microshift_support/microshift-sos-report.adoc#microshift-sos-report[Using sos reports] diff --git a/microshift_running_apps/microshift_operators/microshift-operators-olm.adoc b/microshift_running_apps/microshift_operators/microshift-operators-olm.adoc index e42881846d74..a92358e67c19 100644 --- a/microshift_running_apps/microshift_operators/microshift-operators-olm.adoc +++ b/microshift_running_apps/microshift_operators/microshift-operators-olm.adoc @@ -29,7 +29,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]. +See xref:../../microshift_install_rpm/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_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] diff --git a/microshift_install/microshift-installing-troubleshooting.adoc b/microshift_troubleshooting/microshift-installing-troubleshooting.adoc similarity index 100% rename from microshift_install/microshift-installing-troubleshooting.adoc rename to microshift_troubleshooting/microshift-installing-troubleshooting.adoc diff --git a/microshift_troubleshooting/microshift-troubleshoot-updates.adoc b/microshift_troubleshooting/microshift-troubleshoot-updates.adoc index 39e4b59d10ea..c1e0fdafc83e 100644 --- a/microshift_troubleshooting/microshift-troubleshoot-updates.adoc +++ b/microshift_troubleshooting/microshift-troubleshoot-updates.adoc @@ -20,8 +20,8 @@ include::modules/microshift-updates-troubleshooting.adoc[leveloffset=+1] .Additional resources * xref:../microshift_install_get_ready/microshift-greenboot.adoc#microshift-greenboot-systemd-journal-data_microshift-greenboot[Enabling `systemd` journal service data persistency] * xref:../microshift_troubleshooting/microshift-version.adoc#microshift-version[Checking the MicroShift version] -* xref:../microshift_install/microshift-install-rpm.adoc#microshift-service-stopping_microshift-install-rpm[Stopping the MicroShift service] -* xref:../microshift_install/microshift-install-rpm.adoc#microshift-service-starting_microshift-install-rpm[Starting the MicroShift service] +* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-service-stopping_microshift-install-rpm[Stopping the MicroShift service] +* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-service-starting_microshift-install-rpm[Starting the MicroShift service] * link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/index[Composing, installing, and managing RHEL for Edge images] * link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/composing_installing_and_managing_rhel_for_edge_images/index#rolling_back_rhel_for_edge_images[Rolling back RHEL for Edge images] diff --git a/microshift_welcome/index.adoc b/microshift_welcome/index.adoc index 15eb5cc004bc..9ab5ce53d703 100644 --- a/microshift_welcome/index.adoc +++ b/microshift_welcome/index.adoc @@ -22,7 +22,7 @@ To get started with {microshift-short}, use the following links: //text is in main assembly for the sake of cross references * xref:../microshift_release_notes/microshift-4-17-release-notes.adoc#microshift-4-17-release-notes[{product-title} release notes] -* xref:../microshift_install/microshift-install-rpm.adoc#microshift-install-rpm[Installing {product-title}] +* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-install-rpm[Installing {product-title}] For related information, use the following links: