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

Log in to your WHMCS administrator area. Go to 'System Settings' → 'Addon Modules'.
Afterwards, find 'OpenStack Projects' and press 'Activate' button.

To do so, click on the 'Configure' button, select administrator groups that should have access to this addon and press 'Save Changes'.

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

This enables tasks such as 'suspend resources,' 'unsuspend resources,' 'terminate resources,' and 'lock account' to queue and run.

You can access your module under 'Addons' → 'OpenStack Projects'.

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

In the Server Details section:

• Set Module to 'Openstack Projects'
• Enter your Username/ Password
• Click the Configure button and provide your server details:
  • User Type
  • Identity Port/Path
  • Identity Version - To download the 'Identity Version' , you need to click 'Load Versions' next to 'Identity Port/Path'.
  • Domian
  • Project ID
    

Make sure that your server connection is correct and save the changes.

Important: The module supports OpenStack providers that allow access to the OpenStack API with system admin-level permissions.
To ensure proper operation, use an account with the necessary rights to manage projects and perform actions through the API.
Learn more about access roles in the OpenStack API guide.

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

• Password

• Press the Configure button and provide details:
  • User Type: Select between "System Admin" and "Domain 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.

Important: Please do not add more than one server into a single server group, as the module always fetches data from the first server listed in the group.
It is recommended to create one group per server configuration to prevent potential issues.

Click on 'Create a New Group'.

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

Note: The below description refers to the "VHI" product configuration.

Configuration:

• Domain-Only Mode - when enabled, this mode creates an empty domain without attaching any project. Standard operations such as suspend, unsuspend, and terminate will still apply to all projects within the domain.
• Default Domain - choose a default domain for new projects based on this product or create a new domain. Note: The option to create new domains is not available if "Domain Admin" is set as the User Type in the server configuration.
• 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. Keep in mind that the choice of roles determines the level of allowed permissions. For example, select the image_upload role if you wish to be allowed to upload OS images.
• Default Project Name - enter a project name used when creating a new project. If left empty, the domain name will be used instead. Available variables: {clientId}, {serviceId} and {rand}.
• 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 User Name - enter a user name 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.
• Log API Requests - if you enable it, information on API requests will be stored in the 'Module Log' section in your WHMCS.
• Create User Without Password - if enabled, the password will be cleared in WHMCS and the user will be created in OpenStack without a password.
• Remove Password - if enabled, the password will be removed from the database as soon as the project is created.

Compute, Block Storage, Network, Load Balancer, Container Infrastructure, Traits -
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 the Virtuozzo server 'Traits' stand for 'Placement Groups' endpoints.

• Client Area Login Information - select which login elements should be visible in the "Server Information" table in the client area. Choose from: username, password, domain and web address.
• Block Storage Limits Widget - block storage resource usage can be displayed in the admin and client area, including at least one resource to enable.
• Open Management Panel In New Window - decide whether the management panel should open in the same or a new window.
• Login Restrictions - this enables a feature that enhances security by only issuing temporary passwords that ensure access is granted only for as long as needed.
• Project Servers - this option enables access to the Project Server section in the client area. It is directly linked to "Domain-Only Mode". When that is enabled, the Project Servers section is automatically hidden.

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.
These hooks allow you to trigger actions on external servers or services via HTTP requests when certain events occur in WHMCS.

Module Custom Shell Hooks - enter the commands with WHMCS parameters to perform additional actions after the create/suspend/unsuspend/terminate/change package actions.
These hooks allow you to execute shell commands on your server when specific WHMCS package actions are triggered.
Please refer to the following section to correctly set up the openID configuration to connect to VHI correctly.

Configurable options can be used by your clients to select each virtual machine parameter 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.

There is also an 'Alternative Mode' available, which changes the way the configurable options values are verified and calculated.
Select single configurable options and their values will be summed with the default product configuration values instead of overwriting them.

