The great advantage of this module is the fact that customers can order and manage virtual servers, backups and many more in your own WHMCS client area.
Additionally, it allows you to conveniently overview and control all the customers' servers.

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

In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.

The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.
Note: Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

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' .

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

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

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

Note: If you have WHMCS V7.8.X or later, we recommend using 'previous experience' of server configuration instead of the new wizard tool.

• Provide your Openstack 'IP address/hostname'

• In the next field, enter the 'endpoint identity path' if it is used. You can find its name in the OpenStack 'API Access' section, based on the 'Service Endpoint' address.
  Its path name is between the hostname/IP address and port/API version paths. You can leave this field empty if it is not used.
  Note: If you are using module version prior to 1.8.1, provide the OpenStack address together with the endpoint in the hostname field - e.g. '10.10.10.253/identity'

• Do not also forget to select which API version you want to use ( 'Default', 'V2' or 'V3' ).
  Important - if this dropdown is empty, please validate whether you provided correct data into the 'IP/Hostname', 'Identity Endpoint Path', 'Secure' or 'Port' overwrite fields.

• Next, specify the details of your server. Choose 'OpenStack VPS Cloud' from the Type dropdown menu and provide the 'Username', 'Password' and admin 'Tenant ID.'
  Note: To find your 'Tenant ID' , log in to your OpenStack panel and go to the 'Identity' → 'Projects' menu.
  Now you will need to identify the row which corresponds to your project. The 'Tenant ID' will be located in the 'Project ID' column of the identified project.
  

• Project Name - you may declare your project name to which this server is related (leave empty if not related to the OpenStack version you are using)

• Certificate Path - you can also provide a full certificate path to verify permissions (leave empty if not related to the OpenStack version you are using)

• Optionally, enter your OpenStack custom Domain or leave this field as 'Default' .
  

• If your OpenStack uses https or any custom port, you can additionally provide the relevant configuration in 'Secure' and 'Port' fields.
  

Finally, press 'Save Changes' .

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.
Additionally you can change the endpoint addresses to make sure that all services have been connected successfully or select 'Don't use' if no endpoint is applicable to your OpenStack.
Note: Any chosen endpoint address will be automatically saved after its selection so there is no need to save it manually after each change introduced.

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 module should automatically save and reload settings. If not, click on 'Save Changes' manually.

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'.

Mark the 'Backups Rotation ' checkbox 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'.
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.

• 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).
  
• In order to use passwords for your VM, leave 'Password Management' marked (virtualization has to support the 'Set Admin Pass' feature).
  Please make sure that virtualization used by you supports mentioned actions.
  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.
Note that once this option is enabled, your clients will no longer have access to the 'Backup' and 'Rescue' functions, so you may as well leave the respective fields empty.

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 configuration of VPS with predefined resources.
Detailed information about configuration of VPS with resources chosen by a client can be found here.

'Default Flavour' defined resources assigned to a VM while 'Default VM Image' allows you to choose the VM image used to create a new VM.

It will prepare default configurable options which can be afterward easily edited 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:

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

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

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.

This way you can automate your work instead of making all kinds of specific images for specific tasks manually.

Important notes:

• Scripts can be written in standards like Bash or YAML.
• You can find examplary clout-init config scripts here.
• Initial scripts have to be supported by VPS operating system to be executed properly.
• Scripts should be used only by advanced users. The incorrect usage of the scripts may damage your system!

You can achieve it by writing:

chpasswd:
 list: |
 ubuntu:newpass01
 expire:False

All you need to do is add a new configurable option and assign it to the OpenStack VPS & Cloud product.
Note: These scripts are executed regardless of the script specified in the module settings.
The easiest way is through the edition of existing 'Configurable options for the OpenStack VPS & Cloud' group, and adding the new configurable option there.
For example, if you want to offer the pre-installed PHP version depending on a client's choice, you can add a new option named script_PHP|PHP version and then define multiple options, like on the screenshot below:

