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 manage all the customers' servers.

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

Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' › 'System' › 'PHP Info'.

The content of PHP version files should look like this.

File is located in 'modules/servers/OpenStackVPS/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 'your_whmcs' with your root WHMCS path.

php -q /your_whmcs/modules/servers/OpenStackVPS/cron/cron.php

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

• Provide your IP address/hostname with or without the endpoint name (you can find it in the Openstack 'Authentication URL' field).
  
• Do not forget to select which API version you want tu use ( 'Default', 'V2' or 'V3' ).
  
• Next choose 'OpenStackVPS' 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 'Indentity' → 'Projects' menu.
  There identify the row which corresponds to your project. The 'Tenant ID' is located in the 'Project ID' column for the identified project.
  
• Optionally provide your OpenStack custom domain or leave this field as 'Default' .
  
• If your OpenStack use https or any custom port you can provide the revelant 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, connection with all releated 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 any is not applicable to your OpenStack.
Note: The chose of any new endpoint address will be automatically saved after its selection. No need to be manually saved every time you change them.

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

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

'Check access' will return 'OK' if you set up permissions correctly.

You can set up network in two ways. You can find more information about the configuration here.
We will set up 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 Routing' checkbox if you want to replace oldest backup with newest one when backups file limit is reached.
Afterward, enter a limit of backup files into 'Default Backups Files Limit' .

If you wish to use SSH keys, leave 'Inject 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.

Mark the checkbox next to a feature in order to enable it.

This can be useful if you want clients to receive the notification once their VM is ready, rather than immediately after the product has been activated.
For this feature, we also suggest that you set the standard WHMCS configuration of the 'Welcome Email' to 'None' in the product 'Details' tab.
Otherwise, the customer will receive both emails - after the product has been activated and after the VM has been succesfully 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 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 creation of a new flavor on your server each time a new order is made.

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.
• 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 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' 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/OpenStackVPS/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/OpenStackVPS/scripts/php5.yml

or

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

You can add many scripts in the exact way.

You can monitor and manage each product from your WHMCS admin area.
1. Configurable options which enables you to view current VPS resources and change VPS specifications through changing configurable options and pressing 'Change Package' .
2. Module commands enables you to manage VPS status.
3. Here you can find VPS details and refresh them through pressing the 'Refresh Details' icon.
4. Scheduled tasks status can be found in this table.
5. In marked custom fields you can find IDs of VM and private flavor.

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.

Module allows your customers to easily start/stop, pause/unpause, resume, soft reboot, hard reboot and reset network of their servers through pressing the specific button.
Clients can also rebuild the server, access noVNC console, create a backup and view scheduled tasks.
At 'Tasks' your customers can view all requested tasks that was 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.

Press the 'Rebuild' button as shown on the following screen in order to move to the rebuild page.

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

As you may notice on the following screen, presented earlier the 'First Backup' backup was replaced with the 'New Backup' .
It was caused by a backup routing feature which was triggered by reaching the backups file limit.

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

The status of this protection will be in the admin area as well as the 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 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 properly configured OpenStack server, wget from WHMCS server should be able to get any data from any admin endpoint.
Sample successfull 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. 

Keep in mind 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's page and a discounted invoice will be generated automatically.

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