Developer Dashboard (clustereye)

A web-based Kubernetes dashboard for developers that want to augment their kubectl experience.

Running

Note: make sure to confirm you currently have access to a healthy cluster with kubectl cluster-info.

Start the developer dashboard:

$ clustereye

Check the version:

$ clustereye version

Prerequisites for development

• Go 1.11
• npm 6.4.1 or higher
• yarn
• rice CLI
  • Install with go get github.com/GeertJohan/go.rice/rice
• mockgen
  • go get github.com/golang/mock/gomock && go install github.com/golang/mock/mockgen

Install

Download a prebuilt binary

Go to the releases page and download the tarball.

Extract the tarball:

$ tar -xzvf ~/Downloads/clustereye_0.3.0_Linux-64bit.tar.gz
clustereye_0.3.0_Linux-64bit/README.md
clustereye_0.3.0_Linux-64bit/clustereye

Verify it runs:

$ ./clustereye_0.3.0_Linux-64bit/clustereye version

Decide to move the binary in /usr/local/bin or your home directory. Installing to /usr/local/bin is for system-wide installation but makes running multiple versions difficult. If the dashboard is installed to your home directory, make sure to update your $PATH variable then check which clustereye to verify installation is successful.

Manually build and install

This option is for users who want to build from master. Make sure the prerequisites listed above are installed.

$ go get github.com/heptio/developer-dashboard

Package the web assets to be built into the binary.

$ make web-build

There should be a new directory: $GOPATH/src/github.com/heptio/developer-dash/web/build. Finally, build the binary:

$ make clustereye-dev

The clustereye binary will be found in $GOPATH/src/github.com/heptio/developer-dash/build.

Environment variables

• KUBECONFIG - set to non-empty location if you want to set KUBECONFIG with an environment variable.
• CLUSTEREYE_DISABLE_OPEN_BROWSER - set to a non-empty value if you don't the browser launched when the dashboard start up.
• CLUSTEREYE_LISTENER_ADDR - set to address you want dashboard service to start on. (e.g. localhost:8080)
• CLUSTEREYE_VERBOSE_CACHE - set to a non-empty value to view cache actions
• CLUSTEREYE_LOCAL_CONTENT - set to a directory and dash will serve content responses from here. An example directory lives in examples/content
• CLUSTEREYE_PLUGIN_PATH - add a plugin directory or multiple directories separated by :. Plugins will load by default from $HOME/.config/vmdash/plugins

Running development web UI

$ make setup-web

Running development server

The development server allows running the dashboard while monitoring changes in /web.

Start the dashboard running on a development server:

$ make -j ui-client ui-server

Navigate to localhost:7777 on a browser to view cluster data.

Caveats

• If using fish shell, tilde expansion may not occur when using env to set environment variables.