Skip to content

Command Line Tool for generating report about configured resources requests and limits of Kubernetes PODs

License

Notifications You must be signed in to change notification settings

matteogazzadi/kuberes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

kuberes: Kubernetes Resources Analysis Tool

Latest GitHub release Build

This repository provides kuberes tool.

What is kuberes?

kuberes is a tool to summarize the configured resources requests and limits for Kubernetes PODs in a given cluster.

It allows to produce reports in the following formats:

  • table: directly on screen formated as a table
  • csv: in a .CSV file, comma separated
  • xlsx: in a .XLSX file

Here is a demo of kuberes: kuberes demo

Arguments

kuberes accepts multiple arguments to define output format or filtering.

Arguments can be passed using - or --.

Argument Type Default Description
output String table Output type. Valid values are: table,csv,xlsx
group-by-ns Bool true Should group statistics by namespace ?
file-path String "" Full Path to the .CSV/.XLSX File to produce
exclude-ns String "" Namespaces names to be ignored, comma separated
match-ns-regex String "" Namespaces Names to be matched on the given RegEx

Examples

# List Resources grouped by Namespace in table format
.\kuberes

# List Resources by POD in table format
.\kuberes --group-by-ns=false

# List Resource grouped by Namespace and save in a .CSV file
.\kuberes --output=csv --file-path="output.csv"

# List Resource grouped by Namespace and save in a .XLSX file
.\kuberes --output=xlsx --file-path="output.xlsx"

# List Resources grouped by Namespace in table format, exclude namespaces: default and kube-system
.\kuberes --exclude-ns="default,kube-system"

# List Resources grouped by Namespace in table format, include namespace containing word "test" only
.\kuberes --match-ns-regex="^.*test.*$"

About

Command Line Tool for generating report about configured resources requests and limits of Kubernetes PODs

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages