Install Guide

If you want to simply test the system and quickly get going, please see the Quickstart section.

Customize preexisting VM’s

A simple way to get an installation going is to clone and customize Martin’s repos for your installation. These consist of three repos that are needed to set up the Archiver Appliance environment.

Simply follow the rules in the README of the first repo and the other two repos will be pulled in automatically. The Puppet manifests are found in puppet_module_archiver_appliance.

Site specific installs

Han maintains a set of scripts for site specific installs. This is an excellent starting off point for folks who wish to build their own deployment bundles. This is tested against Debian/CentOS; but should be easily extensible for other distributions.

Using an install script

If you plan to have only one machine in the cluster, you can consider using the install_scripts/single_machine_install.sh install script that comes with the installation bundle. This install script accommodates installations with a “standard” set of parameters and installs the EPICS archiver appliance on one machine. In addition to the System requirements, the install_scripts/single_machine_install.sh will ask for

Location of the Tomcat distribution.
Location of the MySQL client jar - usually a file with a name like mysql-connector-java-5.1.21-bin.jar
A MySQL connection string that looks like so --user=archappl --password=archappl --database=archappl that can be used with the MySQL client like so mysql ${MYSQL_CONNECTION_STRING} -e "SHOW DATABASES". This implies that the MySQL schema has already been created using something like
```
mysql --user=root --password=*****
CREATE DATABASE archappl;
GRANT ALL ON archappl.* TO 'archappl' identified by 'archappl';
```

The install_scripts/single_machine_install.sh install script creates a couple of scripts in the deployment folder that can be customized for your site.

sampleStartup.sh - This is a script in the fashion of scripts in /etc/init.d that can be used to start and stop the four Tomcat processes of your archiver appliance.
deployRelease.sh - This can be used to upgrade your installation to a new release of the EPICS archiver appliance. The deployRelease.sh also includes some post install hooks to deploy your site specific content as outlined here.

Manual installation overview

For finer control over your installation, the steps are:

For the cluster:

Create an appliances.xml (see Configuration)
Optionally, create your policies.py file (see Policies)

In addition to installing the JDK and EPICS (see System requirements), for each appliance: