Abiquo 5.2

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


Numbered Headings

Configure your user account

All users should configure their user accounts before starting work with the cloud platform.

Edit user details

Administrator tasks

This section describes the administrator tasks in public cloud.

Create public cloud regions


Create tenants

Control tenant resources

You can control the resources that an enterprise may consume. This will help prevent resource over allocation, enterprises using resources from other enterprises, and even DoS attacks. Allocation limits will also help system administrators to anticipate user needs and forecast resource demand. Hard and soft limits are used by the resource scheduler to decide if a user can deploy a virtual appliance or not.

  • Hard Limit: the maximum amount of resources (CPU, RAM, Hard Disk, etc.) that an enterprise may consume.
  • Soft Limit: triggers a warning for users that they nearing the hard limits for their enterprise.

Include Page
GUI Enterprise Resource Allocation Limits
GUI Enterprise Resource Allocation Limits

Enterprise allocation limits are checked during configuration or deploy, or before operations as shown in the above table.

Include Page
TEXT Allocation Limit Validation
TEXT Allocation Limit Validation

Allow the tenant to access regions

To set the datacenters and public cloud regions that an enterprise is allowed to access, edit the Enterprise and click the Datacenters tab.

Select one or more datacenters or public cloud regions in the left pane and drag and drop them into the "Allowed Datacenters" right pane.

Access to at least one datacenter or public cloud region is required in order to deploy VMs. The left pane contains datacenters, which are "Prohibited Datacenters" by default.

titleDatacenters Automatically Assigned to Current Enterprise on Creation

By default, when a datacenter or public cloud region is created it is automatically assigned as Allowed for the current user's enterprise only.

Note that Allowed datacenters are working datacenters where users can deploy. This is different to an admin user having administration Scope to administer the infrastructure of datacenter. 

Limit tenant resources in the region

You can set resource allocation limits for this enterprise in each allowed datacenter or public cloud region. To set allocation limits, select one of the Allowed Datacenters in the right pane and click the edit button. Set these limit values in the pop-up that opens.

Limit resources for an enterprise in a public cloud region

Include Page
GUI Enterprise Datacenter Allocation Limits in Public DC
GUI Enterprise Datacenter Allocation Limits in Public DC

Tenants obtain

Obtain cloud provider credentials

If the tenant does not have cloud provider credentials, they should follow their cloud provider's instructions on how to obtain access to the provider's API.

Abiquo provides basic guides to obtaining credentials, but the tenant should always consult the cloud provider for the most up-to-date information.

Add tenant credentials for each provider

Before you enter public cloud credentials, there must be an existing public cloud region for the provider.

To add credentials for a public cloud provider

  1. Check in Infrastructure view or with your Administrator, that the public cloud region is already created
  2. Edit the enterprise and select the Credentials tab
  3. From the Provider pull down list, select the public cloud provider
  4. Enter your Access key ID, which may be a Username, a specific API access key ID or other account identifier
  5. Enter your Secret access key, which may be an API key or other API credential
  6. Click Validate account
  7. After the account has been validated, click Save

Prepare foundation template library

In the Abiquo Apps Library you can compile a selection of certified public cloud templates for your users to deploy by self-service.

Abiquo will store the details of these templates but not their disks.

Include Page
Manage the Public Cloud Apps Library
Manage the Public Cloud Apps Library

Include Page
TEXT Add VM Templates to the Apps Library Public Cloud
TEXT Add VM Templates to the Apps Library Public Cloud

Tenant administrator tasks

This section describes tasks that will generally be performed by a tenant administrator. These tasks will vary depending on the cloud platform configuration.

Include Page
Virtual Datacenters View
Virtual Datacenters View

Excerpt Include
Manage Virtual Datacenters
Manage Virtual Datacenters

Prepare enterprise templates

Depending on their user privileges, the tenant administrator may be able to do the following tasks

  • Search the Apps library for templates
  • Add templates to the Apps library
  • Modify templates
  • Share templates with their customers