Using this method, you can perform assorted actions on newly created machines, e.g.: modifying files, preinstalling & preconfiguring software, executing any statements that would normally be executed via the terminal.

The general rule is that configurable option names should begin with script_prefix to be recognized as containing a custom script.
Then, choices under the option have their own names which are matched with a name of existing file with the corresponding script under the yourWHMCS/modules/servers/OpenStackVpsCloud/scripts path.
Note that files with scripts have to have exactly extension corresponding to the given entries in the configurable options.

In the example above, there are two options: php5.yml and php7.yml, therefore it makes the module read corresponding files:

• modules/servers/OpenStackVpsCloud/scripts/php5.yml

or

• modules/servers/OpenStackVpsCloud/scripts/php7.yml

You can add many scripts in the exact way.

These variables can be managed in the same way as merge fields in email templates.

The exemplary execution of the clout-init test script is presented below:

#cloud-config

runcmd:
    - sudo echo "account id: {$accountid}" >> /tmp/whmcs_info.txt
    - sudo echo "service id: {$serviceid}" >> /root/whmcs_info.txt
    - sudo echo "addon id: {$addonId}" >> /var/log/whmcs_info.txt
    - sudo echo "user id: {$userid}" >> ~/whmcs_info.txt

You will save IDs of the WHMCS 'account', 'service', 'addon' and 'client' into the 'whmcs_info.txt' files in various directories on the created instance.
Of course, you can use the variables in any custom script according to your needs.

Below you can find a complete list of supported variables that can be managed in your custom scripts:

You can monitor and manage each product from your WHMCS admin area.
1. Configurable options which enable you to view current resources and change specifications through changing configurable options and pressing 'Change Package'
2. Module commands (Create, Suspend/Unsuspend, Change Package)
3. Service actions (Stop VM, Pause VM, Soft/Hard Reboot, Reset Network, Rescue, Change Protection)
4. Instance details along with Interfaces, Scheduled Tasks, and Volumes (you will see the 'Volumes' section if you enabled the 'Use Volumes' feature)

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 allows your customers to easily start/stop, pause/unpause, resume, soft reboot, hard reboot, and reset network of their servers by pressing the specific 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 bounded to them, like a type of task, attempts to perform tasks, or a last returned response.

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

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

Before you continue, please note that the rescue VM will be set up with the same network configuration as the real VM.
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, and action button.
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.

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 will be created to define the tasks routine. The entered time interval must be higher or equal to the limit defined 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 'Add' when ready.

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' .

Module allows you to charge your customers based on the server resources used by them.
Note: Advanced Billing currently supports only API prior V3 (OpenStack Ocata). A new compatibility will be added soon.

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 you upgrade the module from the version older than 1.8.1 to 1.8.1 or newer, please remember to update the new server's hostname to the new address format, as described in step 8. of the configuration of server guide.

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.

• Firstly, make a backup copy of your server and database.
• When you successfully performed a backup, now stop cron tasks that are running.
• Delete these folders:

yourWHMCS/includes/OpenStack 

yourWHMCS/modules/servers/OpenStackVPS 

• Delete these two files openstackvps.js and openstackvps.php that are placed in this folder:

yourWHMCS/includes/hooks

• Now, upload new files to your main WHMCS directory.
  

Important! Please remember to reissue the license in the client area after uploading new files to the main WHMCS directory.
If you do not do this, you will get a notification about the wrong license, and the upgrade process will not succeed.
Please follow our documentation to make sure that you reissue the license properly.

• Run the migration cron job:

php -q /yourWHMCS/modules/servers/OpenStackVpsCloud/cron/cron.php migration:v1_v2 

• Set the cron task once again:

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

• Finally, proceed to the configuration of your server and check if the module type is changed to OpenStack VPS Cloud
  and the 'Module Name' to OpenStack VPS Cloud in the 'Module Settings' tab of your product configuration.

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