buoy is a declarative TUI dashboard for Kubernetes. You define your dashboard in a JSON file and it will fetch the information from your Kubernetes cluster and build a dashboard for viewing the requested content right in your terminal window.

• Clone the repository:

git clone https://github.com/everettraven/buoy.git

• cd into the cloned repository:

cd buoy

• Build the buoy binary:

make build

OR

go build -o buoy main.go

• Create a KinD cluster:

kind create cluster

• Run buoy using the test.json file:

./buoy test.json

The test.json file contains samples for each of the different panel types that buoy currently supports. As this is a hobby project very early in the development cycle there are some limitations and things are bound to not work as expected.

test.yaml results in the exact same dashboard as test.json and exists to show YAML support.

buoy uses https://github.com/tidwall/gjson for the path evaluation and extracting of values from resources. Please consult their documentation for valid path syntax.

You can also specify a remote reference to a dashboard configuration file. It must be a valid URL and the response must be the raw YAML or JSON contents of the file.

• ctrl c, q, esc will quit the program and exit the tui
• tab will switch the active tab to the one to the right of the currently active tab
• shift tab will switch the active tab to the one to the left of the currently active tab
• up and down arrow keys and mouse scroll will move up and down in the active tab
• For tables you can use the left and right arrows to scroll horizontally

While this is a hobby project and in the early development stages, I'm more than happy to accept contributions. If you use buoy and find some problems or have some ideas for features/improvements, file an issue. If you want to contribute code, feel free to pick up any unassigned issues and create a pull request.

Since this is a hobby project responses to issues and/or pull requests are likely to be slow.