From 314d28ab5e586c7316f620231e5c2d7c221aa5c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CShauna=20Diaz=E2=80=9D?= Date: Tue, 24 Sep 2024 09:08:45 -0400 Subject: [PATCH] OSDOCS-12108: MicroShift 4.17 nits pass --- ...disable-lvms-csi-provider-csi-snapshot.adoc | 2 +- .../microshift-using-config-tools.adoc | 2 +- .../microshift-install-rhel-image-mode.adoc | 2 +- .../microshift-fips.adoc | 2 +- .../microshift-install-get-ready.adoc | 4 ++-- ...oshift-embed-in-rpm-ostree-offline-use.adoc | 2 +- .../microshift-embed-in-rpm-ostree.adoc | 2 +- .../microshift-authentication.adoc | 2 +- .../microshift-embedded-apps-on-rhel-edge.adoc | 4 ++-- .../microshift-embedding-apps-tutorial.adoc | 2 +- .../microshift-storage-migration.adoc | 4 ++-- .../microshift-cleanup-data.adoc | 6 +++++- .../microshift-update-options.adoc | 2 +- .../microshift-update-rpms-manually.adoc | 2 +- ...shift-making-storage-migration-request.adoc | 4 ++-- ...croshift-rhde-compatibility-table-snip.adoc | 2 +- snippets/microshift-update-paths-snip.adoc | 18 +++++++++--------- 17 files changed, 33 insertions(+), 29 deletions(-) diff --git a/microshift_configuring/microshift-disable-lvms-csi-provider-csi-snapshot.adoc b/microshift_configuring/microshift-disable-lvms-csi-provider-csi-snapshot.adoc index 8ae9651e9f..81118d607d 100644 --- a/microshift_configuring/microshift-disable-lvms-csi-provider-csi-snapshot.adoc +++ b/microshift_configuring/microshift-disable-lvms-csi-provider-csi-snapshot.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="microshift-disable-lvms-csi-provider-csi-snapshot"] -= Disabling LVMS CSI provider and CSI snapshot += Disabling the LVMS CSI provider or CSI snapshot include::_attributes/attributes-microshift.adoc[] :context: microshift-disable-lvms-csi-provider-csi-snapshot diff --git a/microshift_configuring/microshift-using-config-tools.adoc b/microshift_configuring/microshift-using-config-tools.adoc index a719347e3e..6abac9c76c 100644 --- a/microshift_configuring/microshift-using-config-tools.adoc +++ b/microshift_configuring/microshift-using-config-tools.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="microshift-using-config-tools"] -= Using the {microshift-short} configuration file include::_attributes/attributes-microshift.adoc[] += Using the {microshift-short} configuration file :context: microshift-configuring toc::[] diff --git a/microshift_install_bootc/microshift-install-rhel-image-mode.adoc b/microshift_install_bootc/microshift-install-rhel-image-mode.adoc index e56ac9e3ae..d19d116aee 100644 --- a/microshift_install_bootc/microshift-install-rhel-image-mode.adoc +++ b/microshift_install_bootc/microshift-install-rhel-image-mode.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="microshift-install-rhel-image-mode"] -= Using image mode for RHEL with {microshift-short} include::_attributes/attributes-microshift.adoc[] += Using image mode for RHEL with {microshift-short} :context: microshift-install-rhel-image-mode toc::[] diff --git a/microshift_install_get_ready/microshift-fips.adoc b/microshift_install_get_ready/microshift-fips.adoc index 92342ef8d8..c0be6abb65 100644 --- a/microshift_install_get_ready/microshift-fips.adoc +++ b/microshift_install_get_ready/microshift-fips.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY +include::_attributes/attributes-microshift.adoc[] [id="microshift-fips"] = Using FIPS mode with {microshift-short} -include::_attributes/attributes-microshift.adoc[] :context: microshift-fips toc::[] diff --git a/microshift_install_get_ready/microshift-install-get-ready.adoc b/microshift_install_get_ready/microshift-install-get-ready.adoc index 6ceea1f8ac..bfc7eb0136 100644 --- a/microshift_install_get_ready/microshift-install-get-ready.adoc +++ b/microshift_install_get_ready/microshift-install-get-ready.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY +include::_attributes/attributes-microshift.adoc[] [id="microshift-install-get-ready"] = Getting ready to install {microshift-short} -include::_attributes/attributes-microshift.adoc[] :context: microshift-install-get-ready toc::[] @@ -10,7 +10,7 @@ Plan for your {microshift-short} installation and complete host configuration st include::modules/microshift-install-system-requirements.adoc[leveloffset=+1] -[id="embed-offline-rhde-compatibility-table"] +[id="get-ready-install-rhde-compatibility-table_{context}"] == 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: diff --git a/microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc b/microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc index 1521aacc33..c037663f55 100644 --- a/microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc +++ b/microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY +include::_attributes/attributes-microshift.adoc[] [id="microshift-embed-in-rpm-ostree-for-offline-use"] = Embedding in a {op-system-ostree} image for offline use -include::_attributes/attributes-microshift.adoc[] :context: microshift-embed-rpm-ostree-offline-use toc::[] 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 d79b20c99f..51103b7237 100644 --- a/microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc +++ b/microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY +include::_attributes/attributes-microshift.adoc[] [id="microshift-embed-in-rpm-ostree"] = Embedding in a {op-system-ostree} image using image builder -include::_attributes/attributes-microshift.adoc[] :context: microshift-embed-in-rpm-ostree toc::[] diff --git a/microshift_running_apps/microshift-authentication.adoc b/microshift_running_apps/microshift-authentication.adoc index 12434ac7a8..831e54764a 100644 --- a/microshift_running_apps/microshift-authentication.adoc +++ b/microshift_running_apps/microshift-authentication.adoc @@ -4,7 +4,7 @@ include::_attributes/attributes-microshift.adoc[] :context: authentication-microshift -== Understanding and managing pod security admission +toc::[] Pod security admission is an implementation of the link:https://kubernetes.io/docs/concepts/security/pod-security-standards/[Kubernetes pod security standards]. Use pod security admission to restrict the behavior of pods. diff --git a/microshift_running_apps/microshift-embedded-apps-on-rhel-edge.adoc b/microshift_running_apps/microshift-embedded-apps-on-rhel-edge.adoc index b981bedbbb..7696dd7edc 100644 --- a/microshift_running_apps/microshift-embedded-apps-on-rhel-edge.adoc +++ b/microshift_running_apps/microshift-embedded-apps-on-rhel-edge.adoc @@ -1,12 +1,12 @@ :_mod-docs-content-type: ASSEMBLY [id="microshift-embedded-apps-on-rhel-edge"] -= Options for embedding {microshift-short} applications in a RHEL for Edge image += Options for embedding applications in a RHEL for Edge image include::_attributes/attributes-microshift.adoc[] :context: microshift-embedded-apps-on-rhel-edge toc::[] -You can embed microservices-based workloads and applications in a {op-system-ostree-first} image to run in a {microshift-short} cluster. Embedded applications can be installed directly on edge devices to run in air-gapped, disconnected, or offline environments. +You can embed microservices-based workloads and applications in a {op-system-ostree-first} image to run in a {microshift-short} cluster. Embedded applications can be installed directly on edge devices to run in disconnected or offline environments. [id="microshift-add-app-RPMs-to-rpm-ostree-image_{context}"] == Adding application RPMs to an rpm-ostree image diff --git a/microshift_running_apps/microshift-embedding-apps-tutorial.adoc b/microshift_running_apps/microshift-embedding-apps-tutorial.adoc index 4bb779926c..0fd364bc9b 100644 --- a/microshift_running_apps/microshift-embedding-apps-tutorial.adoc +++ b/microshift_running_apps/microshift-embedding-apps-tutorial.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY +include::_attributes/attributes-microshift.adoc[] [id="microshift-embedding-apps-tutorial"] = Embedding {microshift-short} applications tutorial -include::_attributes/attributes-microshift.adoc[] :context: microshift-embedding-apps-tutorial toc::[] diff --git a/microshift_storage/microshift-storage-migration.adoc b/microshift_storage/microshift-storage-migration.adoc index 94ef80435f..bf0bad40df 100644 --- a/microshift_storage/microshift-storage-migration.adoc +++ b/microshift_storage/microshift-storage-migration.adoc @@ -1,11 +1,11 @@ :_mod-docs-content-type: ASSEMBLY [id="microshift-storage-migration"] -= Storage migration using the Kube Storage Version Migrator += Updating existing Kubernetes storage objects include::_attributes/attributes-microshift.adoc[] :context: microshift-storage-migration toc::[] -Storage version migration is used to update existing objects in the cluster from their current version to the latest version. The Kube Storage Version Migrator embedded controller is used in {microshift-short} to migrate resources without having to recreate those resources. Either you or a controller can create a `StorageVersionMigration` custom resource (CR) that will request a migration through the Migrator Controller. +Storage version migration is used to update existing objects in the cluster from their current version to the latest version. The Kube Storage Version Migrator embedded controller is used in {microshift-short} to migrate resources without having to recreate those resources. Either you or a controller can create a `StorageVersionMigration` custom resource (CR) that requests a migration through the Migrator Controller. include::modules/microshift-making-storage-migration-request.adoc[leveloffset=+1] diff --git a/microshift_troubleshooting/microshift-cleanup-data.adoc b/microshift_troubleshooting/microshift-cleanup-data.adoc index 21127c4d0c..de94aef932 100644 --- a/microshift_troubleshooting/microshift-cleanup-data.adoc +++ b/microshift_troubleshooting/microshift-cleanup-data.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="microshift-cleanup-data"] -= Data cleanup += Cleaning up data with support include::_attributes/attributes-microshift.adoc[] :context: microshift-cleanup-data @@ -14,7 +14,11 @@ Do not run this script without the guidance of product Support. Contact Support ==== include::modules/microshift-data-cleaning-overview.adoc[leveloffset=+1] + include::modules/microshift-data-cleaning-full-cleanup.adoc[leveloffset=+1] + include::modules/microshift-data-cleaning-container-images.adoc[leveloffset=+1] + include::modules/microshift-data-cleaning-ovn-data.adoc[leveloffset=+1] + include::modules/microshift-data-cleaning-certs.adoc[leveloffset=+1] diff --git a/microshift_updating/microshift-update-options.adoc b/microshift_updating/microshift-update-options.adoc index 00b862c374..1e20ae78a8 100644 --- a/microshift_updating/microshift-update-options.adoc +++ b/microshift_updating/microshift-update-options.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY +include::_attributes/attributes-microshift.adoc[] [id="microshift-update-options"] = Update options with {product-title} and {op-system-bundle} -include::_attributes/attributes-microshift.adoc[] :context: microshift-update-options toc::[] diff --git a/microshift_updating/microshift-update-rpms-manually.adoc b/microshift_updating/microshift-update-rpms-manually.adoc index ad8a41225b..257776e834 100644 --- a/microshift_updating/microshift-update-rpms-manually.adoc +++ b/microshift_updating/microshift-update-rpms-manually.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="microshift-update-rpms-manually"] -= About updating {product-title} RPMs manually += About updating RPMs manually include::_attributes/attributes-microshift.adoc[] :context: microshift-update-rpms-manually diff --git a/modules/microshift-making-storage-migration-request.adoc b/modules/microshift-making-storage-migration-request.adoc index a417ef7581..66b402f446 100644 --- a/modules/microshift-making-storage-migration-request.adoc +++ b/modules/microshift-making-storage-migration-request.adoc @@ -4,9 +4,9 @@ :_mod-docs-content-type: PROCEDURE [id="microshift-making-storage-migration-request_{context}"] -= Making a storage migration request += Updating stored data to the latest storage version -Storage migration is the process of updating stored data to the latest storage version, for example from `v1beta1` to `v1beta2`. To update your storage version, use the following procedure. +Updating stored data to the latest Kubernetes storage version is called storage migration. For example, updating from `v1beta1` to `v1beta2` is migration. To update your storage version, use the following procedure. .Procedure diff --git a/snippets/microshift-rhde-compatibility-table-snip.adoc b/snippets/microshift-rhde-compatibility-table-snip.adoc index 5b29412c17..8d69bbcd3c 100644 --- a/snippets/microshift-rhde-compatibility-table-snip.adoc +++ b/snippets/microshift-rhde-compatibility-table-snip.adoc @@ -11,7 +11,7 @@ [cols="4",cols="~,~,~,20h"] |=== -^|*{op-system} Version(s)* +^|*{op-system-base} Version(s)* ^|*{microshift-short} Version* ^|*{microshift-short} Release Status* ^|*Supported {microshift-short} Version{nbsp}→{nbsp}Version Updates* diff --git a/snippets/microshift-update-paths-snip.adoc b/snippets/microshift-update-paths-snip.adoc index 63e608abda..a7fcda80ea 100644 --- a/snippets/microshift-update-paths-snip.adoc +++ b/snippets/microshift-update-paths-snip.adoc @@ -8,22 +8,22 @@ [id="microshift-about-updates-checking-version-update-path_{context}"] = Checking the {microshift-short} version update path -Before updating {microshift-short} or {op-system}, determine the compatibilities. Plan for the versions of each that you intend to use. +Before updating {microshift-short} or {op-system-base}, determine the compatibilities. Plan for the versions of each that you intend to use. *{product-title} update paths* {microshift-short} version 4.17:: -* Version 4.17{nbsp}→{nbsp}4.17.z on {op-system} 9.4 +* Version 4.17{nbsp}→{nbsp}4.17.z on {op-system-base} 9.4 {microshift-short} version 4.16:: -* Version 4.16{nbsp}→{nbsp}4.17 on {op-system} 9.4 -* Version 4.16{nbsp}→{nbsp}4.16.z on {op-system} 9.4 +* Version 4.16{nbsp}→{nbsp}4.17 on {op-system-base} 9.4 +* Version 4.16{nbsp}→{nbsp}4.16.z on {op-system-base} 9.4 {microshift-short} version 4.15:: -* Version 4.15 on {op-system} 9.2 or 9.3{nbsp}→{nbsp}4.16 on {op-system} 9.4 -* Version 4.15{nbsp}→{nbsp}4.15.z on {op-system} 9.2 or 9.3 +* Version 4.15 on {op-system-base} 9.2 or 9.3{nbsp}→{nbsp}4.16 on {op-system-base} 9.4 +* Version 4.15{nbsp}→{nbsp}4.15.z on {op-system-base} 9.2 or 9.3 {microshift-short} version 4.14:: -* Version 4.14 on {op-system} 9.2 or 9.3{nbsp}→{nbsp}4.16 on {op-system} 9.4 -* Version 4.14{nbsp}→{nbsp}4.15 on {op-system} 9.2 or 9.3 -* Version 4.14{nbsp}→{nbsp}4.14.z on {op-system} 9.2 or 9.3 \ No newline at end of file +* Version 4.14 on {op-system-base} 9.2 or 9.3{nbsp}→{nbsp}4.16 on {op-system-base} 9.4 +* Version 4.14{nbsp}→{nbsp}4.15 on {op-system-base} 9.2 or 9.3 +* Version 4.14{nbsp}→{nbsp}4.14.z on {op-system-base} 9.2 or 9.3 \ No newline at end of file