https://github.com/kubernetes/kubedash

[EOL] Analytics dashboard for Kubernetes
https://github.com/kubernetes/kubedash

Last synced: 3 months ago
JSON representation

[EOL] Analytics dashboard for Kubernetes

• Host: GitHub
• URL: https://github.com/kubernetes/kubedash
• Owner: kubernetes-retired
• License: apache-2.0
• Archived: true
• Created: 2015-07-13T17:24:19.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-06-08T20:17:39.000Z (over 8 years ago)
• Last Synced: 2024-04-14T17:43:02.491Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 3.97 MB
• Stars: 216
• Watchers: 30
• Forks: 62
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Kubedash

Performance analytics UI for [Kubernetes](http://github.com/GoogleCloudPlatform/kubernetes) Clusters.

The goal of Kubedash is to allow the user or an administrator of a Kubernetes cluster to easily verify and understand the performance of a cluster and jobs running within it through intuitive visualizations of aggregated metrics, derived stats and event patterns.

It is not intended to be a general-purpose Kubernetes UI.

Instead, kubedash uses multiple sources of information to summarize and provide high-level analytic information to users and to the cluster administrator.

Some of the current features are:

- Resource utilization views of Cluster, Nodes, Namespaces, Pods and Containers for the past 1 hour.

- Derived stats for each resource over the past 1 day.

- Indications of containers with no resource limits.

Future features include the following:

- Recommendations of resource limits for individual containers.

- Detecting and highlighting resource starvation in a cluster.

- Detecting and highlighting crash-looping and misbehaving containers.

- Support for other cluster management systems like CoreOS, Swarm, etc.

## Usage

To use Kubedash, the following are required:

- A Kubernetes cluster of v1.0 or higher is operational and accessible from kubectl.

- For Kubernetes <1.2 Heapster v0.18.0 is running as the `heapster` service on the `kube-system` namespace.

After cloning this repository, use the following command to create the Kubedash pod:

For Kubernets 1.0 and 1.1:

`kubectl create -f deploy/kube-config.yaml`

For Kubernetes 1.2 and higher:

`kubectl create -f deploy/bundle.yaml`

To access the Kubedash UI, visit the following URL: `https:///api/v1/proxy/namespaces/kube-system/services/kubedash/`

where `` is the IP address of the kubernetes master node.

## Implementation

Kubedash is based on three components-

[Heapster](http://github.com/kubernetes/heapster) provides the data for Kubedash.

Heapster runs as a service by default in all kubernetes clusters, collecting metrics and analytics for individual containers.

The [Heapster Model](https://github.com/kubernetes/heapster/blob/master/docs/model.md) exposes aggregated metrics and statistics that are relevant for cluster-level analytics through a RESTful API.

Kubedash provides the other two pieces - a web server relaying REST calls, managing sockets and providing additional authentication and, a frontend to provide visualizations for the aggregated metrics and statistics of interest.

Heapster in Kubernetes 1.2 is not compatibile with the current version of Kubedash. For Kubernetes 1.2 we suggest deploying Kubedash

with an older Heapster version running inside a single Pod. See [this](deploy/bundle.yaml) for details.

##License

  The work done has been licensed under Apache License 2.0.The license file can be found

  [here](https://github.com/kubernetes/kubedash/blob/master/LICENSE).

  You can find out more about license,at

  

    http://www.apache.org/licenses/LICENSE-2.0