README.md

Overview

This project automates the pre-deployment setup for named instances consisting of ruby applications run with puma.

It assumes a functional application, web, and database tier is already in place.

Paradigm

The predeployment offered by this project is intended to be configured and run once, resulting in full preparation for deployment to the web, app, and db tiers. Actual deployment of the named instance is up to the developer(s), as is the configuration of their named instance's deployment.

Each deployment stage (or target) of a project is its own, self-contained named instance. I.e., umrdr-staging and umrdr-production are two separate named instance.

Each named instance is associated with its own named instance user and group. Developers with deployment permission are added to the named instance's group. Thus, this project provisions the necessary file and sudo permissions to allow them to deploy and restart the named instance.

Each named instance should have its own:

• unique name, preferably of the form appname-stagename
• predeploy configuration file
• inventory file

Usage

Short Version

git clone [email protected]:mlibrary/ansible-predeploy.git
cd ansible-predeploy
./bin/predeploy --initialize -n myapp-mystage
# A&E fills out instances/myapp-mystage/inventory
# A&E and the developer fills out instances/myapp-mystage/required_vars.yml
./bin/predeploy --setup -n myapp-mystage
./bin/predeploy --ansible -n myapp-mystage

Full Version

1. Minimally, the developer provides an application name and stagename. By convention, stage names should be one of production, staging, or testing.
2. Fill out the files created by ./bin/predeploy -i -n myapp-mystage
3. Run bin/predeploy -s -n myapp-mystage to convert the file we just created into the form that ansible will use. There is no need to edit the resulting file. However, it does contain some useful information, such as the passwords generated for the deploy and the final database user name.
4. Run the ansible playbook with ./bin/predeploy --ansible -n myapp-mystage
5. Run the appropriate ansible playbook, as below:

From here, the playbook should run without issue. The playbook is idempotent, so re-running if there is an problem is not an issue.

Infrastructure Requirements

deployment host:

• ansible >= ??
• subversion (for checking out solr config)
• git

all:

• python
• passwordless ssh as root

database:

• mysql
• python mysqldb module is required

web:

• apache
• common umich apache macros

Testing

Testing with Vagrant using virtual box provider

1. install external ansible roles ansible-galaxy install -r dependencies.yml
2. install vagrant
3. install virtual-box
4. expand variables: ./bin/setup_ansible -v required_vars.yml > ./vars/example-vars-staging-expanded.yml
5. run vagrant up from project directory
6. provision vagrant host using:

# Run the full playbook
ansible-playbook playbook.predeploy.yml --private-key=.vagrant/machines/default/virtualbox/private_key -u vagrant -i inventory/vagrant --extra-vars="config_file=./vars/example-vars-staging-expanded.yml"

# Limit to just the tasks for the web servers
ansible-playbook playbook.predeploy.yml --private-key=.vagrant/machines/default/virtualbox/private_key -u vagrant -i inventory/vagrant --extra-vars="config_file=./vars/example-vars-staging-expanded.yml" -l web

7. deploy named instance (out of scope - see fauxpaas)

8. test setup using:

ansible-playbook playbook.test.yml --private-key=.vagrant/machines/default/virtualbox/private_key -u vagrant -i inventory/vagrant --extra-vars="config_file=./vars/example-vars-staging-expanded.yml"