Skip to content

A relatively simple and lightweight dashboard to monitor kubernetes state and resources.

License

Notifications You must be signed in to change notification settings

jawahars16/kubex

Repository files navigation

Kubex

Build Status Go Report Card

Kubex is a simple and lightweight dashboard to monitor kubernetes cluster state and resources.

alt text

Installation

Install via go get command.

go get -u github.com/jawahars16/kubex

Note: Homebrew installation is planned.

Getting Started

To watch the state and resources (CPU and memory) of all your services

kubex watch [resource] [--port port_number] [--namespace cluster_namespace]

Example

kubex watch service --port 5000 --namespace dallas_team

Use --all-namespaces flag to watch resources from all namespaces. Kubex support watching service, node and deployments for now.

Prerequisites

Kubex reads cluster information from default kube config file($HOME/.kube/config). Before start watching the state using kubex, make sure you set a context entry in kubeconfig.

kubectl config set-context NAME [--cluster=cluster_nickname] [--user=user_nickname] [--namespace=namespace]

Read here for more details about setting a context entry

Kubex read matrics data from cluster using metrics-server. If no metrics-server installed in cluster, kubex cannot show metrics information. Other visualization still works.

Read here for more details about installing metrics-server in kubernetes cluster

Built With

  • React - Building user interfaces
  • godep - Dependency toolt for go
  • client-go - Used to fetch data from kubernetes cluster
  • Ant design - UI Design library for react

License

This project is licensed under the MIT License - see the LICENSE file for details