It enables them to order and manage their instances, backups, and other resources directly from your WHMCS client area.
At the same time, it provides administrators with full visibility and control over all deployed servers from a single interface.

We will guide you step by step through the whole installation and configuration process.

The content of the package to upload should look like this.

The file is located in 'modules/servers/OpenStackVpsCloud/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

Enter your license key between quotation marks as presented on the following screen.
You can find your license key in our client area → 'My Products' .

This folder is available at 'your_whmcs/modules/servers/OpenStackVpsCloud' .

Use cron job below but switch the 'your_whmcs' with your root WHMCS path.

php -q /yourWHMCS/modules/servers/OpenStackVpsCloud/cron/cron.php queue 

To do so, log in to your WHMCS and navigate to 'System Settings' →'Addon Modules'. Find 'OpenStack VPS & Cloud' and press 'Activate'.

To do so, click on the Configure button, select Full Administrator, and then press Save Changes.
Important: The administrator responsible for setting up OpenStack products must have access to the addon module.
Otherwise, the server configuration will not be completed successfully.

Go to the 'Setup' → 'Products/Services' → 'Servers' and press 'Add New Server'.

Important: The module supports OpenStack providers that allow access to the OpenStack API with project admin-level permissions or higher.
The list in the 'Features' section includes key examples, but other providers can also be used, as long as the account has the necessary rights to perform actions through the API.
Learn more about access roles in the OpenStack API guide.

• Provide your OpenStack IP address or hostname.

• Module – select OpenStack VPS & Cloud from the dropdown menu.
• Username and Password – enter your OpenStack administrator credentials.
• Click the Configure button to open the server configuration window:
  • Identity Port/Path – specify the API endpoint port or path if used. You can find it in the OpenStack API Access section under Service Endpoint.
    The path segment appears between the hostname/IP and the port/API version. Leave this field empty if not required.
  • Identity Version – select the OpenStack Identity API version (v2 or v3).
    Important: If the dropdown list is empty, verify that your IP/Hostname, Identity Path, Secure, and Port fields are filled in correctly.
  • Tenant ID – enter your administrator Tenant ID.
    Note: To locate the Tenant ID, log in to the OpenStack panel and navigate to Identity → Projects. Find your project row and copy the value from the Project ID column.
  • Domain – optionally, provide your OpenStack domain name or leave as Default.
  • Certificate – optionally, enter the full path to your SSL certificate for verification (leave empty if not applicable).
  • Project Name – enter the project name associated with this server (leave empty if not applicable).

• Click Reload Endpoints to automatically detect available service endpoints from OpenStack.

• Additional fields:
  • Region – select the region (e.g., RegionOne).
  • Compute, Identity, Image, Network, Volume, Metric – choose between public or internal for each endpoint type, depending on your OpenStack setup.

• If your OpenStack environment uses HTTPS or a custom port, configure them using the Secure and Port fields.

Finally, click Confirm - the system will automatically generate the Access Hash used for server communication.

Simply, edit the previously created server and press 'Test Connection' as shown on the screen below.
During the test, the connection with all related endpoints will be checked.

For more information about connections, visit the Common Problems and Tips sections.

Click on 'Create a New Group' .

To create a product click on 'Create a New Product' .

'Product Type' should be set to 'Shared Hosting'.

The App Templates section allows you to manage OpenStack images that clients can deploy to their virtual machines directly from the client area.
Use the interface to import, edit, group, and assign application templates to products.

• Click the refresh icon to import or update the list of templates from OpenStack.

Navigate to 'App Templates' → 'Groups' and click on the 'Create' button.

• Name
• Description
• Items to include

For now, go back to your product's module settings and complete the configuration there.

The module should automatically save and reload settings. If not, click on 'Save Changes' manually.

App Templates Configuration - To create instances based on operating systems or applications, you must first configure the App Templates in the module's addon.
Once your applications and groups are set up there, you can select the desired application in the product's Module Settings tab to be used during instance creation.
Please refer to the App Templates and App Templates Advanced Configuration sections of the documentation for detailed setup instructions.