Onboard from public cloud

Onboard virtual datacenters from public cloud

Abiquo automatically onboards from public cloud regions

If your public cloud provider does not support virtual datacenter entities, the platform will automatically onboard when you select the public cloud region.

Restrict user access to virtual datacenters

By default, all users have access to all virtual datacenters. However, you can select a list of virtual datacenters for each user and they will only be able to access these virtual datacenters.

To restrict VDC access, open Users view and create or edit a user who is not an administrator or who does not have the No VDC restriction privilege.

On the create or edit dialog, select the Restrict access to VDC checkbox to open the list of available virtual datacenters. If none are selected, the user will have access to all VDCs. Select the VDCs where this user will be able to deploy VMs. You can only restrict the VDC access of users without the No VDC restriction privilege.

Manage Networks

This section describes how to manage networks in private datacenters and public cloud providers. 

Excerpt Include
Manage Networks
Manage Networks

Excerpt Include
Manage Firewalls and Load Balancers
Manage Firewalls and Load Balancers

Cloud user tasks

This section describes the tasks that may be performed by the cloud user. 

Edit your user account details

After you log in, you may need to edit your user account to update your details:

  1. Click on the user icon in top right-hand corner of the screen and select Edit user from the pull-down menu
  2. Change your password and edit your user details. Check you have the correct email and phone number to receive passwords and authentication
  3. Add your public key that that the platform will use to launch VMs so that you can access them with SSH


    Edit user general information

    Edit user advanced

Create a virtual appliance to group your VMs

A virtual appliance is folder that holds a group of VMs so that you can easily access them and launch them into the cloud together. At the virtual appliance level, you may also be able to create templates from the disks of your VMs, view VM metrics and create alarms. 

To create a new virtual appliance:

  1. Open the Virtual datacenters view
  2. Select the Virtual datacenter where you will deploy the VM
  3. Click the   add button for virtual appliances, and complete the form as shown below

The platform will create the virtual appliance. To open it, click on its name.

titleClick here to show/hide the screenshots

Screenshot: Select a virtual datacenter and click Create virtual appliance

Screenshot: Create a virtual appliance




The name of the virtual appliance

Virtual datacenter

The virtual datacenter where the virtual appliance will be deployed, selected in the V. Datacenters list or with this selector

IconThe URI of the icon to represent the virtual appliance
(Checkbox)To go straight in to the virtual appliance, select Automatically open it after creation

Create VMs

To create a VM:

  1. Open Virtual datacenters → Select a virtual datacenter
  2. Go to the Virtual appliances tab → Open a virtual appliance by clicking on its name or create a new virtual appliance
  3. Drag and drop a VM template from the Templates tab into the VMs pane. Or double-click on a template to create a VM from it
  4. Select a hardware profile for your VM

The platform will create your VM. The status bar below the VM icon says NOT_ALLOCATED, which means that the VM has not yet been launched into the cloud. Select your VM to display its details in the lower panel.

Screenshot: Create a VM with drag and drop

Screenshot: Select a hardware profile

Launch VMs

To launch your VMs, click the Deploy virtual appliance button on the right-hand side of the screen.

The platform will launch the VMs and power them on. The status bar below each VM icon will be coloured green. And the Deploy button changes to become the Undeploy button, which you can use to destroy the VMs.

Screenshot: Deploy a virtual appliance

Manage VMs

To display the VM control panel, select the VM icon. From this panel, you can:

  • Check the details of the VM 
  • Power it off or on, and pause or reset as allowed by the provider, using the round control buttons
  • Destroy (undeploy) or launch (deploy) the VM
  • Connect to the VM with remote access, using the eye icon

By default, the description panel provides a short description of the VM template. 

The following screenshots show the Network and Storage panels, which are an easy way to check what IP addresses and storage are assigned to your machine. 

