From 8c2e1b68148488dc3a650038dc356af912b64f6a Mon Sep 17 00:00:00 2001 From: bjahagir-OpenShift Date: Thu, 2 Jul 2026 14:41:07 +0530 Subject: [PATCH] For OSDOCS-17136 CQA Remediation --- .../microshift-cleanup-data.adoc | 8 +++++++- .../microshift-installing-troubleshooting.adoc | 3 ++- .../microshift-responsive-restarts-cas.adoc | 2 +- .../microshift-troubleshoot-updates.adoc | 5 +---- modules/microshift-updates-troubleshooting.adoc | 16 ++++++---------- 5 files changed, 17 insertions(+), 17 deletions(-) diff --git a/microshift_troubleshooting/microshift-cleanup-data.adoc b/microshift_troubleshooting/microshift-cleanup-data.adoc index 4c3a4a5c1650..6c57d834a000 100644 --- a/microshift_troubleshooting/microshift-cleanup-data.adoc +++ b/microshift_troubleshooting/microshift-cleanup-data.adoc @@ -11,7 +11,7 @@ You can use the `microshift-cleanup-data` script for troubleshooting tasks such [WARNING] ==== -Do not run this script without the guidance of product Support. Contact Support by xref:../microshift_support/microshift-getting-support.adoc#microshift-support-submitting-a-case_getting-support[Submitting a support case]. +Do not run this script without the guidance of product Support. You must first open a Support case. ==== include::modules/microshift-data-cleaning-overview.adoc[leveloffset=+1] @@ -23,3 +23,9 @@ 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] + +[role="_additional-resources"] +[id="additional-resources_microshift-cleanup-data"] +== Additional resources + +* xref:../microshift_support/microshift-getting-support.adoc#microshift-support-submitting-a-case_getting-support[Submitting a support case] diff --git a/microshift_troubleshooting/microshift-installing-troubleshooting.adoc b/microshift_troubleshooting/microshift-installing-troubleshooting.adoc index af46bb134b16..416f97be79da 100644 --- a/microshift_troubleshooting/microshift-installing-troubleshooting.adoc +++ b/microshift_troubleshooting/microshift-installing-troubleshooting.adoc @@ -11,9 +11,10 @@ To troubleshoot a failed {microshift-short} installation, you can run an `sosrep include::modules/microshift-gathering-sos-report.adoc[leveloffset=+1] -[id="additional-resources_microshift-installing-troubleshooting"] [role="_additional-resources"] +[id="additional-resources_microshift-installing-troubleshooting"] == Additional resources + * xref:../microshift_support/microshift-sos-report.adoc#microshift-sos-report[About {microshift-short} sos reports] * link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/getting_the_most_from_your_support_experience/generating-an-sos-report-for-technical-support_getting-the-most-from-your-support-experience[Generating an sos report for technical support] diff --git a/microshift_troubleshooting/microshift-responsive-restarts-cas.adoc b/microshift_troubleshooting/microshift-responsive-restarts-cas.adoc index 0d5f48c0d5c2..420918fe870e 100644 --- a/microshift_troubleshooting/microshift-responsive-restarts-cas.adoc +++ b/microshift_troubleshooting/microshift-responsive-restarts-cas.adoc @@ -19,8 +19,8 @@ include::modules/microshift-short-term-certificate-rotation.adoc[leveloffset=+2] include::modules/microshift-long-term-certificate-rotation.adoc[leveloffset=+2] -[id="additional-resources_microshift-responsive-restarts-cas"] [role="_additional-resources"] +[id="additional-resources_microshift-responsive-restarts-cas"] == Additional resources * xref:../microshift_configuring/microshift_auth_security/microshift-custom-ca.adoc#microshift-custom-ca[Configuring custom certificate authorities] diff --git a/microshift_troubleshooting/microshift-troubleshoot-updates.adoc b/microshift_troubleshooting/microshift-troubleshoot-updates.adoc index 7e887fb133b9..c2b87e6446fd 100644 --- a/microshift_troubleshooting/microshift-troubleshoot-updates.adoc +++ b/microshift_troubleshooting/microshift-troubleshoot-updates.adoc @@ -1,6 +1,3 @@ -// This assembly is included in the following assemblies: -// -// * microshift_troubleshooting/microshift-troubleshoot-updates.adoc :_mod-docs-content-type: ASSEMBLY [id="microshift-troubleshoot-updates"] = Troubleshooting updates @@ -23,8 +20,8 @@ include::modules/microshift-check-journal-logs-updates.adoc[leveloffset=+1] include::modules/microshift-greenboot-check-status.adoc[leveloffset=+1] -[id="additional-resources_microshift-troubleshoot-updates"] [role="_additional-resources"] +[id="additional-resources_microshift-troubleshoot-updates"] == 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] diff --git a/modules/microshift-updates-troubleshooting.adoc b/modules/microshift-updates-troubleshooting.adoc index 41b0322c76c6..a1488207b601 100644 --- a/modules/microshift-updates-troubleshooting.adoc +++ b/modules/microshift-updates-troubleshooting.adoc @@ -1,24 +1,21 @@ //Module included in the following assemblies: // -//* microshift_troubleshooting/microshift-updates-troubleshooting.adoc +//* microshift_troubleshooting/microshift-troubleshoot-updates.adoc -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE [id="microshift-troubleshooting-updates_{context}"] = Troubleshooting {microshift-short} updates [role="_abstract"] In some cases, {microshift-short} might fail to update. In these events, it is helpful to understand failure types and how to troubleshoot them. -[id="microshift-update-path-blocked-by-version-sequence_{context}"] -== Update path is blocked by {microshift-short} version sequence +Update path is blocked by {microshift-short} version sequence:: Non-EUS versions of {microshift-short} require serial updates. For example, if you attempt to update from {microshift-short} `4.15.5` directly to `4.17.1`, the update fails. You must first update `4.15.5` to `4.16.z`, and then you can update from `4.16.z` to `4.17.0`. -[id="microshift-update-path-blocked-by-version-incompatibility_{context}"] -== Update path is blocked by version incompatibility +Update path is blocked by version incompatibility:: RPM dependency errors result if a {microshift-short} update is incompatible with the version of {op-system-ostree-first} or {op-system-base-full}. For more information, see "{op-system-bundle} release compatibility matrix". -[id="microshift-ostree-update-failed_{context}"] -== {op-system-ostree} update failed +{op-system-ostree} update failed:: If you updated on an `rpm-ostree` system, the greenboot health check automatically logs and acts on system health. A system rollback by greenboot can indicate an update failure. In cases where the update failed, but greenboot did not complete a system rollback, you can troubleshoot using the {op-system-ostree} documentation linked in the "Additional resources" section. * Manually check the greenboot logs to verify system health by running the following command: @@ -28,6 +25,5 @@ If you updated on an `rpm-ostree` system, the greenboot health check automatical $ sudo systemctl restart --no-block greenboot-healthcheck && sudo journalctl -fu greenboot-healthcheck ---- -[id="microshift-rpm-update-failed_{context}"] -== Manual RPM update failed +Manual RPM update failed:: If you updated by using RPMs on a non-OSTree system, greenboot can indicate an update failure, but the health checks are only informative. Checking the system logs is the next step in troubleshooting a manual RPM update failure. You can use greenboot and the `sos report` tool to check both the {microshift-short} update and the host system.