• Default Application Group - The group of applications available for reinstalls. See the Groups section for more details.
• Default Application - The application that will be installed by default during creation. See the Applications section.

You can set up a network in two ways. You can find more information about the configuration here.
We will create the network without a floating IP address as presented on the following screen.
Additionally, choose a quantity of IP addresses assigned to a product by typing it into 'Default Number Of IP Addresses'.

• Backups
  

Enable 'Backups Rotation' if you want to allow replacing the oldest backup with a new one when the backup files limit has been reached.
Afterward, enter a number of allowed backups that can be created into the 'Default Backups Files Limit' field. Enter '-1' for unlimited.

You may also let your clients define the backups tasks, they will be then created automatically according to the defined time interval.
Select the 'Scheduled Backups' option and then set the minimum time interval which your clients will have to obey when defining their task schedule at 'Backups Time Interval'.
'Client Scheduled Backups' - if enabled client may manually add tasks to the scheduled tasks.
Note: The number of backups created manually and those scheduled and created automatically is counted together and their overall sum cannot be higher than the defined limit.

• Snapshots
  

Define a default number of allowed snapshots. Enter '-1' to set it to 'Unlimited'.
Important: The option Use Volumes must be enabled under the 'Virtual Machines Settings' in order to let clients create snapshots.

• Mark a security group from 'Use Security Groups' and select 'Console Type'.
  Apart from the selected here groups you may also apply custom rules to the VM. You can learn more about them at Custom Security Group section.

• If you wish to use SSH keys, leave 'Generate SSH Key' marked (virtualization has to support the 'Inject File' feature).
  

Full list of supported features can be found here.
Important: It is recommended to leave 'Delete SSH Private Key' marked.

• The following types of console can be chosen: 'VNC', 'RDP', 'SPICE' and 'Serial'.

To do so, make sure to tick the 'Use Volumes' checkbox and enter the desired number into the 'Default Volume Size' field.
Once this option is enabled, your clients will no longer have access to the 'Rescue' function, so you may as well leave the respective fields empty.
Note: Scheduled backups cannot be generated when volumes are in use; only manual backups are available.

Enter the firewall inbound, outbound and total rules limits. When the limit is reached, the client will not be able to create a new rule until one of the existing rules has been removed.

You can also decide which images used to rebuild the server will be available to your customers.

This feature can prove useful if you want clients to receive the notification once their VM is ready rather than immediately after product activation.
If you decide on this option, we suggest that you also set the standard WHMCS configuration of the 'Welcome Email' to 'None' in the 'Details' tab of a product.
Otherwise, the customer will receive both emails - after the product has been activated and after the VM has been successfully created on OpenStack.
Press 'Save Changes' when you are done.

In this section, we will show you the configuration of a VPS with predefined resources.
Detailed information about the configuration of VPS with resources chosen by a client can be found here.

'Default Flavour' defines resources assigned to a VM, while 'Default Application' allows you to choose the VM image used to create a new VM.

It will prepare default configurable options which can be easily edited afterward as described in this article.
Important: Configurable option 'flavor|Flavor' will be overwritten by 'disc|Disc', 'ram|RAM' and 'vcpus|VCPUs'.
Therefore, you can solve this in three ways:

• Disable 'disk|Disk' , 'ram|RAM' and 'vcpus|VCPUs' configurable option and rely completely on 'flavor|Flavor' .
• Disable 'disk|Disk' and 'vcpus|VCPUs' , and allow 'flavor|Flavor' being overwritten by 'ram|RAM' (multiple combinations are allowed here).
• Disable 'flavor|Flavor' and rely completely on 'disk|Disk' , 'ram|RAM' and 'vcpus|VCPUs' .

Note: The second and the third options result in the creation of a new flavor on your server each time a new order is made.

Supported 'Custom Flavor Specification' format:

key1=value1
key2=value2

for example:

hw:cpu_sockets = 3
CIM_PASD_ProcessorArchitecture=x86

Select 'Apply Custom Rules' option at Virtual Machine Settings and enable 'Firewall' option in the client area.

