OpenStack VPS For Blesta

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About OpenStack VPS For Blesta

OpenStack VPS For Blesta is a module which lets you automate the provisioning and handling of customized virtual servers to your customers.

The great benefit of this module is a wide range of supported options customers can order and manage right in your own Blesta client area.
Furthermore, it allows you to easily monitor and manage all the customers' servers.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Cancel Server
✔ View Server Status And Details
✔ View Interface Details
✔ View List Of Scheduled Tasks
✔ Configure Client Area Features Per Product
✔ Define Backup Quantity Limit
✔ Enable Backups Routing
✔ Set Security Groups
  • Client Area Features:
✔ View Server Status And Details
✔ Start/Stop/Pause/Unpause Server
✔ Reboot Server - Soft/Hard
✔ Rebuild Server
✔ Reset Network
✔ Access noVNC Console
✔ Create/Restore/Delete Backups
✔ Download Public & Private SSH Keys
✔ View List Of Scheduled Tasks
  • Available Configurable Options:
✔ Flavor
✔ VM Image
✔ IP Addresses
✔ Backups Files Limit
✔ Disk
✔ RAM
✔ VCPUs
  • Required Components:
✔ Keystone
✔ Glance
✔ Nova
✔ Neutron
  • General Info:
✔ Automated Generation Of SSH Keys - Public SSH Key Is Injected To VM Automatically
✔ Multi-Language Support
✔ Supports OpenStack Ocata and Previous
✔ Supports PHP 5.4 Up To PHP 7
✔ Supports Blesta V3 and V4

Installation and Configuration

In this brief tutorial we will show you how to successfully install and set up OpenStack VPS For Blesta.

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

Installation

1. Log in to your client area and download the module.
OSB 1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.
It does not apply to open source versions.
OSB 2 1.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main Blesta directory.

The content of PHP version files should look like this.

OSB 2.png
4. When you install OpenStack VPS For Blesta for the first time you have to rename 'license_RENAME.php' file.

File is located in 'components/modules/openstack/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

OSB 3.png
5. 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 in your client area → 'My Products'.

OSB 4.png
6. The last step is setting up a cron job (each 5 minutes suggested).

Use cron job below but switch 'your_blesta' with your root Blesta path.

php -q /your_blesta/components/modules/openstack/cron/cron.php

Activation

New Account

Now, you have to install the module in your Blesta system.

Log in to your Blesta staff panel and proceed to 'Settings' → 'Modules' → 'Available'.
Afterwards, find 'OpenStack' and press 'Install' button.

OSB 5.png
Next, you may move to the second part of configuration.

Press 'Manage' under installed OpenStack VPS module.

OSB 6.png
Here, you have to enter any data required to connect your Blesta with OpenStack VPS server.

Enter details to connect with your server:

  • Hostname
  • IP Address
  • Username
  • Password
  • Tenant ID
  • Debug Mode

Finally, test connection, if it is successful save your account.

OSB 7.png
At this moment you should also generate default configurable options.

Press the button and your clients will be allowed to compose their VM within the allowed limits.

OSB 8.png
That is all! Your Blesta is now connected with OpenStack VPS server.

Packages

New Package

Before you can offer virtual machines for sale you must create some packages with configured products and pricing.

Go to 'Packages' → 'Browse' and press 'Create Package'.

OSB 9.png
You will see an extensive form. Start with naming your package, select module - 'OpenStack' and activate it now.

At this moment you also have to generate configurable options that will allow your clients to adjust the product they purchase to their needs.

OSB 10.png
Next, configure your module options.

Start from selecting 'Default Tenant'.
'Check access' will return 'OK' if you set up permissions correctly.

OSB 11.png
Afterwards, set up network. Choose 'Fixed Network', 'Floating Network' and 'Default Number Of IP Addresses'.

You can set up network in two ways. Find more information about the configuration here.
We will set up a network without floating IP address as presented on the following screen.
Additionally, choose the number of IP addresses assigned to product by typing it into 'Default Number Of IP Addresses'.

OSB 11 1.png
At this step you can set up backups.

Mark 'Backups Routing' checkbox if you want to replace oldest backup with newest one when backups file limit is reached.
Afterwards, enter limit of backup files into 'Default Backups Files Limit'.

OSB 11 2.png
Mark security group from 'Use Security Groups'.

If you wish to use SSH keys, leave 'Inject SSH Key' marked (virtualization has to support 'Inject File' feature).
In order to use passwords for your VM, leave 'Password Management' marked (virtualization has to support 'Set Admin Pass' feature).
Please make sure, that virtualization used by you supports mentioned actions.
Full list of supported features can be found here.
Important: It is recommended to leave 'Delete SSH Private Key' marked.

OSB 11 3.png
Finish through selecting features available at the client area.

Mark checkbox next to feature in order to enable it.

