This project contains the source code for an implementation of using Proxmox as a Web Cloud Provider in VISA.
VISA (Virtual Infrastructure for Scientific Analysis) makes it simple to create compute instances on facility cloud infrastructure to analyse your experimental data using just your web browser.
See the User Manual for deployment instructions and end user documentation.
The VISA Cloud Web Provider Proxmox providers a RESTful web service for interacting with the Proxmox API. VISA can be configured to use a web provider that will contact your cloud provider of choice.
npm install
npm start
The application requires environment variables to be set. These can be in a .env file at the root of the project. Details of the environment variables are given below.
The following environment variables are used to configure VISA Cloud Web Provider for Proxmox and can be placed in a .env file:
| Environment variable | Default value | Usage |
|---|---|---|
| VISA_WEB_PROVIDER_PROXMOX_SERVER_PORT | 4000 | The port on which to run the server |
| VISA_WEB_PROVIDER_PROXMOX_SERVER_HOST | localhost | The hostname on which the server is listening on |
| VISA_WEB_PROVIDER_PROXMOX_SERVER_AUTH_TOKEN | The expected x-auth-token value |
|
| VISA_WEB_PROVIDER_PROXMOX_LOG_LEVEL | 'info' | Application logging level |
| VISA_WEB_PROVIDER_PROXMOX_LOG_TIMEZONE | The timezone for the formatting the time in the application log | |
| VISA_WEB_PROVIDER_PROXMOX_LOG_SYSLOG_HOST | The syslog host (optional) | |
| VISA_WEB_PROVIDER_PROXMOX_LOG_SYSLOG_PORT | The syslog port (optional) | |
| VISA_WEB_PROVIDER_PROXMOX_LOG_SYSLOG_APP_NAME | The syslog application name (optional) | |
| VISA_WEB_PROVIDER_PROXMOX_ENDPOINT | URL of proxmox API (ends with /api2/json/) |
|
| VISA_WEB_PROVIDER_PROXMOX_TIMEOUT | Timeout of HTTP calls to proxmox | |
| VISA_WEB_PROVIDER_PROXMOX_USER | Username of proxmox API token (user@realm!tokenname) | |
| VISA_WEB_PROVIDER_PROXMOX_PASSWORD | Proxmox API token password | |
| VISA_WEB_PROVIDER_PROXMOX_SELECT_COEFF | 4294967296 | Ratio of CPU to ram for load balancing |
| VISA_WEB_PROVIDER_PROXMOX_METADATA_SERVER | URL of the metadata server (must be accessible from the VM) | |
| VISA_WEB_PROVIDER_PROXMOX_PROJECT_ID | Unique ID that you can choose and will be passe to the instance. It can be used to distinguish between dev/preprod/prod env. | |
| VISA_CLOUD_SERVER_NAME_PREFIX | 'VISA_INSTANCE' | Prefix for instance name in proxmox |
| VISA_CLOUD_SERVER_MAX_START_RETRY | 10 | Proxmox sometime return that a clone is finished before it's true, and so we try to start it too early. This parameter allows to retry multiple time before deciding that there's a problem. |
| VISA_WEB_PROVIDER_PROXMOX_CONNECTOR_HOST | PostgreSQL host | |
| VISA_WEB_PROVIDER_PROXMOX_CONNECTOR_PORT | 5432 | PostgreSQL port |
| VISA_WEB_PROVIDER_PROXMOX_CONNECTOR_DATABASE | PostgreSQL database | |
| VISA_WEB_PROVIDER_PROXMOX_CONNECTOR_SCHEMA | PostgreSQL schema | |
| VISA_WEB_PROVIDER_PROXMOX_CONNECTOR_USERNAME | PostgreSQL username | |
| VISA_WEB_PROVIDER_PROXMOX_CONNECTOR_PASSWORD | PostgreSQL password |
In order for cloud init to work correctly, we need to run an HTTP server that will return user-data and meta-data for a given instance.
cd metadata-server
npm start
The metadata use SQLite for database. It contains no essential information, so it don't really need to be backed up.
| Environment variable | Default value | Usage |
|---|---|---|
| VISA_WEB_PROVIDER_PROXMOX_LOG_LEVEL | 'info' | Application logging level |
| VISA_WEB_PROVIDER_PROXMOX_LOG_TIMEZONE | The timezone for the formatting the time in the application log | |
| VISA_WEB_PROVIDER_PROXMOX_LOG_SYSLOG_HOST | The syslog host (optional) | |
| VISA_WEB_PROVIDER_PROXMOX_LOG_SYSLOG_PORT | The syslog port (optional) | |
| VISA_WEB_PROVIDER_PROXMOX_LOG_SYSLOG_APP_NAME | The syslog application name (optional) | |
| VISA_WEB_PROVIDER_PROXMOX_SERVER_HOST | localhost | The hostname on which the server is listening on |
| VISA_WEB_PROVIDER_PROXMOX_SERVER_PORT | 4001 | The port on which to run the server |
| VISA_WEB_PROVIDER_PROXMOX_METADATA_HOST | PostgreSQL host | |
| VISA_WEB_PROVIDER_PROXMOX_METADATA_PORT | 5432 | PostgreSQL port |
| VISA_WEB_PROVIDER_PROXMOX_METADATA_DATABASE | PostgreSQL database | |
| VISA_WEB_PROVIDER_PROXMOX_METADATA_SCHEMA | PostgreSQL schema | |
| VISA_WEB_PROVIDER_PROXMOX_METADATA_USERNAME | PostgreSQL username | |
| VISA_WEB_PROVIDER_PROXMOX_METADATA_PASSWORD | PostgreSQL password |
There is no flavour in proxmox, thus you need to manually create them in the flavour table of the proxmox connector database.
VISA has been developed as part of the Photon and Neutron Open Science Cloud (PaNOSC)
PaNOSC has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreement No 823852.