Documentation

Skip to end of metadata
Go to start of metadata

1. Introduction to Monolithic server

The Abiquo Monolithic server is a simple environment suitable for trial and proof-of-concept environments. 

The Monolithic Appliance includes Abiquo Server, Abiquo Remote Services and Abiquo V2V Services on the same host. It does not include the NFS repository.

The Monolithic Appliance is a single server installation of the full Abiquo platform. You can use this platform to manage separate hypervisors and external storage in demonstrations or very small environments. Remember that the server where you are installing the Abiquo platform will also be performing the virtual image conversions. The number and size of the VMs you deploy using this setup may affect the performance of your system.

The Monolithic platform can support a single private cloud datacenter with hypervisors and Docker, as well as a number of public cloud regions.

The following diagram shows the monolithic install. The main connections configured during this install process are shown with solid black lines.

You can extend the monolithic install to add more private cloud datacenters and public cloud regions. To do this, install another Remote services server.

2. Prerequisite Steps

It is important to install and configure the following Abiquo platform components  in this order :

  1. NFS server for private cloud
  2. Monitoring server
  3. Hypervisors and public cloud providers
    • See Installation and Configuration sections for your hypervisors, even if they are already installed. You must check that your installation is compatible and configure your hypervisors so they will run properly with Abiquo.
  4. Abiquo Monolithic Server

3. System Requirements

The Abiquo monolithic appliance has the following system requirements.

ServerMonolithic
Recommended
test server specifications
  • CentOS 6.5 (Linux 2.6 x64)
  • 2 x CPUs
  • 4 GB RAM
  • 100 GB Disk
  • 2 x E1000 NIC

If you just want to "try out" Abiquo with a few small virtual machine templates, you can run the virtual machine as it is! However, you should keep an eye on logs and disk space.

Hypervisor networks

For Abiquo DHCP server without a separate DHCP relay server, install the Abiquo Monolithic Appliance on a hypervisor with VLAN support configured. For example, for ESXi, see  How to configure an ESXi host to support VLAN tagging

Platform networks

Connect the Abiquo Monolithic server to these platform networks:

  • Management network
  • Service network (DHCP) with switch ports in trunk mode
Internet access

For GoogleMaps, Abiquo remote image repository, public cloud

vCenter Integration (optional)

vCenter admin credentials are required

4. Install Abiquo Monolithic Appliance

4.1. Download Abiquo Monolithic Appliance

Download Abiquo Monolithic Appliance and check the MD5 sum.

4.2. Configure virtual machine

Load the appliance into your hypervisor and check the configuration. The following table describes the default appliance settings.

DescriptionDefault Configuration
Guest OS TypeRed Hat (64 bit)
CPU2
RAM4096 MB
Network adapterIntel PRO/1000 MT Server
Hard Disk Controller (SCSI)LsiLogic
Virtual Disk Image Capacity9.77 GB

4.2.1. Networking

Connect to the Management Network and for this interface configure the network with a VLAN tag that is not trunked in the switch and will be EXCLUDED from the tags available to Abiquo for assigning to private networks.

If you are using the Abiquo Server's built-in DHCP server, connect to the Service Network, which should be configured in trunk mode to support virtual networks.

4.3. Configure Monolithic Server

4.3.1. Download JCE

To download Java Cryptography Extension (JCE) Unlimited Strength, accept terms of the Oracle licence agreement. See http://www.oracle.com/technetwork/java/javase/terms/license/index.html

After you click Accept, a confirmation screen will advise you to wait. Click OK to continue.

4.3.2. Enter your NFS repository configuration

Abiquo requires an NFS repository that will hold the VM template library for private cloud. Abiquo will mount the NFS repository on the Abiquo Remote Services and V2V Server. It will also configure the NFS repository in the abiquo.properties file of the Abiquo Server. This will enable the template repository to be mounted on your hypervisors.

Enter the IP address in the <nfs-ip> field and the exported directory (by default this is /opt/vm_repository). For example, mynfs.exmaple.com:/opt/vm_repository

The IP address cannot be a localhost value (127.0.0.1 or localhost). It must be reachable by other hosts in your LAN.

If you are installing Abiquo to use with a public datacenter only, no NFS repository is required, so you can enter a valid IP address where no NFS server is present.

4.3.3. Configure your Abiquo datacenter ID parameter

