This is a Python package providing a library that can be imported from fabric3 scripts to provide common implementations of typical tasks for projects that are using tequila for provisioning and deploy.

This Ansible role is released under the BSD License. See the LICENSE file for more details.

We attempt to not make changes that break backward-compatibility. Nonetheless, you should always use a pinned version of this repo to be safe. Check the release history before upgrading for any notes or warnings.

If you think you've found a bug or are interested in contributing to this project, check out tequila-fab on Github.

Development sponsored by Caktus Consulting Group, LLC.

pip install into your virtualenv:

$ pip install git+https://github.com/caktus/[email protected]#egg=tequila-fab

The simplest case is to just import everything from tequila_fab at the top of your fabfile.py:

# fabfile.py

from tequila_fab import *

Then write some tasks to select environments, e.g.:

from fabric.api import env, task

@task
def staging():
    """
    Usage: fab staging <tasks>
    """
    env.environment = 'staging'

These just need to set env.environment to the name of one of your tequila environments.

Now users can use the tasks as documented in the reference below. You'd likely start with:

$ fab install_roles
$ fab <ENVNAME> bootstrap

for new servers. Then:

$ fab <ENVNAME> deploy:playbook=site.yml
$ fab <ENVNAME> create_superuser:[email protected]

Most of these tasks end up invoking Ansible playbooks from tequila, so be sure to see the docs there for more information, and of course your own playbooks and configuration in your project's deployment directory.

(In alphabetical order.)

Does the simplest possible install of Python v2 so that Ansible can run from then on. Use when the target servers might not even have Python installed.:

$ fab <ENVNAME> bootstrap

Check that the roles required in requirements.yml are all installed and at the right version, and fail if not.

This gets run automatically before a deploy or bootstrap, so won't often need to be run by itself.:

$ fab check_role_versions

Create a superuser with no password (there's no way to pass a new password to the createpassword command non-interactively). Use password reset after creating the user.:

$ fab <ENVNAME> create_superuser:<USERNAME>

For example:

$ fab staging create_superuser:[email protected]

Run an ansible deploy for an environment.

By default, runs the playbook web and deploys the default branch for the specified environment. You can override either of those by passing playbook or branch options. Do not include .yml in the playbook name.

You can also set/override any Ansible variable by passing the extra_vars option. Here's the usage:

$ fab <ENV> deploy[:playbook=NNNN][:extra_vars=aaa=1,bbb=2][:branch=xxx]

Some examples:

$ fab staging deploy
$ fab staging deploy:playbook=site
$ fab staging deploy:branch=PRJ-9999
$ fab staging deploy:playbook=site:extra_vars=gunicorn_num_workers=8

Run Ansible galaxy's role installer for the requirements in deployment/requirements.yml.