Proxmox VE VPS For WHMCS
From ModulesGarden Wiki
(Difference between revisions)
|
|
Line 551: |
Line 551: |
| ==Interface== | | ==Interface== |
| {| | | {| |
− | |style="padding: 10px 0px 15px 15px;"|Client area interface of Proxmox VPS For WHMCS should look like the one on the screen below. As you can see, control panel contains useful options needed for managing VPS.<br /> | + | |style="padding: 10px 0px 15px 15px;"|Client area interface of Proxmox VPS For WHMCS should look like the one on the screen below.<br /> |
| + | As you can see, control panel contains useful options needed for managing VPS.<br /> |
| Module allows your customers to easily boot(1), reboot(2), stop(3) and shutdown(4) their servers through pressing specified button.<br /> | | Module allows your customers to easily boot(1), reboot(2), stop(3) and shutdown(4) their servers through pressing specified button.<br /> |
| Clients can also reinstall(5) server, access VNC console(6), create backup (7) and set up backup jobs(8).<br /> | | Clients can also reinstall(5) server, access VNC console(6), create backup (7) and set up backup jobs(8).<br /> |
Revision as of 15:05, 16 April 2014
Proxmox VPS For WHMCS is a powerful module which allows you to automatically provision virtual servers to your customers.
Additionally 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 Address To Hosting IP Addresses Table
|
✔ Possibility To Return IP Address To IP Addresses Pool
|
✔ Possibility To Add Additional IP Address To VM
|
✔ Configuration Of Features Available At The Client Area
|
✔ IP Management (Per Server)
|
✔ Backup Files & Job Limits (Max Number Of Files & Max Size Of Files)
|
✔ 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 Authentication
|
✔ Dynamically Chosen Server Resources While Ordering And Possibility To Upgrade Those Resources
|
✔ Integrated With Advanced Billing For WHMCS - Server Resource Usage Billing (read more)
|
✔ Integrated With IP Manager For WHMCS - Complete Management of IP Pools (read more)
|
✔ Supports Proxmox VE 3 and Later
|
✔ Supports WHMCS V5 and Later
|
- Available Configurable Options:
✔ Number of Cores Per Socket
|
✔ The Number of CPU Sockets
|
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 the '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 license 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 the 'Setup' → 'Products/Services' → 'Servers' and press 'Add New Server' button.
|
8. Next, enter your server name, IP address, username and password. Choose authentication type from 'Authentication' and 'Proxmox VPS' from 'Type' dropdown menus. Confirm through pressing 'Save Changes' .
|
9. After configuring your server correctly, you will see a following screen.
In order to check connection with Proxmox server, simply press 'Test Connection' as shown on the 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 go to the '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 assign your product to it.
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 the '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' and 'Default Storage' .
Type your VM description in 'Container Description' and scroll down.
|
19. Now, select desired values from 'Storage' , 'Disk Type' , 'CD/DVD-ROM Type' , 'ISO Image' , 'Network Mode' and 'Network Model' .
If you are using IP Manager For WHMCS you can assign configuration with IPv4 and IPv6 pools at 'IP Manager' section.
For more information, visit IP Manager Integration section.
Additionally, set up backups at 'Backups' section through selecting values from 'Storage' and 'Backups Routing' dropdown menus.
Backups routing automatically remove oldest backup as soon as new backup is created and backup limit is reached.
|
20. Setting of OpenVZ virtualization type. (skip, if you have chosen KVM virtualization type)
From dropdown menus choose 'Default Storage' and 'OpenVZ OS Template' .
If you are using IP Manager For WHMCS you can assign configuration with IPv4 and IPv6 pools at 'IP Manager' section.
For more information, visit IP Manager Integration section.
Additionally, define backup settings at 'Backups' section through selecting values from 'Storage' and 'Backups Routing' dropdown menus.
Backups routing automatically delete oldest backup when new backup is created and backup limit is reached.
Type your VM description in 'Container Description' and press 'Save Changes' .
|
21.Afterwards, 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.
|
KVM
|
Open VZ
|
The number of CPU sockets
|
The number of CPU sockets
|
The number of cores per socket
|
Amount of SWAP
|
CPU weight for a VM
|
CPU weight for a VM
|
Amount of RAM
|
Amount of RAM
|
Disk Space
|
Disk Space
|
Network Rate
|
IPv4 Addresses
|
IPv4 Addresses
|
IPv6 Addresses
|
IPv6 Addresses
|
Backups Limit
|
Backups Limit
|
Backups Files Limit
|
Backups Files Limit
|
Bandwidth Limit
|
Bandwidth Limit
|
VM Template
|
VM Template
|
|
ISO Image
|
|
22. At the end of product configuration you have to add cron job shown below (each 5 minutes suggested).
php -q /your_whmcs/modules/servers/proxmoxVPS/cron/cron.php
Do not forget to replace 'your_whmcs' with your WHMCS root location.
|
Congratulations! You have just finished the installation and configuration of the module.
|
Configuration of Addon
23. Adding new IP address (if you are not using IP Manager For WHMCS).
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.
|
24. Start of typing desired IP address and mask into 'IP Pool' .
Next, choose server from a 'Server' dropdown menu and define for which virtualization should it be applied through selecting from 'Visualization' dropdown menu.
Afterwards, press 'Add Pool' .
|
25. 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 product should look similar to the one on the screen below.
|
26.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 was created and assigned to your Proxmox server simply click on its 'Server Name' .
|
As you can see on the screen below, you can find a lot of useful information here like e.g. IP Address, VM ID or VM Type.
|
At the '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 its name.
|
Here you can find various information about cluster, from available resource to graph of their use.
|
Templates Management
You can easily convert any VM at your server to template.
In order to convert VM, go to the 'Proxmox Addon' → 'Templates' → 'Create Template' .
Choose server on which VM to convert exist and press 'Next Step' .
Important: VM will be consumed in process.
|
Next, choose node and VM to convert.
Fill 'Template Friendly Name' and press 'Save Changes' .
|
To access list of all available templates go to the 'Proxmox Addon' → 'Templates' → 'Show Templates' .
|
Interface
Client area interface of Proxmox VPS For WHMCS should look like the one on the screen below.
As you can see, control panel contains 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).
Additionally, your clients are able to access graph of resource usage (9) and view VM history(10).
|
VNC Console
One of the most interesting functionality is VNC console(6) where your clients can remotely manage their servers.
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 a 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 following 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 clients can find information about current usage of CPU, memory and disk (OpenVZ only).
Customers can also view 'DNS' (OpenVZ only) and 'IP Addresses' .
|
Graphs
Through pressing 'Graphs' (9) button clients will be moved to page with graph of CPU usage, memory usage, network traffic and disc I/O.
They can also switch timeline of the graphs by choosing it from a dropdown menu pointed at the following screen.
|
Task History
Your clients are able to easily access history of theirs VMs simply by pressing 'Task History' (10) button.
|
IP Manager Integration
Thanks to integration with IP Manager For WHMCS you are able to easily create pools of IP addresses and assign them to desired products.
1. Proceed to IP Manager For WHMCS → IP Pools in order to prepare IP addresses pool for Proxmox VPS For WHMCS.
2. Afterwards, create a new configuration and assign previously created pool to it.
Note 1: Do not assign Proxmox VPS For WHMCS product to configuration. Simply, create new configuration with assigned IP addresses pool.
Note 2: Multiple IP addresses pools can be assigned to one configuration.
3. In order to finish, go to the Proxmox VPS For WHMCS product → 'Module Settings' .
Find 'IP Manager' section and choose previously created pool from 'Configuration IPv4' or 'Configuration IPv6' dropdown menu.
Finish through pressing 'Save Changes' .
|
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 For WHMCS 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 4 custom fields.
They are 'vmid' , 'node' , 'storage' and 'backup storage' .
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.
|