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 -k <resource_kind:mandatory> -n <namespace_name:optional> --name <resource_name_starts_with:optional>
  • Example:
get -k Node # To get all Nodes
get -k PersistentVolumeClaim --name hpp # To get all PVCs when name starts from 'hpp'
get -k pvc -n openshift-storage --name 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 -k pvc --name hpp -oyaml # To print yamls of all PVCs when name starts from 'hpp'
get -k pvc -n openshift-storage --name hpp -oyaml # To print yamls of all PVCs in 'openshift-storage' namespace when name starts from 'hpp'
  • Help:
help
help get
  • 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.7.tar.gz (40.2 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for must_gather_explorer-0.1.7.tar.gz
Algorithm Hash digest
SHA256 2b052ea6b63db4a18fa572ed91dcbc38858161b4763f4aefbe7ebbfd7c1dd479
MD5 39db3b11b4bbe8fecc2617ec65b75bcf
BLAKE2b-256 be67491b86658085262a29b0ca2613828090f86a97f1fe422d76f863c1b5c8ab

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