The Upmind integration (provider version 0.1.0) is a provider in Upmind's servers provision category (upmind/provision-provider-servers), registered as Servers / VMStack. One Upmind service is one panel server. It covers the server's life cycle, resizes, reinstalls, rescue and single sign-on; it has no add-ons or usage billing.
Requirements#
- PHP 8.1 to 8.3, as the provision package.
- The panel reachable over HTTPS with a valid certificate.
- A panel API key as described in API key for a billing system, with an allowed address for the address Upmind calls from.
Install#
Upmind runs providers from its provision packages. To test the provider yourself in Upmind's provision workbench:
- Get
vmstack-upmind-<version>.zip(see Integrations); from the source,php bin/build-vmstack.phpwrites it todist/. - Unzip it into the workbench's
local/directory. - In the workbench:
composer require upmind/provision-provider-servers:@dev
php artisan upmind:provision:cache
- Create a Servers / VMStack configuration (below).
For use in your Upmind account, the provider has to be available in Upmind's provision catalogue; ask Upmind support or contact us.
Configuration#
| Field | Required | Meaning |
|---|---|---|
hostname |
yes | the panel's domain, such as panel.example.com (no scheme, no path) |
api_key |
yes | the key (vmk_…) |
reseller_id |
no | administrator keys only: the reseller new accounts go under. Empty: the panel's own customers |
customer_can_create_servers |
no | new accounts get May create and delete servers |
customer_setup |
no | new servers wait in Awaiting setup (customer setup); the order's image is offered first |
delete_customer_on_terminate |
no | delete the owner's account after its server is gone (the panel refuses while it owns something else) |
suspend_reason |
no | what the owner reads on a suspended server (default "Overdue invoice") |
timeout |
no | request timeout in seconds, 1 to 180 (default 20) |
There is no test-connection function: a wrong key or a missing scope shows up at the first create. A user's key is refused ("The API key belongs to a user account. Use an administrator or reseller key."). The scopes used are those in the scope table except usage:read.
Product values#
| Value | Accepts |
|---|---|
location |
a location ID or location:<id>, group:<id> for a node group, node:<id> for a node, or a location's name |
size |
a plan ID or an active plan's name. Without it, cpu_cores, memory_mb and disk_mb are used, which needs node:<id> and an administrator's key |
image |
an image ID, or an enabled image's slug or name |
label |
becomes the hostname |
root_password |
optional; checked by the panel (12 to 72 characters) |
Customers are matched by their Upmind client ID, then by email, as described in How accounts and servers are matched.
Functions#
| Upmind function | Panel |
|---|---|
| create | creates the server (SSH password login on) |
| getInfo | state (Awaiting setup, Building, Running, Stopped, Rescue, Suspended, Error, Deleting), main address, size, other addresses, NAT address and SSH port, traffic |
| getConnection | a sign-in link to the server's page, or with console a console link |
| changeRootPassword | resets the root password (the server restarts) |
| resize | upgrades to the new plan or size; refused while running unless the call allows it |
| reinstall | reinstalls with the given image |
| reboot, shutdown, powerOn | power actions (idempotent) |
| suspend, unsuspend | suspends and lifts the suspension |
| attachRecoveryIso, detachRecoveryIso | start and end the rescue system (the rescue password is in the panel) |
| terminate | deletes the server |
Limitations#
- No add-ons, usage billing, reverse DNS, firewall, backups, ISOs, port forwards or SSH keys.
- The server gets no
external_id, so it is found by its panel ID only. - Sign-in links are not bound to the client's address.
- No downgrades.
- Actions are not sent on behalf of the customer, so the plan's customer permissions do not apply to them.