Personal tools
Namespaces

Variants
Actions

Virtuozzo Hybrid Infrastructure S3 For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Installation and Configuration)
(→‎Configuration of Product)
Line 348: Line 348:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_12.png]]
 
|}
 
|}
 
{|
 
{|
Line 355: Line 355:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_13.png]]
 
|}
 
|}
 
{|
 
{|
Line 361: Line 361:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_14.png]]
 
|}
 
|}
 
{|
 
{|
Line 368: Line 368:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_15.png]]
 
|}
 
|}
 
{|
 
{|
Line 375: Line 375:
 
* '''User Email''' -  
 
* '''User Email''' -  
 
* '''Custom Email''' -  
 
* '''Custom Email''' -  
−
* '''Panel Login URL''' - select a preferred mode that defines how new hostings will be created.
+
* '''Panel Login URL''' -  
−
* '''API Endpoint''' - is the web address for the login page to the OpenStack panel.
+
* '''API Endpoint''' -  
−
* '''Default Domain''' - enter a domain that will be used when the domain name is not provided. Available variables: ''{clientId}, {serviceId}'' and ''{rand}''
+
* '''API Documentation URL''' -  
−
* '''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}''
+
−
* '''Overwrite WHMCS Domain''' - if enabled, during create action, the domain assigned to hosting in WHMCS will be overwritten with the domain name assigned to the project in the OpenStack panel.
+
−
* '''Show Domain ''' - if you enable, the domain will be visible in the client area.
+
−
* '''Log API Requests''' - if you enable, information on API requests will be stored in the 'Module Log' section in your WHMCS <br/>
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_16.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|
+
|style="padding: 0px 0px 15px 15px;"|USer Limits:<br/>
−
'' '''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.<br/>  You may easily adjust your product to your needs by modifying the available options. Type '' '-1' '' for unlimited.<br/>
+
'''Operations Per Seconds'''
−
'''''Note:''' Keep in mind that in the case of Virtuozzo server 'Traits' stand for 'Placement Groups' endpoints.''
+
* '''Default [kilo ops/min]''' -  
 +
* '''DELETE [kilo ops/min]''' -  
 +
* '''GET [kilo ops/min]''' -  
 +
* '''PUT [kilo ops/min]''' -
 +
* '''LIST [kilo ops/min]''' -  <br/>
 +
'''Bandwidth'''
 +
* '''Out [Mb/s]''' -
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_16_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_17.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|
+
|style="padding: 0px 0px 15px 15px;"|Quota Management
−
'' '''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.
+
* '''User Quota [GB]''' -  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_16_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_18.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''16. At the end of the configuration process, you can enable the '' 'Metric Billing' '' and decide whether you want to generate configurable options for the product.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|Admin Area Features
−
Configurable options can be used by your clients to select each virtual machine parameters individually during order placement.<br/>Otherwise, if configurable options are not defined, then the fixed parameters specified in the earlier configuration will be used instead.<br/>
+
* '''Last Month Usage Records''' - Show Last Month Usage Records Table
−
If you decide to use configurable options, select the configurable options unit and then press the 'Create Configurable Options' button.
+
* ''' User Limits'' - Show User Limits Table
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_16_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_19.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_17.png]]
+
 
|}
 
|}
 +
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"| Now, select which options you want to generate and confirm by clicking '' 'Create' ''.<br/> Note that the configuration for disabled options will still be taken from the configuration of the main product.<br/>More information about how to use configurable options can be found [https://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options here] or in the official WHMCS [https://docs.whmcs.com/Addons_and_Configurable_Options documentation].
 
|style="padding: 0px 0px 15px 15px;"| Now, select which options you want to generate and confirm by clicking '' 'Create' ''.<br/> Note that the configuration for disabled options will still be taken from the configuration of the main product.<br/>More information about how to use configurable options can be found [https://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options here] or in the official WHMCS [https://docs.whmcs.com/Addons_and_Configurable_Options documentation].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OSP_18.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:VHI_20.png]]
 
|}
 