• Packet Rate Limit combines the following:
  • Packet Rate Limit Rules - Max Egress (kpps) - maxEgressKpps: 0
  • Packet Rate Limit Rules - Max Egress Burst (kpps) - maxEgressBurstKpps: 0
  • Packet Rate Limit Rules - Max Ingress (kpps) - maxIngressKpps: 0
  • Packet Rate Limit Rules - Max Ingress Burst (kpps) - maxIngressBurstKpps: 0
    

Configured as: maxEgressKpps: 0,maxEgressBurstKpps: 0,maxIngressKpps: 0,maxIngressBurstKpps: 0|Unit

• Bandwidth Limit combines the following:
  • Bandwidth Limit Rules - Max Egress (kbps) - maxEgressKbps: 0
  • Bandwidth Limit Rules - Max Egress Burst (kbps) - maxEgressBurstKbps: 0
  • Bandwidth Limit Rules - Max Ingress (kbps) - maxIngressKbps: 0
  • Bandwidth Limit Rules - Max Ingress Burst (kbps) - maxIngressBurstKbps: 0
    

Configured as: maxEgressKbps: 0,maxEgressBurstKbps: 0,maxIngressKbps: 0,maxIngressBurstKbps: 0|Unit

• Minimum Bandwidth combines the following:
  • Minimum Bandwidth Rate Rules - Min Egress (kbps) - minEgressKbps: 0
  • Minimum Bandwidth Rate Rules - Min Ingress (kbps) - minIngressKbps: 0
    

Configured as: minEgressKbps: 0,minIngressKbps: 0|Unit

• Minimum Packet Rate combines the following:
  • Minimum Packet Rate Rules - Min Egress (kbps) - minEgressKpps: 0
  • Minimum Packet Rate Rules - Min Ingress (kbps) - minIngressKpps: 0

Configured as: minEgressKpps: 0,minIngressKpps: 0|Unit

In the QoS Policy generate the following configurable options:

• Minimum Bandwidth: minEgressKbps: 50,minIngressKbps: 60|Unit
• Bandwidth Limit: maxEgressKbps: 70,maxEgressBurstKbps: 80,maxIngressKbps: 90,maxIngressBurstKbps: 100|Unit
  

This will result in the following configuration (overwriting the product configuration QoS Rules):

• 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, for example you need to select here the "image_upload" role to allow uploading images

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

To set quotas via the module, they must be added to the quotas.json file at: /modules/servers/OpenstackProjects/app/Config/quotas.json. This file defines the default quota values for projects managed by the module.

Use the following CLI commands to list available quotas from your OpenStack environment:

openstack quota show --compute -f json
openstack quota show --network -f json
openstack quota show --volume -f json
openstack loadbalancer quota show default -f json
openstack coe quota list
openstack trait list   

Important:
Please note that the values defined in the 'quotas.json' file serve as default settings.
You can override these default settings in individual product configurations to create specific project requirements.
For instance, setting a quota value to -1 indicates an unlimited allocation for that resource.

• Run the command: openstack quota show --compute -f json
• The following output may return:

 [
 {
   "Resource": "cores",
   "Limit": -1
 },
 {
   "Resource": "instances",
   "Limit": -1
 },
 {
   "Resource": "ram",
   "Limit": -1
 },
 {
   "Resource": "fixed_ips",
   "Limit": null
 },
 {
   "Resource": "floating_ips",
   "Limit": null
 },
 {
   "Resource": "networks",
   "Limit": null
 },
 {
   "Resource": "security_group_rules",
   "Limit": null
 },
 {
   "Resource": "security_groups",
   "Limit": null
 },
 {
   "Resource": "injected-file-size",
   "Limit": 10240
 },
 {
   "Resource": "injected-path-size",
   "Limit": 255
 },
 {
   "Resource": "injected-files",
   "Limit": 5
 },
 {
   "Resource": "key-pairs",
   "Limit": -1
 },
 {
   "Resource": "properties",
   "Limit": 128
 },
 {
   "Resource": "server-group-members",
   "Limit": -1
 },
 {
   "Resource": "server-groups",
   "Limit": -1
 }
 ]