OSB 11 4.png
In the next step set your prices and provide the content of a welcome email if you wish.
OSB 12.png
Finally, select a group to which the package will belong to. If you do not have any groups yet, you may quickly create one right now.

Do not forget to press 'Create Package' button in the end.

OSB 13.png
Your package is ready now, create as many packages as you need to diversify your pricing offer.

Order Forms

Once you have your package ready, you have to create a new order form. Move to 'Packages' → 'Order Forms' and press 'Add Order Form'.
OSB 15.png
Provide 'Basic' settings for the order form that will be assigned to your previously created package.
  • set the status
  • name the order form
  • provide a unique label (next to the label a URL to this order form in client area will appear)
  • select type of the form - 'General'
  • choose template from the available
  • configure any additional options like allowing coupons or human verification, etc
  • select domain package group - the one you created in the previous step
  • select allowed currencies and payment gateways

Press 'Add Form' when everything is ready.

OSB 16.png

Management

OpenStack VPS For Blesta allows your customers to manage their OpenStack VPS via client area in your Blesta system.

You can monitor and manage each product from your admin area.

Basic Options

1. Basic information on the service.
2. Module actions allow you to change VPS status.
3. Upgrade/Downgrade option which enables you to view current VPS resources and change VPS specifications.

OSB 18.png
VM Details

4. Here you can find VPS details and refresh them through pressing 'Refresh Details' icon.
5. Scheduled tasks status can be found in this table.
6. In 'Additional Information' you can find IDs of VM and private flavor.

OSB 19.png

Ordering

Owing to configurable options, you are able to offer product which your clients can tailor according to their needs.

Additionally, you are able to set up pricing for each configurable option, which makes your offer even more competitive.
To learn more about configurable options move here.

OSB 17.png

Client Area

Client area interface of OpenStack VPS should look like the one on the screen below.

As you can see, control panel contains all the most important information on the virtual machine.

OSB 20.png
Module allows your customers to easily start/stop, pause/unpause, soft reboot, hard reboot and reset network of their servers through pressing specified button.

Clients can also rebuild the server, access noVNC console, create a backup and view scheduled tasks.
At 'Tasks' your customers can view all requested tasks that haven't been completed yet.
Each task has additional information bounded to them, like type of task, attempts to perform tasks or last returned response.

OSB 21.png

Rebuild

Rebuild feature allows your clients to change server image.

To reinstall your server, choose an image and confirm through pressing 'Rebuild' button.

OSB 22.png

Backups

Your customers can also create a backup of VPS. To do so, press 'Backups' button.

Now, provide backup name and press 'Backup Now' button.

OSB 23.png
To restore VPS from backup, simply press 'Restore' button next to it.
OSB 23 1.png

noVNC Console

Anothe functionality, access to noVNC console, seems to be one of the most crucial. Thanks to it, your clients can remotely manage server.

To access it, simply press the 'Console' button.

OSB 24.png
noVNC is a browser based VNC client. It was implemented using HTML5 Canvas and WebSockets.
OSB 25.png

SSH Keys

SSH key pair is generated automatically by OpenStack VPS For Blesta.

Public SSH key is automatically injected into VM while private key can be downloaded from the client area.
In order to download Unix private SSH key press 'Download Private Key'.
You can easily convert your private Unix key (.rsa) to private PuTTY key (.ppk) using 'PuTTYgen'.

OSB 30.png
Public SSH key on the other hand, can be downloaded as many times as your client will need it.

Press 'Download Public Key' as shown on the following screen to save it on your disk.

OSB 31.png

Network Configuration Cases

OpenStack VPS For Blesta allows you to set up two types of network.

The first one is a network without floating IP address.
To set up this type of a network, choose 'Public' as 'Fixed Network' and 'Disabled' as 'Floating Network'.
On the following screen you can view exemplary topology of such network.

OSB 36.png
Second type of network is a network with floating IP address.

Select 'Shared Network' as 'Fixed Network' and 'Public' as 'Floating Network'.

OSB 37.png

Configurable Options

In case standard configuration does not fit your needs, you can adjust it through configurable options.

To do so, go to 'Packages' 'Options' and find the group of configurable options used by your product.
Its name is 'Configurable options for your_product_name'.
Press 'Options'.

OSB 26.png
Now we will show you how to edit options. Let's say that you want to add an option to order VPS with 8GB (8192 MB) RAM.

To do so, edit 'RAM' by pressing edit button as shown on the screen below.

OSB 27.png
To add new option, press 'Add Additional Option'.
OSB 28.png
Then enter the new option name and value in a textbox under all other options.

If you want to replace it with option you currently have, simply edit its textbox.
Next, press 'Update Package Option'.

OSB 29.png

Tips

1. Please be advised that using Debug Mode on production system is not recommended.

It may cause plenty of error messages being displayed and interrupting flawless work unnecessarily.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Personal tools
Namespaces

Variants
Actions
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
OpenStack VPS For Blesta