That is what a default content of the additionalRules.json file looks like:

• direction - "egress" or "ingress"

• ethertype - "IPv4" or "IPv6"

• description - "your rule description" - visible in the panel only

• remote_ip_prefix - IP address, format bound to the ethertype field, e.g.: "::/0"

• port_range_min - value between 1 and 63535, eg: "101"

• port_range_max - value between 1 and 63535, e.g.: "200"
  In case you enter the same value in the 'port_range_min' and 'port_range_max', then one port will be set, not a range of ports.

• protocol - enter one of the following: "tcp", "udp", "icmp", "custom"
  Important: 'Protocol' must be provided if 'port_range' has been defined.

Important: When you are updating your module, and you do not want to overwrite your personalized additionalRules.json file you do not have to do anything.
The file in the newest version of the module is named: additionalRules.json_sample and it will not overwrite the file in your system.

This section is intended for advanced users and administrators who want to manually manage imported virtul machine images.

To import or refresh templates in WHMCS:

• Navigate to Addon Module → App Templates.
• Use the refresh icon to load the latest images from your OpenStack server.
  

Once imported, the image templates can be grouped and assigned to specific products within WHMCS, no further manual steps are required.

Important! Only images that already exist in OpenStack are supported. There is no need to create templates manually in WHMCS.

• Grouped under App Templates → Groups
• Assigned to specific WHMCS products in the product module settings.
  

No additional manual configuration is required for them to be used in provisioning.

• Click the Edit icon next to a template.
• In the Virtual Machine Image Details section, you can:
  • Update the name, description, and status
  • Upload or change a custom icon for visual presentation
• Review internal configuration values (Setting Details)

Metadata is now applied per individual application (image) instead of per product as in previous versions. If needed, simply fill in the metadata details as shown in the example below.

key1=value1
key2=value2

For example:
sw_database_cassandra_admin=cassandra
sw_webserver_apache_http_port=80
admin_password=custom_password

The configuration of custom initialization scripts (Cloud-Init) has been moved from the module settings to the App Templates section in the addon module.
Each application (image) can now include its own script defined in the user_data field, which will be executed automatically when the instance is created and booted for the first time.
This approach allows scripts to be managed directly per application template, just like metadata.

Important notes:

• Scripts can be written in standards such as Bash or YAML.
• You can find example Cloud-Init configuration scripts here.
• The script must be supported by the operating system used by the VPS instance.
• Use only if you are familiar with Cloud-Init syntax; an incorrect script may prevent the instance from booting properly.

Below is an example of a simple Cloud-Init script defined in the user_data field that sets a new root password for Ubuntu:

#cloud-config
debug: True
ssh_pwauth: True
disable_root: false
chpasswd:
  list: |
    root:newpass01
  expire: False
runcmd:
  - sed -i'.orig' -e's/without-password/yes/' /etc/ssh/sshd_config
  - service ssh restart

This configuration ensures that the root password is updated and SSH access is properly enabled when the instance starts.

You can use the Related Field inside the user_data script to dynamically pass product or client information.

#cloud-config
runcmd:
  - echo "Client ID: {$userid}" >> /root/whmcs_info.txt
  - echo "Service ID: {$serviceid}" >> /root/whmcs_info.txt

Important: If you want to use braces { } in your script without including a variable, wrap them with {literal}{/literal} to avoid template parsing errors.

Use the Additional Actions to delete all images at once.
To upload a new image, use the 'Upload Image' button.

It allows you to view and interact with task details, including task IDs, statuses, and related items.
You can filter tasks, execute actions like deleting or running tasks, and even use mass actions for bulk operations.
For detailed guidance on using this tool, please refer to the dedicated article available here.

Prepare translations for the original English files with this handy built-in tool. For specific instructions on how to use this tool please refer to its dedicated article, you will find it here.

For precise details on Logs, please refer to our dedicated documentation article, which you may find here.

