Documentation

Skip to end of metadata
Go to start of metadata

Introduction to Abiquo Properties

Abiquo uses a system based on Java properties that is flexible and easy to configure.

Configuration options are grouped in the file /opt/abiquo/config/abiquo.properties on each server of the Abiquo platform (Abiquo Server, Remote Services, V2V Services). The Abiquo Installer will create configuration files for your installation and example configuration files can be found in the directory /opt/abiquo/config/examples. If you wish to change the configuration options, add the properties you wish to change to your abiquo.properties file and specify the new values. 

The tables below contain all the configuration options that can be modified and their default values as set by Abiquo. The default values for properties are used within the Abiquo platform if you do not set the properties. However, some default configuration options may also be set outside of the Abiquo platform, for example, in the hypervisor. 

After modifying this file, check carefully to ensure you have the correct values and no unnecessary whitespace around the properties. You must restart the abiquo-tomcat service for the changes to take effect.

[root@localhost ~]# service abiquo-tomcat restart

Changes to Properties

New Properties in 3.0.1

  1. abiquo.storagemanager.nexenta.blocksize 

This property was introduced in Abiquo 2.6.7 and Abiquo 3.0.1. If you do not set this property, the default block size of 8 KB will be used.

Abiquo supports Nexenta block sizes from 8 KB to 128 KB. Nexenta requires the block size to be a power of 2. The block size is only validated by Nexenta and it will accept values set with this property of 8, 16, 32, 64, and 128. Abiquo recommends that the block size should be at least 8 KB.

New Properties in 3.0

These properties are new in Abiquo 3.0.

LOGIN

  1. abiquo.api.login.failurelapse
  2. abiquo.api.login.maxtries

LDAP

  1. abiquo.ldap.connection.timeout
  2. abiquo.ldap.read.timeout

OAUTH

  1. abiquo.oauth.accesstoken.validity
  2. abiquo.oauth.requesttoken.validity
VSM Polling
  1. abiquo.vsm.pollingfrequency.amazon

VSM Synchronization

  1. abiquo.vsm.vmsyncfrequency.vmx_04
  2. abiquo.vsm.vmsyncfrequency.kvm
  3. abiquo.vsm.vmsyncfrequency.hyperv_301
  4. abiquo.vsm.vmsyncfrequency.oracle_vm
  5. abiquo.vsm.vmsyncfrequency.xenserver
  6. abiquo.vsm.vmsyncfrequency.amazon

Session cookie name

  1. abiquo.api.session.cookie.name

Stale sessions

  1. abiquo.stale.sessions.check.delay: note that between RC releases, the default value has been changed to 300000 milliseconds from 900000 milliseconds

New properties marked with the (star) symbol in the Info column of the properties table.

Removed and Deprecated Properties in Abiquo 3.0

Properties have been removed in this version are:

Storagelink properties related to technology that is no longer supported by Abiquo: XenServer Storagelink:

  1. hypervisors.storagelink.address
  2. hypervisors.storagelink.password
  3. hypervisors.storagelink.user

Other properties:

  1. abiquo.api.max.sessions: note that this property was only present in the 3.0.0 RC releases
  2. abiquo.vsm.pollingfrequency.vbox
  3. abiquo.vsm.xen.refresh.mstosleep
  4. abiquo.vsm.xen.refresh.retries
  5. abiquo.vsm.vmsyncfrequency.vbox: note that this property was only present in the 3.0.0 RC releases

Deprecated Flex Client Properties:

  1. client.SERVER_ADDRESS
  2. client.USE_SECURE_CHANNEL_LOGIN

Changes to KVM Configuration Without Full Virtualization

 You may now need to perform other configuration in addition to setting abiquo.virtualfactory.kvm.fullVirt=false. See KVM Cloud Node Installation and Configuration

Required Remote Services API property

Since Abiquo 2.6 the property abiquo.server.api.location is now also required by remote services in distributed installations for template download to and upload from the user's local filesystem

Open Sessions on Hyper-V and ESXi

Set abiquo.virtualfactory.openSession=1 as a workaround to problems with concurrent deployments in:
  • Hyper-V

Configure infrastructure checks

  • abiquo.nodecollector.infcheck  is the delay period after an infrastructure check completes before the next check begins.
  • abiquo.ha.check.delay is the delay between checks of machines that already have HA in progress in order to determine if HA movements are complete
  • See Configure Infrastructure Checks and Timeouts

 

 