Obtain public IPs for VMs

Include Page
Obtain public IPs in public VDC
Obtain public IPs in public VDC

Configure or reconfigure a VM

To change the general configuration of a VM:

  1. Check that the VM is powered off or not deployed, depending on the provider. The status bar of the VM should be red with the word "OFF".
  2. Mouse over the VM options menu, and select Edit
  3. Make changes to the VM details as described below
titleClick here to show/hide the screenshots

Edit virtual machine General


  1. Select the Private or Public tab, depending on the type of IP address you want to add to the VM
  2. If you want to add a new public IP address, click + and select the address
  3. Drag and drop the IP address into the Network interfaces list

Continue configuring your VM or click Save to finish

Firewall policies

  • Select the firewall policies to add. You can add as many firewall policies as necessary, up to the cloud provider's limit

Bootstrap script

  • Use a template that is compatible with cloud-init version 0.7.9 or above, or cloud-base init
  • Paste the configuration or script in the text box

Load balancers

  • Select the load balancers to use for the VM


  • Use a template that is compatible with cloud-init version 0.7.9 or above, or cloud-base init
  • Add the variables that will be sent to the VM at deploy time

If the VM is deployed but other VMs are not deployed, the changes might not be applied directly. You may need to click the Deploy all VMs button to apply the changes in the hypervisor.  

Configure Chef Recipes and Roles

Chef is an infrastructure automation product that uses configuration recipes. You can use Abiquo Chef Integration to deploy a VM that will then configure itself using Chef recipes and roles. 

The Chef tab is enabled if the enterprise is Chef-enabled and the VM template is Chef-enabled. Before the VM is deployed, you can select from the available roles and recipes. These will be added to the machine's runlist. When the machine is deployed it will download the roles and recipes, and run them in order. Click the Chef tab. By default on this tab you can select roles. Mark the "Select individual components" checkbox to select individual recipes too. The selected recipes will be added to the Virtual Appliance's runlist in order of selection.

To change the order of the runlist, click on the pencil button beside a role or recipe, then edit the order number, then click OK.

Change the Order of Roles and Recipes After Deployment

To change the runlist order after deployment click on the pencil button, then edit the order number, then click OK. The Abiquo Chef Agent will connect to the Chef Server and update the runlist.

See also Configuring and Using Abiquo Chef Integration in the Abiquo HOWTOs and Troubleshooting Abiquo Chef Integration in the Administrator's Guide.

Include Page
GUI virtual machine load balancers
GUI virtual machine load balancers

Configure Monitoring and Metrics

You can enable the option to fetch metrics from the public cloud region.

To enable VM monitoring and metrics,work with a VM that is powered off or undeployed:

  1. Edit the VM and go to the Monitoring tab
  2. Mark the Fetch metrics checkbox.
  3. Select from the available options, for example, for AWS, you can select detailed or basic monitoring
  4. The functionality and list of available metrics depend on the underlying virtualization technology
  5. Select the individual metrics you would like to retrieve for your VM
Display Metrics for a VM

To display metrics for a VM, on the VM icon, click the Monitoring symbol. The metrics panel will open.

To update the display of a metric, click the refresh button .

To configure the display of a metric

  1. Click the filter button 
  2. Set the:
    1. Granularity, which is how often the metric is sampled
    2. Statistic, which determines how the raw values will be processed over time
    3. "Last" period, which is how long the display will look behind at the processed data.
    Click Accept to save the values.

To view the exact metric values in a call-out box, mouse over the monitoring graph line.

To create a highlight point, click on the metric graph line.

To simultaneously view the data for more than one VM, use the virtual appliance monitoring view.

Delete a VM

To delete a VM, move the mouse over the VM icon, and from the options menu, select Delete. You can delete a VM that is deployed. If you undeploy a VM before you delete it, the platform may request that you synchronize the virtual appliance until you delete the undeployed VM.