bedrock-ansible

Ansible playbook designed to be used with Bedrock to configure dev & production servers for Bedrock-based WordPress sites.

This playbook will install the common LEMP (Linux/Nginx/MySQL/PHP) stack with PHP 5.5 and MariaDB as a drop-in MySQL replacement (but better) on Ubuntu 14.04 Trusty LTS.

Vagrant is recommended to provision servers and this comes with a basic Vagrantfile for an easy dev setup.

Requirements

1. Ansible >= 1.5.4 - Installation docs
2. Virtualbox >= 4.3.10 - Downloads
3. Vagrant >= 1.5.4 - Downloads

OS Notes

From the Ansible docs:

Currently Ansible can be run from any machine with Python 2.6 installed (Windows isn’t supported for the control machine). This includes Red Hat, Debian, CentOS, OS X, any of the BSDs, and so on.

If your host machine is running Windows, the workaround is to run Ansible on the VM (since it's running Ubuntu) and not locally. This requires some additions to the default Vagrantfile and an extra script.

Example Vagrantfile for Windows can be found here. There may also be issues with permissions/UAC and symlinks. See this comment.

Installation

1. Download/fork/clone this repo to your local machine.
2. Download/fork/clone Bedrock or have an existing Bedrock-based site ready

You should now have the following directories at the same level somewhere:

- bedrock-ansible/
- example.dev/

Usage

1. Edit Vagrantfile and set your config.vm.synced_folder path so that it points to a local relative path for a Bedrock project from #2 above.
2. Edit group_vars/development and add your WordPress site(s). See Options below for details.
3. Optionally add any dev hostnames to your local /etc/hosts file (or use the hostsupdated plugin.
4. Run vagrant up.

Servers/Environments

This playbook is setup for development environments by default with its Vagrant integration. However, the following default environments are built in:

• development
• staging
• production

Example hosts and group_var files for these environment exist and should be modified as needed.

Note: hosts/development is there for completeness sake only as Vagrant automatically generates and uses its own.

Production note: the only necessary thing currently missing for full production support is setting a root password for MySQL. Right now no password is set.

Passwords

There a few places you'll want to set/change passwords:

• group_vars/<environment> - mysql_root_password
• group_vars/<environment> - wordpress_sites.admin_password
• group_vars/<environment> - wordpress_sites.env.db_password

For staging/production environments, it's best to randomly generate longer passwords using something like random.org.

You may be concerned about setting plaintext passwords in a Git repository, and you should be. Any type of server configs such as this playbook should always be in a private Git repository.

Even then it's still best to try avoid it if possible, so you have few options:

• Use Ansible Vault
• Use Git Encrytpt

Note: if you're mostly using this for development environments only, you probably don't need to worry about any of this as everything is just run locally.

Vagrantfile

The example Vagrantfile in this project can be kept in this folder, or moved anywhere else such as a project/site folder. Generally if you want to have multiple sites on 1 Vagrant VM, you should keep the Vagrantfile where it is (in the bedrock-ansible dir). If you want to have 1 Vagrant VM PER project/site, you should make copies of the Vagrantfile and put them into each project's dir. You'd then run vagrant up from the project specific directory.

Whenever you move or copy the Vagrantfile somewhere else, you need to make sure to adjust the relative paths in it including config.vm.synced_folder and ansible.playbook = './site.yml'.

Vagrant Box

By default, the example Vagrantfile now uses the roots/bedrock box. It's publicly available on the Vagrant Cloud site here.

The roots/bedrock box is simply the regular ubuntu/trusty64 base box already provisioned with this playbook (except for the wordpress-sites role). The benefit to using this base box instead of a bare Ubuntu one is that provisioning will be much faster.

Vagrant Cloud offers releases/versions for the boxes, so the roots/bedrock box versions will be kept in sync with this project. You can see if there's updates by running vagrant box outdated and update it with vagrant box update.

Note: you can always set the box back to the base Ubuntu one if you prefer with config.vm.box = 'ubuntu/trusty64'

Options

All Ansible configuration is done in YAML.

wordpress_sites is the top level array used to define the WordPress sites/virtual hosts that will be created.

• site_name (required) - name used to identify site (commonly the domain name) (default: none)
• site_hosts (required) - array of hosts that Nginx will listen on (default: none)
• user (optional) - user owner of site directories/files (default: root | user in site.yml)
• group (optional) - group owner of site directories/files (default: www-data)
• site_install (optional) - whether to install WordPress or not (default: true)
• site_title (optional) - WP site title (default: site_name)
• db_import (optional) - Path to local sql dump file which will be imported (default: false)
• system_cron (optional) - Disable WP cron and use system's (default: false)
• run_composer (optional) - Run composer install before WP install (default: false)
• admin_user (optional) - WP admin user name (default: admin)
• admin_password (required if site_install) - WP admin user password (default: none)
• admin_email (required if site_install) - WP admin email address (default: none)
• multisite (optional) - hash of multisite options
  • enabled (optional) - Multisite enabled flag (default: false)
  • subdomains (optional) - subdomains option (default: false)
  • base_path (optional) - base path/current site path (default: /)
• env (required) - hash of multisite options
  • wp_home (required) - WP_HOME constant or home option (default: none)
  • wp_siteurl (required) - WP_SITEURL constant or siteurl option (default: none)
  • wp_env (required) - WordPress environment (default: none)
  • db_name (optional) - name of database (default: site_name)
  • db_user (required) - database user name (default: none)
  • db_password (required) - database user password (default: none)
  • db_host (required) - database host (default: localhost)

Todo

• Multisite: basic support is included but not yet complete. There are issues with doing a network install from scratch via WP-CLI.
• Nginx: configuration needs more options and advanced setups like static files and subdomain multisite support.