DOCSEARCHbyAlgolia
Submit Docs

Cluster Wizard Documentation

website·Indexed 31 days ago

https://cluster-wizard.corespeq.com/

Cluster management and virtualization software for edge computing and SMBs. Version 0.6.0 includes tools such as Node Wizard for node-level agent management, Wizard Client for VM management via CLI and WebUI, and Node Client for lightweight control plane interfaces. Documentation covers installation on Linux and Windows, PCI device pass-through, Ceph storage configuration, and network bridge setup using Netplan and nmcli.

Tokens
93.1K
Snippets
517
Records
734
Agent score
45%

What's inside Cluster Wizard

  1. Overview of Cluster Wizard Server and VM Management

    Cluster Wizard provides a centralized web-based dashboard to manage servers, virtual machines (VMs), and network devices. It is designed to simplify infrastructure management, reduce manual errors, and allow non-technical staff (such as office managers or operations teams) to handle basic server tasks without deep technical expertise. It is compatible with popular operating systems and various IT environments.

  2. Overview of Node Wizard installation and registration

    Node Wizard (v0.6.0) is a node-level agent component that must be installed on every VM host. After installation, the VM host must be registered with a control plane—either Cluster Wizard or Node Client—to function correctly.

  3. Overview of the Cluster Wizard product family

    Cluster Wizard provides an Internal Development Platform as a Self-Service Platform for platform engineering and application deployment. The product family consists of:

    • Cluster Wizard: The central control plane.
    • Node Wizard: The worker processor/agent installed on hosts.
    • Wizard Client (Web UI & CLI): Interfaces for interacting with the Cluster Wizard control plane.
    • Node Client (Web UI & CLI): Interfaces for interacting directly with the Node Wizard agent.

  5. Overview of Node-Wizard and Node-Client architecture

    Cluster-Wizard (v0.2.0) consists of two primary components: Node-Wizard and Node-Client. Node-Wizard acts as a GRPC server responsible for VM life-cycle management on a host using KVM (Kernel-based Virtual Machine), while Node-Client serves as the GRPC client that communicates with the Node-Wizard server.

  7. Overview of Cluster Wizard components

    Cluster Wizard is management software for VMs and networks across multiple hosts with user access level control. It consists of three primary components:

    1. Cluster Wizard: The Control Plane.
    2. Wizard Client Web UI: A web-based interface client.
    3. Wizard Client (CLI): A command-line interface client available for download from the official download page.

  8. Overview of Cluster-Wizard components and VM management

    Cluster-Wizard (v0.3.0) consists of two primary components: Node-Wizard (a gRPC server) and Node-Client (a gRPC client). Node-Wizard manages the lifecycle of Virtual Machines (VMs) on a host using KVM (Kernel-based Virtual Machine). Key capabilities include:

    • Listing, creating, deleting, starting, shutting down, and destroying VMs.
    • Managing hardware attachments: disks, network devices (bridge/virtual function), and GPUs.
    • Snapshot management: creating, deleting, and rolling back to local snapshots.
    • Template creation and cloning.
    • Providing VNC access and Domain XML information.

  9. Overview of Cluster-Wizard Node-Wizard and Node-Client

    Cluster-Wizard (v0.1.0) provides VM lifecycle management on hosts using KVM (Kernel-based Virtual Machine) via two components: Node-Wizard (a GRPC server) and Node-Client (a GRPC client).

    Node-Wizard enables the following operations:

    • VM Management: List, Create, Delete, Start, Shutdown, and Destroy VMs.
    • Hardware Configuration: Attach/Detach disks, network devices (bridge/virtual function), and GPUs.
    • Snapshots and Templates: Create, Delete, and Rollback-to local snapshots; create templates and clones.
    • Access: Provide VNC access and Domain XML information.

  10. Overview of Node Wizard installation and registration

    Node Wizard is a node-level agent component that must be installed on every VM host. It serves as an agent for a control plane, which can be either Cluster Wizard or Node Client. After the installation of Node Wizard on a VM host, the host must be registered with the chosen control plane to function correctly.

  11. Overview of Cluster Wizard Core Functionalities

    Cluster Wizard provides a foundational layer for Internal Development Platforms, focusing on self-service server virtualization and network management. Key capabilities include:

    • VM Life-cycle Management: Across multiple hosts, including creating, deleting, starting, shutting down, and destroying VMs. Supports listing VMs, attaching/detaching disks, network, and PCI devices, managing local snapshots (create/delete/rollback), and creating templates and clones. Provides VNC access and Domain XML information.
    • User & Access Management: User management with authentication via mTLS (Mutual TLS) or username/password, including the assignment of VMs and hosts to specific users.
    • Network Management: Host network management for multiple hosts and VM network device management (creating/deleting bridges, VLAN, and VXLAN devices).
    • Automated Deployment: VM Auto-installation support for Ubuntu, RedHat, Rocky Linux, SUSE Linux, and Windows servers.
    • HPC & Storage: PCI device pass-through for GPUs, high-speed networks, and PCI storage devices. Full support for Ceph block storage for VM images, including snapshots and clones.

  12. Overview of the Cluster Wizard Platform Stack

    The Cluster Wizard Project provides an Internal Development Platform (IDP) as a Self-Service Platform. It is designed to offer cloud-native infrastructure for application development and deployment while minimizing management overhead and complexity. The architecture relies on two main design principles: automation to reduce overhead and a loosely-coupled architecture to maintain manageability. Kubernetes is utilized as the primary vehicle for deploying high-availability (HA) cloud-native services.