jmcarp / cos-ansible-base

Our base ansible scripts for deployment and orchestration

cos-ansible-base

• Issue/Task tracking: https://huboard.com/CenterForOpenScience/cos-ansible-base

Requirements

• ansible >= 1.6
• virtualbox
• vagrant >= 1.5
• invoke (Python task execution library)

Installing Ansible and Vagrant on Mac OSX with homebrew

Virtualbox and Vagrant can be installed with homebrew cask. If you have homebrew installed, run the following in the project directory

$ brew bundle

Installing python requirements

Invoke can be installed with pip

$ pip install invoke
$ pip install -r requirements.txt

Vagrant setup

Once you have Vagrant and ansible installed, follow these steps:

• Generate your ssh key with ssh-keygen

$ ssh-keygen

• Run $ vagrant up. Then will start the VM provision with invoke vprovision.

$ vagrant up
$ invoke vprovision

SSH

To ssh into your Vagrant box, you can run (must have invoke installed):

$ invoke vssh -u yourusername

Generating passwords

To generate a password, run

$ invoke genpass

This crypted password can be used by the genericusers role.

Running playbooks

Playbooks can be run with the ansible-playbook command. You need to specify which inventory file with the -i option as well as a user with the -u option. Run in sudo mode with -s

$ ansible-playbook security.yml -i vagranthosts -u sloria -s

Or, using invoke for shorthand:

$ invoke play security.yml -i vagranthosts -u sloria

Provisioning

The site.yml playbook is responsible for provisioning all servers in an inventory.

Run it like so:

$ ansible-playbook site.yml -i vagranthosts -u sloria -s

The above command runs the site.yml playbook using the vagrant inventory file with user sloria in sudo mode.

Or, if you prefer to use invoke:

$ invoke provision -i vagranthosts -u sloria

NOTE: You can also provision the vagrant box by running invoke vprovision with no arguments.

Many of the roles have variables use variables defined in their defaults/main.yml file. You can override these on the command line with the -e option:

$ ansible-playbook site.yml -i vagranthosts -u sloria -e "ssh_test=false"

or, equivalently:

$ invoke provision -u sloria -e "ssh_test=false"

The above would temporarily disable SSH configuration testing.

Deployment

The deploy.yml script is used to deploy the OSF.

To deploy on staging:

$ invoke deploy_staging -u sloria

You will be prompted for the branch to checkout on staging.

To deploy to production:

$ invoke deploy_production -u sloria

This will deploy to the production server, checking out the master branch from Github.