This is a preliminary version of the Altinity Dashboard. It is used for viewing and managing Kubernetes-based ClickHouse installations controlled by clickhouse-operator. It looks like this:
The Altinity Dashboard allows easy deployment and management of ClickHouse in Kubernetes, managed using the Altinity clickhouse-operator. Using the dashboard, you can:
Deploy clickhouse-operator to your Kubernetes cluster.
Upgrade clickhouse-operator.
Remove clickhouse-operator.
Deploy a ClickHouse Installation from a YAML specification (examples are provided), including the ability to define the cluster layout, storage, users and other operational parameters.
Modify existing ClickHouse Installations, even if they were not created by the Dashboard (as long as they are managed by clickhouse-operator).
View containers and storage used by ClickHouse Installations, and their status.
Current builds of Altinity Dashboard should be considered pre-release, and are not ready for production deployment. We are using an upstream-first open source development model, so you can see and run the code, but it is not yet a stable release.
First, make sure you have a valid kubeconfig pointing to the Kubernetes cluster you want to work with.
Linux / Mac:
chmod a+x adash-linux-*
./adash-linux-* --openbrowser
Windows:
Container images are available on the GitHub Container Registry. To use this:
docker pull ghcr.io/altinity/altinity-dashboard:latest
to get the latest build of the container.docker run -it --rm ghcr.io/altinity/altinity-dashboard:latest adash --help
. If everything is working, you should see command-line help.-kubeconfig
to point to it.git clone git@github.com:altinity/altinity-dashboard
).git submodule update --init --recursive
).make
.If you are doing development work, it is recommended to install pre-commit hooks so that linters are run before commit. To set this up:
npm --prefix ./ui run install-git-hooks
.make lint
to check that everything is working.Back-end development:
make ui
before compiling, so that the most recent UI gets embedded into the Go binary. If nothing in the UI has changed, make ui
will not re-run the build unnecessarily.adash -devmode
. This will add a tab with Swagger UI that lets you exercise REST endpoints even if there isn't a UI for them yet.Front-end development:
make ui-devel
will start a filesystem watcher / hot reloader for UI development.If you have questions or want to chat, join the altinitydb Slack and talk to us in the #kubernetes
channel.