Skip to content
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

CLID 207: Added trobleshooting section in oc-mirror plugin v2 assembly #82315

Closed
wants to merge 1 commit into from
Closed
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
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,9 @@ 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:


[id="additional-resources"]
== Additional resources

Expand All @@ -97,6 +100,8 @@ include::modules/oc-mirror-procedure-delete-v2.adoc[leveloffset=+2]
// About dry-run
include::modules/oc-mirror-v2-about-dry-run.adoc[leveloffset=+1]

include::modules/oc-mirror-troubleshooting-v2.adoc[leveloffset=+1]

// Performing Dry-run for V2
include::modules/oc-mirror-dry-run-v2.adoc[leveloffset=+2]

Expand Down
47 changes: 47 additions & 0 deletions modules/oc-mirror-troubleshooting-v2.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
// 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 oc-mirror v2 Image Mirroring 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

. Rectifying server related issues

.Example error
[source,terminal]
----
[ERROR] Failed to mirror image: operator-registry.redhat.io/operator:v1.2.3
Reason: HTTP 500 - Internal Server Error
----

.. Open the errors.log file located in the oc-mirror output directory.
.. Look for error messages like the one above, which typically indicate server-side issues (e.g., HTTP 500 errors, expired tokens, or timeouts).
.. Retry the mirroring process or contact support if the issue persists.

. Errors related incomplete operators:

.Example error
[source,terminal]
----
----

.. Check for warnings in the console or log file indicating which operators are incomplete.
.. If an operator is flagged as incomplete, the image related to that operator likely failed to mirror.
.. You might need to manually mirror the missing image or retry the mirroring process.


. Errors related to generated cluster resources:

.. Even if some images fail to mirror, oc-mirror v2 will still generate cluster resources (IDMS.yaml and ITMS.yaml) for the successfully mirrored images.
.. Check the output directory for the generated files.
.. If these files are missing for specific images, ensure that no critical errors occurred for those images during the mirroring process.

By following these steps, users can better diagnose issues and ensure smoother mirroring operations.