KubeNodeUsage

KubeNodeUsage is a tool designed to provide insights into Kubernetes node usage. It offers various options for customization to help you analyze and filter node metrics effectively.

KubeNodeUsage use your local KubeConfig file to connect to the cluster and use Kubernetes API directly using Kubernetes GO SDK

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.

It has lot of capabilities to filter the output based on

• NodeName
• Usage
• Free/Availability of Disk,CPU, Memory
• Max/Capacity of Disk,CPU,Memory
• Color - We use Green, Red and Orange to represent the usage
  • Green - Below 30% Usage
  • Orange - Between 30% to 70% Usage
  • Red - Above 70% Usage

:sparkle: Screenshot of Latest Version 3.0.1 with Cluster Info

Kubernetes Supported Versions / Clusters :white_check_mark:

As KubeNodeUsage use the Kubernetes Go SDK and directly connects to the API - It supports all the Kubernetes cluster which supports .kube/config file based authentication

Clusters

I have tested it with the following K8s clusters

• EKS - Elastic Kubernetes Service from AWS
• Azure Kubernetes Service
• GKE - Google Kubernetes Engine
• Minikube
• Kind Cluster

Versions

I have tested KubeNodeUsage starting from 1.19 - 1.28 ( the latest stable version as of Dec2023)

How it Works :bulb:

KubeNodeUsage is written in GoLang and uses client-go and kubernetes SDK libraries

When you start KubeNodeUsage - It try to read the $HOME/.kube/config file in your HOME directory

KubeNodeUsage connects to the Default cluster set by the CurrentContext on the ./kube/config file

You can manually edit this file and update it but the recommended way to update current-context is to use kubectl config use-context

KubeNodeUsage does not use kubectl directly and it relies on the .kube/config file and the authentication method defined in there

KubeNodeUsage works the same way - kubectl works based on the configuration information found on .kube/config file

If the kubectlcommands are not working - its highly likely KubeNodeUsage would fail too - In this case you have to check your Kube config file

Is it secure ? How about Data Privacy :lock:

KubeNodeUsage do not collect any data or send anywhere

KubeNodeUsage Source code is Public, Feel free to download and validate it yourself  

How to Download :arrow_double_down:

You can clone this project and run it as shown below

git clone https://github.com/AKSarav/Kube-Node-Usage.git
cd Kube-Node-Usage
go run main.go

Or Download the Binaries from the Github release page

Goto the https://github.com/AKSarav/Kube-Node-Usage/releases and download the suitable binary for your OS and use it

unzip KubeNodeUsage-windows-386.exe.zip
./KubeNodeUsage-windows-386

How to use :book:

KubeNodeUsage is a command line utility with lot of startup options/flags

KubeNodeUsage [options]

You can find the detail information on all available options here

  Available Options :memo:

• help: Display help information.

• metrics: Choose which metric to display. Valid options include:

  • memory
  • disk
  • cpu

• filternodes: Filter nodes based on node name using a regular expression. (Note: Only one filter can be used at a time, and the input should be enclosed in quotes.)

• filtercolor: Filter nodes based on color categories. Valid options include:

  • red
  • green
  • orange

• desc: Enable reverse sort order.

• debug: Enable debug mode. ( Prints more logging for debug)

• sortby: Sort the output by a specific metric. Valid options include:

  • name (Sort by node name alphabetically)

  • node (Sort by node name alphabetically, same as 'name')

  • free (Sort by available resources)

  • usage (Sort by resource usage)

  • color (Sort by color category, same as usage)

  • capacity (Sort by resource capacity)

  • max (Sort by maximum resource value, same as 'capacity')

Examples:

# Display help information
KubeNodeUsage --help

# Display node usage with default settings (memory is the default metric)
KubeNodeUsage

# Display node usage sorted by node name
KubeNodeUsage --sortby=name

# Display node usage sorted by free resources in descending order
KubeNodeUsage --sortby=free --desc

# Display node usage sorted by usage in ascending order
KubeNodeUsage --sortby=usage

# Display node usage sorted by capacity in descending order
KubeNodeUsage --sortby=capacity --desc

# Filter nodes with a name starting with "web"
KubeNodeUsage --filternodes="web.*"

# Filter nodes with color category "green"
KubeNodeUsage --filtercolor=green

# Display memory usage for all nodes
KubeNodeUsage --metrics=memory

# Display disk usage for nodes with a name containing "data"
KubeNodeUsage --metrics=disk --filternodes=".*data.*"

# Show CPU usage for nodes with color category "red" in descending order
KubeNodeUsage --metrics=cpu --filtercolor=red --desc

# Display node usage sorted by maximum resource value in ascending order
KubeNodeUsage --sortby=max

# Display node usage sorted by capacity, show memory usage, and filter nodes with a name starting with "prod"
KubeNodeUsage --sortby=capacity --metrics=memory --filternodes="prod.*"

# Show CPU usage for nodes with color category "orange" and filter nodes with a name containing "IP range"
KubeNodeUsage --metrics=cpu --filtercolor=orange --filternodes=".*172-31.*"

# Display node usage sorted by name, filter nodes with a name starting with "app", and enable debug mode
KubeNodeUsage --sortby=name --filternodes="app.*" --debug

Todo

• FilterLabels Filter by Label feature to be added
• Pod Usage stats to be added as a feature

Contributions / Feature Requests are welcome :handshake:

Feel free to send your Pull requests and Issues to make this better.

Please share and Leave a Github Star :star: :star: :star: :star: if you like KubeNodeUsage - It would motivate me