Brief Overview of Cloudmodule
Cloudmodule is a shared library for the BillManager6 billing platform that adds additional features for interacting with instances.
The full list of changes for cloudmodule can be found at this link
Supported OS
-
AlmaLinux 9
-
Instances
-
Stop
-
Start
-
Reboot
-
Rescue
-
Boot from ISO
-
Unrescue
-
Rebuild
-
Change Password
-
Snapshots
-
Backups
-
Scheduled Backups
-
-
Images
-
Ability to upload your own image from a URL and use it for the instance as a boot source.
-
Installation Process
To install Cloudmodule, you can download the installation script and run it as the root user:
curl -fsSL https://repo.zomro.com/get-module.sh -o get-module.sh
sudo sh get-module.sh
During the installation, BillManager will be restarted, so make sure that nothing important is running during the installation.
Post Installation
After installation, you can log into your admin account,
go to the Product types tab and notice the Auth Details and Import Itemtype buttons.
Go to the Auth Details section and paste the actual connection information for your Zomro account.
In the URL field, paste https://api.zomro.com/billmgr
.
After clicking the OK
button, you will be redirected to the Product types page, where you can proceed to import the necessary product types.
Click Import Itemtype and select what you want to import (usually instances and images are imported).
There may be a bug where nothing happens when you click the
OK
button; just click it again, and everything will work.
After importing item types, you need to restart BillManager for the changes to take effect.
To synchronize statuses, you need to add the sync.sh
file to the /usr/local/mgr5/addon
directory with the following content:
#!/usr/bin/sh
/usr/local/mgr5/sbin/mgrctl -m billmgr instances.sync elid=${PARAM_elid} sok=ok
To automatically create backups on a schedule, add the following cron job:
*/10 * * * * /usr/local/mgr5/sbin/mgrctl -m billmgr bckps_schedule.cron >/dev/null 2>&1
Importing Tariff Plans
To import tariff plans, you can use the standard processing module of BillManager:
-
Go to the «Data Centers» section and add a new data center without an external identifier (it will be added later).
-
Go to the Processing Modules section and create a new processing module for BillManager linked to the new data center created in step 1
(use the same credentials as in the Auth Details form).
More detailed information can be found here.
-
Now you can import tariff plans related to the product types Instances and Images.
Not all parameters will be imported; after this, you need to manually configure the tariff parameters.
-
Return to the «Data Centers» section and add an external identifier to the data center created in step 1.
This should be the region where the boot sources are stored. Currently, it is Netherlands-2.
Features Overview
Cloudmodule provides additional capabilities for interacting with services. Here is a brief overview of each of them:
Rescue
The Rescue mode connects an image to your instances. You can choose one of the public images or upload your own.
Boot From ISO
Connects an ISO image to the instance. Currently, only public images are supported.
Unrescue
Available for instances in rescue or booting from ISO state. This function detaches the image and reboots the instance.
Rebuild
Installs the OS on the instance. Note that during the installation, all data on the instance will be lost.
The installation can be performed from public images or your own.
Snapshots
Displays a list of snapshots associated with the selected instance and provides buttons for interacting with the snapshots.
Backups
Displays a list of backups associated with the selected instance and provides buttons for working with the backups.
Backup Schedules
Displays a list of backup schedules associated with the selected instance and provides buttons for interacting with the backup schedules.
We also suggest studying articles that may be useful for interacting with Cloud VPS products using the API:
- API - Creating a Service
- API - Obtaining Information About Available Tariffs and Their Parameters
- API - Operation Start & Stop
- API - Operation Reboot
- API - Operation Rebuild
- API - Operation Delete
- API - Interaction with Backup Schedule
- API - Interacting with Rescue
- API - Interaction with Backup
- API - Interacting with Snapshots
- API - Interacting with Boot From ISO
- API - Interaction with Image