• Following the structure:

 "compute": {
  "quota_resource_name": "default_limit_value"
 }

• The corresponding quotas.json entry would be:

 "compute": {
  "cores": -1,
  "instances": -1,
  "ram": -1,
  "fixed_ips": null,
  "floating_ips": null,
  "networks": null,
  "security_group_rules": null,
  "security_groups": null,
  "injected-file-size": 10240,
  "injected-path-size": 255,
  "injected-files": 5,
  "key-pairs": -1,
  "properties": 128,
  "server-group-members": -1,
  "server-groups": -1
 }

• Run the command: openstack loadbalancer quota show default -f json
• The following output may return:

 {
  "load_balancer": 0,
  "listener": -1,
  "pool": -1,
  "health_monitor": -1,
  "member": -1,
  "l7policy": -1,
  "l7rule": -1
 }   

• This should be added to quotas.json under the loadBalancer key:

 "loadBalancer": {
  "load_balancer": 0,
  "listener": -1,
  "pool": -1,
  "health_monitor": -1,
  "member": -1,
  "l7policy": -1,
  "l7rule": -1
 }  

• Running the command: openstack coe quota list
• May return:

• This should be added under the containerInfra key:

"containerInfra": {
 "hard_limit": 20
}  

• Running the command: openstack trait list
• May return:

• For example, if CUSTOM_MG is required, add:

"traits": {
 "CUSTOM_MG": 1
}  

modules/servers/OpenstackProjects/app/Config/quotas.json  

Manually add additional storage types to block storage as needed. To set a volume size limit for block storage, modify the blockStorage configuration object.

Example Configuration for SSD Volume Type

To specify an unlimited quota for SSD volumes, use the following setting:

"gigabytes_ssd": -1  

After making changes, the blockStorage section of the file should resemble:

 "blockStorage": {
   ....
   "gigabytes_default": -1,
   "gigabytes_ssd": -1
 }

Once the file is updated and the page is refreshed, the new quota will be reflected in the Block Storage section.

Important: If you have multiple OpenStack Project servers connected to WHMCS and use more than one OpenStack product, remember that the quotas configuration is global.
All linked servers must support the same settings defined in quotas.json.
If a server lacks a particular feature, provisioning may fail unless you either align all server configurations or leave the affected quota fields empty to skip them.

 {
 "compute": {
   "cores": -1,
   "fixed_ips": -1,
   "floating_ips": -1,
   "injected_file_content_bytes": 10240,
   "injected_file_path_bytes": 255,
   "injected_files": 5,
   "instances": -1,
   "key_pairs": -1,
   "metadata_items": 128,
   "ram": -1,
   "security_group_rules": -1,
   "security_groups": -1,
   "server_group_members": -1,
   "server_groups": 30
 },
 "blockStorage": {
   "volumes": 100,
   "per_volume_gigabytes": 50,
   "snapshots": 100,
   "gigabytes": 300,
   "backups": 10,
   "backup_gigabytes": 200,
   "volumes_default": -1,
   "gigabytes_default": -1,
   "snapshots_default": -1,
   "groups": 10
 },
 "network": {
   "network": -1,
   "subnet": -1,
   "subnetpool": -1,
   "port": -1,
   "router": -1,
   "floatingip": -1,
   "rbac_policy": -1,
   "security_group": -1,
   "security_group_rule": -1,
   "security_group_device": -1,
   "endpoint_group": -1,
   "vpnservice": -1,
   "ipsec_site_connection": -1,
   "ipsecpolicy": -1,
   "ikepolicy": -1
 },
 "loadBalancer": {
   "load_balancer": -1,
   "listener": -1,
   "member": -1,
   "pool": -1,
   "health_monitor": -1
 },
 "containerInfra": {
   "hard_limit": 20
 },
 "traits": {}
 }  

Command:

php -q /yourWHMCS/modules/servers/OpenstackProjects/cron/cron.php create:missing-qos 

