Deploying Open Food Network

These are Ansible playbooks (scripts) for managing an Open Food Network app server. This is not for your local development environment. Head to the OFN getting started guide to run the OFN locally.

Documentation

See the wiki for more information, including: additional setup, configuring, provisioning and deployment.

For deploying OFN versions below v4.x.x, please use the ofn-v3 branch of this repo.

Playbooks

These playbooks will install the Open Food Network app onto a server running an apt-compatible OS like Debian or Ubuntu. It has currently been tested on Ubuntu 16.04 and 18.04 (64 bit) on AWS, DigitalOcean and Scaleway cloud servers.

The playbooks take information from the inventory. Make sure that your host's information is up to date before running a playbook.

These are the main playbooks:

setup.yml - Use a root login to ensure python is installed and create a default user (defined in inventory/group_vars/all.yml) on the server for installation (mandatory the first time you provision a server).
provision.yml - Install and configure all required software on the server (requires secrets, see below).
deploy.yml - Deploy OFN to the server by copying a git repo to the server and using ruby/rake/rails tasks to configure and migrate.
backup.yml - Backup database and image files on the server to the local machine.
rollback.yml - Rollback the database and codebase to the previous version.

You may want to use the anisble option "checkrun" to do a dry-run of the playbooks. With this option, Ansible will run the playbooks, but not actually make changes on the server.

Setup

Fork the ofn-install repository.

Clone the forked copy:

git clone https://github.com/<your-namespace>/ofn-install.git

Python

It's recommended you set up your Python environment using Pyenv.

Install and configure pyenv
Install and configure pyenv-virtualenv
Install the required Python version:
```
$ pyenv install 3.8.2
```
Create the virtualenv:
```
$ pyenv virtualenv 3.8.2 ofn-install
```

Dependencies

You will need to install Ansible, alongside other dependencies, on your machine to run the playbooks. You can do so with:

pip install -r requirements.txt

Ansible Galaxy Roles

Some playbooks require third-party roles, which are specified in bin/requirements.yml. You can install with the included script:

$ bin/setup

Secrets

Some tasks require host-specific secrets. These can be provided with a parameter like so:

ansible-playbook playbooks/provision.yml --limit=au-prod -e "@../path/to/au-prod/secrets.yml"

If you have access to the ofn-secrets repository, you can automatically fetch them with the fetch_secrets role, activated by an environment variable:

    echo "export FETCH_OFN_SECRETS=TRUE" >> ~/.bash_profile

But warning, there is an open issue with this method: openfoodfoundation#861

Code quality

Run the ansible-lint checks using:

ansible-lint site.yml --exclude=community

This is also run in CI.

Security

This repository doesn't manage additional security configuration. The private repository ofn-security is used for servers managed by the OFN team.

mkllnk/ofn-install