Skip to content

Latest commit

 

History

History
69 lines (38 loc) · 3.28 KB

INSTALL.md

File metadata and controls

69 lines (38 loc) · 3.28 KB
Raw

Clout Installation Guide

Required Dependencies

clout requires:

Building and Installing Clout

To build clout, run:

python setup.py build

To install in your home directory:

python setup.py install --prefix=$HOME

To install system-wide:

python setup.py install

For a complete discussion of customizations related to the setup.py script, see this page.

System Setup

Edit your ssh config (typically in ~/.ssh/config) and add the following two lines:

StrictHostKeyChecking no
ServerAliveInterval 120

The first line tells SSH not to ask us whether we want to connect or not to an unknown host, which will ALWAYS occur since the Amazon EC2 instance will always be a new host each time one is created. This option allows us bypass this prompt and keep the entire process automated.

The second line tells us to send keepalive packets to the Amazon EC2 instance every two minutes so that our SSH connection doesn't drop during long-running test suites.

Test that your install appears to be working by running the following command:

clout -h

You should see clout's help text printed to your terminal.

Cron Job Setup

You may want to add the clout executable to a crontab to have your test suites automatically run at some regular time interval. To do so, you'll need to set the PYTHONPATH from within the crontab to tell Python where to look for clout's library code. You'll also need to add the directories where Python and StarCluster reside to the PATH variable within the crontab, or run the script specifying the full path to your Python executable, and use the --starcluster_exe_fp option to clout to specify the full path to StarCluster.

Edit your crontab with the following command:

crontab -e

Add the following lines to the crontab, if you'd like to use environment variables to locate Python and StarCluster:

PATH=/path/to/starcluster/executable/directory
PYTHONPATH=/path/to/clout/directory

For example, if Python is in /usr/bin and StarCluster is in /usr/local/bin:

PATH=/usr/bin:/usr/local/bin
PYTHONPATH=/home/ubuntu/clout

Please be sure to use absolute paths for all filepaths and commands in the crontab.

Alternatively, you can remove the PATH line altogether by running the clout command like so in your crontab (using full paths to avoid having to set PATH):

/usr/bin/python /home/ubuntu/clout/scripts/clout -i <...> --starcluster_exe_fp /usr/local/bin/starcluster

There are various ways to set up your system to receive email from the cron job if the script produces any output (e.g. if it raises an error). If the script runs normally, there shouldn't be any output (stdout or stderr), but it is a good idea to make sure that someone will receive emails from the cron system if something goes wrong. This website has an excellent guide to setting up your system to forward emails to an external SMTP server (they show how to set it up for an external Gmail account). This was verified to work on an Amazon EC2 instance that was running the cron job.