Blesta

The VirtConsole module for Blesta automates the instance lifecycle from order to termination. It covers:

Creation
Suspension and unsuspension
Termination
Package upgrades. Downgrades error where the storage size would shrink.
A client-area Manage tab with a one-click SSO login into the panel

Before you begin

A working panel with at least one instance plan. See Quick setup.
A billing API token, generated on the management server with vcli api:billing-token generate. See API tokens.

Install the module

The module is open source. Download the latest Blesta module archive from the VirtConsole package host at https://packages.virtconsole.com/, unzip it and copy the contents into the root directory of your Blesta installation.

Your module path should look like /var/www/html/components/modules/hypervisor_v2/hypervisor_v2.php.

Then activate it in Blesta:

In the Blesta admin area, go to Settings > Modules.
Open the Available tab.
Find Hypervisor V2 and click Install.

Connect to the panel

The module uses module rows (servers) for the connection. In the Blesta admin area, open the installed Hypervisor V2 module and add a module row with:

Field	What to enter
`Name`	A label you recognise in lists.
`Hostname`	Your management server hostname.
`API Access Token`	The billing API token generated with `vcli api:billing-token generate`. See API tokens.

The token is stored encrypted by Blesta. The module always connects over HTTPS and does not verify the management server’s certificate, so a self-signed certificate or an IP address works. Where you can, still use a hostname with a valid certificate: the API token travels over this connection.

Product and configurable options

On the package (product) in Blesta, the module adds these fields. The plan and group values are IDs; you find the ID of each object on the panel when you open it for editing.

Field	What to enter
`Plan`	The ID of any instance plan from your management server.
`Hypervisor Group ID`	The ID of the hypervisor group to deploy into. Instances deploy onto an available hypervisor from this group.
`Hypervisor`	The ID of a specific hypervisor, used together with the override option below.
`Override Hypervisor Group/Region`	Tick to change how the deployment target is chosen.

When an order provisions, the module finds or creates the panel user by the customer’s email address, then creates the instance with the package’s plan and target. The service stores the instance ID, the panel user ID and a label, visible to admins on the service in Blesta.

Client area

The customer’s service page gets a Manage tab. It shows a Virtual Machine Access card with the instance’s IP address and live status, and a Launch Control Panel button that signs the customer straight into the user panel with SSO to manage the instance.

Power control, reinstall and other instance actions are not offered inside Blesta; customers use the panel for those after the SSO login.

Common problems

The module does not appear under Settings > Modules. The files are not in components/modules/hypervisor_v2/ under the Blesta root. Check the path and reload the modules list.
Provisioning fails with an authentication error. The API Access Token on the module row is wrong, disabled, or IP-restricted to a different address than the Blesta server. Generate a fresh token with vcli api:billing-token generate using the Blesta server’s IP.
Upgrade fails with a storage error. The new plan’s disk is smaller than the current one. Disk shrinks are refused; move the customer to a plan with an equal or larger disk.
The Launch Control Panel button shows an error. The panel cannot be reached from the Blesta server, or the stored instance no longer exists. Check the hostname and the instance on the panel.

For panel-side issues, see the FAQ.