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

Extracted files in your WHMCS directory should look like this:

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

Enter your license key between the 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 '/yourWHMCS/modules/servers/OpenStackProjects/'.

Proceed to your 'OpenStack' panel. All necessary information will be found in the 'View Credentials' section under 'API Access' .

Now, provide your 'OpenStack Server Details' . To download the 'Identity Version' , you need to click 'Get Versions' next to 'Identity Port/Path' .
Make sure that your server connection is correct and save changes.

If you you use Virtuozzo Hybrid Infrastructure (VHI) – OpenStack from Virtuozzo, please use the following guide:

1. WHMCS server must have access to VHI OpenStack API, please open the required ports according to the guide

2. Configure OpenStack endpoint OpenStack endpoint

3. Use system admin or domain admin credentials to access the cluster from WHMCS side:

• Name: any name

• Hostname: VHI domain name

• Module: Openstack Projects

• Username: admin

• Identity Port/Path: 5000

• Identity Version: v3

• Domain: Default

• Project ID: ID of the “admin” project from the Default domain

• Secure: yes
  

Use the above data to fill out the server creation form in the WHMCS admin area.

Click on 'Create a New Group'.

To do so, first click on 'Create a New Product'.

If you did not set the proper permissions, you will be asked to do it now.

Configuration:

• Default Domain - choose a default domain for new projects based on this product.
• Client Projects Mode - select a preferred mode that defines how new hostings will be created.
• Project User Roles - define default roles for a new user.
  • Inherit Domain Roles - enable if the Domain User Role should be inherited from the Project User Roles or defined separately.
    Note that this option is dependent on the 'Default Domain' setting. More about User Roles can be found here.
  • Domain User Roles - if the above 'Inherit Domain Roles' is disabled, this setting appears; here you may choose a default role in the domain for a new user based on this product.
    This setting, if not left empty, overwrites the 'with and without domain permissions' selections in the 'Client Projects Mode' option
• OpenStack Panel Web Address - is the web address for the login page to the OpenStack panel.
• Default Domain Name - enter a domain that will be used when the domain name is not provided. Available variables: {clientId}, {serviceId} and {rand}
• Default Project Name - enter a project name that will be used when creating a new project. If left empty, the domain name will be used instead. Available variables: {clientId}, {serviceId} and {rand}
• Default User Name - enter a user name that will be used when creating a new user. Available variables: {clientId}, {serviceId} and {rand}
• Domain Field Content - specify the content data that will overwrite the WHMCS Domain Field
• Client Area Login Information - select which of the login elements should be visible in the "Server Information" table in the client area. Choose from: username, password, domain and web address.
• Log API Requests - if you enable, information on API requests will be stored in the 'Module Log' section in your WHMCS
  

Compute, Block-Storage, Network, Load Balancer, Container Infrastructure, Traits, QoS Policy: 'Minimum Bandwidth Rate Rules' and 'Bandwidth Limit Rules' -
these sections may vary depending on the project, some of them might be unavailable for your OpenStack project. You may easily adjust your product to your needs by modifying the available options. Type '-1' for unlimited.
Note: Keep in mind that in the case of Virtuozzo server 'Traits' stand for 'Placement Groups' endpoints.

Module Custom Web Hooks - here you may add the URL with WHMCS parameters to perform additional actions after the create/suspend/unsuspend/terminate/change package actions.

Configurable options can be used by your clients to select each virtual machine parameters individually during order placement.
Otherwise, if configurable options are not defined, then the fixed parameters specified in the earlier configuration will be used instead.
If you decide to use configurable options, select the configurable options unit and then press the 'Create Configurable Options' button.

• Domain - on top of the hierarchy in OpenStack, domain includes all projects and users
  • User - a user can have domain roles and project roles assigned, when you log into OpenStack, you log into a user
  • Project - projects are created with the OpenStack Project For WHMCS module. It includes all remaining elements that are visible after logging into the user's panel, for example: virtual machines or networks

• Default Domain:
  • {exemplary_domain} - 'Project' and ' User' are created in a selected domain; the 'Inherit Domain Roles' switcher and 'Domain User Roles' dropdown disappear, this is where permissions to the domain are not granted
  • Create New One - if this option is selected, look at the 'Client Projects Mode' setting, as its selection is decisive now (a new domain per client or per service in WHMCS is created, all client services must have all projects assigned to one domain).

• Client Projects Mode
  • Default - every hosting creates a new domain (project and user), in this case name generated in 'Default Domain Name' should be unique (e.g. dependent on the Service ID in WHMCS)
  • Only one domain per client (with domain permissions) - the first service of the clients creates a domain, every next one assigns project and the new user to that domain (a user has all the permissions to the domain)
  • Only one domain per client (without domain permissions) - the first service of the clients creates a domain, every next one assigns project and the new user to that domain (a user has no permissions to the domain)
  • Only one domain and user per client - the first service of the client creates a domain and a user, every next service creates a project only within the existing domain

• Project User Roles - assigning project roles to a user

• Inherit Domain Roles - if enabled, the user has the same roles assigned for both the domain and for the project

• Domain User Roles - if the above 'Inherit Domain Roles' option is disabled, the user has the selected here domain roles assigned and the 'with/without domain permissions' settings are overwritten.
  If left empty, the 'with/without domain permissions' setting is taken into consideration.

This includes supervision of such features as:

• Log In To Control Panel – redirecting to the OpenStack login page.
• Configurable options which enable you to view the chosen server details
• Module commands to allow easy and quick management of the server
  
  • Create – creating a new user, a new project with a set of limits.
  • Suspend – unassigning a project from the user to prevent a user from managing their resources.
  • Unsuspend – assigning back a project from a user.
  • Terminate – removing a project and removing a user (if they do not have any other projects assigned at OpenStack).
    Important! From the 1.1.0 version of the module, the following cron command is required to terminate a project (5-minute interval suggested).
    Do not forget to replace 'yourWHMCS' with your WHMCS root location.

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

  • Change Package – upgrading resources of the project.
• Scheduled Tasks - data on all scheduled tasks, their status, attempts, and dates
• Metric Statistics - the section is completed with all metrics the module can observe.

/yourWHMCS/modules/servers/OpenstackProjects/app/Config/configuration.yml

Find the 'averageBilling' option and set:

• 'false' for total usage
• 'true' for average usage

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.