You can monitor and manage each product from your WHMCS admin area.
1. Module commands (Create, Suspend/Unsuspend, Change Package)
2. Service actions (Start/Stop VM, Pause/Unpause VM, Soft/Hard Reboot, Rescue/Unrescue VM, Change Protection)
3. Service management (Change Password, Change Protection, Console) 3. Instance details along with

• Interfaces,
• Volumes (you will see the 'Volumes' section if you enabled the 'Use Volumes' feature),
• Virtual Machine Images available for reinstallation
• Firewall: add/delete rule
• Backups: create, restore, manage, delete
• Snapshots: create, restore, delete
• Schedule Tasks: run, delete

Additionally, you are able to set up pricing for each configurable option, which make your offer even more competitive.
Important: VPS is not created immediately after ordering 'Create' . Therefore, it is wise to inform your clients about the delay.

1. Firstly, manually create an order for your customer in WHMCS. Choose a client and in the summary view, click on the ' Add New Order' button. Next, select a 'Product/Service' and press 'Submit Order' .
What is important, do not perform the 'Create' action. The status has to remain as 'Pending' .
More info about placing orders can be found here
2. Proceed to the newly created product's card in your admin area. Find the following empty fields:

• VM ID

The above-mentioned information has to be consistent with the data from your OpenStack panel. Now, complete these fields as presented below.
Important! Remember to make sure that the format of the provided data is compatible with the format supported by the module. You can preview it for another product of the module you have already created and enter it in a similar way.
If you completed the required data, now change the status from 'Pending' to 'Active' and 'Save Changes' .

The module enables your customers to easily start/stop, pause/unpause, resume, soft reboot, and hard reboot their servers by pressing the corresponding button.
Clients can also rebuild the server, access the VNC console, create a backup, manage firewalls, and view scheduled tasks.
At 'Scheduled Tasks' , your customers can view all requested tasks that were not yet completed.
Each task has additional information bound to it, like the type of task, the number of attempts to perform tasks, or the last returned response.

To reinstall your server, choose an image and confirm through pressing the 'Reinstallation' button and confirm the action.

The rescue VM will be launched to permit the user to fix their VM.

When you want to disable the rescue mode, click the 'Unrescue' button. The VM status will then also return to 'ACTIVE'.

Moreover, a new root password will be generated and the VM status will change to 'RESCUE'.
The new VM will also have a rescue image as the primary filesystem and the secondary filesystem would be the original VM's primary file system.

In this section, you will find three different categories related to backups and their management.
At the very top, you will find a current list of existing and available backups with details on their status, creation date, pinned information and action buttons.
Underneath, you may create backups manually at any moment you need. From the 1.9.0 module version, volume backups on demand are also supported.

Manual backups can be created on:

• virtual machines with volumes
• virtual machines without volumes
  

Scheduled backups can be created on:

• virtual machines without volumes

Note: If your backup is 'Pinned', then it will not be overwritten by the next scheduled backup. You may pin more than just one backup.

Note 1: Sometimes it may take up to several dozen minutes to finish creating the backup. Please wait until the process is complete.
Note 2: If there has been a limit set on the number of allowed backups and you have just reached that restriction, then a backup with the earliest creation date will be removed to make room for the new on.

When enabled, provide a time interval to wait until the next backup is created to define the task's routine. The entered time interval must be higher than or equal to the limit specified by your administrator.
Note: The number of backups created manually and those scheduled and created automatically is counted together, and their overall sum cannot be higher than the defined limit.

If selected backups are no longer needed, you may easily delete them.

To access it, simply click on the 'Console' button.

The selected status of this protection will be applied to both admin area and client area.

To add a new firewall rule, use the button marked on the following screen.

Press 'Confirm' when ready.

Once the shutter has been created, the customer can restore it, change its description or delete it.

Please note that taking a new snapshot may take a while to process.

The first one is a network without a floating IP address.
To set up this type of network, choose 'Public' as 'Fixed Network' and 'Disabled' as 'Floating Network' .
On the following screen you can view an exemplary topology of such a network.

Select 'Shared Network' as 'Fixed Network' and 'Public' as 'Floating Network' .

