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.2

Disabled properties

  1. abiquo.api.max.sessions: note that this property has been temporarily disabled and will be enabled in future releases

Open Sessions on Hyper-V

Set abiquo.virtualfactory. openSession=1 as a workaround to problems with concurrent deployments in Hyper-V
Configure Abiquo Events Properties

Abiquo M Configuration

Abiquo has a default role called OUTBOUND_API that has access to events. This role is assigned to a default user, which is called "default_outbound_api_user".

Configure M

If you do not configure M properly, no events will be available in Abiquo. You will need to configure some of the M properties in the abiquo.properties file on the server where M will run. By default, M runs on the Abiquo Server. The API location is required and if you change the M user password, you must add the M user account details.

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
    1. Abiquo automatically configures M with a randomly generated M user password; please contact Abiquo support if you need to know this password
    2. The M user credentials and password are NOT included in properties file
    3. If the customer changes the password of the M user account, they must add the M user and the password in the abiquo.properties file as described below
  2. Upgrade from older version of Abiquo
    1. As part of the database upgrade, Abiquo automatically creates a new M user, assigns a password, and displays these credentials to the customer
    2. The customer must add the M user and password to 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 M user, the hidden default values will not function
    • This user must have appropriate 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 with the user name "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 = default_outbound_api_user
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 ALL load 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

Range: all range values are inclusive

(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