Kubeapt

Kubernetes dashboard for developers

Running

Start the developer dashboard:

$ apt dash

Check the version:

$ apt version

Prerequisites

• Go 1.11
• npm 6.4.1 or higher
• yarn
• rice CLI
  • Install with go get github.com/GeertJohan/go.rice/rice

Install

Download a prebuilt binary

Go to the releases page and download the tarball.

Extract the tarball:

$ tar -xzvf ~/Downloads/apt_0.1.1_Linux-64bit.tar.gz
apt_0.1.1_Linux-64bit/README.md
apt_0.1.1_Linux-64bit/apt

Verify it runs:

$ ./apt_0.1.1_Linux-64bit/apt 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 apt 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/twosson/kubeapt

Package the web assets to be built into the binary.

$ make web-build

There should be a new directory: $GOPATH/src/github.com/twosson/kubeapt/web/build. Finally, build the binary:

$ make apt-dev

The apt binary will be found in $GOPATH/src/github.com/twosson/kubeapt/build.

Environment variables

• KUBECONFIG - set to non-empty location if you want to set KUBECONFIG with an environment variable.

• DASH_DISABLE_OPEN_BROWSER - set to a non-empty value if you don't the browser launched when the dashboard start up.

• DASH_LISTENER_ADDR - set to address you want dashboard service to start on. (e.g. localhost:8080)

• DASH_VERBOSE_CACHE - set to a non-empty value to view cache actions

• DASH_TELEMETRY_ADDRESS - set telemetry address

• DASH_DISABLE_TELEMETRY - set to non-empty value to disable telemetry

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.