To do so, go to 'Setup' → 'Products/Services' → 'Configurable Option' and press the edit button next to a configurable option used by your product.
Its name is 'Configurable options for your_product_name' .

Now we will show you how to edit options. Let's say that you want to add an option to order VPS with 8GB (8192 MB) RAM.
To do so, edit 'ram|RAM' by pressing the edit button as shown on the screen below.

To add a new option, enter it in a textbox under all other options. If you want to replace it with an option you currently have, simply edit its text box.
Next, press 'Save Changes' .

Tasks visible at 'Scheduled Tasks' are subsequently performed by a cron job.
Full list of tasks supported by 'Scheduled Tasks' are: create, terminate, change package, remove IP address and remove backup.

In a properly configured OpenStack server, wget from WHMCS server should be able to get any data from any admin endpoint.
Sample successful requests:

wget openstack:9292
--2014-03-31 09:35:24-- http://openstack:9292/
Resolving openstack(openstack)... 192.168.1.222
Connecting to openstack(openstack)|192.168.1.222|:9292... connected.
HTTP request sent, awaiting response... 300 Multiple Choices
Length: 520 [application/json]
Saving to: `index.html'

100%[==========================================================>] 520 --.-K/s in 0s

2014-03-31 09:35:24 (118 MB/s) - `index.html' saved [520/520]

wget openstack:8777
--2014-03-31 09:41:05-- http://openstack:8777/
Resolving openstack(openstack)... 192.168.1.222
Connecting to openstack(openstack)|192.168.1.222|:8777... connected.
HTTP request sent, awaiting response... 401 Unauthorized
Authorization failed. 

When creating a VM:

• set up the password using a custom script, details are described here
• the module sends the password entered by a user, however, in order to set this password correctly, injecting passwords option must be enabled.
  Read more about password injection.

When resetting a VM:

• In order to reset a password you must have the 'quemu guest agent' installed

• open file 'imageUsernames.yml' located at: /yourwhmcs/modules/servers/OpenStackVpsCloud/app/Config
• change the file content according to the pattern:

 image name (use name displayed in the databse): 'newUsername'

For example:

 ca6628a6-f627-480f-8aeb-07fdc372712a: 'cirros'

Take a look at the screen to see how an exemplary, correctly modified file content might look like:

Keep in mind that there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product page and a discounted invoice will be generated automatically.

All your existing settings, products, and client data will be preserved during the update.

1. Make sure all tasks are completed.
2. Delete all files from the previous version of the module.
3. Upload the new module files.
4. Activate the new addon module and set the appropriate access control level for administrators.
Note: The administrator responsible for configuring the product must have access to the OpenStack VPS & Cloud module addon.
5. The migration tool must be triggered manually, then your existing data will be automatically transferred to the new module. Use the following cron command to initiate the migration:

 php -q /YOUR_WHMCS/modules/servers/OpenStackVpsCloud/cron/cron.php upgrade run 3.0.0    

6. After a successful migration, run the synchronize:networks cron task to synchronize network information (IP addresses from OpenStack) with WHMCS for services created before the migration.

 php -q /YOUR_WHMCS/modules/servers/OpenStackVpsCloud/cron/cron.php synchronize:networks

Opt for the Open Source version of your OpenStack VPS & Cloud For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

8774, 35357, 9292, 5000, 8777, 9696, 8776

• Log in to virtual machine via FTP or noVNC
• Check content of the directory: /var/lib/cloud/instance/user-data.txt
• If content is the same as you have defined it in the module, it means that the problem is not connected with the module itself
• In order to verify if the script includes any errors, please run the below command from the console and analyze the results searching for any errors:

 cloud-init --debug init

'Error:Connection Error: No route to host (Action: GET https://compute-api.svc.vstoragedomain.:8784/v2.1/5dcda23cb9bd4718b32610bbe18a1382/os-availability-zone). Check WHMCS module log for more information'

Please make sure the API IP address is public or there is a domain setup. For more details please refer to the official Virtuozzo Hybrid Infrastructure documentation.