KDash - A fast and simple dashboard for Kubernetes

Note: Feedback, feature requests and contributions are welcome

rust _ __ ___ _ | |/ /| \ __ _ ___| |_ | ' < | |) |/ _` |(_-<| ' \ |_|\_\|___/ \__,_|/__/|_||_|

A simple terminal dashboard for Kubernetes built with Rust

Installation

Homebrew (Mac & Linux)

```bash brew tap kdash-rs/kdash brew install kdash

If you need to be more specific, use:

brew install kdash-rs/kdash/kdash ```

To upgrade

bash brew upgrade kdash

Chocolatey (Windows)

Choco package located here. Since validation of the package takes time, it may take a while to become available after a release.

```bash choco install kdash

Version number may be required for newer releases, if available:

choco install kdash --version=0.1.0 ```

To upgrade

bash choco upgrade kdash --version=0.1.0

Install script

TODO

Manual

Binaries for macOS, Linux and Windows are available on the releases page

1. Download the latest binary for your OS.
2. For Linux/macOS:
   1. cd to the file you just downloaded and run tar -C /usr/local/bin -xzf downloaded-file-name. Use sudo if required.
   2. Run with kdash
3. For Windows:
   1. Use 7-Zip or TarTool to unpack the tar file.
   2. Run the executable file kdash.exe

Docker

Run KDash as a Docker container by mounting your KUBECONFIG. For example the below for default path

bash docker run --rm -it -v ~/.kube/config:/root/.kube/config deepu105/kdash

You can also clone this repo and run make docker to build a docker image locally and run it using above command

Note: This may not work properly if you run Kubernetes locally using Minikube or Kind

Cargo

If you have Cargo installed then you install KDash from crates.io

bash cargo install kdash

You can also clone the repo and run cargo run or make to build and run the app

Note:: On Linux you might need to have package xorg-dev (Debian/Ubuntu) or xorg-x11-server-devel (Fedora) or equivalent installed for the copy to clipboard features to work

USAGE:

bash kdash

Press ? while running the app to see keybindings

FLAGS:

• -h, --help: Prints help information
• -V, --version: Prints version information
• -t, --tick-rate <tick-rate>: Set the tick rate (milliseconds): the lower the number the higher the FPS.
• -p, --poll-rate <poll-rate>: Set the network call polling rate (milliseconds, should be multiples of tick-rate): the lower the number the higher the network calls.

Limitations/Known issues

• [Windows] KDash looks better on CMD since Powershell's default theme makes the colours look weird.
• [Windows] If using k3d for local clusters, set the server URL to 127.0.0.1 as 0.0.0.0 doesn't work with kube-rs. You can use k3d cluster create --api-port 127.0.0.1:6550 or change the cluster.server value in your .kube/config for the k3d cluster to 127.0.0.1:<port>

Features & Todos

• CLI Info
• Resource Watch (configurable polling interval with -p flag)
  • [x] Pods
  • [x] Nodes
  • [x] Namespace
  • [x] Services
  • [x] Containers
  • [x] ConfigMaps
  • [x] StatefulSets
  • [x] ReplicaSets
  • [x] Deployments
• Describe/YAML resources
  • [x] select/copy output
  • [x] Pods
  • [x] Nodes
  • [x] Services
  • [x] Deployments
  • [x] ConfigMaps
  • [x] StatefulSets
  • [x] ReplicaSets
• Stream logs/events
  • [x] select/copy output
  • [x] Containers
  • [ ] Services
  • [ ] Deployments
  • [ ] StatefulSets
• Context
  • [x] Context info
  • [x] Node metrics
  • [x] Context watch
  • [x] Change namespace?
  • [x] Context switch
• [x] Resources utilizations for nodes, pods and namespaces based on metrics server. Requires metrics-server to be deployed on the cluster.
• [x] Dark/Light themes
• [ ] Custom keymap
• [ ] Custom theme
• [ ] Tests, a lot of them :)

Screenshots

Overview screen

Container logs screen (light theme)

Pod describe screen (light theme)

Contexts screen

Utilization screen

Libraries used

• tui-rs
• crossterm
• clap
• tokio
• duct.rs
• kube-rs
• serde
• kubectl-view-allocations
• rust-clipboard

How does this compare to K9S?

K9S is a beast compared to this as it offers way more features including CRUD actions.

KDash only offers a view of most used resources with a focus on speed and UX. Really, if something is slow or have bad UX then please raise a bug. Hence the UI/UX is designed to be more user friendly and easier to navigate with contextual help everywhere and a tab system to switch between different resources easily.

At least for now there are no plans to add CRUD for resources

Licence

MIT

Authors

• Deepu K Sasidharan