Personal tools
Namespaces

Variants
Actions

Virtuozzo Hybrid Infrastructure S3 For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Installation and Configuration)
(→‎About Virtuozzo Hybrid Infrastructure S3 For WHMCS)
 
(92 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="<meta name="keywords" content="openstack projects for whmcs, openstack projects configuration, whmcs openstack projects management, whmcs openstack projects installation, whmcs openstack projects common problems, about whmcs openstack projects, whmcs openstack projects documentation, whmcs openstack projects faq, whmcs openstack projects help, whmcs openstack projects guide, whmcs openstack projects wiki, whmcs openstack projects tutorial, whmcs openstack projects tips, whmcs openstack projects wiki">
+
<meta name="keywords" content="<meta name="keywords" content="virtuozzo hybrid infrastructure s3 for whmcs, virtuozzo hybrid infrastructure s3 configuration, whmcs virtuozzo hybrid infrastructure s3 management, whmcs virtuozzo hybrid infrastructure s3 installation, whmcs virtuozzo hybrid infrastructure s3 common problems, about whmcs virtuozzo hybrid infrastructure s3, whmcs virtuozzo hybrid infrastructure s3 documentation, whmcs virtuozzo hybrid infrastructure s3 faq, whmcs virtuozzo hybrid infrastructure s3 help, whmcs virtuozzo hybrid infrastructure s3 guide, whmcs virtuozzo hybrid infrastructure s3 wiki, whmcs virtuozzo hybrid infrastructure s3 tutorial, whmcs virtuozzo hybrid infrastructure s3 tips, whmcs virtuozzo hybrid infrastructure s3 wiki">
−
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The OpenStack Projects For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Virtuozzo Hybrid Infrastructure S3 For WHMCS Module."></meta>
  
−
=About [https://www.modulesgarden.com/products/whmcs/virtuozzo_hybrid_infrastructure_s3 Virtuozzo Hybrid Infrastructure S3 For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/virtuozzo-hybrid-infrastructure-s3 Virtuozzo Hybrid Infrastructure S3 For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Virtuozzo Hybrid Infrastructure S3 For WHMCS''' is a module.......
+
|style="padding: 10px 0px 10px 0px;"|'''Virtuozzo Hybrid Infrastructure S3 For WHMCS''' is a module that allows quick and easy creation as well as management of S3 user accounts.<br/> You will be given a chance to create new accounts with predefined limits as well as let your clients set the limits by themselves.<br/> Use this great module to automate the accounts management and keep track of the usage calculations' in a convenient and eye-friendly way.
 
|}
 
|}
  
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate OpenStack Projects
+
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate S3 User Account
 
|}
 
|}
 
{|
 
{|
Line 15: Line 15:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Log In To Panel
+
|style="padding: 0px 0px 0px 30px;"|✔ View Last Month Usage Items
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Created Project/User/Domain IDs
+
|style="padding: 0px 0px 0px 30px;"|✔ View Set User Limits
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Set Up Project Configuration:
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Up User Account Configuration:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Default Domain
+
|style="padding: 0px 0px 0px 45px;"|✔ Use User Or Custom Email For Accounts
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define User Roles
+
|style="padding: 0px 0px 0px 45px;"|✔ Provide Login URL To Panel
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Client Projects Mode:
+
|style="padding: 0px 0px 0px 45px;"|✔ Provide API Endpoint
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 60px;"|✔ Default
+
|style="padding: 0px 0px 0px 45px;"|✔ Provide API Documentation URL
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 60px;"|✔ Only One Domain Per Client
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Up User Limits For:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 60px;"|✔ Only One Domain And User Per Client
+
|style="padding: 0px 0px 0px 45px;"|✔ Operations Per Seconds:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Provide OpenStack Panel Web Address
+
|style="padding: 0px 0px 0px 60px;"|✔ Default [kilo ops/min]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Provide Default Project/User Name
+
|style="padding: 0px 0px 0px 60px;"|✔ DELETE [kilo ops/min]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Toggle WHMCS Domain Overwriting
+
|style="padding: 0px 0px 0px 60px;"|✔ GET [kilo ops/min]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Displaying Domain For Clients
+
|style="padding: 0px 0px 0px 60px;"|✔ LIST [kilo ops/min]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Logging API Requests
+
|style="padding: 0px 0px 0px 60px;"|✔ PUT [kilo ops/min]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Set Up Limits For:
+
|style="padding: 0px 0px 0px 45px;"|✔ Bandwidth:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Compute
+
|style="padding: 0px 0px 0px 60px;"|✔ Out [Mb/s]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Block-Storage
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Quota Management Details:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Network
+
|style="padding: 0px 0px 0px 45px;"|✔ Define User Quota Usage Limit
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Load Balancer
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Bandwidth Usage Calculation Method
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Container Infrastructure
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Admin Area Features:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Kubernetes
+
|style="padding: 0px 0px 0px 45px;"|✔ Show Last Month Usage Records Table
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Traits (OpenStack) / Placement Groups (Virtuozzo)
+
|style="padding: 0px 0px 0px 45px;"|✔ Show User Limits Table
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Set Up Module Custom Webhooks
+
|style="padding: 0px 0px 10px 30px;"|✔ Generate Configurable Options
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Generate Configurable Options
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Run Server Connection Test
+
 
|}
 
|}
  
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ View Project Details:
+
|style="padding: 10px 0px 0px 30px;"|✔ View/Generate/Revoke Panel Access Keys
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Domain
+
|style="padding: 0px 0px 0px 30px;"|✔ View API Information:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Username
+
|style="padding: 0px 0px 0px 45px;"|✔ Endpoint
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Password
+
|style="padding: 0px 0px 0px 45px;"|✔ Documentation URL
 