The command scans all OpenStack products and attempts to assign a QoS Policy where it is missing.
If a QoS Policy already exists, the command will first try to locate and re-assign it, avoiding duplicate creation errors.

If the QoS configuration for a product is empty (all values set to 0), a warning will be displayed.
When properly configured in the product's module settings or via CLI, the command will automatically create or assign the missing QoS Policy and update the 'QoS Policy ID' field in WHMCS.

Check the manual below to learn how to configure the module to take all the advantages it has to offer.

The task cards can be used to filter the task table underneath.

• ID - identification number unique to each task.
• Related Item - the product related to the task. Clicking on it will take you to its product page.
• Status - the current status of the task (finished, running, pending, waiting or error).
• Task - specific action that the task attempts to run, these are:
  • Lock Account
  • Suspend Resources
  • Unsuspend Resources
  • Terminate Resources
• Attempts - the number of times the task was attempted.
• Created At - the date when the task was first created.
• Updated At - the date when the status of the task was last updated.

• Details - access more in-depth information about the task, including error logs.
• Run - attempt to run the task one more time.
• Delete - remove the task from the queue and the list.

• Auto Prune - toggle the switch on to enable the task auto prune feature, which will delete the tasks after the specified time has passed.
• Auto Prune Older Than - specify the number of days that have to pass before a task is automatically pruned.
• Display 'Cron Job Configuration' Hint - disable to hide the cron job information.

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.

This includes supervision of such features as:

• Log In To Control Panel – redirecting to the OpenStack login page.
• Configurable options that enable you to view the chosen server details (if applicable)
• 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).
    
  • Change Package – upgrading resources of the project.
  • Change Password – changing the password of the main user in the project.
    Note: To change the password input the new password in the 'Password' field, scroll down to the bottom of the page to 'Save Changes' and when the page reloads, click on 'Change Password'.
• Scheduled Tasks - data on all scheduled tasks, their status, attempts, and dates.
• Block Storage Limits - if the option is enabled in the module settings, block storage resources usage will be displayed here.
• Metric Statistics - the section is completed with all metrics the module can observe.

1. Find a client to whom you want to assign a project.
2. Create a new service, but do not use the 'Create' action.
3. Edit the service by entering the information in every field highlighted in the image below, besides the Dedicated IP.
4. Ensure that product settings mirror the ones set up on the OpenStack side.
5. Change the service status to active.
6. Press the 'Save Changes' button.

As you can see, you may easily be redirected to the 'OpenStack' login page. Moreover, you can check the 'Configurable Options ' and 'Metrics Billing'.
At the bottom of the page, you may find the 'Project Servers' list, which allows you to tell each server's status at a glance.
You can change your password by clicking on the button under 'Actions' in the side menu.

• Secure Account - use the lock icon to secure the user account to make it inaccessible until an administrator manually intervenes to reset the password or restore user access.
• Temporary Access - use the key icon to generate a password for the user, that will work only for a specified time.

Follow the instructions below step by step to allow adding OpenID configuration automatically:
1. Configure OpenID in WHMCS, read the following article to learn how to proceed.
2. Open file: vhi-integration/vinfra-cmd and enter the below enumerated data:

 ### VHI ACCESS DETAILS
 export VINFRA_PORTAL=
 export VINFRA_USERNAME=
 export VINFRA_PASSWORD=""
 export VINFRA_PROJECT=""
 
 ### WHMCS OPENID CONFIGURATION
 ISSUER="" 
 CLIENT_ID=""
 CLIENT_SECRET="" 

3. Move to the product 'Module settings' → 'Module Custom Shell Hooks' section. There add content to the 'Create' and ' Terminate' actions, for example:
Create:

 /home/yourWHMCS/vhi-integration/vinfra-cmd -d {$customfields.DomainName} -a create -n {$customfields.DomainName}

Terminate:

 /home/yourWHMCS/vhi-integration/vinfra-cmd -d {$customfields.DomainName} -a delete -n {$customfields.DomainName}

5. Run 'Create' module command.
6. Press the 'Log into Panel ' button, and you will be redirected to the "Sign in" pop-up, press Sign in with 'your_user_name'.

