From d9c43ded46d70848686d4b33f744b2504be693d3 Mon Sep 17 00:00:00 2001 From: subhtk Date: Tue, 24 Sep 2024 12:41:14 +0530 Subject: [PATCH] Added troubleshooting section in oc-mirror v2 docs --- .../about-installing-oc-mirror-v2.adoc | 4 +++ .../moudles/oc-mirror-about-ts-v2.adoc | 27 +++++++++++++++++++ modules/oc-mirror-troubleshooting-v2.adoc | 27 +++++++++++++++++++ 3 files changed, 58 insertions(+) create mode 100644 installing/disconnected_install/moudles/oc-mirror-about-ts-v2.adoc create mode 100644 modules/oc-mirror-troubleshooting-v2.adoc diff --git a/installing/disconnected_install/about-installing-oc-mirror-v2.adoc b/installing/disconnected_install/about-installing-oc-mirror-v2.adoc index e47616824d3f..2a046aa5af14 100644 --- a/installing/disconnected_install/about-installing-oc-mirror-v2.adoc +++ b/installing/disconnected_install/about-installing-oc-mirror-v2.adoc @@ -76,6 +76,10 @@ include::modules/oc-mirror-workflows-fully-disconnected-v2.adoc[leveloffset=+2] include::modules/oc-mirror-mirror-to-disk-v2.adoc[leveloffset=+2] include::modules/oc-mirror-disk-to-mirror-v2.adoc[leveloffset=+2] +// Troubleshooting errors +include::moudles/oc-mirror-about-ts-v2.adoc[levleoffset=+2] +include::modules/oc-mirror-troubleshooting-v2.adoc[leveloffset=+2] + [id="additional-resources"] == Additional resources diff --git a/installing/disconnected_install/moudles/oc-mirror-about-ts-v2.adoc b/installing/disconnected_install/moudles/oc-mirror-about-ts-v2.adoc new file mode 100644 index 000000000000..c172fb28a5d6 --- /dev/null +++ b/installing/disconnected_install/moudles/oc-mirror-about-ts-v2.adoc @@ -0,0 +1,27 @@ +// Module included in the following assemblies: +// +// * installing/disconnected_install/installing-mirroring-disconnected-v2.adoc + +:_mod-docs-content-type: CONCEPT +[id="oc-mirror-about-ts-v2_{context}"] += Troubleshooting oc-mirror plugin v2 issues + +In oc-mirror plugin v2, there are specific behaviors to handle errors during the mirroring process, especially when issues arise with operator images, additional images, or release images. Understanding how the tool behaves in these scenarios can help users troubleshoot and resolve issues more effectively. + +*Key Behaviors of oc-mirror plugin v2*: + +* Mirroring Continuation: + +When errors occur while mirroring operator or additional images, oc-mirror plugin v2 continues to mirror other images instead of halting the entire process. However, if there are errors during the mirroring of release images, the process is aborted. + +* Cluster Resource Generation: + +oc-mirror plugin v2 generates cluster resources (such as IDMS and ITMS files) based on the subset of images that were successfully mirrored. Even when some images fail, the necessary resources for the correctly mirrored images are created. + +* Error Logging: + +All mirroring errors are logged in a separate log file for review. This log file provides detailed information about the errors encountered during the process. + +* Operator Package Association: + +When possible, oc-mirror v2 associates the image mirroring errors with the operator package that failed as a consequence. This helps users identify which operators are incomplete due to missing or failed images. \ No newline at end of file diff --git a/modules/oc-mirror-troubleshooting-v2.adoc b/modules/oc-mirror-troubleshooting-v2.adoc new file mode 100644 index 000000000000..02ac355b12a3 --- /dev/null +++ b/modules/oc-mirror-troubleshooting-v2.adoc @@ -0,0 +1,27 @@ +// Module included in the following assemblies: +// +// * installing/disconnected_install/installing-mirroring-disconnected-v2.adoc + +:_mod-docs-content-type: PROCEDURE +[id="oc-mirror-troubleshooting-v2_{context}"] +== Troubleshooting the oc-mirror plugin v2 errors + +oc-mirror plugin v2 now logs all image mirroring errors in a separate file, making it easier to track and diagnose failures. + +Additionally, when an image fails to mirror, oc-mirror plugin v2 informs the user which operator is incomplete as a result. This provides greater clarity and helps identify which operator bundles are affected by the mirroring errors. + +.Procedure + +. *Check the log files*: + +Review the separate log file for detailed error messages related to image mirroring. This file will contain specific errors encountered during the process. + +. *Identify incomplete operators*: + +If the mirroring process fails for some images, look for warnings in the console or logs that indicate which operator is incomplete due to the failure. + +. *Review the cluster resources*: + +Even if some images fail to mirror, oc-mirror plugin v2 should generate cluster resources for the images that were successfully mirrored. Ensure the necessary resources (such as IDMS and ITMS files) are in place for the correctly mirrored images. + +By following these steps and understanding how oc-mirror plugin v2 handles errors, users can better diagnose issues and ensure smoother mirroring operations. \ No newline at end of file