|}
 
|}
 
{|
 
{|
Line 109: Line 103:
 
*'''Configurable Options:'''
 
*'''Configurable Options:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Backup Gigabytes
+
|style="padding: 10px 0px 0px 30px;"|✔ OPS Default [kilo ops/min]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Backups
+
|style="padding: 0px 0px 0px 30px;"|✔ OPS DELETE [kilo ops/min]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Cores
+
|style="padding: 0px 0px 0px 30px;"|✔ OPS GET [kilo ops/min]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Fixed IPs
+
|style="padding: 0px 0px 0px 30px;"|✔ OPS LIST [kilo ops/min]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Floating IP
+
|style="padding: 0px 0px 0px 30px;"|✔ OPS PUT [kilo ops/min]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Floating IPs
+
|style="padding: 0px 0px 0px 30px;"|✔ Bandwidth Out [Mb/s]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Gigabytes
+
|style="padding: 0px 0px 10px 30px;"|✔ User Quota [GB]
 
|}
 
|}
 +
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Groups
+
|style="padding: 10px 0px 0px 30px;"|✔ Integrated With [https://www.modulesgarden.com/products/whmcs/advanced-billing Advanced Billing For WHMCS] - Actual User Account Resource Usage Billing
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Hard Limit
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Heath Monitor
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Injected File Content [Bytes]
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Metric Billing - Integration: OPS Other, OPS GET, OPS PUT, OPS LIST, OPS Total, Uploaded, Downloaded, Storage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Injected File Path [Bytes]
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Injected Files
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.10 Back To WHMCS V8.7
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Instances
+
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Key Pairs
+
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/virtuozzo-hybrid-infrastructure-s3#open-source-version Open Source Version]
 
|}
 
|}
 +
 +
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Listener
+
|style="padding: 10px 0px 30px 0px;"|'''The below tutorial will guide you step by step through the installation and configuration of the [https://www.modulesgarden.com//products/whmcs/virtuozzo_hybrid_infrastructure_s3 Virtuozzo Hybrid Infrastructure S3 For WHMCS] module.''' <br />
 +
Read the instructions carefully to collect as much information as possible and quickly start using the module in your everyday business.
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Load Balancer
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Member
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Metadata Items
+
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the extension into the main WHMCS directory.<br />
 +
Extracted files in your WHMCS directory should look like this:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Network
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Per Volume Gigabytes
+
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Virtuozzo Hybrid Infrastructure S3 For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br />
 +
The file is located in '' '/yourWHMCS/modules/servers/VirtuozzoHybridInfrastructureS3/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Pool
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Port
+
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br />
 +
Enter your license key between the quotation marks as presented on the following screen.<br />
 +
You can find your license key in our client area → '' 'My Products'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ RAM [MB]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_4.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Role-based Access Control Policy (RBAC Policy)
+
|style="padding: 0px 0px 15px 15px;"|'''5. Now, set up the  '' 'storage' '' folder as recursively writable.'''<br />
 +
This folder is available at '' '/yourWHMCS/modules/servers/VirtuozzoHybridInfrastructureS3/'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Router
+
|style="padding: 0px 0px 30px 25px;"|[[File:VHI_5.png]]
 
|}
 
|}
 +
 +
==Configuration of Server==
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Security Group
+
|style="padding: 10px 0px 15px 15px;"|'''Before you can go on, you need to generate the user ID and the API key pair, they will be necessary to successfully connect to the VHI server.'''<br/>
 +
Please follow the below steps to generate the access data:
 +
 
 +
# Log in via SSH to your VHI server
 +
# Run the below command:
 +
 
 +
ostor-s3-admin create-user -e [email protected] -S -V 0100000000000002
 +
 
 +
Follow instructions that are visible in your console.<br/>
 +
 
 +
Please refer to the official Virtuozzo documentation [https://docs.virtuozzo.com/virtuozzo_storage_administrators_command_line_guide/exporting-virtuozzo-storage-cluster-data/accessing-virtuozzo-storage-clusters-via-s3.html#creating-s3-users  Creating S3 User] to get detailed instruction.<br/>
 +
Once you have the access keys generated, copy them and keep safe as you will need them in the next step of the server configuration.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Security Group Rule
+
|style="padding: 0px 0px 20px 15px;"|'''6. Now, log in to your WHMCS and proceed to '' 'System Settings' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Security Group Rules
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_7.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Security Groups
+
|style="padding: 0px 0px 15px 15px;"|'''7. Next, enter your server '' 'Name' '', '' 'Hostname' '' and select '' 'Virtuozzo Hybrid Infrastructure S3' '' from the '' 'Module' '' field.'''<br/>
 +
Now, provide your '' 'VirtuozzoHybridInfrastructureS3' '' API details that you generated in the previous step: 
 +
*'''Username''' → '' 'S3AccessKeyId' ''
 +
*'''Password''' → '' 'S3SecretAccessKey'.''<br/>
 +
Make sure that your server connection is correct and save the changes.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Server Group Members
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_8.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Server Groups
+
|style="padding: 0px 0px 20px 15px;"|'''8. It is time to create a server group. To do so, click on '' 'Create New Group'.'' '''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Snapshots
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Subnet
+
|style="padding: 0px 0px 20px 15px;"|'''9. Enter a name, click on your previously created server, press '' 'Add' '' and afterward '' 'Save Changes'.'' '''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Subnet Pool
+
|style="padding: 0px 0px 30px 25px;"|[[File:VHI_10.png]]
 
|}
 
|}
 +
 +
==Configuration of Product==
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Traits (OpenStack) / Placement Groups (Virtuozzo)
+
|style="padding: 10px 0px 15px 15px;"|'''10. In order to create and configure a product, go to '' 'System Settings' '' → '' 'Products/Services' '' → '' 'Products/Services'.'''''<br />
 +
Click on '' 'Create a New Group'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Volumes
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_11.png]]
 
|}
 
|}
−
 
−
*'''Required Components:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 10px 30px;"|✔ Gnocchi (Required For Billing)
+
|style="padding: 0px 0px 20px 15px;"|'''11. Enter your product group name and press '' 'Save Changes'.'''''
 
|}
 
|}
−
 
