Every feature

What LexiVirt does

Everything the product has, grouped the way the console is. Each entry says what the feature is for, how to use it step by step, and, where there is one, what it does not do — a description that only lists what works is marketing, and the limits are the part you need before you depend on it.

Infrastructure

Fleet1.8.1

Every LexiVirt cluster this console manages, read live from each one: capacity added up, alerts in one feed, and a search that finds a virtual machine without opening each console in turn. A cluster is registered with its URL and an API key it issues itself, so its own roles decide what the fleet may do and its own audit log records it.

Limits: Reads and reports. No cross-cluster migration, no policy pushed into a peer, no capacity planning across clusters.

How to use it

  1. On the other cluster's console, open Settings and choose New key under API Keys. Give it the role the fleet should have there — viewer is enough to read.
  2. Copy the key. It is shown once.
  3. Back on this console, open Fleet and choose Register cluster.
  4. Fill in Name, Console URL (the other console's address) and API key from that cluster, then save.
  5. The page now shows that cluster's nodes, VMs and alerts, read live. Use Search to find a VM across every registered cluster.
  6. To end the relationship, remove the cluster here or revoke its key on the other console.

Clusters1.7.0

This console's own cluster: which nodes are in it, what they add up to, and where each virtual machine sits. Health is derived from what the nodes report, never asserted.

How to use it

  1. Open Clusters.
  2. Read the totals: how many nodes are online and what CPU, memory and disk they add up to.
  3. Check where each virtual machine sits; a node's health here is what the node itself reported.
  4. To add capacity, choose Add Node; to change a node, choose Manage nodes.

Nodes1.0

The machines that actually run virtual machines. Each runs a small agent the console talks to over an authenticated channel. A node that refuses the console says which of the three reasons it is — a wrong secret, a secret it generated itself, or one it cannot keep between restarts — because those have different fixes.

What it includes

  • Maintenance mode: a node in maintenance receives no new VMs.
  • Move every VM off this node: each VM goes to the node with the most room — live where its disks are shared, copied where they are not.

How to use it

  1. Open Nodes and choose Add Node.
  2. Run the command the dialog shows on the new server, as root. When it asks for the agent secret, paste the secret the dialog gives you.
  3. Fill in Node Name, IP / Hostname and Agent Port (9071 unless you changed it), then choose Connect Node.
  4. The node appears as online. If it does not, its card says why — a wrong secret, a secret it generated itself, or one it cannot keep — and each has its own fix.
  5. Before working on a node, use the power button on its card to put it in maintenance (no new VMs are placed there), and Move every VM off this node to empty it.
  6. When a node runs an older agent than the console, its card offers Update agent.

Virtual machines1.0

Create, start, stop, clone and resize KVM guests. Boot from an uploaded ISO or a cloud image, give them several network cards, set CPU topology, and open a console in the browser — including pasting text into guests that have no clipboard.

What it includes

  • Create one VM or up to fifty in one pass: a batch is named web-01, web-02 … and placed by the scheduler on whichever nodes have room.
  • Templates: save the whole Create VM configuration under a name — from the last step of the wizard, or from an existing VM's tools — and start the next VM from it in one click.
  • Cloud-init for cloud images: a user, a password or SSH key, a host name and one command to run on first boot, delivered on a small seed disk the guest finds by itself.
  • Several network cards per VM, each on its own network and optionally with a fixed address; CPU topology as sockets × cores.
  • UEFI or BIOS chosen from the installer itself: an ISO that cannot boot under UEFI gets BIOS, so an arbitrary installer does not stop at a blank screen.
  • Move to another node: live when every disk is on shared NFS storage, otherwise shut down, copied and started there — nothing is deleted until the copy runs.
  • Export a VM to one .lexivirt.tar file in the image library and Import it from there; clone a VM; resize CPU, memory and disks while it is off.
  • The image library downloads an image from a URL to every node (with an optional sha256 check) and converts VMware, Hyper-V and VirtualBox disks — VMDK, VHD, VHDX, VDI, OVA — to qcow2.

How to use it

  1. Put an installer ISO or a cloud image in the image library first: Nodes → ISO Library, then upload a file or give a URL and choose Download to all nodes.
  2. Open Virtual Machines and choose Create VM. The wizard walks through Name & placement, Source, Resources, Networking, Guest setup, Project & owner and Review.
  3. Under Source, pick an Installer ISO or a Disk image. With a disk image you can set a user, a password or SSH key and a host name under Guest setup (cloud-init).
  4. Choose Create. The console checks before it starts that a node has the network, the image and the space the VM needs, and says which node lacks what if none does.
  5. In the list, use the row buttons to start, stop or restart, open the console in the browser, or edit resources (the VM has to be off to resize).
  6. The camera button opens the VM's tools: disks, recovery points, snapshots, high availability, project and owner, Move to another node, Export, Save as a template and Clone.

Many VMs at once, and templates

  1. In Create VM, under Name & placement, set How many — up to 50. More than one makes name-01, name-02, … and the scheduler places each on a node with room.
  2. To start from a saved configuration, pick it under Start from a template on the same step. It fills everything in; the name and the count stay as you typed them.
  3. To save one, fill in Save this configuration as a template (optional) on the Project & owner step before you create.
  4. To turn an existing VM into a template, open its tools and choose Save as a template.
  5. Templates on the Virtual Machines page lists them and deletes them. A template is the configuration only — its disks stay in the image library — so deleting one touches no VM made from it.

First boot of a cloud image (cloud-init)

  1. Put a cloud image in the library: Nodes → ISO Library, give its URL (for example a Debian or Ubuntu cloud .qcow2) and choose Download to all nodes.
  2. In Create VM, under Source, choose Disk image and pick it. Cloud-init is only offered with a disk image: an installer ISO installs a system, a cloud image already is one and waits to be told who it is.
  3. Under Guest setup, tick Configure the first boot (cloud-init) and give the User, a Password or an SSH public key (at least one, or nobody can sign in), the Host name and, if you want, a command under Run on first boot (optional).
  4. Create the VM. It finds its settings on first boot by itself; the user can use sudo.
  5. In a batch, the host name gets the same -01, -02 suffix as the VM names.

A disk from VMware, Hyper-V or VirtualBox

  1. Open Nodes → ISO Library and upload the .vmdk, .vhd, .vhdx, .vdi or .ova, or give its URL and choose Download to all nodes. An optional sha256 is checked on arrival.
  2. A disk image a VM cannot boot from yet has a convert button on its row. Choose it and give the name of the qcow2 to make; the conversion runs as a task.
  3. Create a VM with Source → Disk image and pick the converted file. Keep the firmware the machine was installed with: a guest installed under UEFI does not boot on BIOS.

Moving, exporting and importing a VM

  1. To move a VM, open its tools and choose Move to another node, then the target. If every disk is on a shared NFS container it moves live; otherwise it is shut down, copied, started on the target, and only then removed from the source.
  2. To take a VM off the node as a file, choose Export in its tools. The export is one .lexivirt.tar in the image library; follow it on the Tasks page.
  3. To bring one back, choose Import on the Virtual Machines page, pick the export, the node and, if you want, a new name.

Containers1.7.4

OCI containers beside virtual machines, on whichever runtime a node already has — Podman first because it is daemonless, then Docker. A node with neither says which package to install rather than reporting an empty list.

Limits: A memory and CPU ceiling is required. An unbounded container can take the host, and on a hypervisor that takes every virtual machine on it too.

How to use it

  1. Open Containers and choose Run container.
  2. Pick the Node and the Image (for example docker.io/library/nginx).
  3. Set Memory limit (MB), CPU limit and Process limit. They are required: an unbounded container can take the host.
  4. Optionally add Published ports and Volumes, one per line, and a Command.
  5. Choose Run. Each row then has Stop, Restart, Start, Logs and Remove.
  6. If a node has neither Podman nor Docker, the page says which package to install.

GPU1.7.2

Discovers the graphics and compute cards on each node and passes a whole card through to one virtual machine. The page states which cards are bound to a passthrough driver and which are still held by the host.

Limits: Whole-card passthrough only. No vGPU, no time-slicing, no sharing one card between guests.

How to use it

  1. Open GPU. Each card found on each node is listed; choose Rescan after adding hardware.
  2. A card held by the host cannot be passed through. Why not? says what is in the way and what to change.
  3. Shut the VM down: a card is attached at boot, not while the machine runs.
  4. Choose Assign to VM, pick the Virtual machine and confirm with Assign.
  5. Start the VM; the whole card is now its own. Detach (with the VM off) gives the card back.

Storage

Storage1.0

Where a virtual machine's disk lives on each node: the node's own disk, another mounted directory, an NFS export, or an LVM volume group. A VM picks its container when it is created.

Limits: No distributed storage. Shared storage is an NFS export you provide, and high availability and live migration both need one.

How to use it

  1. Open Storage and choose Add container.
  2. Pick the Type: Directory on the node, NFS export or LVM volume group.
  3. For a directory give the Path; for NFS the Server, the Export and optional Mount options; for LVM the Volume group and optional Thin pool.
  4. Under Add it on, choose the nodes that get it, then Add. For high availability and live migration, add the same NFS export on every node.
  5. Pick the container under Storage when you create a VM; disks added later can go to any container too.

Volumes1.6

Disks that belong to no single machine: attach one to several at once for a cluster's quorum disk or shared data. On a shared container it is one disk every node sees.

How to use it

  1. Open Storage and choose New volume.
  2. Give it a Name, a Size (GB) and the Container it lives in. On a shared (NFS) container it is one disk every node sees.
  3. To attach it, open the VM's tools (camera button in Virtual Machines), choose Add New Disk and pick the Shared volume.
  4. Repeat for every VM that should share it. Volumes lists each volume and where it is attached.

Snapshots1.5

Point-in-time copies of a virtual machine's disks, taken while it is off, including its firmware variables. Roll one back or clone from it.

Limits: Offline only. A snapshot of a running guest is not taken, because a disk copied mid-write is not a copy you can trust.

How to use it

  1. Shut the VM down: a snapshot is taken only while it is off.
  2. Open its tools (camera button in Virtual Machines). Under Snapshots, type a name such as before-upgrade and choose Take.
  3. To go back, choose Restore next to the snapshot, again with the VM off.
  4. Snapshots in the menu lists every snapshot across every VM in one place.

Backups and recovery points1.5

A schedule that takes recovery points of a set of virtual machines and keeps the last N of them. Restores are done from the same page.

What it includes

  • Recovery points are taken while the VM runs. With the QEMU guest agent answering they are application-consistent — the guest flushes and freezes its filesystems first; without it they are crash-consistent, and each one is labelled as such.
  • Retention per policy: the newest N are kept and older ones are removed.
  • Export (in the VM's tools) writes a whole VM to a single file you can copy off the node.

Limits: Recovery points live on the node they protect, so losing that node loses them. There is no off-node repository and no automatic restore verification.

How to use it

  1. Open Backups and choose New policy.
  2. Give it a Name, choose how often to Take a recovery point (hourly to weekly), and how many to Keep the newest.
  3. Tick the VMs covered and Save. Protection by VM then shows which VMs are protected and when each last ran.
  4. To take one by hand, open the VM's tools and choose Take one now under Recovery points.
  5. To restore, use the restore button next to a recovery point in the VM's tools.
  6. Copy important VMs off the node as well (Export in the VM's tools): a recovery point lives on the node it protects.

Network

Networks1.0

Bridged and NAT networks on each node, VLAN-tagged segments, and DHCP reservations that pin a guest to an address.

What it includes

  • A fixed address can be given per network card right in the Create VM wizard; it is reserved on that network's own DHCP server, and in a batch it steps by one per VM.
  • Four kinds of network: NAT (outbound only), isolated (guests only), LAN (on the nodes' own network) and bridged, optionally VLAN-tagged.
  • A network is validated on every node before it is created, so a bridge missing on one host is reported instead of discovered later.

How to use it

  1. Open Networks and choose Create Network.
  2. Pick the Type: NAT (outbound only), Isolated (guests only), LAN (on the nodes' own network) or Bridged (a host bridge, optionally VLAN-tagged).
  3. Give the Name and, for NAT or isolated, the Subnet (CIDR); for bridged, the Host bridge and an optional VLAN id.
  4. Choose Validate to see what each node will do, then Create. The network is made on every node.
  5. To pin a VM to an address, choose the Fixed addresses on this network button on the network's row, pick the VM (or type a MAC), give the Address and choose Reserve.

Overlay networks1.7.3

A VXLAN segment that spans nodes, so virtual machines on different hosts share one layer-2 network without touching the physical switches. Peers are set up from the console and the MTU is lowered to leave room for the encapsulation.

Limits: Unencrypted. VXLAN carries the frames as they are, so the underlying network has to be one you trust.

How to use it

  1. Open SDN and choose New overlay.
  2. Give it a Name and a VNI (the segment number); the Subnet is for your reference. Leave MTU and UDP port at their defaults unless your network needs otherwise.
  3. Save. The console sets up the peers on every node.
  4. Connect VMs to the overlay as you would to any network: it appears in the network list when you create a VM or add an interface.
  5. If a node was offline when you saved, choose Re-apply to nodes once it is back.

Firewall1.7.2

Rules that open and block traffic between virtual machines, compiled to an nftables ruleset and pushed to every node. Rules name machines, and names are resolved against the live cluster on every apply, because an address learned an hour ago may belong to a different guest now.

Limits: A node without nftables cannot enforce, and the readiness report names it rather than letting the console believe a rule is in force everywhere.

How to use it

  1. Open Firewall and choose Add Rule.
  2. Set the Source and Destination — a VM by name, or Address or range… — the Protocol and the Port or range.
  3. Pick the Action: Allow, Drop (silent) or Reject (reply), and a Priority (lower runs first).
  4. Save. The ruleset is compiled and pushed to every node, and the page reports any node that could not enforce it.
  5. Use the toggle on a rule to switch it off without deleting it, and Re-apply to nodes after a node comes back.

Load balancer1.7.4

One address and port spread over several backends, as destination NAT in the kernel's connection tracker. Round-robin or source affinity.

Limits: Layer 4, and the page says so: it balances TCP and UDP connections and knows nothing about requests, paths, headers or TLS. There is no health checking — a backend that is down still receives its share.

How to use it

  1. Open Load Balancer and choose New service.
  2. Give it a Name, the address and Port it Listens on, and the Protocol (TCP or UDP).
  3. Pick the Method: Round robin spreads evenly; Source hash keeps one client on the same backend.
  4. List the Backends, one per line, as address:port. Save.
  5. Remember there is no health checking: take a backend that is down out of the list yourself.

Operations

Monitoring1.4

CPU, memory and disk per node and per virtual machine, recorded over time, with a capacity runway derived from what was actually measured.

How to use it

  1. Open Monitoring for live CPU, memory and disk on every node.
  2. Open a VM's history from the chart button on its row in Virtual Machines, and pick the range — from the last hour to the last 30 days.
  3. The Capacity runway on the Dashboard is derived from what was measured, so give a new installation a few days before trusting it.
  4. Set how long history is kept under Settings (Keep per-minute history and Keep hourly history).

Alerts1.4

What is wrong now, most severe first, with the reason and the fix. A message goes out once per problem — and again if it gets worse — never repeatedly for the same thing.

What it includes

  • Delivery by e-mail (any SMTP server, STARTTLS or SSL) and by webhook in Slack, Microsoft Teams or plain JSON format.
  • A minimum severity decides what is sent; each problem is sent once, and again only if it gets worse.
  • Failed deliveries are retried, and the settings page shows whether the last attempt worked.

How to use it

  1. Open Alerts. Problems are listed most severe first, each with its reason and fix.
  2. Choose Acknowledge on an alert you are handling.
  3. To be told by email or webhook, open Settings, fill in Alerts & notifications (SMTP server or webhook URL) and choose Send a test.
  4. Adjust the thresholds there too: disk warning and critical, memory warning, and how many days before a certificate expires to warn.

Tasks1.3

Everything slow — clones, image copies, migrations, backups, updates — runs as a task with progress and history, rather than holding a request open.

How to use it

  1. Start anything slow — creating VMs, cloning, copying an image, moving a VM, a backup, an update. It runs as a task and the request returns at once.
  2. Open Tasks to see progress, what each task is doing now, and how long it took.
  3. A failed task keeps its error message: read it there before retrying.
  4. Choose Refresh to update the list.

High availability1.7.3

A virtual machine marked for HA is restarted on another node when its own is lost — after a second node confirms it cannot reach the first, so a console that merely lost its own network does not fail everything over. When the lost node returns, the copy there is stopped and taken off autostart before it can write to the same disks. That obligation is written to the database with the failover itself, so it survives the console restarting.

Limits: Only virtual machines whose disks are on shared storage, and fencing goes through the returning node's own agent — a node whose agent is dead but whose guests are running cannot be fenced.

How to use it

  1. Put the VM's disks on a shared (NFS) container first — see Storage.
  2. Open the VM's tools, set a priority under High availability and Save. A VM with priority 0 is not restarted.
  3. Open Backups: the High availability card lists protected VMs and whether each definition was copied. Use Copy the definitions again after changing a VM.
  4. Open Automation to see that the watchdog and the other background jobs are running, and when each last ran.
  5. If a node is lost, its protected VMs start on another node after a second node confirms it cannot reach the first. The task and alert say which VMs moved.

Kubernetes1.7.5

Builds a k3s cluster out of virtual machines from a cloud image, and fetches the kubeconfig back for you.

Limits: Provisioning only. There is no workload view, no upgrade path and no reconciliation — once it is built, it is an ordinary k3s cluster you manage with kubectl.

How to use it

  1. Put a cloud image in the image library first: Nodes → ISO Library.
  2. Open Kubernetes and choose New cluster.
  3. Give it a Name, the k3s channel and the Cloud image, then how many Servers and Agents (workers), and vCPUs each, Memory each (MB) and Disk each (GB).
  4. Choose Build cluster. The machines are created as ordinary VMs and the progress shows on the page.
  5. When it is ready, choose kubeconfig and Copy or Download it, then use kubectl.
  6. Deleting the cluster here deletes its machines.

AI agents1.8.3

The console is an MCP server, so Claude Code, Codex, Agent Zero, Hermes, OpenCLAO or any other Model Context Protocol client can read and operate a cluster with nothing installed on the agent's machine: a URL and an API key are enough. One button creates the key and downloads a finished configuration. Every tool call goes through the console's own API with that key, so its role decides what the agent may do and every action appears in the audit log under it.

Limits: Read-only unless the address ends in ?write=1, and there is no tool that deletes anything and no command execution at all — by choice, not omission.

How to use it

  1. Open Agents.
  2. Pick your Client (Claude Code, Codex, or anything else that speaks MCP over HTTP) and the Key role: viewer to read, operator to act.
  3. Choose Create a key and download the config. The file holds this console's address (…/api/mcp) and the new key — nothing needs installing on the agent's machine.
  4. Put the file where your client reads it, as the page says for that client. For Codex, also set LEXIVIRT_API_KEY to the key.
  5. If the console still has its own first-run certificate, download its certificate authority from the same page and trust it on the agent's machine.
  6. Revoke the key in Settings → API Keys to cut the agent off.

HCI console1.9.0

A console for whoever runs the infrastructure rather than the virtual machines, on a port of its own (9440 by default) so it can be firewalled to the management network. Installing or updating LexiVirt sets that port up by itself. One page answers: is the cluster healthy, could it lose a node, when does it run out of room, what is each node and storage pool doing, what is alerting, what is running right now and which version is each part on. It reads the console's own API and uses the same sign-in, for administrators and operators; a viewer is told it is not for them. A figure that could not be collected is shown as unknown, never as zero, and when the console stops answering the page keeps the last data it had under a banner that says so.

Limits: Read-only. The node-failure check is about memory for the cluster as a whole: it does not look at disks, CPU or the network and does not check that a particular virtual machine fits in one node's remainder. A runway is a straight line through recorded history, for memory and the system disk only — not a forecast. Storage figures are what each node agent reports for its own containers; there is no physical-disk inventory. The same API also answers on the VM console's port, so the allow-list on the management port narrows what is exposed there and does not replace the sign-in. Setting the port up takes root: the default install has it, while a console moved to an unprivileged account prints the one command to run in its update log instead. The page is in English only.

How to use it

  1. Sign in as an administrator or an operator and choose HCI Console in the sidebar. A viewer does not see the link and is told the page is not for them.
  2. Read the verdict at the top, then Findings: each one says what is wrong and what it rests on. A verdict of Unknown means part of the cluster could not be read — it does not mean the cluster is fine.
  3. Work down the page: Nodes, Storage, Capacity runway, Resiliency & HA, Alerts, Tasks and Updates. The page refreshes by itself.
  4. It also has a port of its own, https://your-server:9440/hci, and installing or updating LexiVirt sets that up by itself — the update log prints the address. Sign in with your usual account; nothing else is needed. To choose another port or limit who may connect, run once as root on the console host: bash /opt/lexivirt/console/scripts/hci-port.sh --port 9550 --allow-from 10.0.0.0/24. A console that does not run as root cannot do the first setup itself and prints that command in the update log instead.
  5. To take the port away, run the same script with --remove; later updates then leave it off. To keep an update from adding it in the first place, run echo 0 | sudo tee /etc/lexivirt/hci-port before updating. The page stays available on the console's own port either way.

Administration

Projects1.6

Group virtual machines and the people who may touch them, so one team's machines are not another team's to start, stop or delete.

How to use it

  1. Open Projects and choose New project.
  2. Give it a Name and Description, and optional quotas: VMs, vCPUs, Memory (GB) and Storage (GB).
  3. Tick the Members — the people who may start, stop and delete its VMs — and Save.
  4. Put new VMs in it under Project & owner in the Create VM wizard, or move an existing VM there from its tools.
  5. Deleting a project leaves its VMs running; they stop belonging to a project.

Users and roles1.0

Local accounts in three roles — administrator, operator and viewer — with optional two-factor authentication. The role is read from the database on every request, so demoting somebody takes effect at once.

What it includes

  • Two-factor sign-in with any authenticator app (TOTP). Turning it on takes a working code, and eight one-time recovery codes are issued with it, stored hashed.
  • An administrator can clear two-factor for someone who has lost both their phone and their recovery codes; it is written to the audit log.

Limits: Accounts are local to the installation. There is no LDAP, Active Directory or SAML.

How to use it

  1. Open Users (administrators only) and choose Add user.
  2. Fill in Username and Email — people sign in with their email address — and pick the Role: administrator, operator, or viewer (sees everything, changes nothing).
  3. Leave the password empty and the console generates one and shows it to you once. Pass it on safely.
  4. To change someone's role, use the edit button on their row; it takes effect on their next request.
  5. Each person can turn on two-factor sign-in in Settings → Two-factor authentication → Set it up.

Security1.6

API keys for scripts and agents, each with its own role and revocable on its own, and the recent activity on the installation in one place.

What it includes

  • A REST API for everything the console does, under /api/v1/. The interactive reference is at /api/docs on your own console, for anyone signed in.
  • Scripts authenticate with an API key sent as Authorization: Bearer <key>. Only a hash of the key is stored, and it is shown once.
  • Each key has its own role — a read-only integration gets a viewer key — and each can be revoked on its own.

Limits: There is no LexiVirt command-line tool and no Terraform provider or Ansible collection: automation calls the HTTP API directly, with curl or any HTTP library.

How to use it

  1. Open Security (administrators only).
  2. Review the accounts and the recent activity; Full audit log opens everything.
  3. For a script or agent, choose Create an API key: it opens Settings → API Keys. Choose New key, give it a Name and the smallest Role that does the job.
  4. Copy the key when it is shown; it is not shown again.
  5. Revoke a key from the same list when it is no longer needed. Nothing else stops working.

Using the REST API

  1. Create a key: Settings → API Keys → New key, with the smallest Role that does the job. Copy it when it is shown.
  2. Open /api/docs on your own console while signed in: every endpoint, its parameters and its answers, and a way to try each one.
  3. Send the key with each request, for example: curl -H "Authorization: Bearer $KEY" https://<your-console>/api/v1/nodes
  4. Slow operations — creating VMs, copying images, migrations — answer with a task id at once. Read its progress at /api/v1/tasks/<id>.
  5. To read a VM's definition out of Proxmox, VMware or an OVF package, POST the .conf, .vmx or .ovf text to /api/v1/migrate/parse as {"text": "…"}. You get back its CPUs, memory, disks and network cards, the steps still to do, and a warning for everything that will not come across. Nothing is created.

Audit log1.2

Who did what, when, and from where — written per action by the console that performed it. Actions on a node are recorded by that node, not copied here: two logs that disagree are worse than one in the right place.

How to use it

  1. Open Audit Logs.
  2. Each row has the Time, the User, the Action, the Resource it was done to, Details and whether it succeeded.
  3. The newest entries come first; use the browser's find (Ctrl+F) to look for a name.
  4. Actions done on a node are recorded by that node; look there for them.

Files1.5

A shared drive for administrators: upload a file from one machine and download it from another, with nothing but the console sign-in. Installer ISOs and cloud images are not kept here — they have their own library on the Nodes page, which takes them once and relays them to every node chunk by chunk, so the console never holds a whole image in memory.

How to use it

  1. Open Files (administrators only) and choose Upload.
  2. Pick any file. It is stored on the console host under a random name, with who uploaded it and when.
  3. Sign in from the other machine, open Files and download it from the Actions column.
  4. Delete it when it has arrived. ISOs and disk images do not go here: they go in Nodes → ISO Library.

Terminal1.6

A shell on the console host, in the browser, as the account the console runs as — not as root, once the console has been moved onto its own unprivileged account.

How to use it

  1. Open Terminal (administrators only).
  2. A shell opens on the console host, as the account the console runs as.
  3. If the connection drops, choose Reconnect.
  4. Use it for the commands the readiness report and alerts suggest; anything on a node itself is done over SSH to that node.

Settings1.4

Thresholds for alerts, notification delivery, session length, appearance, what each node is told about time and name servers, and what this installation reports about itself.

What it includes

  • An address allowlist for the console. It has to include the address of whoever saves it, so nobody locks themselves out.
  • Cluster lockdown: SSH to every node by key only. It is refused on a node whose root account has no authorized key.
  • Session length from 1 hour to 30 days, a minimum password length from 10 to 72 characters, an optional rule that a password mixes letters and digits, and a sign-in banner.

How to use it

  1. Open Settings.
  2. Under Account Settings, change your password; under Two-factor authentication, choose Set it up, scan the key, enter The code it shows and Turn it on.
  3. Administrators: under Console & security, set how long a sign-in lasts, the shortest password, the language, a sign-in banner, and which addresses may reach the console. Save.
  4. Under Node settings, set Time servers and Name servers and choose Apply to every node.
  5. Under Alerts & notifications, set delivery and thresholds and choose Send a test.
  6. Under API Keys, create and revoke keys for scripts and agents.
  7. Under What this installation reports, see the two values sent with the update check, and untick Report these two values with the update check to stop it.

Updates1.2

One pass updates the console and every node agent it can reach, each reported by name. The page shows which version is running against which is installed, because an update that synced files and never restarted is the failure that silently voids every fix in it.

What it includes

  • Versions, from 1.9.2: install any published release from 1.8.0 on, newer or older, on the whole cluster, on the console alone, or on one node. Going back is the same operation as going forward.
  • Before every version change the console saves a snapshot of its own code and keeps the last five; putting one back works without reaching the update server.
  • Upload a release package for a console that should not download from the internet. One identical to a published release is that release; anything else is an unofficial build, which may go on the console only, after its version is typed to confirm.
  • A node taken back to an older version is held there, so the hourly pass does not bring it forward again, until someone installs the newest or releases the hold. Going back on the console turns automatic updates off for the same reason.

Limits: Node agents install published releases only, and nothing older than 1.8.0 is offered. The database is never rolled back: schema changes only add, so an older console reads a newer database.

How to use it

  1. Open Updates (administrators only). It shows the version that is running, the one installed, and whether a newer release exists.
  2. Install the update. The console and every node agent it can reach are updated, each reported by name.
  3. If the page says the installed version is newer than the running one, choose Restart console now — an update that is installed but not restarted has not taken effect.
  4. To install updates on their own, set Automatic Updates in Settings: as soon as a release appears (checked hourly) or at a time you choose.

Going back to an earlier version, or forward to a chosen one

  1. Open Updates and scroll to Versions. The table at the top says which version the console and each node run, and which nodes are held.
  2. Under Published releases, choose Roll back… (or Upgrade…) next to the version you want.
  3. In the dialog, pick Whole cluster, Console only or One node. What happens lists every step for that choice, node by node, before anything runs.
  4. Confirm. The task saves a snapshot of the console first, then installs; follow it on the Tasks page.
  5. To undo, choose Snapshots and Restore… the snapshot taken just before. To let a held node follow new releases again, choose Release hold on its row.

Readiness1.0

What stands between this installation and running its first virtual machine: each finding with its severity, why it matters and the command that fixes it. A check that cannot say what to do is left out.

How to use it

  1. Open Dashboard — it is the page the console lands on after you sign in.
  2. Read the readiness list from the top: each finding has a severity, why it matters, and the command or page that fixes it.
  3. Fix the findings marked as blocking first; they are what stands between the installation and its first virtual machine.
  4. Use Create VM on the dashboard to start a VM, or All VMs to go to the full list.
This page is generated from the product itself. A test fails if a page exists in the console with no entry here, so a feature cannot ship without appearing on this page.