Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.

Abiquo 4.7

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Next »


Trial requirements

To deploy a trial environment, you need to get and deploy the Abiquo Monolithic appliance in your infrastructure, and configure the infrastructure, network and appliance accordingly to your need.

The following components are required for an Abiquo trial environment:

  • Abiquo monolithic appliance
  • Compute infrastructure
  • Network infrastructure
  • VM repository folder

It is a good idea to document the required information for each component in the corresponding workpages in the links below. We provide some example workpages and empty workpages for you to document all the Abiquo platform relevant configuration details:

Infrastructure requirements

NFS shareNFS on separate server is recommended (not hypervisor datastore).
HypervisorsAbiquo recommends ESXi with vCenter, Hyper-V or KVM. Check your HVs requirements in the Cloud Node documentation
Clock synchronization

Platform clocks must be synchronized. Abiquo uses NTP to keep platform clocks synchronized. Check your vendor documentation for other components

ICMPThe Abiquo monolithic appliance must be able to ping the infrastructure management IPs
Service networkA trunk capable network segment with VLAN tagging capabilities

For versions, see Compatibility Tables 

For server specifications, see Trial Requirements

Network requirements

Every time a VM is deployed, Abiquo creates its NIC's and attaches them to the corresponding networks inside the service network accordingly.

 Abiquo manages the service network in different ways depending on the underlying network solution:

  • Standard VLAN network management
  • SDN network management

Standard VLAN service networks includes the following:

  • Virtual networks as separate VLANs
  • The Cloud Administrator defines VLAN tag pools in Abiquo when creating the racks
  • External and public networks are created in the infrastructure and define in Abiquo later
  • Private networks will be defined by Abiquo from the racks VLAN tag pools

Abiquo relies in ISC DHCP servers with OMAPI support and DHCP relay servers to manage the IP networks. Check the links below for further details:

Also, Abiquo can inject network connections into the VMs using cloud-init or hypervisor tools, which requires VM templates that support these methods. Abiquo will use this option if the DHCP server is not found. 

For SDN as VMware NSX and OpenStack Neutron, check the configuration requirements in the links below:

Appliance requirements

You will need to enter the following parameters about your environment during the monolithic install. These parameters configure your system to interact with the platform prerequisites that you must configure prior to the install.



Hostname FQDN

This FQDN must be resolvable from the customer premises, in order for SSL and the Appliance manager to work as expected. Abiquo will use self-signed certificates for the trial environment

Management IP address

IP of the management NIC

Management IP netmask

Netmask of the management NIC

Default gatewayDefault gateway in the management network
DNS server listIPs of DNS servers separated by a blank space
Abiquo Datacenter IDInternal ID of the trial DC.

NFS Template repository

NFS share for the VM repository of the DC. Each private DC must have a different NFS

 VM repository folder

In Abiquo, all DCs must have their own VM repository folder, which holds the VM templates for all enterprises in each DC. The Remote Services and HVs must be able to mount and manage this folder through NFS or CIFS (Depending on the underlying HV technology)

When you configure the platform, enter the location of the VM repository folder, and the platform will automatically configure the appliances to use this folder as VM repository and mount it on the HVs when needed automatically.

For further details, please check the VM repository documentation at the link below:

Platform networks

The main platform networks to configure for Abiquo are:

  • Management network: for managing the cloud platform, including monitoring of infrastructure and VMs, and deployment of VM templates
  • Service network: for VM communications using VLANs. Requires VLAN support. See  Configuring the Service Network for Cloud Tenant Networks
  • Storage network: for virtual storage on external storage devices, optional

Configure each of these networks as a separate network.

 Click here to show/hide the network diagram

Network inputs

You will need to configure your firewalls to enable the following ports and communications.

Abiquo Monolithic Server



Input Port



Abiquo Monolithic Server

TCP 80


ClientAbiquo Monolithic ServerTCP 443HTTPS
WebsockifyAbiquo Monolithic ServerTCPHTTPS

Platform and Storage Servers



Input Port