1. OpenID Connect → Authorized Redirect URIs. Type in the VHI address that connects to your WHMCS, use the formula:

https://VHI_DOMAIN:8800 

and/or

https://VHI_DOMAIN:8800/api/v2/login/idp/

Order allow,deny
Allow from 138.128.150.246
Allow from 192.168.5.91
satisfy any

RewriteEngine On
RewriteRule ^.well-known/openid-configuration ./oauth/openid-configuration.php [L,NC]

1. Configure OpenID in WHMCS, read the following article to learn how to proceed.
2. Make sure your product 'project_admin' included in 'Project User Roles' and a domain under 'Default Domain' in the product configuration.

• systemAdmin – Contains authentication settings for requests made by System Admin user type.
• domainAdmin – Contains authentication settings for requests made by Domain Admin user type.
  

Each section contains:

• default - A default authentication method, used when no specific request configuration is defined.
• Custom authentication methods for specific API requests that require unique authorization.

 systemAdmin:
 default:
   authUrl: "{$server.authUrl}"
   auth:
     identity:
       methods:
         - "password"
       password:
         user:
           name: "{$server.username}"
           domain:
             name: "{$server.domain}"
           password: "{$server.password}"
     scope:
       project:
         id: "{$server.projectId}"
 "network.v2.actions.floating_ips.get.get":
   auth:
     identity:
       methods:
         - "password"
       password:
         user:
           name: "{$server.username}"
           domain:
             name: "{$server.domain}"
           password: "{$server.password}"
     scope:
       project:
         id: "{$service.projectId}"
         domain:
           name: "{$service.domainName}"
 

Domain Admin Configuration

 domainAdmin:
 default:
   authUrl: "{$server.authUrl}"
   auth:
     identity:
       methods:
         - "password"
       password:
         user:
           name: "{$server.username}"
           domain:
             name: "{$server.domain}"
           password: "{$server.password}"
     scope:
       project:
         id: "{$server.projectId}"
         domain:
           name: "{$server.domain}"
 "identity.v3.actions.users.delete.delete":
   auth:
     identity:
       methods:
         - "password"
       password:
         user:
           name: "{$server.username}"
           domain:
             name: "{$server.domain}"
           password: "{$server.password}"
     scope:
       domain:
         name: "{$server.domain}"  

• The default authentication method is used for general API requests and for retrieving the service catalog.
• If a specific request requires a unique authentication method, it is explicitly defined within the configuration.
  For example:
  • network.v2.actions.floating_ips.get.get for System Admins overrides the default configuration
  • identity.v3.actions.users.delete.delete for Domain Admins uses a custom authentication scope.

1. Enable API logging in the module settings: Log API Requests.

To add custom authentication for the network.v2.actions.qo_s_policy.create.post request under Domain Admin, modify the auth.yml file:

domainAdmin:
 "network.v2.actions.qo_s_policy.create.post":
   auth:
     identity:
       methods:
         - "password"
       password:
         user:
           name: "{$server.username}"
           domain:
             name: "{$server.domain}"
           password: "{$server.password}"
     scope:
       project:
         id: "{$service.projectId}"
         domain:
           name: "{$service.domainName}"
 

After this modification, the request network.v2.actions.qo_s_policy.create.post will no longer use the default authentication but instead use the newly defined scope.

To completely disable the termination function in the module, set the disableTerminate: option in the configuration.yml file to true:

 disableTerminate: true 

When set to true, this option changes the termination process. Instead of immediately removing resources, a new task called Alternate Terminate Resources is created.
This task blocks user access and performs a shelve operation on the virtual machines.

 serviceTerminationAlternateMode: true 

This email provides details about the affected product and account. In addition to the standard Product/Service Related and Client Related merge fields, the template also supports the following extra module merge fields:

• project_domain_name
• project_domain_id
• project_id
• project_user_id
• project_username

Opt for the Open Source version of your OpenStack Projects 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.

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