DOCSEARCHbyAlgolia
Submit Docs

Cluster Wizard Documentation

website·Indexed 30 days ago

https://cluster-wizard.com/

Documentation for Cluster Wizard, including guides for Node Wizard and Node Client. Covers VM host management, CLI and WebUI usage, network bridge configuration (Netplan, nmcli), Ceph storage integration, and PCI device pass-through. Supports versions 0.1.0 through 0.6.0.

Tokens
183.4K
Snippets
1K
Records
1.5K
Agent score
38%

What's inside Cluster Wizard

  1. Overview of Cluster Wizard Server and VM Management

    Cluster Wizard is a management tool that provides an all-in-one dashboard for managing servers, virtual machines (VMs), and network devices. It is designed to simplify infrastructure management via an intuitive web interface, reducing the need for deep technical expertise and allowing non-technical staff (such as office managers or operations teams) to handle basic management tasks. It is compatible with popular operating systems and is designed to fit any IT environment.

  2. Overview of Cluster-Wizard components and VM management

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

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

  3. Overview of Cluster-Wizard VM Management

    Cluster-Wizard (v0.1.0) provides VM lifecycle management on hosts using KVM (Kernel-based Virtual Machine). The system architecture consists of two components: Node-Wizard, which acts as a gRPC server, and Node-Client, which acts as a gRPC client that communicates with Node-Wizard.

    Key capabilities include:

    • VM operations: List, Create, Delete, Start, Shutdown, and Destroy VMs.
    • Hardware management: Attach/Detach disks, network devices (bridge/virtual function), and GPUs.
    • Snapshot and Template management: Create, Delete, and Rollback-to local snapshots; create templates and clones.
    • Access: VNC access and retrieval of Domain XML information.

  4. Overview of the Admin Interface

    The Admin Interface provides centralized tools for cluster-wide management. Key management areas include:

    • Dashboard: Overview of license status, hosts, VMs, templates, users, and pending CSRs.
    • Hosts Management: Access host consoles, manage assignments, and renew licenses.
    • VMs, Templates, and Networks Management: Centralized control of cluster resources.
    • Users Management: Manage user accounts.
    • CSRs Management: Review and manage Certificate Signing Requests.

  5. Overview of Cluster Wizard product suite

    Cluster Wizard provides tools for Server Virtualization, Network Management, and Cluster Management. The suite consists of:

    • Cluster Wizard: The control plane for cluster management.
    • Wizard Client (CLI and WebUI): The user interface for interacting with Cluster Wizard.
    • Node Client (CLI and WebUI): A lightweight control plane for direct node management.
    • Node Wizard: An agent installed on each node that provides server virtualization and network management; it is managed by either Cluster Wizard or Node Client.

  7. Overview of Cluster Wizard capabilities

    Cluster Wizard is a self-service platform designed as a foundational layer for Internal Development Platforms, focusing on Server Virtualization, Network Management, and Cluster Management. Key capabilities include:

    • VM Life-cycle Management: Across multiple hosts, including creation, deletion, start/shutdown/destroy, disk/network/PCI device attachment, local snapshots (create/delete/rollback), and template/clone management.
    • Access & Security: VNC access, Domain XML information, and user authentication via mTLS (Mutual TLS) or username/password.
    • Network & Host Management: Host network management for multiple hosts and assignment of VMs/hosts to specific users.
    • Automated Provisioning: VM auto-installation support for Ubuntu, RedHat, Rocky Linux, SUSE Linux, and Windows servers.
    • Network Device Management: Creation and deletion of bridges, VLAN, and VXLAN devices for VM networks.
    • HPC Features: PCI device pass-through (GPUs, high-speed networks, PCI storage) and full support for Ceph block storage for VM images, snapshots, and clones.

  8. Overview of Cluster Wizard components

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

    • Cluster Wizard: The Control Plane.
    • Wizard Client Web UI: A web-based interface client.
    • Wizard Client (CLI): A command-line interface client.

  9. 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 Cluster Wizard.
    • Node Client (Web UI & CLI): Interfaces for interacting with Node Wizard.

  10. Overview of Cluster Wizard Control Plane

    Cluster Wizard is a control plane designed for Internal Development Platforms (IDP) and Self-Service Platforms. It provides centralized management for VM lifecycles across multiple hosts, host network management, mTLS-based user authentication, and Ceph block storage support (including snapshots and clones). It is deployed on a Kubernetes cluster using a Helm Chart.

  11. Overview of Cluster Wizard capabilities

    Cluster Wizard is a self-service platform designed as a foundational layer for Internal Development Platforms, focusing on Server Virtualization, Network Management, and Cluster Management. Key capabilities include:

    • VM Life-cycle Management: Across multiple hosts, including creation, deletion, start/shutdown/destroy, disk/network/PCI device attachment, local snapshots (create/delete/rollback), templates, clones, and VNC access.
    • User & Access Management: Authentication via mTLS (Mutual TLS) or username/password, with the ability to assign VMs and hosts to specific users.
    • Network Management: Host network management for multiple hosts and VM network device management (bridges, VLAN, and VXLAN).
    • Automated Deployment: VM auto-installation support for Ubuntu, RedHat, Rocky Linux, SUSE Linux, and Windows servers.
    • HPC & Storage: PCI device pass-through (GPUs, high-speed network, PCI storage) and full support for Ceph block storage for VM images, snapshots, and clones.

  12. Overview of Cluster-Wizard components and VM management

    Cluster-Wizard (v0.3.0) consists of two primary components: Node-Wizard, a gRPC server responsible for VM life-cycle management on a host using KVM, and Node-Client, a gRPC client used to communicate with Node-Wizard.

    Node-Wizard provides the following VM management capabilities:

    • 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 and clone creation.
    • Providing VNC access and Domain XML information.