Skip to content

Commit

Permalink
Merge pull request #22 from AKSarav/AKSarav-patch-2
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
AKSarav authored Jun 30, 2024
2 parents 0cd51b8 + fc78bea commit 10b6962
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,15 @@ KubeNodeUsage use your local KubeConfig file to connect to the cluster and use K

It fetches the Node Metrics from Kubernetes API and apply filters and aggreations to display it in a nice human readable Graphical format as Bar Charts.

KubeNodeUsage helps you to monitor the **CPU**, **Memory** and **Disk** usage of the Nodes in your Kubernetes Cluster

The output can be sorted, filtered, and customized based on your requirements


## Features in NutShell

KubeNodeUsage has different filters to filter the output based on
KubeNodeUsage helps you to monitor the **CPU**, **Memory** and **Disk** usage of the Nodes in your Kubernetes Cluster

The output can be **sorted**, **filtered**, and **customized** based on your requirements

KubeNodeUsage has different filters to format the output based on the following properties

* NodeName
* Usage
Expand All @@ -46,6 +47,12 @@ You can sort the output using following flags
- `sortby` - This is used to sort the output based on the specific metric ( name, free, usage, color, capacity, max)
- `desc` - This is used to sort the output in descending order

By Default KubeNodeUsage prints the Cluster info you can disable it with `--noinfo` flag

If you want to display a specific label as an output - you can use `--label` option with your desired output alias.

We have example commands and screenshots to help you. Feel free to reach out for any help.

 

**Additional Key Features include**
Expand Down

0 comments on commit 10b6962

Please sign in to comment.