−
*'''General Info:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Integrated With [https://www.modulesgarden.com/products/whmcs/advanced-billing Advanced Billing For WHMCS] - Actual Project Resource Usage Billing
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_12.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With [https://www.modulesgarden.com/products/whmcs/products-reseller Products Reseller For WHMCS] - End-To-End Solution For Products And Servers Reselling
+
|style="padding: 0px 0px 15px 15px;"|'''12. Once you have a product group, you can create a new product.'''<br />
 +
To do so, first click on '' 'Create a New Product'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_13.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports OpenStack Victoria and Previous
+
|style="padding: 0px 0px 15px 15px;"|'''13. Afterward, choose your product type, enter your product name, choose module and the product group from the dropdown menus. Press '' 'Continue'. '' '''<br />
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports OpenStack Gnocchi
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_14.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports Virtuozzo Hybrid Infrastructure
+
|style="padding: 0px 0px 15px 15px;"|'''14. Now, go to the '' 'Module Settings' '' section, choose your previously created server group from the dropdown menu.'''<br />
 +
If you did not set the proper permissions, you will be asked to do it now.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 7.2 Up To PHP 7.4
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_15.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ 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,<br/> Memory Usage, Network Incoming Bytes, Network Incoming Packets, Network Outgoing Bytes, Network Outgoing Packets, OS Images, VCPUs, Volume Size, Volumes Usage
+
|style="padding: 0px 0px 15px 15px;"|'''15. Now, let's start configuring the product settings.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_16.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.0 And Later
+
|style="padding: 0px 0px 15px 15px;"|The first section is dedicated to basic product configuration, select email type that will be used to create the service, provide all the required data:
 +
 
 +
* '''User Email''' - enable this option and the user email address will be used when creating the service
 +
* '''Custom Email''' - if '' 'User Email' '' is disabled, the user will be generated in the VHI S3 panel based on the typed in here email address
 +
* '''Panel Login URL''' - type in the web address of the Virtuozzo S3 panel. Clients will be redirected to this site when they press the '' 'Log in to Panel' '' button in your client area.<br/> Please remember to provide a valid HTTP protocol
 +
* '''API Endpoint''' - enter the API endpoint that will be displayed in your client area
 +
* '''API Documentation URL''' - type in the link to the API documentation, it will be visible in the client area as well
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Easy Module Upgrade To [https://www.modulesgarden.com/products/whmcs/openstack-projects#open-source-version Open Source Version]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_16_1.png]]
 
|}
 
|}
−
 
−
=Installation and Configuration=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com//products/whmcs/virtuozzo_hybrid_infrastructure_s3 Virtuozzo Hybrid Infrastructure S3 For WHMCS] smoothly.''' <br />
+
|style="padding: 0px 0px 15px 15px;"|Next move to setting the user limits, define the operations limit and bandwidth.<br/>
−
We will guide you step by step through the whole installation and configuration process.
+
'''Operations Per Seconds'''
 +
* '''Default [kilo ops/min]''' - in this field please enter the value that will be treated as a default one for operations limits.<br/> If provided, all unspecified operation limits will be set to this default value, otherwise they will be set to 0.
 +
* '''DELETE [kilo ops/min]''' - enter the value for the DELETE operations limit
 +
* '''GET [kilo ops/min]''' - enter the value for the GET operations limit
 +
* '''PUT [kilo ops/min]''' - enter the value for the PUT operations limit
 +
* '''LIST [kilo ops/min]''' - enter the value for the LIST operations limit <br/>
 +