Monolithic Server

Nexenta storage agent

TCP 2000

Nexenta API

Monolithic Server

NetApp storage connector

TCP 80

NetApp API

Monolithic Server

LVM storage connector

TCP 8180

Abiquo LVMSCSI server

Hypervisor, Abiquo V2V

Any Storage host

TCP 3260

Volumes on the storage host iSCSI

Abiquo Monitoring Server with KairosDB

SourceDestinationInput PortDescription
Monolithic ServerMonitoring ServerTCP 8080KairosDB
NFS Server



Input Port


Monolithic Server, Hypervisor


TCP/UDP 2049


Monolithic Server, Hypervisor




SourceDestinationInput PortDescription
Monolithic ServerESXi

TCP 80 

Monolithic ServerESXiTCP 443 
Monolithic ServerHyper-VTCP 135 
Monolithic ServerKVMTCP 8889 
Monolithic ServerXenServerTCP 443 
Monolithic ServerOracle VMTCP 7002 
Monolithic ServerPublic cloudTCP 443 
 Click here to show/hide the network diagram



Monolithic server

Download the Abiquo Monolithic OVA. Before you begin, you will need the values of the following OVA properties for step 12 of the deploy.

Unable to render {include} The included page could not be found.

Unable to render {include} The included page could not be found.

Deploy OVA on ESXi with vCenter

  1. Download the OVA from the links in the release announcement to your desktop
  2. Open a browser and log in to your vCenter using the vSphere web client
  3. Go to vSphere client Host and clusters section in the vSphere web client side panel
  4. Go to Actions and click on Deploy OVF template
  5. Select Local file and choose the OVA you downloaded in step 1. Click Next
  6. The vSphere client will display the OVA details. Click Next
  7. Accept the EULA and click Next
  8. Edit the deployed VM name and choose where you want to deploy it. After this, click Next
  9. Select which cluster or host will be used for deploy and click Next
  10. Choose the datastore for the deployed VM and click Next
  11. Select the network destination for the VM management NIC and click Next
  12. Enter the template details depending on the OVA you are deploying. For more details, see the parameters table above. When configured, click Next
  13. Review the deployment configuration details. If they are OK, you can select the "Power on after deployment" checkbox. But if you need to add extra NICs and HDDs to the VM before deployment, do not select it. Click Finish

Post-install steps

  1. After installation, Abiquo will display the UI login URL. Remember to change your Abiquo passwords as soon as possible.
  2. Change the root password in the appliances
  3. Template conversions and uploads will consume space on the server until they move the the NFS VM repository. So, if you wish to use big templates, extend the appropiate filesystems accordingly.
  4. review the Abiquo properties file at /opt/abiquo/config/abiquo.properties For trial deployments, you will probably configure some of the following properties:

    • To use a monitoring server, enter monitoring server IP address and port, and enable monitoring
    • For Hyper-V or XenServer hypervisors, you may need to configure the repository location properties which are described as part of the hypervisor configuration

After changing the properties, remember to restart the Abiquo Tomcat service always:

service abiquo-tomcat restart


  1. Configure Abiquo UI, for example: 
    1. To change the UI text or translate it into different languages, create language files and configure the UI to work with them
    2. To configure Abiquo to work offline
    3. To customize the UI look and feel, creating your own themes, see Abiquo Branding Guide
    See also the complete guide to user interface configuration at Configure Abiquo UI

For more information about the configuration described in this section, see Configuring Abiquo

Log In to the Abiquo web client

Now open your web browser and type in the site address for the Abiquo server.


The default cloud administrator login username and password are "admin" and "xabiquo", respectively. Remember to change your password as soon as you log in for the first time.

If you change the name and/or password of the "default_outbound_api_user" in Abiquo, you will need to change them in the Abiquo properties file. The Abiquo "M" module completes event details in Abiquo and streams events in the outbound API. For more details see Abiquo Configuration Properties#Configure Abiquo Events Properties

Add a License

See Configuration View#License Management

Quick Tutorial

