Skip to main content

Tool to explore must-gather data

Project description

Must-gather explorer

Explore the collected must-gather data

Prerequisite

Install uv

Installation

uv tool install must-gather-explorer

After successful installation, these CLI tools will be available:

  • must-gather-explorer
  • must-gather-explorer-update-aliases

How to use

  • Run the command:

To run with debug logs pass -v/--verbose flag.

must-gather-explorer --path=<path-to-must-gather-folder>

Once you executed the command, you will enter the must-gather-explorer shell Enter the command:, where you can prompt these commands:

  • Get the resources:
get <resource_kind:mandatory> <-n namespace_name:optional> <resource_name_starts_with:optional>
  • Example:
get Node # To get all Nodes
get PersistentVolumeClaim hpp # To get all PVCs when name starts from 'hpp'
get pvc -n openshift-storage hpp # To get all PVCs in 'openshift-storage' namespace when name starts from 'hpp'
  • To print the resource YAML, add -oyaml to the get command, for example:
get pvc hpp -oyaml # To print yamls of all PVCs when name starts from 'hpp'
get pvc -n openshift-storage hpp -oyaml # To print yamls of all PVCs in 'openshift-storage' namespace when name starts from 'hpp'
  • Help:
help
  • Exit:
exit

Update cluster resources aliases

  • Need to be logged-in to the OpenShift cluster or have exported KUBECONFIG
  • Run the command:
must-gather-explorer-update-aliases

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

must_gather_explorer-0.1.5.tar.gz (37.8 kB view details)

Uploaded Source

File details

Details for the file must_gather_explorer-0.1.5.tar.gz.

File metadata

  • Download URL: must_gather_explorer-0.1.5.tar.gz
  • Upload date:
  • Size: 37.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.0

File hashes

Hashes for must_gather_explorer-0.1.5.tar.gz
Algorithm Hash digest
SHA256 36773618768ce9a5e2b921bc483a3d7d1ee4a1817b8ff75f3274b560c0ee1248
MD5 547e7a8141b4cccf7b0381e794a3737a
BLAKE2b-256 91644f1d870942c46309d197474decc455c6a0caad696ee83a3865b28a26c7f5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page