Enter the unique ID for the physical datacenter where this remote service is being installed and click OK to continue.

The Datacenter ID must be the same as it is for the other Remote Services of this datacenter and different from all other datacenters. This ID is used to configure the RabbitMQ queues and the routing keys. The configuration information you enter on this screen is used to configure the abiquo.properties file. See Abiquo Configuration Properties#Datacenter  

4.3.4. Configure your API Endpoint

On a test monolithic machine, you should accept the default endpoint, which is the IP address of the monolithic server. 

4.3.5. Configure SSL

Abiquo recommends that you always use SSL for your platform. This will enable your users to make secure connections from the client UI to the UI Server. However, you could run the platform without SSL for a very basic test install.


4.3.6. M user configuration

The installer will extract the default randomly-generated M user password from the Abiquo database and add the M user credentials the Abiquo properties file.  The M user credentials is required for completing event details in Abiquo and event streaming. If you change the credentials of the M user in Abiquo, you must also change them in the Abiquo properties file. See Abiquo Configuration Properties#Configure Abiquo Events Properties


4.3.7. Configuration finished

When the configuration is complete, Abiquo will display the address where you can log in and the login details. Remember to change your Abiquo passwords as soon as possible.

4.3.8. Configure Monolithic Server

The Monolithic Server is a CentOS system. After install, log in and configure the server, including:

  • Configure system time (ntpdate and ntp)
  • Change the root password in CentOS
  • Your template conversions will be created on this server, so if you wish to use larger templates, extend the default 10 GB logical volume

4.3.9. Configure Abiquo Properties

Edit the Abiquo Configuration Properties file, which by default can be found at:

/opt/abiquo/config/abiquo.properties

Set the recommended properties as described in the Abiquo Administrator's Guide.

Some example configuration properties may be: 

  • the monitoring server IP address and port

  • for Hyper-V or XenServer hypervisors, the repository location properties which are described as part of the hypervisor configuration

  • to enable Docker, enter the Docker repository location

  • for virtualized KVM servers, enter the fullvirt property

See  Abiquo Configuration Properties  for a complete properties reference.

After completing the configuration step, remember to restart the Abiquo Tomcat server:

4.4. Configure Abiquo UI

If you wish to configure the UI, for example, to change the UI text or translate it into different languages, see Configure Abiquo UI

5. Log In to the Web Client

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

https://<myabiquo.example.com>/ui

The default cloud admin login and password are "admin" and "xabiquo", respectively.

Remember to change your cloud admin password as soon as you log in for the first time.

5.1.1. Add a License

See Configuration View#License Management

5.1.2. Quick Tutorial

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

6. Troubleshooting

6.1.1.1. Check configuration file formats and properties

Check that your abiquo.properties file is correctly formatted, for example, there should be no spaces after the property values. Also check that property names are spelled correctly and appropriate values are supplied.

6.1.1.2. Check Client UI config

Review the Abiquo UI Configuration file, which by default can be found at.

/var/www/html/ui/config/client-config-custom.json

Check that the file is correct JSON format and check that the property names are typed correctly and appropriate values have been entered.

Check that your API endpoint is set correctly and add any other required options.

{
  "config.endpoint": "https://abiquo.server.ip/api"
}

See Configure Abiquo UI for a complete reference.

6.1.1.3. Check NFS configuration

Check that you have set up an external NFS/CIFS server as described in NFS Server Setup.

Check that the /opt/abiquo/config/abiquo.properties file contains values for the following properties.

For example, if the Abiquo Server is located at 10.10.10.5 and the NFS repository is located at 10.10.10.4, the abiquo.properties file would look as follows.

6.1.1.3.1. After Changing abiquo.properties Restart abiquo-tomcat

After changing these settings, restart abiquo-tomcat service:

service abiquo-tomcat restart
6.1.1.4. Check the External NFS Server on the Hypervisors

Log in to the hypervisors as root and check that the external NFS server is mounted, for example, using the df command.

The NFS shared directory must have an empty file named .abiquo_repository (the dot prefix is required). If you selected "Abiquo NFS Repository" as recommended by this guide, this file is automatically created for you. Otherwise, to create this file, mount the NFS share and enter the command:

For further details of NFS configuration and troubleshooting, please see NFS Server Setup and Distributed Install - 4. Post-install Configuration.