Configure Abiquo Events Properties

Changes to M configuration in Abiquo 3.0

Abiquo 3.0 has a new default role called OUTBOUND_API that has access to events. This role is assigned to a default user, which is called "Outbound API Default Events User".

Configure M

If you do not configure M properly, no events will be available in Abiquo. You will probably need to configure the M properties in the abiquo.properties file on the server where M will run. By default, M runs on the Abiquo Server. The required properties are the M user account details and the API location.

The Abiquo M module listens for events in the Abiquo API. When it receives events, it performs requests to the Abiquo API to retrieve further details about the events. Then it writes the events to the Abiquo database and broadcasts them as the event stream of the Outbound API.

Automatic M User Account Configuration

When you install or upgrade Abiquo, it is essential to check that the M module is properly configured to ensure that your platform will record events.

  1. Fresh install + customer enters cloud admin password in configuration screens
    1. Abiquo automatically configures M is automatically configured with the admin password
    2. M user and password are NOT included in properties file
    3. If the customer changes the admin account, they must reconfigure M with user and/or password in the abiquo.properties file as described below
  2. Fresh install + customer does NOT enter cloud admin password in install screens
    1. Abiquo automatically configures M with the default admin account (user admin, password xabiquo)
    2. When the customer changes the admin account, they must configure M with user and/or password in the abiquo.properties file as described below
  3. Upgrade from older version of Abiquo
    1. Abiquo automatically configures M with the default cloud admin account (user admin, password xabiquo)
    2. The customer must configure M with user and password in the abiquo.properties file as described below

Configure M Properties

You must configure the abiquo.properties file on the server where M will run. Without this configuration, no events will be available in Abiquo

  1. Abiquo M User
    • M will use this identity and credential to access the Abiquo API and retrieve information about the events
    • It will record the events in the Abiquo database and stream them through the Outbound API
    • When you modify the default cloud admin user, the hidden default values of admin and xabiquo will not function
    • This user must have permission to access all events
      • Abiquo 3.0 has a new default role called OUTBOUND_API that has the required privileges and a default outbound API user. See Privileges

  2. Abiquo API Location with Port
    • The API location must be an externally accessible IP and port
    • Use the API port to ensure that an event streaming user with a regular user role can access events
    • The API location IP address cannot be a localhost value (127.0.0.1 or localhost)
    • The Abiquo API location is also used for the Chef integration, so remember this if you have distributed platform components

Example of Manual M Configuration

Abiquo M Configuration
abiquo.m.identity = AbiquoMUser 
abiquo.m.credential = AbiquoMPassword
abiquo.server.api.location = http://my.api.location:80/api

Configure API Load Balancing Properties

API load balancing properties

  • API Servers: set ALLload balancing properties on all API servers that are load balanced. The properties must point to the datanode, which contains the common instances of RabbitMQ, Redis, Zookeeper, and MariaDB/MySQL
    1. abiquo.api.zk.serverConnection
    2. abiquo.database.user
    3. abiquo.database.password
    4. abiquo.database.host
    5. abiquo.redis.host
    6. abiquo.redis.port
  • Remote Services Servers: set RabbitMQ properties on all remote services servers in API load balancing datacenters
    1. abiquo.rabbitmq.connectionTimeout
    2. abiquo.rabbitmq.host
    3. abiquo.rabbitmq.password
    4. abiquo.rabbitmq.port

Key to the Abiquo Configuration Properties Table

(star)  – New property 
(warning)  – Changed property
(minus) – Deprecated Property

 – Abiquo Server / API
 – Remote Services
 – V2V Remote Services 
 – Outbound API
 

This table describes the abiquo.properties file of the Abiquo platform servers. For example, if a property is marked with  symbol  in the  column, it can be configured in the abiquo.properties file of the Abiquo Server/API and Abiquo Monolithic Server.

Abiquo Monolithic Server

An Abiquo Monolithic Server is a single-server install of all or most of the Abiquo platform components, so the properties present on the Abiquo Server and the Remote Service machines may not be necessary or may only need to be added once. For example, see the Note on Redis Properties below the table.

Abiquo Configuration Properties Table