Proxmox VE VPS For WHMCS
From ModulesGarden Wiki
(Difference between revisions)
|
|
| Line 32: |
Line 32: |
| | {| | | {| |
| | |style="padding: 0px 0px 0px 30px;"|✔ Reinstall Server | | |style="padding: 0px 0px 0px 30px;"|✔ Reinstall Server |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Possibility To Add Additional IP To VM
| |
| | |} | | |} |
| | {| | | {| |
| Line 46: |
Line 43: |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 10px 30px;"|✔ VNC Console Access | + | |style="padding: 0px 0px 0px 30px;"|✔ VNC Console Access |
| | + | |} |
| | + | {| |
| | + | |style="padding: 0px 0px 0px 30px;"|✔ Auto Node - Possibility To Automatically Create VM On The Node With The Most Free Space |
| | + | |} |
| | + | {| |
| | + | |style="padding: 0px 0px 0px 30px;"|✔ Possibility To Import IP To Hosting IP Addresses Table |
| | + | |} |
| | + | {| |
| | + | |style="padding: 0px 0px 0px 30px;"|✔ Possibility To Return IP To IP Addresses Pool |
| | + | |} |
| | + | {| |
| | + | |style="padding: 0px 0px 10px 30px;"|✔ Possibility To Add Additional IP To VM |
| | |} | | |} |
| | *'''Proxmox Addon Features:''' | | *'''Proxmox Addon Features:''' |
| Line 105: |
Line 114: |
| | |} | | |} |
| | *'''Additionally:''' | | *'''Additionally:''' |
| | + | {| |
| | + | |style="padding: 10px 0px 0px 30px;"|✔ Supports PVE And PAM Autentication |
| | + | |} |
| | {| | | {| |
| | |style="padding: 10px 0px 0px 30px;"|✔ Dynamically Chosen Server Resources While Ordering And Possibility To Upgrade Those Resources | | |style="padding: 10px 0px 0px 30px;"|✔ Dynamically Chosen Server Resources While Ordering And Possibility To Upgrade Those Resources |
Revision as of 11:55, 21 November 2013
Proxmox VPS For WHMCS is a powerful module which allows you to automatically provision virtual servers to your customers.
Additionaly it allows you to conveniently manage your servers, IP addresses and clusters.
The great advantage of this module is the fact that customers can manage virtual servers, backups and much more in your own WHMCS client area!
|
| ✔ Suspend/Unsuspend Server
|
| ✔ Change Package (Supports Configurable Options)
|
| ✔ View Server Status, Details And Statistics
|
| ✔ View Graphs (With Ability To Change The Time Scale of MRTG Graphs)
|
| ✔ Display Disk And Bandwidth Usage Of Each Product
|
| ✔ Auto Node - Possibility To Automatically Create VM On The Node With The Most Free Space
|
| ✔ Possibility To Import IP To Hosting IP Addresses Table
|
| ✔ Possibility To Return IP To IP Addresses Pool
|
| ✔ Possibility To Add Additional IP To VM
|
| ✔ IP Management (Per Server)
|
| ✔ Backup Limits (Max Number Of Files & Max Size Of Files)
|
| ✔ Backup Limit Jobs (Max Number Of Tasks Performing Backups)
|
| ✔ View Server Status, Details And Statistics
|
| ✔ View Graphs (With Ability To Change The Time Scale of MRTG Graphs)
|
| ✔ Display Disk And Bandwidth Usage
|
| ✔ Easy Product Upgrade/Downgrade
|
| ✔ Supports PVE And PAM Autentication
|
| ✔ Dynamically Chosen Server Resources While Ordering And Possibility To Upgrade Those Resources
|
| ✔ Integrated With Advanced Billing For WHMCS - Server Resource Usage Billing (read more)
|
| ✔ Supports Proxmox VE 3 and Later
|
| ✔ Supports WHMCS V5 and Later
|
- Available Configurable Options:
| ✔ Number of Cores Per Socket
|
Installation and Configuration
This tutorial will show you how to successfully install and configure Proxmox VPS For WHMCS.
We will guide you step by step through the whole installation and configuration process.
|
Installation
| 1. Log in to your client area and download Proxmox VPS For WHMCS.
|
| 2. Upload and extract the module into the main WHMCS directory.
|
3. When you install Proxmox VPS for the first time you have to rename 'license_RENAME.php' file.
File is located at 'modules/servers/proxmoxVPS/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .
|
4. In order to configure your license key, you have to edit a previously renamed 'license.php' file.
Enter your licence key between quotation marks as presented on the following screen.
You can find your license key at your client area → 'My Products' .
|
Activation of Proxmox Addon
5. Firstly we should activate Proxmox Addon.
To do so, log in into your WHMCS and press 'Setup' → 'Addon Modules' . Find 'Proxmox Addon' and press 'Activate' .
|
6. In next step you need to permit access to this module.
To do so click on 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.
|
Configuration of Server
7. Now we will show you how to configure a new product.
Go to 'Setup' → 'Products/Services' → 'Servers' and press 'Add New Server' .
|
8. Next, enter your server name, IP address, username and password. Choose 'Proxmox VPS' from a dropdown menu and press 'Save Changes' .
|
9. After you configure your server correctly, you will see a following screen.
You can check connection with Proxmox server, simply press 'Test Connection' as shown on screen below.
|
| 10. It is time to create a server group, to do so click on 'Create Server Group' .
|
| 11. Enter name, click on your previously created server, press 'Add' and afterwards 'Save Changes' .
|
Configuration of Product
12. In order to create and configure a product click on 'Setup' → 'Products/Services' → 'Products/Services' .
Click on 'Create a New Group' .
|
| 13. Enter product group name and press 'Save Changes' .
|
14. When you have a product group, you can create your product.
To create a product click on 'Create a New Product' .
|
15. Afterwards choose your product group and type from dropdown menus, enter your product name and press 'Continue' .
'Product Type' should be set to 'Dedicated/VPS Server' in order to add nameservers later.
|
16. Now go to 'Module Settings' section, choose both 'Proxmox VPS' and your previously created server group from dropdown menus.
Next, click on 'Save Changes' .
|
17. From dropdown menus choose 'Virtualization Type' , 'Default Node' and 'Template & ISO Storage' .
Afterwards press 'Save Changes' .
Note: If you choose 'Auto-Node' as 'Default Note', new virtual servers will be created on the least used node.
|
18. Setting of KVM virtualization type. (skip, if you have chosen OpenVZ virtualization type)
From dropdown menus choose 'KVM OS Type' , 'Storage' , 'Disk Type' , 'CD/DVD-ROM Type' , 'ISO Image' , 'Network Mode' , 'Network Model' , 'Bridge' , 'Node' and 'Storage' .
Type your VM description in 'Container Description' and click 'Save Changes' .
|
19. Setting of OpenVZ virtualization type. (skip, if you have chosen KVM virtualization type)
From dropdown menus choose 'OpenVZ OS Template' , 'Target Storage' , 'Node' and 'Storage' .
Type your VM description in 'Container Description' and press 'Save Changes' .
|
| 20. At the end of product configuration press 'Generate default' nearby 'Configurable Options' and 'Custom Fields' .
|
By doing so, you have just added a custom field 'vmid' and configurable options shown on the screen below.
Left column is for configurable options for KVM virtualization type, right column is for OpenVZ.
|
| Congratulations! You have just finished the installation and configuration of the module.
|
Configuration of Addon
20. Adding new IP address
In order to create new product you have to add product 'Dedicated IP ' to 'IP Addresses' list in 'Proxmox' addon module.
To do so, go to 'Addons' → 'Proxmox Addon' → 'IP Management' and press 'Add Pool' .
Note: You can add both IPv4 and IPv6 addresses.
|
21. Type desired IP and mask in 'IP Pool' and choose server from a 'Server' dropdown menu.
Afterwards press 'Add Pool' .
|
22. You are now able to create new product using previously added IP address.
If you used KVM virtualization type, the client area of successfully created producs should look similar as on the screen below.
Note that the screen below presents the module, right after creation of the product. Graphs will fill with data after use of certain server resources.
|
| 23.The client area of product using OpenVZ virtualization type looks quite similar.
|
Management
Proxmox VPS allows your customers to manage their PVE accounts via client area in your WHMCS system.
You can monitor and manage each product from your WHMCS admin area.
You are also able to add IP address to product. To do so, press 'Add New IP' as shown on the following screen.
|
| Afterwards, enter IP address in a textbox and confirm through 'Save Changes' .
|
Management of Addon
In 'Addons' → 'Proxmox Addon' → 'Server List' you can find servers you have configured.
To see what product were created and assigned to your Proxmox server simply click on it's 'Server Name' .
|
| As you can see on the screen below, you can find a lot of useful information here like e.g. IP, VM ID or VM Type.
|
| In 'IP Management' tab you can add, edit and remove IP addresses of Proxmox products.
|
| 'Clusters' tab contains clusters list. To view information about cluster simply press on it's name.
|
Here you can find various information about cluster, from available resource to graph of their use.
In order to go back to cluster list, press on 'Back to clusters list' button.
|
Interface
Client area interface of Proxmox VPS should look like the one on the screen below. As you can see, control panel contain useful options needed for managing VPS.
Module allows your customers to easily boot(1), reboot(2), stop(3) and shutdown(4) their servers through pressing specified button.
Clients can also reinstall(5) server, access VNC console(6), create backup (7) and set up backup jobs(8).
|
VNC Console
One of the most interesting functionality is VNC console(6) where your clients can remotely manage server. To access it, simply press on the 'Console' button.
Console requires Java software. You need to accept security risk to run it.
|
Reinstall
Reinstall feature allows to change template from available templates list. To reinstall your server, choose a template and click on 'Reinstall' (5) button.
|
Backup Jobs & Backup
By pressing 'Backup Jobs' (8) in your client area, you will be carried to backup jobs management page.
To add new backup job press 'New Job' as shown on the following screen.
|
Now define backup time, mark days to run it and choose 'Compression Dump File' and 'Backup Mode' from dropdown menus.
Next, press 'Add' button.
|
| You can also create a single backup. To do so, press 'Backup' (7) button and click on 'New Backup' as shown on the folowing screen.
|
Now choose 'Compress Dump File' and 'Backup Mode' from dropdown menus.
Afterward press 'Add Backup' .
|
| To restore VM from backup simply press 'Restore' and then click 'OK' button in a popup window to confirm.
|
In main product page in the client area, under 'Details' headline your client can find information about current usage of CPU, memory and disk (OpenVZ only).
Customer can also view 'DNS' (OpenVZ only) and 'IP Adresses' .
|
Graphs
Under 'Details' section client can find graph of CPU usage, memory usage, network traffic and disc I/O.
He can also switch timeline of the graphs by choosing it from a dropdown menu pointed at the following screen.
|
Management of Configurable Options
| When you successfully set up a product, your client can order it by choosing from default configurable options.
|
In case those options aren't fitting your needs, you can edit them.
To do so, go to 'Setup' → 'Products/Services' → 'Configurable Option' and press edit button next to configurable option used by your product.
Its name is 'Configurable options for your_product_name' .
|
Here you can view all products this configurable option group is assigned to.
Now we will show you how to edit options. Let's say you want to add an option to order VPS with 4 cores per socket.
To do so, edit 'The number of cores per socket' by pressing edit button as shown on the screen below.
|
You will see a popup window, so make sure your browser will not block it.
To add new option enter it in a textbox under all other options, but if you want to replace it with option you currently have, simply edit its textbox.
Next, press 'Save Changes' .
|
Management of Billing
When you combine Proxmox VPS For WHMCS with Advanced Billing For WHMCS, you will be able to set up additional billing options.
Module allows you to charge your customers based on the server resources used by them.
|
| With Advanced Billing module, you can also display your customers the current server resource usage and their cost.
|
Management of Existing Accounts
You can easily use Proxmox VPS module with your existing Proxmox accounts. To do so, follow the instructions below:
1. Create and configure a Proxmox VPS server and a server group.
2. Create and configure a Proxmox VPS product.
3. Place new order with previously created product for your customer. Do not activate product yet.
4. Go to 'Products/Services' section of freshly created product and fill the field 'vmid' with your customer's VM ID.
5. If possible, enter IP addresses into fields 'Dedicated IP' and 'Assigned IPs' .
6. Set product status to 'Active' .
Remember to not click 'Create' button during the entire process. That would unnecessarily create a new virtual machine.
|
Tips
| 1. Operations performed on the virtual servers are not executed immediately. Give your Proxmox Virtual Environment some time for processing the request and execution of operation.
|
Common Problems
| 1. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
|
