Skip to content

Commit

Permalink
CASMINST-6765 troubleshooting section refactored (#5315)
Browse files Browse the repository at this point in the history
  • Loading branch information
Pankhuri-Rajesh authored Aug 23, 2024
1 parent cd70df7 commit 1649e16
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion operations/iuf/IUF.md
Original file line number Diff line number Diff line change
Expand Up @@ -808,12 +808,17 @@ The administrator can then execute any remaining stages that did not complete du

The following actions may be useful if errors are encountered when executing `iuf`.

### 1. CLI

- Examine IUF log files as described in the [Output and log files](#output-and-log-files) section for information not provided on `iuf` standard output.

### 2. Argo UI

- Use the [Argo UI](../argo/Using_the_Argo_UI.md) to find the Argo pod that corresponds to the failed IUF operation. This can be done by finding the Argo workflow identifier displayed on [`iuf` standard output](#iuf-output) for the failed
IUF operation and performing an Argo UI query with that value. Argo workflow identifiers can also be found by running [`iuf activity`](#activities). The Argo UI will provide additional log information that may help debug the issue.
- There are two methods for limiting the list of Argo workflows displayed by the Argo UI.
1. Display a single workflow of an activity by specifying the Argo workflow identifier, e.g. `admin-230126-ebjx3-process-media-cq89t`, after the Argo UI "magnifying glass" icon.
1. Display all workflows for an IUF activity by specifying the activity identifier, e.g. `activity=admin-230126`, in the Argo UI `LABELS` filter.
2. Display all workflows for an IUF activity by specifying the activity identifier, e.g. `activity=admin-230126`, in the Argo UI `LABELS` filter.
- If an error is associated with a script invoked by a product's [stage hook](#stages-and-hooks), the script can be found in the expanded product distribution file located in the media directory (`iuf -m MEDIA_DIR`). Examine the
`hooks` entry in the product's `iuf-product-manifest.yaml` file in the media directory for the path to the script.
- If Argo UI log output is too verbose, filter it by specifying a value such as `^INFO|^NOTICE|^WARNING|^ERROR` in the `Filter (regexp)...` text field.
Expand All @@ -824,6 +829,15 @@ The following actions may be useful if errors are encountered when executing `iu
- If an Argo step fails, Argo will attempt to re-execute the step. If the retry succeeds, the failed step will still be displayed, colored red, in the Argo UI alongside the successful retry step, colored green. Although the failed
step is still displayed, it did not affect the success of the overall workflow and can be ignored.

### 3. Log Files

- Examine IUF log files as described in the [Output and log files](#output-and-log-files) section for information not provided on `iuf` standard output.
- If an error is associated with a script invoked by a product's [stage hook](#stages-and-hooks), the script can be found in the expanded product distribution file located in the media directory (`iuf -m MEDIA_DIR`). Examine the
`hooks` entry in the product's `iuf-product-manifest.yaml` file in the media directory for the path to the script.
- If the source of the error cannot be determined by the previous methods, details on the underlying commands executed by an IUF stage can be found in the IUF `workflows` directory. The [Stages and hooks](#stages-and-hooks) section
of this document includes links to descriptions of each stage. Each of those descriptions includes an **Execution Details** section describing how to find the appropriate code in the IUF `workflows` directory to understand the
workflow and debug the issue.

## Install and Upgrade Observability Framework

The Install and Upgrade Observability Framework includes assertions for Goss health checks, as well as metrics and dashboards for health checks.
Expand Down

0 comments on commit 1649e16

Please sign in to comment.