'''Bandwidth'''
 +
* '''Out [Mb/s]''' - define an outgoing bandwidth limit
 
|}
 
|}
−
==Installation==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_17.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_1.png]]
+
|style="padding: 0px 0px 15px 15px;"|The next section is dedicated to quota management:
 +
* '''User Quota [GB]''' - define the storage usage limit per user in gigabytes
 +
* '''Bandwidth Usage Calculation''' - select the bandwidth usage calculation method: include the uploads or downloads only, or both.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the extension into the main WHMCS directory.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_18.png]]
−
Extracted files in your WHMCS directory should look like this:
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_2.png]]
+
|style="padding: 0px 0px 15px 15px;"|In the next section the units of "disk space" and "bandwidth" configurable options shall be defined:
 +
* '''Disk Space''' - specify the unit in which the "disk space" configurable option will be offered: MG, GB, TB
 +
* '''Bandwidth''' - specify the unit in which the "bandwidth" configurable option will be offered: MG, GB, TB
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Virtuozzo Hybrid Infrastructure S3 For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_18_1.png]]
−
The file is located in '' '/yourWHMCS/modules/servers/VirtuozzoHybridInfrastructureS3/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_3.png]]
+
|style="padding: 0px 0px 15px 15px;"| To set up the quota and bandwidth limits via the "disk space" and "bandwidth" configurable options you must configure them as well.<br/> Please refer to the official [https://docs.whmcs.com/Disk_Space_and_Bandwidth_Overage_Billing#Custom_Fields_and_Configurable_Options WHMCS documentation] for precise instructions on how to do that, as the two configurable options are not automatically generated by the module. <br/>''
 +
If you decide to set up the limits in the module settings, please manually create new configurable options and assign them to the product.<br/>
 +
'''''Note:''' When setting up limits remember to use whole numbers for GB and MB, and integer numbers for TB. If you add 0.5TB then 1GB is displayed in User Limits.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_18_2.png]]
−
Enter your license key between the quotation marks as presented on the following screen.<br />
+
−
You can find your license key in our client area → '' 'My Products'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_18_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. Now, set up the '' 'storage' '' folder as recursively writable.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|In '' 'Admin Area Features' '' select options that will be visible under the product details:
−
This folder is available at '' '/yourWHMCS/modules/servers/VirtuozzoHybridInfrastructureS3/'. ''
+
* '''Last Month Usage Records''' - if enabled, the ' ''Last Month Usage Records' '' table will be available
 +
* '''User Limits''' - show the '' 'User Limits' '' table
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:VHI_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_19.png]]
 
|}
 
|}
  
−
==Configuration of Server==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 0px;"|'''Before you can go on, you need to copy your '' 'API Details' ''. You will need them to connect with the server successfully.'''<br/>
+
|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].
−
Proceed to your '' 'Virtuozzo Hybrid Infrastructure S3' '' panel. All necessary information will be found in the '' 'View Credentials' '' section under '' 'API Access' ''. ???????????<br/>
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_6.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:VHI_20.png]]
 
|}
 
|}
 +
 +
=Management=
 +
==Admin Area==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''6. Now, log in to your WHMCS and proceed to '' 'System Settings' '' → '' 'Products/Services' '' → '' 'Servers' '' and press '' 'Add New Server'.''
+
|style="padding: 10px 0px 15px 15px;"|''' Virtuozzo Hybrid Infrastructure S3 For WHMCS allows you to manage the user account from the admin area of your WHMCS system.'''<br />
 +
This includes supervision of such features as:
 +
* Configurable options which enable you to view the chosen user limits, if they are used in the product
 +
* Module commands to allow easy and quick management of the user account:<br/>
 +
** Create – creating a new user with a set of limits
 +
** Suspend – it changes the user status to disabled in the panel, which means that access to its bucket is impossible
 +
** Unsuspend – the user status is reverted to enabled and access to bucket is possible again
 +
** Terminate –  removing a user from the Virtuozzo S3 panel
 +
** Change Package – upgrading the user limits
 +
* '' 'Last Month Usage Items' '' table
 +
* '' 'User Limits' '' table
 +
* Metric Statistics - the section is completed with all metrics the module can observe; please note that you must previously enable the statistics on your S3 gateway to allow the module to collect them.<br/> Please refer to the [[#Tips|Tips]] section, tip number '''5''' to learn how to do that.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_7.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:VHI_21.png]]
 
|}
 
|}
 +
 +
