Metadata-Version: 2.1
Name: okd-camgi
Version: 0.5.0
Summary: OKD Cluster Autoscaler Must Gather Investigator
Home-page: https://github.com/elmiko/okd-camgi
Author: michael mccune
Author-email: msm@opbstudios.com
License: GPLv3
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE

# OKD Cluster Autoscaler Must Gather Investigator

[![Docker Repository on Quay](https://quay.io/repository/elmiko/okd-camgi/status "Docker Repository on Quay")](https://quay.io/repository/elmiko/okd-camgi)

A tool for examining [OKD/OpenShift must-gather](https://github.com/openshift/must-gather) records
to investigate cluster autoscaler behavior and configuration.

## Quickstart

1. install from [PyPi](https://pypi.org/project/okd-camgi) with `pip3 install okd-camgi --user`
1. Have a must-gather ready to go in `$MUST_GATHER_PATH`
1. Run `okd-camgi --webbrowser $MUST_GATHER_PATH`

Your web browser should now show a page with a summary of the must-gather and some interactive navigation
buttons. If your browser does not open, you will see the URL printed on the terminal, copy it into a new
browser tab or window.

## Containerized Server

An alternative to running the command line tool is to start a local containerized webserver which
hosts the must-gather investigation page. Follow these steps to start a local server:

1. `podman run --rm -it -p 8080:8080 -v /path/to/must-gather:/must-gather:Z quay.io/elmiko/okd-camgi`
1. Open you web browser to `http://localhost:8080`

As in the Quickstart, your web browser should now show the must-gather investigation page.


