Skip to main content
Version: 0.4.0-beta

🚀 Quick Start Guide

This Quick Start guide provides two ways to launch CORESPEQ Cluster Wizard with the Wizard Client Web UI:

  1. K3s Deployment — lightweight Kubernetes-based setup
  2. Docker Compose Deployment — containerized local environment

Both methods deliver a fully functional Cluster Wizard environment suitable for evaluation, development, or small-scale production. For full setup and configuration details visit:

☸️ Deploying Cluster Wizard on K3s​

The K3s deployment provides a production-aligned environment using Kubernetes and Helm, automating:

  • Installation of cert-manager and Helm
  • Deployment of Cluster Wizard and Wizard Client Web UI
  • Certificate generation and secret management
  • NodePort-based service exposure

For complete installation instructions, refer to the official GitHub project: Cluster Wizard K3s Deployment Repository

Highlights​

  • Single-script automated setup: 
    curl -sfL https://raw.githubusercontent.com/corespeq-cw/deployments/refs/heads/main/k3s/setup-cluster-wizard-on-k3s.sh | bash -s -- <license-file>
  • Integrates Helm, cert-manager, and Cluster Wizard services automatically.
  • Accessible via:
    • Cluster Wizard API: https://<node-ip>:30002
    • Wizard Client Web UI: http://<node-ip>:30012

🐳 Deploying Cluster Wizard with Docker Compose​

The Docker Compose project provides a self-contained environment suitable for testing, and demos.

It includes:

  • PostgreSQL Database
  • Cluster Wizard Service
  • Wizard Client Web UI
  • Automatic Certificate and CA generation

For full setup and configuration details, visit: Cluster Wizard Docker Compose Repository

Highlights​

  • Easy local setup: 
    docker compose up -d
  • Compatible with both Docker and Podman.
  • Supports optional non-sudo setup
  • Access via:
    • Wizard Client Web UI: https://<EXTERNAL_IP>:25080

Access and Credentials​

Both deployment methods create an admin certificate and private key for secure access to Cluster Wizard. You can use these credentials with either the Wizard Client CLI or Wizard Client Web UI.

Refer to:

Next Steps​

Once Cluster Wizard and Wizard Client Web UI are deployed:

  1. Log in to the Web UI using your admin certificate and private key.
  2. Add new nodes using Node Wizard — see Node Wizard Installation Guide
  3. Start managing VMs, storage, and users directly from the Cluster Wizard dashboard.

Learn More​