==Ordering==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. Next, enter your server '' 'Name' '', '' 'Hostname' '', '' 'IP Address' '' and select '' 'VirtuozzoHybridInfrastructureS3' '' from the '' 'Module' '' field.'''<br/>
+
|style="padding: 10px 0px 15px 15px;"|Thanks to configurable options, your clients are allowed to adjust the account limits already on the order level.<br />Additionally, you are able to set up pricing for each configurable option, which makes your offer more flexible.<br/>
−
Now, provide your '' 'VirtuozzoHybridInfrastructureS3 Server Details' ''. Make sure that your server connection is correct and save changes.  
+
 
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_8.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:VHI_22.png]]
 
|}
 
|}
 +
 +
==Client Area==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''8. It is time to create a server group. To do so, click on '' 'Create New Group' ''.'''
+
|style="padding: 10px 0px 15px 15px;"|The client area interface of Virtuozzo Hybrid Infrastructure S3 For WHMCS looks like below.<br/>As you can see, you may easily redirect to your '' 'Virtuozzo Hybrid Infrastructure S3' '' bucket via a direct login, just press the '' 'Log in to Panel' '' icon.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_23.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''9. Enter a name, click on your previously created server, press '' 'Add' '' and afterward '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 15px 15px;"|Under the '' 'Access Keys'' ' section you will find the IDs of the already generated key pairs. Please remember that only IDs are visible as true credentials were displayed only once when generated. <br/> There is a limit of two key pairs to be generated, you may always delete any of the generated API credentials, and then, the option to create a new one will be reverted.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:VHI_10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_24.png]]
 
|}
 
|}
−
 
−
==Configuration of Product==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''10. In order to create and configure a product, go to '' 'System Settings' '' → '' 'Products/Services' '' → '' 'Products/Services'.'''''<br />
+
|style="padding: 0px 0px 15px 15px;"|Press the '' 'Generate Access Key' '' button, you will see a modal with generated S3 access key ID and an S3 secure access key. It is important to copy and save the keys in a secure place as there is no way to preview them again.<br/> When you reach the limit of two pairs generated, the option to '' 'Generate Access Key' '' will be suspended. 
−
Click on '' 'Create a New Group'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_11.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_25.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''11. Enter your product group name and press '' 'Save Changes'.'''''
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_26.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_12.png]]
+
|style="padding: 0px 0px 20px 15px;"|Moreover, you can check the WHMCS '' 'Metrics Billing' '' in the adequate section.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''12. Once you have a product group, you can create a new product.'''<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:VHI_23_1.png]]
−
To do so, first click on '' 'Create a New Product'.''
+
 
|}
 
|}
 +
 +
==[https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS] Integration==
 +
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_13.png]]
+
|style="padding: 10px 0px 15px 15px;"|'''Smooth integration with the [https://www.docs.modulesgarden.com/Hosting_Quota_Notifications_For_WHMCS Hosting Quota Notifications For WHMCS] module allows to keep constant and comfortable control over the used resources.'''<br/>
 +
If you decide to use the two modules together, you will be granted numerous advantages. <br/> First and foremost, you will be allowed to automatize the system of informing your clients about exceeding or just being close exceed set up limits of bandwidth and disk usage via an email and/or a ticket.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''13. Afterward, choose your product type, enter your product name, choose module and the product group from the dropdown menus. Press '' 'Continue'. '' '''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_28_0.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_28.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''14. Now, go to the '' 'Module Settings' '' section, choose your previously created server group from the dropdown menu.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|The contents of the ticket message can be easily changed, customized and translated to perfectly fit your needs.<br/> You may do that straight in the Hosting Quota Notifications addon: ''' "Ticket Templates" ''' section.
−
If you did not set the proper permissions, you will be asked to do it now.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_29.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''15. Now, let's start configuring the settings.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|Furthermore, you may set up dedicated rules according to which the resource usage of the selected VHI S3 service will be checked.<br/> Decide whether the service shall be automatically suspended or terminated once the limit is exceeded.<br/>
−
'' '''Configuration:''' ''
+
For details on how to configure the rules, follow the Hosting Quota Notification module [https://www.docs.modulesgarden.com/Hosting_Quota_Notifications_For_WHMCS#Rule_Configuration documentation].
−
* '''User Email''' -
+
−
* '''Custom Email''' -
+
−
* '''Panel Login URL''' - select a preferred mode that defines how new hostings will be created.
+
−
* '''API Endpoint''' - is the web address for the login page to the OpenStack panel.
+
−
* '''Default Domain''' - 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}''
+
−
* '''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_30.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|
+
|style="padding: 0px 0px 15px 15px;"|The module also allows to check the details of the current resource usage of the [https://www.docs.modulesgarden.com/Hosting_Quota_Notifications_For_WHMCS#Services service] per each day.<br/> View the statistics on the disk and bandwidth usages per single product directly in the addon: ''Services → Usage'' section.
−
'' '''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/>
+
−
'''''Note:''' Keep in mind that in the case of Virtuozzo server 'Traits' stand for 'Placement Groups' endpoints.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_16_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:VHI_31.png]]
 
|}
 
|}
 +
 +
=Tips=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|
+
|style="padding: 10px 0px 5px 15px;"|1. Please remember that if you integrate Virtuozzo Hybrid Infrastructure S3 For WHMCS with [https://www.modulesgarden.com/products/whmcs/advanced-billing Advanced Billing For WHMCS], the cron task should be set no more than once for an hour.  
−
'' '''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.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_16_2.png]]
+
|style="padding: 0px 0px 10px 15px;"|2. Metrics can be calculated based on '''total''' or '''average usage''' for a given period of time. You can edit this in the following file:
 +
<pre>/yourWHMCS/modules/servers/VirtuozzoHybridInfrastructureS3/app/Config/configuration.yml</pre>
 +
