🚀 Quick Start Guide
This Quick Start guide provides two ways to launch CORESPEQ Cluster Wizard with the Wizard Client Web UI:
- K3s Deployment — lightweight Kubernetes-based setup
- Docker Compose Deployment — containerized local environment
Both methods deliver a functional Cluster Wizard environment suitable for evaluation, development, or small-scale production use. For larger or full production deployments, refer to the full Cluster Wizard Deployment documentation.
For full setup and configuration details visit:
If the nodes IP address changes after deployment, the cluster may require rebuilding.
☸️ Deploying Cluster Wizard on K3s
The K3s deployment option assumes that a working K3s cluster is already installed and running. This guide does not cover installing K3s itself.
The K3s deployment of CORESPEQ Cluster Wizard with the Wizard Client Web UI 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, and simple steps to install k3s, 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
- Cluster Wizard API:
🐳 Deploying Cluster Wizard with Docker Compose
The Docker Compose deployment option assumes that Docker and Docker Compose are already installed and available. This guide does not install Docker or 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
💻 Windows and macOS Compatibility
The Docker Compose deployment for CORESPEQ Cluster Wizard runs on Windows 10/11, macOS, and Linux, providing a consistent setup experience across all platforms.
Highlights
- Easy local setup:
docker compose up -d - Compatible with Linux, macOS, and Windows.
- Compatible with both Docker and Podman
- Supports optional non-sudo setup
- Access via:
- Wizard Client Web UI:
https://<EXTERNAL_IP>:25080
- Wizard Client Web UI:
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:
- Log in to the Web UI using your admin certificate and private key.
- Add new nodes using Node Wizard — see Node Wizard Installation Guide
- Start managing VMs, storage, and users directly from the Cluster Wizard dashboard.
Learn More
- Wizard Client Web UI
- Cluster Wizard
- 💡 Cluster Wizard Overview
⚠️ Problems and Troubleshooting
-
Login error:
If you see
"Error with login process. Please retry later or verify your credentials!"
Some browsers (notably Firefox) trust the Wizard Client Web UI’s frontend certificate after you accept it, but not the backend certificate automatically.
As a result, the Web UI may fail to function correctly.
See Wizard Client Web UI Deployment Troubleshooting for solutions. -
Other issues:
Check out Cluster Wizard Deployment Troubleshooting or Wizard Client Web UI Deployment Troubleshooting.