For an overview of the Abiquo platform work through the tutorials built in to the product or try the Abiquo Quick Tutorial.


Monitoring and metrics server

The Abiquo VM monitoring and metrics feature enables you to obtain a rapid and convenient overview of VM performance through the Abiquo cloud console. Abiquo supports monitoring and metrics of VMs on the AWS, Azure, ESXi, KVM and XenServer, as well as Docker. ESXi hypervisors must be connected to a vCenter server

Supported monitoring and metrics:

  • Built-in metrics provided by each hypervisor or public cloud plugin and fetched periodically by the monitor manager
  • Custom metrics that can be configured and populated through the Abiquo API. After you create a metric, you can push the metric’s datapoints to Watchtower using the Abiquo API
  • Custom metrics that can be configured in collectd and populated through the Abiquo collectd plugin

Test environment: install Monitoring OVA that includes:

  1. Watchtower server
  2. KairosDB: can run without Cassandra using default KairosDB configuration with h2 datastore
  3. Cassandra: can run on same server as KairosDB in small installations or separate server

Install Abiquo Monitoring Appliance

The Abiquo Monitoring Appliance is a CentOS system with Abiquo watchtower, KairosDB and Cassandra on the same VM. For instructions on how to install it, see Quickstart Install Abiquo OVAs

After you complete the install, configure the following:

  1. Edit the kairosdb.properties file and set KairosDB properties, such as data retention time. The following link describes the KairosDB property for the time to live for a datapoint and Cassandra will automatically delete it after this time has elapsed: https://github.com/kairosdb/kairosdb/blob/v0.9.4/src/main/resources/kairosdb.properties#L91-L95

  2. In Cassandra.yaml configure seeds with KairsoDB IP (even though it's on the same server) and set Broadcast address as per Cassandra docs
  3. Firewall: You must open the appropriate port to enable the Abiquo Server and ALL the Remote Services servers (except separate V2V services) to access Watchtower  

Monitoring Post-install configuration

  1. Synchronize server clocks: you MUST configure and synchronize NTP across all Abiquo servers and all hypervisors before you enable metrics. Alerts will not be sent if the time is not synchronized on all servers, including the monitoring and metrics server and the hypervisors (ESXi and vCenter servers)
  2. On remote services (Monolithic and Remote Services, but not V2V services), edit the abiquo.properties file to add the following properties, then restart the Tomcat service.

    # Enable/disable monitoring and alarms
    abiquo.monitoring.enabled = true
    # Address where watchtower is located
    # Port where watchtower is listening
  3. Optional: Configure KVM properties. See AIM - Abiquo Infrastructure Management . 
    1. To support metric dimensions in KVM through AIM, there is a related abiquo.properties entry called abiquo.vsm.measures.pusher.frequency. See  Abiquo Configuration Properties#vsm
  4. Within Abiquo configure fetch and display metrics by default
    1. To set a default for all VMs to fetch metrics and display all metrics, set the "Enable VM monitoring by default" property in the general section of Configuration view. (See Configuration View#General ). This property will apply to all VMs created after you change the value of the property.
  5. Within Abiquo assign user privileges to work with monitoring, metrics, alarms and alerts as required

Optional components

The following components are optional for an Abiquo trial environment. We will describe how to configure a Monitoring appliance in this document later. Check the links for further details on each component.

Abiquo Monitoring Server Monitoring can be enabled or disabled in the trial environment
Public Cloud providersAWS, Azure ARM, or other supported providers. Optional, See Public cloud provider features
CollectdUse Abiquo collectd plugin installation 
Persistent StorageAny NFS storage (not available for Hyper-V), vFiler on NetApp, Nexenta
OpenStack NeutronWith KVM hypervisors and OpenStack clouds
VMware NSXFor firewalls and load balancers use the Advanced edition or higher
Jaspersoft ReportsFor Abiquo reports. Separate server for JasperServer Community and Abiquo Reports modules
Chef ServerLocal Chef server or hosted Chef and access to cookbooks. Requires cloud-init templates
  • No labels