Find the 'averageBilling' option and set it:
 +
*'false' for total usage
 +
*'true' for average usage
 
|}
 
|}
 
{|
 
{|
−
|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 20px 25px;"|[[File:VHI_27.png]]
−
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/>
+
−
If you decide to use configurable options, select the configurable options unit and then press the 'Create Configurable Options' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_16_3.png]]
+
|style="padding: 0px 0px 10px 15px;"|3. Although the module does not require any domain to work properly, you will need to use one to allow WHMCS metrics to be correctly fetched and displayed.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OSP_17.png]]
+
|style="padding: 0px 0px 10px 15px;"|4. It is possible to verify if the usage statistics displayed in the product details are correctly calculated. Please run the below cron command in your console to do so:
 +
php -q /home/yourWHMCS/modules/servers/VirtuozzoHybridInfrastructureS3/cron/cron.php metrics:fetch
 +
Remember to replace '' 'yourWHMCS' '' with the correct WHMCS directory.
 
|}
 
|}
 
{|
 
{|
−
|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 15px;"|5. You need to enable the statistics collection on your S3 gateway to allow the module to collect data and display them in the "Metric Statistics" in the admin area. <br/>
−
|}
+
* Create a file on every S3 storage node: '''/var/lib/ostor/local/gw.conf'''<br/> Content of the newly created files:
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:OSP_18.png]]
+
−
|}
+
  
−
=Management=
+
  # Enable usage statistics collection.
−
==Admin Area==
+
  S3_GW_COLLECT_STAT=1
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|''' OpenStack Projects For WHMCS allows you to supervise and manage your customer products from the admin area of your WHMCS system.'''<br />
+
−
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<br/>
+
−
** 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).<br/> '''Important!''' From the 1.1.0 version of the module, the following cron command is required to terminate a project ('''5-minute interval suggested'''). <br/> Do not forget to replace 'yourWHMCS' with your WHMCS root location.  <pre> php -q /yourWHMCS/modules/servers/OpenstackProjects/cron/cron.php queue </pre>
+
−
** 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.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:OSP_19.png]]
+
−
|}
+
  
−
==Ordering==
+
* Restart the S3 storage service to apply the configuration changes. Run the following command on all S3 storage nodes:
−
{|
+
 
−
|style="padding: 10px 0px 15px 15px;"|Thanks to configurable options, you are able to offer a product which your clients can match to their needs.<br />Additionally, you are able to set up pricing for each configurable option, which makes your offer even more competitive.<br/>
+
  # systemctl restart ostor-agentd.service
  
 
|}
 
|}
 +
 +
=Update Instructions=
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OSP_20.png]]
+
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
 +
Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.
 
|}
 
|}
−
==Client Area==
+
=Upgrade Guide=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The client area interface of OpenStack Projects For WHMCS looks like below.<br/>As you can see, you may easily redirect to the '' 'OpenStack' '' login page. Moreover, you can check the '' 'Configurable Options'' ' and '' 'Metrics Billing' ''<br />
+
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/>
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:OSP_21.png]]
+
−
|}
+
  
−
=Tips=
+
Opt for the [https://www.modulesgarden.com/products/whmcs/virtuozzo-hybrid-infrastructure-s3#open-source-version Open Source version] of your Virtuozzo Hybrid Infrastructure S3 For WHMCS module to unlock these benefits.<br/> 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.<br/>
−
{|
+
 
−
|style="padding: 10px 0px 15px 15px;"|1. Please remember that if you integrate OpenStack Projects For WHMCS with [https://www.modulesgarden.com/products/whmcs/advanced-billing Advanced Billing For WHMCS], the cron task should be set no more than once for an hour.  
+
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module 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.
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|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: 
+
−
<pre>/yourWHMCS/modules/servers/OpenstackProjects/app/Config/configuration.yml</pre>
+
−
Find the 'averageBilling' option and set:
+
−
*'false' for total usage
+
−
*'true' for average usage
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:OSP_22.png]]
+
 
|}
 
|}
  
−
=Update Instructions=
+
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
+
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
−
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!<br/>
+
−
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.<br/>
+
 
|}
 
|}
−
 
−
=Common Problems=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 0px 0px 30px 15px;"|2. If you encounter a module command error: '' 'API Error: The bucket you tried to delete is not empty' ''<br/>
 +
Please remove all the bucket content before terminating it. The bucket must be empty to run the '' 'Terminate' '' action successfully.
 
|}
 
|}

Latest revision as of 11:48, 26 April 2024

Contents

[edit] About Virtuozzo Hybrid Infrastructure S3 For WHMCS

Virtuozzo Hybrid Infrastructure S3 For WHMCS is a module that allows quick and easy creation as well as management of S3 user accounts.
You will be given a chance to create new accounts with predefined limits as well as let your clients set the limits by themselves.
Use this great module to automate the accounts management and keep track of the usage calculations' in a convenient and eye-friendly way.
  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate S3 User Account
