. . .

Debian package Installation

This guide will lead you through the installation of the ApiOmat .deb package. The package is supported for the follwing OS versions (see Infrastructure Requirements)

Installing MongoDB

ApiOmat is based on MongoDb database. MongoDB can be also installed via apt-get:

Installing ApiOmat

For package dependencies, see System preparations.

Installation from APT repository

If your installation machine has internet access, add the ApiOmat APT repository add install via apt-get ( replace **** with the password provided via email):

echo "deb ftp://f00c6540:****@apiomat.com/deb ./" > ~/apiomat.list
sudo mv ~/apiomat.list /etc/apt/sources.list.d/
wget -O - ftp://f00c6540:****@apiomat.com/apiomat.key | sudo apt-key add -
sudo apt-get update
sudo apt-get install apiomat-yambas apiomat-dashboard2

With the release 2.5.0 it is now possible to set the installation path for the ApiOmat Dashboard. During installation, the path and the Apache alias are requested. The data is then stored under /etc/apiomat/installPath . The installPath file has the following structure:

export APIOMAT_DASHBOARD2=/opt/aom-dashboard
export APIOMAT_DASHBOARD2_ALIAS=/
export APIOMAT_DASHBOARD=/opt/aom-dashboard3
export APIOMAT_DASHBOARD_ALIAS=/d3

If your distribution contains a PHP version >= 7 (e.g. Ubuntu 16.04)

echo "deb ftp://f00c6540:****@apiomat.com/deb ./" > ~/apiomat.list
sudo mv ~/apiomat.list /etc/apt/sources.list.d/
wget -O - ftp://f00c6540:****@apiomat.com/apiomat.key | sudo apt-key add -
#Add the ppa for php7 only if PHP7 not already contained in distribution
#sudo add-apt-repository ppa:ondrej/php -y
sudo apt-get update
sudo apt-get install apiomat-yambas apiomat-dashboard2-php7

Installation with deb files

If you obtained the installation files manually, copy the .deb packages of YAMBAS and Dashboard to the application server(s) and enter:

sudo dpkg --install apiomat-yambas-xxxx.deb
sudo dpkg --install Dashboard-xxx.deb
#or
sudo dpkg --install Dashboard-php7-xxx.deb
 
 
# On installation errors because of missing dependencies execute
sudo apt-get -f install

After Dashboard installation, you will be asked to open http://localhost/dashboard/install in your browser. Follow the steps in this installer tool to get ApiOmat configured automatically.

Reboot afterwards to start all services automatically.

Beta - Installing Dashboard 3

[Optional] Preparation if older Dashboard Versions are installed

If you have another dashboard already installed and want to install Dashboard3 next to it, then you have to execute the following operations before starting the installation.
Otherwise the installation of Dashboard3 may overwrite existing ones.

  1. Configure Installation path by adding export APIOMAT_DASHBOARD=/opt/aom-dashboard3 and export APIOMAT_DASHBOARD_ALIAS=/d3 manually to /etc/apiomat/installPath (like shown in section Installation from APT repository)

  2. If necessary check and remove ancient apache sites which you do not need anymore (e.g. zzz-aom-dashboard.conf from older dashboard version 2.4.0):

sudo rm /etc/apache2/sites-available/zzz-aom-dashboard.conf
sudo a2dissite zzz-aom-dashboard.conf

Install Dashboard3 with Deb Package

Unpack and install Dashboard3 deb package using the following command:

sudo apt-get install apiomat-dashboard
#or with deb-file
sudo dpkg -i Dashboard3-2.5.0.deb

When installing dashboard3, it may ask you for the install path. Do not use the path to dashboard2! It will also ask for an alias. This alias will define the URL to dashboard 3 e.g. localhost/d3. If you want to install dashboard 3 at localhost just use "/" as alias.

Adjust older Dashboard Installations

If you install dashboard 3 besides dashboard 2, you have to configure the alias of the dashboard2 in its vhost file (/etc/apiomat/apiomat-dashboard2.conf) like:

Alias /d2 "/opt/aom-dashboard/site/apiomat/"
<Directory "/opt/aom-dashboard/site/apiomat">
AllowOverride All
...

After editing the .conf-file the apache service needs to be restarted.

With this configuration the 2 versions of dashboard would be accessible on localhost/d2 and localhost/d3.

Next steps

Installing Monitoring Service (optional)

ApiOmat microservices require a Java8 runtime to be installed. If Java8 was not installed before (YAMBAS includes an installation) it has to be installed manually:

echo 'deb http://ppa.launchpad.net/webupd8team/java/ubuntu xenial main' | sudo tee /etc/apt/sources.list.d/webupd8team-java.list
sudo apt-get update
echo 'oracle-java8-installer shared/accepted-oracle-license-v1-1 select true' | sudo debconf-set-selections
sudo apt-get install --force-yes -y oracle-java8-installer
sudo apt-get install --force-yes -y oracle-java8-set-default

ApiOmat is able to monitor server data like CPU load or disk space. To enable this feature, a central service registry has to be installed on one node in the cluster.

sudo apt-get install apiomat-serviceregistry

Additionally, a monitoring service has to be installed on each node (app and database) which should be monitored:

sudo apt-get install apiomat-monitoringservice

By default, the services are not added to any runlevel. To automatically start the services after reboot, execute the following commands:

sudo update-rc.d apiomat-serviceregistry defaults
sudo update-rc.d apiomat-monitoringservice defaults

In the next step, you have to check the Java version: Oracle Java 8 is required (do not use OpenJDK).

Finally, start the services and make sure the service registry is fully started (http://localhost:8761/ is reachable) before you start the monitoring service:

sudo /etc/init.d/apiomat-serviceregistry start
sudo /etc/init.d/apiomat-monitoringservice start

Checks

YAMBAS

  • Logs: /var/log/tomcat/catalina.out

  • http test: http://<HOSTNAME>:8080/yambas/rest - should print the version number

Dashboard

  • Logs: /var/log/apache

  • http test: http://<HOSTNAME>/dashboard

Monitoring Services

  • Logs:

    • /var/log/apiomat-monitoringservice.log

    • /var/log/apiomat-serviceregistry.log

Please visit the FAQ section for questions and solutions.

* link only available in Enterprise Documentation