risingwavelabs/wavekit repository overview

⁠WaveKit

WaveKit is a simple on-prem tool designed to enhance observability for your RisingWave cluster, enabling faster issue detection, efficient troubleshooting, and improved performance.

WaveKit supports all RisingWave deployment types, including Docker, Kubernetes, and RisingWave Cloud.

⁠Installation (Quick setup)

This method installs WaveKit with a bundled PostgreSQL database for convenience. However, if you prefer to use your own self-hosted PostgreSQL database for data persistence, skip to the next section.

⁠Starting the WaveKit Server

You can start the WaveKit server in two ways:

⁠Option 1: Ephemeral Storage (No Persistence)

Runs WaveKit with a bundled PostgreSQL database, but metadata is stored inside the container. If the container is removed, all metadata will be lost.

docker run --rm -p 8020:8020 --name wavekit risingwavelabs/wavekit:v0.1.2-pgbundle

⁠Option 2: Persistent Storage (Recommended)

Runs WaveKit with a bundled PostgreSQL database and stores metadata in a persistent Docker volume (wavekit-data), ensuring data persists across restarts.

docker run -p 8020:8020 --name wavekit -v wavekit-data:/var/lib/postgresql risingwavelabs/wavekit:v0.1.2-pgbundle

⁠Accessing WaveKit

Once the server is running, open your browser and go to:

• http://localhost:8020⁠

Use the following default credentials to log in:

• Username: root
• Password: root

⁠Installation (Binary)

To install WaveKit using a standalone binary, follow these steps:

1. Download and install the latest WaveKit binary:

curl https://wavekit-release.s3.ap-southeast-1.amazonaws.com/download.sh | sh

1. Run the following command to start the WaveKit server:

WK_PG_DSN=postgres://postgres:postgres@localhost:5432/postgres ./wavekit

⁠Installation (Recommended for production)

The following section provides a step-by-step guide to setting up WaveKit with your self-hosted PostgreSQL database. This approach is recommended if you need persistent metadata with high availability.

First, create docker-compose.yaml file with the following content:

version: "3.9"
services:
  wavekit:
    image: cloudcarver/wavekit:v0.1.2
    ports:
      - "8020:8020"
    environment:
      WK_PORT: 8020
      WK_PG_DSN: postgres://postgres:postgres@localhost:5432/postgres
      WK_RISECTLDIR: /

  db: 
    image: "postgres:latest"
    ports:
      - "5432:5432"
    environment:
      POSTGRES_PASSWORD: postgres
    volumes:
      - db-data:/var/lib/postgresql/data

volumes:
  db-data:
  wavekit-data:

Start WaveKit by running the following command:

docker compose up

When the server is running, open your browser and go to: http://localhost:8020⁠

⁠Customizing WaveKit Settings

WaveKit offers flexible configuration options through either a configuration file or environment variables. For detailed information about available settings and configuration methods, please refer to our configuration documentation⁠.

⁠Contributing to WaveKit

We welcome contributions to WaveKit! Please refer to our CONTRIBUTING.md⁠ for more information on how to contribute to the project.

⁠WaveKit Editions

WaveKit is available in two editions:

• WaveKit-Lite – A lightweight, open-source edition that includes core functionalities. Licensed under Apache 2.0.
• WaveKit-Pro – A full-featured edition with advanced capabilities. A license key is required for access. To apply, contact us at [email protected]⁠ or fill out this form⁠.