The mesh Command

The mesh command is the primary CLI tool for managing Mesh Hypervisor. It runs on the central orchestration node, controlling the system, nodes, and workloads. This section explains its structure and basic usage.

Overview

mesh is a wrapper script grouping commands into three categories: system, node, and workload. Each category has subcommands for specific tasks, executed from the central node’s console.

Usage

Run mesh <category> <action> [options] from the console. Full syntax:

Usage: mesh <category> <action> [options]

Categories and Actions:
  system:
    stop                 Stop the system
    configure            Configure system settings
    start                Start the system
    logview              View system logs
    download             Download system components

  node:
    info                 Display node information
    ctl                  -n <node> [command]

  workload:
    list                 [-n <node>]
    start                -n <node> -w <workload>
    hard-stop            -n <node> -w <workload>
    soft-stop            -n <node> -w <workload>
    pause                -n <node> -w <workload>
    resume               -n <node> -w <workload>
    download             -n <node> -w <workload> [-f]
    createimg            -n <node> -w <workload> [-f]
    snapshot-take        -n <node> -w <workload> [-s <snapshot name>]
    snapshot-list        -n <node> -w <workload>
    snapshot-revert      -n <node> -w <workload> -s <snapshot name>
    snapshot-delete      -n <node> -w <workload> -s <snapshot name>

Options:
  -n, --node <uuid>             Node UUID
  -w, --workload <uuid>         Workload UUID
  -s, --snapshot-name <string>  Snapshot name
  -f, --force                   Force the operation
  -V, --version                 Show version information
  -h, --help                    Show this help message

Key Commands

  • System:
    • mesh system start: Launches PXE, DHCP, and HTTP services.
    • mesh system logview: Opens logs in lnav for debugging.
  • Node:
    • mesh node info: Lists online nodes with UUIDs.
    • mesh node ctl -n <uuid>: Runs a shell command (e.g., apk upgrade) or logs in via SSH.
  • Workload:
    • mesh workload start -n <uuid> -w <name>: Starts a KVM VM.
    • mesh workload list -n <uuid>: Shows running workloads on a node.

Notes

  • Commands execute over SSH for remote nodes, using preinstalled root keys (configurable in /host0).
  • Node UUIDs come from mesh node info; workload names match config files (e.g., qemutest1).
  • See subsequent sections for specifics: Managing Nodes, Configuring Workloads.

Next, explore Managing Nodes.