|}
  

Revision as of 12:08, 8 November 2021

Contents

About Virtuozzo Hybrid Infrastructure S3 For WHMCS

Virtuozzo Hybrid Infrastructure S3 For WHMCS is a module.......
  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate OpenStack Projects
✔ Change Package
✔ Log In To Panel
✔ View Created Project/User/Domain IDs
✔ Set Up Project Configuration:
✔ Define Default Domain
✔ Define User Roles
✔ Define Client Projects Mode:
✔ Default
✔ Only One Domain Per Client
✔ Only One Domain And User Per Client
✔ Provide OpenStack Panel Web Address
✔ Provide Default Project/User Name
✔ Toggle WHMCS Domain Overwriting
✔ Toggle Displaying Domain For Clients
✔ Toggle Logging API Requests
✔ Set Up Limits For:
✔ Compute
✔ Block-Storage
✔ Network
✔ Load Balancer
✔ Container Infrastructure
✔ Kubernetes
✔ Traits (OpenStack) / Placement Groups (Virtuozzo)
✔ Set Up Module Custom Webhooks
✔ Generate Configurable Options
✔ Run Server Connection Test
  • Client Area Features:
✔ View Project Details:
✔ Domain
✔ Username
✔ Password
✔ Log In To Panel
  • Configurable Options:
✔ Backup Gigabytes
✔ Backups
✔ Cores
✔ Fixed IPs
✔ Floating IP
✔ Floating IPs
✔ Gigabytes
✔ Groups
✔ Hard Limit
✔ Heath Monitor
✔ Injected File Content [Bytes]
✔ Injected File Path [Bytes]
✔ Injected Files
✔ Instances
✔ Key Pairs
✔ Listener
✔ Load Balancer
✔ Member
✔ Metadata Items
✔ Network
✔ Per Volume Gigabytes
✔ Pool
✔ Port
✔ RAM [MB]
✔ Role-based Access Control Policy (RBAC Policy)
✔ Router
✔ Security Group
✔ Security Group Rule
✔ Security Group Rules
✔ Security Groups
✔ Server Group Members
✔ Server Groups
✔ Snapshots
✔ Subnet
✔ Subnet Pool
✔ Traits (OpenStack) / Placement Groups (Virtuozzo)
✔ Volumes
  • Required Components:
✔ Gnocchi (Required For Billing)
  • General Info:
✔ Integrated With Advanced Billing For WHMCS - Actual Project Resource Usage Billing
✔ Integrated With Products Reseller For WHMCS - End-To-End Solution For Products And Servers Reselling
✔ Multi-Language Support
✔ Supports OpenStack Victoria and Previous
✔ Supports OpenStack Gnocchi
✔ Supports Virtuozzo Hybrid Infrastructure
✔ Supports PHP 7.2 Up To PHP 7.4
✔ Supports WHMCS Metric Billing - Integration: CPU, Compute Instance Booting Time, Disk Device Read Bytes, Disk Device Read Requests, Disk Device Write Bytes, Disk Device Write Requests, Disk Ephemeral Size, Disk Root Size, Memory,
Memory Usage, Network Incoming Bytes, Network Incoming Packets, Network Outgoing Bytes, Network Outgoing Packets, OS Images, VCPUs, Volume Size, Volumes Usage
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.0 And Later
✔ Easy Module Upgrade To Open Source Version

Installation and Configuration

This tutorial will show you how to successfully install and configure Virtuozzo Hybrid Infrastructure S3 For WHMCS smoothly.

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

Installation

1. Log in to our client area and download the module.
VHI 1.png
2. Upload and extract the extension into the main WHMCS directory.

Extracted files in your WHMCS directory should look like this:

VHI 2.png
3. When you install Virtuozzo Hybrid Infrastructure S3 For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

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

VHI 3.png
4. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

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

VHI 4.png
5. Now, set up the 'storage' folder as recursively writable.

This folder is available at '/yourWHMCS/modules/servers/VirtuozzoHybridInfrastructureS3/'.

VHI 5.png

Configuration of Server

Before you can go on, you need to copy your 'API Details' . You will need them to connect with the server successfully.

Proceed to your 'Virtuozzo Hybrid Infrastructure S3' panel. All necessary information will be found in the 'View Credentials' section under 'API Access' . ???????????

File:VHI 6.png
6. Now, log in to your WHMCS and proceed to 'System Settings' → 'Products/Services' → 'Servers' and press 'Add New Server'.
VHI 7.png
7. Next, enter your server 'Name' , 'Hostname' , 'IP Address' and select 'VirtuozzoHybridInfrastructureS3' from the 'Module' field.

Now, provide your 'VirtuozzoHybridInfrastructureS3 Server Details' . Make sure that your server connection is correct and save changes.

VHI 8.png
8. It is time to create a server group. To do so, click on 'Create New Group' .
VHI 9.png
9. Enter a name, click on your previously created server, press 'Add' and afterward 'Save Changes' .
VHI 10.png

Configuration of Product

10. In order to create and configure a product, go to 'System Settings' → 'Products/Services' → 'Products/Services'.

Click on 'Create a New Group'.

VHI 11.png
11. Enter your product group name and press 'Save Changes'.
VHI 12.png
12. Once you have a product group, you can create a new product.

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

VHI 13.png
13. Afterward, choose your product type, enter your product name, choose module and the product group from the dropdown menus. Press 'Continue'.
VHI 14.png
14. Now, go to the 'Module Settings' section, choose your previously created server group from the dropdown menu.

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

VHI 15.png
15. Now, let's start configuring the settings.

Configuration:

  • User Email -
  • Custom Email -
  • Panel Login URL -
  • API Endpoint -
  • API Documentation URL -
VHI 16.png
USer Limits:

Operations Per Seconds

  • Default [kilo ops/min] -
  • DELETE [kilo ops/min] -
  • GET [kilo ops/min] -
  • PUT [kilo ops/min] -
  • LIST [kilo ops/min] -

Bandwidth

  • Out [Mb/s] -
VHI 17.png
Quota Management
  • User Quota [GB] -
VHI 18.png
Admin Area Features
  • Last Month Usage Records - Show Last Month Usage Records Table
  • ' User Limits - Show User Limits Table
VHI 19.png
Now, select which options you want to generate and confirm by clicking 'Create' .
Note that the configuration for disabled options will still be taken from the configuration of the main product.
More information about how to use configurable options can be found here or in the official WHMCS documentation.
VHI 20.png

Management

Admin Area

OpenStack Projects For WHMCS allows you to supervise and manage your customer products from the admin area of your WHMCS system.

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.
OSP 19.png

Ordering

Thanks to configurable options, you are able to offer a product which your clients can match to their needs.
Additionally, you are able to set up pricing for each configurable option, which makes your offer even more competitive.
OSP 20.png

Client Area

The client area interface of OpenStack Projects For WHMCS looks like below.
As you can see, you may easily redirect to the 'OpenStack' login page. Moreover, you can check the 'Configurable Options ' and 'Metrics Billing'
OSP 21.png

Tips

1. Please remember that if you integrate OpenStack Projects For WHMCS with Advanced Billing For WHMCS, the cron task should be set no more than once for an hour.
2. Metrics can be calculated basing on total or average usage for a given period of time. You can edit this in the following file: 
/yourWHMCS/modules/servers/OpenstackProjects/app/Config/configuration.yml

Find the 'averageBilling' option and set:

  • 'false' for total usage
  • 'true' for average usage
OSP 22.png

Update Instructions

An essential guidance through the process of updating the module is offered here.

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.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Virtuozzo_Hybrid_Infrastructure_S3_For_WHMCS&oldid=57184"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Virtuozzo Hybrid Infrastructure S3 For WHMCS