Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 4.14 KB

README.md

File metadata and controls

78 lines (50 loc) · 4.14 KB
Raw

Altinity Dashboard

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:

image

What is 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.

Production Readiness

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.

How to Use

  • First, make sure you have a valid kubeconfig pointing to the Kubernetes cluster you want to work with.

  • Linux / Mac:

  • Windows:

    • Download and double-click on the Windows EXE file from https://github.com/Altinity/altinity-dashboard/releases.
    • A command prompt window will open and will show a URL.
    • Copy and paste the URL into a web browser.
    • Windows SmartScreen Filter may warn that the EXE file is rarely downloaded. You can ignore this.

Running the container image from the GitHub Container Registry

Container images are available on the GitHub Container Registry. To use this:

  • Run docker pull ghcr.io/altinity/altinity-dashboard:latest to get the latest build of the container.
  • Run docker run -it --rm ghcr.io/altinity/altinity-dashboard:latest adash --help. If everything is working, you should see command-line help.
  • If you run this container inside Kubernetes, it should perform in-cluster auth.
  • To run it outside Kubernetes, you will need to volume mount a kubeconfig file and use -kubeconfig to point to it.

Building from source

  • Install the following on your development system:
    • Go 1.16 or higher
    • Node.js v16 or higher, including npm 7.24 or higher
    • GNU Make version 4.3 or higher (yum/dnf/apt install make)
  • Clone the repo (git clone [email protected]:altinity/altinity-dashboard).
  • Initialize submodules (git submodule update --init --recursive).
  • Run 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:

  • Install golangci-lint.
  • From the repo root, run npm --prefix ./ui run install-git-hooks.
  • Run make lint to check that everything is working.

Setting up a development environment

Back-end development:

  • Set up your IDE to run 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.
  • Run the app in the debugger with 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.

Talk to Us

If you have questions or want to chat, join the altinitydb Slack and talk to us in the #kubernetes channel.