The instruction below describes how to install Aquilon from the sources and run it as a non-root user. The installation steps described here require that you are root on the machine. It is possible to do the installation itself as an ordinary user, using a Python virtualenv, but this is not described here (if you need it, you are assumed to know what is involved in setting a virtualenv environment).
Note: the commands provided in this documentation are intended to be copy/pasted.
Under EL7, you need to install RPMs listed below. For this you need to have the following YUM repositories configured:
RPMs to install are:
yum install python python-devel python-setuptools python-dateutil python-lxml python-psycopg2 \ python-coverage python-ipaddr python-mako python-jsonschema PyYAML python-cdb python-twisted-runner \ python-twisted-web ant-apache-regexp ant-contrib-1.0 gcc protobuf-compiler protobuf-python \ make git git-daemon libxslt-devel libxml2-devel java-1.8.0-openjdk-devel panc \ knc krb5-workstation python-pip # If you don't use an external Kerberos server yum install krb5-server
In addition install the
sqlalchemy module from PIP (the EPEL version is too old):
pip install sqlalchemy
If using a distribution other than EL7, you will need python 2.7.x and git 1.7+.
Cloning the git repositories
cd your_work_directory git clone https://github.com/quattor/aquilon-protocols.git
Pass in an alternate INSTALLDIR if desired. Compiling the protocol buffers into Perl may fail.
cd aquilon-protocols make PROTOC=protoc install # or make INSTALLDIR=/usr/local/lib/aquilon/protocols PROTOC=protoc install
cd /opt/ git clone https://github.com/quattor/aquilon.git
Commit messages require a
Simply add the gerrit
You can (try to) use following commands (will overwrite previous
wget -q -O - "https://gerrit.googlesource.com/gerrit/+/v188.8.131.52/gerrit-server/src/main/resources/com/google/gerrit/server/tools/root/hooks/commit-msg?format=TEXT" | base64 --decode > .git/hooks/commit-msg chmod +x .git/hooks/commit-msg
Example commit message should look like
Short Summary of the change Details what was done Details what more was done Change-Id: I9f8d7d0f656e72877c436727d0e4a8d8a62a4b89
If the installation is done as root and all the dependencies (listed in
/opt/aquilon/setup.py have been installed
as RPM or using the
pip command, there are no more installation steps to do and you should be able to run the
/opt/aquilon/tests/dev_aqd.sh. This command should fail with:
sqlalchemy.exc.OperationalError: (sqlite3.OperationalError) unable to open database file
Any other error means that something is wrong in the installation
Installation as a non-root user
This section is for advanced users only.
If you install Aquilon in a Python virtualenv, you need to run the following commands to get the dependencies into your virtualenv.
cd aquilon/tools ./bootstrap_env.py > aq_env.py aq_env.py --python=python2.7 --prompt="(aquilon) " /usr/local/aquilon/pythonenv --system-site-packages
cx_Oracleinstall will fail if there is no local Oracle client installed - that’s fine.
cdbpackage installed as a RPM will be reported as missing but it should not prevent the installation from working
- For some packages, the current stable version may be used instead of the minimum requested version
If the installation succeeded, the following directories should be present:
To add the Aquilon dependencies to Python path, execute:
Create the Broker Configuration
Set up the aquilon broker configuration file. There is an example
/opt/aquilon/etc/aqd.conf.defaults. Move this file to
and create a empty
(or define the
AQDCONF environment variable to point wherever it is
installed). The default will use a sqlite database back-end. Main required
dsdb: change to
git_daemon: change to
ant_contrib_jar: change to
- Comment out every else in the
tool_locationssection that point to a path starting with
pan_compiler: change to
protocolssection): change to
Configure the Kerberos Server
If you don’t rely on an existing Kerberos server, you need to set up one. See the
servername in [realms] section.*
*Note: if you install the Kerberos on a new machine with not a lot of activity, it may take a while for the Kerberos database creation to complete, due to its need to wait for enough randomness entropy. To speed up this process, you can follow the recipe in the following blog post.
Be sure to define properly the domain associated with your realm: it must match your actual domain.
If you don’t run as
root, be sure to create a keytab for the current user.
Create a User to Run the Broker
It is recommended not to run the broker as root. This cause quite a number of problem with Kerberos in particular. To create and configure a user to run the broker:
adduser aquilon mkdir /var/spool/keytabs kadmin.local kadmin.local: addprinc aquilon kadmin.local: addprinc aquilon/your.host.fqdn kadmin.local: ktadd -k /var/spool/keytabs/aquilon kadmin.local: quit chown aquilon:aquilon /var/spool/keytabs/aquilon
Initialise the Aquilon Database
To create the Aquilon database:
mkdir -p /var/quattor/aquilondb chown -R aquilon:aquilon /var/quattor su - aquilon kinit # Enter the password you set previously /opt/aquilon/tests/aqdb/build_db.py
Test The Broker
To test the broker, run
/opt/aquilon/tests/dev_aqd.sh that must run successfully if your
installation is correct. Before running this script, you need to define
/etc/aqd.conf (the script uses
/etc/aqd.conf.dev by default).
To check that the broker is working properly, in another window, execute the following command:
The command should return some information on your current Aquilon environment, without any error.
If this is the case, stop the broker started by the
Start the Production Broker
Starting the production service:
/opt/aquilon/etc/rc.d/init.d/aqdand add the following lines if they are not present
# chkconfig: 2345 99 1 # description: Aquilon Broker
/var/log/aquilonand set the owner to
/var/run/aquilonand set the owner to
- Configure the init script and start the service
ln -s /opt/aquilon/etc/rc.d/init.d/aqd /etc/init.d chkconfig --add aqd ln -s /opt/aquilon/etc/sysconfig/aqd /etc/sysconfig service aqd start
Git Daemon Configuration
Create a bare Git repository in ``/var/quattor/template-king
that will be the master repository for
the templates and create its prod` branch (which is expected to exist after the database
initialisation but is not created):
git init --bare /var/quattor/template-king cd /tmp git clone /var/quattor/template-king cd template-king touch README.md # You may want to add something in it but this is not required git add README.md # If Git complains about missing user.email and user.name, define them (actual value does not matter) git commit -am 'Empty README added' git push origin master:prod
By default Aquilon broker uses
trash branch to take a snapshot of a domain before deleting it.
If you wish to disable this functionality, leave
trash_branch option in the
[broker] configuration section blank.
To use this feature
trash branch will need to be manually created as part of initial Git set up:
git push origin prod:trash
Then start the Git daemon:
git daemon --export-all --base-path=/var /var/quattor/template-king/ &