✔ Change Package
✔ View Last Month Usage Items
✔ View Set User Limits
✔ Set Up User Account Configuration:
✔ Use User Or Custom Email For Accounts
✔ Provide Login URL To Panel
✔ Provide API Endpoint
✔ Provide API Documentation URL
✔ Set Up User Limits For:
✔ Operations Per Seconds:
✔ Default [kilo ops/min]
✔ DELETE [kilo ops/min]
✔ GET [kilo ops/min]
✔ LIST [kilo ops/min]
✔ PUT [kilo ops/min]
✔ Bandwidth:
✔ Out [Mb/s]
✔ Set Quota Management Details:
✔ Define User Quota Usage Limit
✔ Select Bandwidth Usage Calculation Method
✔ Choose Admin Area Features:
✔ Show Last Month Usage Records Table
✔ Show User Limits Table
✔ Generate Configurable Options
  • Client Area Features:
✔ View/Generate/Revoke Panel Access Keys
✔ View API Information:
✔ Endpoint
✔ Documentation URL
✔ Log In To Panel
  • Configurable Options:
✔ OPS Default [kilo ops/min]
✔ OPS DELETE [kilo ops/min]
✔ OPS GET [kilo ops/min]
✔ OPS LIST [kilo ops/min]
✔ OPS PUT [kilo ops/min]
✔ Bandwidth Out [Mb/s]
✔ User Quota [GB]
  • General Info:
✔ Integrated With Advanced Billing For WHMCS - Actual User Account Resource Usage Billing
✔ Multi-Language Support
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Metric Billing - Integration: OPS Other, OPS GET, OPS PUT, OPS LIST, OPS Total, Uploaded, Downloaded, Storage
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.10 Back To WHMCS V8.7
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] Installation and Configuration

The below tutorial will guide you step by step through the installation and configuration of the Virtuozzo Hybrid Infrastructure S3 For WHMCS module.

Read the instructions carefully to collect as much information as possible and quickly start using the module in your everyday business.

[edit] 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

[edit] Configuration of Server

Before you can go on, you need to generate the user ID and the API key pair, they will be necessary to successfully connect to the VHI server.

Please follow the below steps to generate the access data:

  1. Log in via SSH to your VHI server
  2. Run the below command: 
ostor-s3-admin create-user -e [email protected] -S -V 0100000000000002

Follow instructions that are visible in your console.

Please refer to the official Virtuozzo documentation Creating S3 User to get detailed instruction.
Once you have the access keys generated, copy them and keep safe as you will need them in the next step of the server configuration.

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' and select 'Virtuozzo Hybrid Infrastructure S3' from the 'Module' field.

Now, provide your 'VirtuozzoHybridInfrastructureS3' API details that you generated in the previous step:

  • Username → 'S3AccessKeyId'
  • Password → 'S3SecretAccessKey'.

Make sure that your server connection is correct and save the 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

[edit] 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 product settings.
VHI 16.png
The first section is dedicated to basic product configuration, select email type that will be used to create the service, provide all the required data:
  • User Email - enable this option and the user email address will be used when creating the service
  • Custom Email - if 'User Email' is disabled, the user will be generated in the VHI S3 panel based on the typed in here email address
  • Panel Login URL - type in the web address of the Virtuozzo S3 panel. Clients will be redirected to this site when they press the 'Log in to Panel' button in your client area.
    Please remember to provide a valid HTTP protocol
  • API Endpoint - enter the API endpoint that will be displayed in your client area
  • API Documentation URL - type in the link to the API documentation, it will be visible in the client area as well
VHI 16 1.png
Next move to setting the user limits, define the operations limit and bandwidth.

Operations Per Seconds

  • Default [kilo ops/min] - in this field please enter the value that will be treated as a default one for operations limits.
    If provided, all unspecified operation limits will be set to this default value, otherwise they will be set to 0.
  • DELETE [kilo ops/min] - enter the value for the DELETE operations limit
  • GET [kilo ops/min] - enter the value for the GET operations limit
  • PUT [kilo ops/min] - enter the value for the PUT operations limit
  • LIST [kilo ops/min] - enter the value for the LIST operations limit

Bandwidth

  • Out [Mb/s] - define an outgoing bandwidth limit
VHI 17.png
The next section is dedicated to quota management:
  • User Quota [GB] - define the storage usage limit per user in gigabytes
  • Bandwidth Usage Calculation - select the bandwidth usage calculation method: include the uploads or downloads only, or both.
VHI 18.png
In the next section the units of "disk space" and "bandwidth" configurable options shall be defined:
  • Disk Space - specify the unit in which the "disk space" configurable option will be offered: MG, GB, TB
  • Bandwidth - specify the unit in which the "bandwidth" configurable option will be offered: MG, GB, TB
VHI 18 1.png
To set up the quota and bandwidth limits via the "disk space" and "bandwidth" configurable options you must configure them as well.
Please refer to the official WHMCS documentation for precise instructions on how to do that, as the two configurable options are not automatically generated by the module.

If you decide to set up the limits in the module settings, please manually create new configurable options and assign them to the product.
Note: When setting up limits remember to use whole numbers for GB and MB, and integer numbers for TB. If you add 0.5TB then 1GB is displayed in User Limits.

VHI 18 2.png
VHI 18 3.png
In 'Admin Area Features' select options that will be visible under the product details:
  • Last Month Usage Records - if enabled, the ' Last Month Usage Records' table will be available
  • User Limits - show the '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

[edit] Management

[edit] Admin Area

Virtuozzo Hybrid Infrastructure S3 For WHMCS allows you to manage the user account from the admin area of your WHMCS system.

This includes supervision of such features as:

  • Configurable options which enable you to view the chosen user limits, if they are used in the product
  • Module commands to allow easy and quick management of the user account:
    • Create – creating a new user with a set of limits
    • Suspend – it changes the user status to disabled in the panel, which means that access to its bucket is impossible
    • Unsuspend – the user status is reverted to enabled and access to bucket is possible again
    • Terminate – removing a user from the Virtuozzo S3 panel
    • Change Package – upgrading the user limits
  • 'Last Month Usage Items' table
  • 'User Limits' table
  • Metric Statistics - the section is completed with all metrics the module can observe; please note that you must previously enable the statistics on your S3 gateway to allow the module to collect them.
    Please refer to the Tips section, tip number 5 to learn how to do that.
VHI 21.png

[edit] Ordering

Thanks to configurable options, your clients are allowed to adjust the account limits already on the order level.
Additionally, you are able to set up pricing for each configurable option, which makes your offer more flexible.
VHI 22.png

[edit] Client Area

The client area interface of Virtuozzo Hybrid Infrastructure S3 For WHMCS looks like below.
As you can see, you may easily redirect to your 'Virtuozzo Hybrid Infrastructure S3' bucket via a direct login, just press the 'Log in to Panel' icon.
VHI 23.png
Under the 'Access Keys ' section you will find the IDs of the already generated key pairs. Please remember that only IDs are visible as true credentials were displayed only once when generated.
There is a limit of two key pairs to be generated, you may always delete any of the generated API credentials, and then, the option to create a new one will be reverted.
VHI 24.png
Press the 'Generate Access Key' button, you will see a modal with generated S3 access key ID and an S3 secure access key. It is important to copy and save the keys in a secure place as there is no way to preview them again.
When you reach the limit of two pairs generated, the option to 'Generate Access Key' will be suspended.
VHI 25.png
VHI 26.png
Moreover, you can check the WHMCS 'Metrics Billing' in the adequate section.
VHI 23 1.png

[edit] Hosting Quota Notifications For WHMCS Integration

Smooth integration with the Hosting Quota Notifications For WHMCS module allows to keep constant and comfortable control over the used resources.

If you decide to use the two modules together, you will be granted numerous advantages.
First and foremost, you will be allowed to automatize the system of informing your clients about exceeding or just being close exceed set up limits of bandwidth and disk usage via an email and/or a ticket.

VHI 28 0.png
VHI 28.png
The contents of the ticket message can be easily changed, customized and translated to perfectly fit your needs.
You may do that straight in the Hosting Quota Notifications addon: "Ticket Templates" section.
VHI 29.png
Furthermore, you may set up dedicated rules according to which the resource usage of the selected VHI S3 service will be checked.
Decide whether the service shall be automatically suspended or terminated once the limit is exceeded.

For details on how to configure the rules, follow the Hosting Quota Notification module documentation.

VHI 30.png
The module also allows to check the details of the current resource usage of the service per each day.
View the statistics on the disk and bandwidth usages per single product directly in the addon: Services → Usage section.
VHI 31.png

[edit] Tips

1. Please remember that if you integrate Virtuozzo Hybrid Infrastructure S3 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 based on total or average usage for a given period of time. You can edit this in the following file: 
/yourWHMCS/modules/servers/VirtuozzoHybridInfrastructureS3/app/Config/configuration.yml

Find the 'averageBilling' option and set it:

  • 'false' for total usage
  • 'true' for average usage
VHI 27.png
3. Although the module does not require any domain to work properly, you will need to use one to allow WHMCS metrics to be correctly fetched and displayed.
4. It is possible to verify if the usage statistics displayed in the product details are correctly calculated. Please run the below cron command in your console to do so: 
php -q /home/yourWHMCS/modules/servers/VirtuozzoHybridInfrastructureS3/cron/cron.php metrics:fetch

Remember to replace 'yourWHMCS' with the correct WHMCS directory.

5. You need to enable the statistics collection on your S3 gateway to allow the module to collect data and display them in the "Metric Statistics" in the admin area.
  • Create a file on every S3 storage node: /var/lib/ostor/local/gw.conf
    Content of the newly created files: 
 # Enable usage statistics collection.
 S3_GW_COLLECT_STAT=1
  • Restart the S3 storage service to apply the configuration changes. Run the following command on all S3 storage nodes: 
 # systemctl restart ostor-agentd.service

[edit] Update Instructions

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

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

[edit] Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your Virtuozzo Hybrid Infrastructure S3 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.

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. If you encounter a module command error: 'API Error: The bucket you tried to delete is not empty'

Please remove all the bucket content before terminating it. The bucket must be empty to run the 'Terminate' action successfully.

Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Virtuozzo_Hybrid_Infrastructure_S3_For_WHMCS&oldid=66684"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Virtuozzo Hybrid Infrastructure S3 For WHMCS