Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openfoodfoundation/ofn-install
Ansible scripts for provisioning and deploying Open Food Network
https://github.com/openfoodfoundation/ofn-install
ansible openfoodnetwork
Last synced: 5 days ago
JSON representation
Ansible scripts for provisioning and deploying Open Food Network
- Host: GitHub
- URL: https://github.com/openfoodfoundation/ofn-install
- Owner: openfoodfoundation
- Created: 2014-05-19T19:28:44.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T05:12:32.000Z (11 days ago)
- Last Synced: 2024-10-29T16:13:14.547Z (10 days ago)
- Topics: ansible, openfoodnetwork
- Language: Jinja
- Homepage:
- Size: 1.56 MB
- Stars: 54
- Watchers: 34
- Forks: 112
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- awesome-starred - openfoodfoundation/ofn-install - Ansible scripts for provisioning and deploying Open Food Network (ansible)
README
Deploying Open Food Network
===========================
These are [Ansible](http://docs.ansible.com/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](https://github.com/openfoodfoundation/openfoodnetwork/blob/master/GETTING_STARTED.md) to run the OFN locally.
## Documentation
See the [**wiki**](https://github.com/openfoodfoundation/ofn-install/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, 18.04 and 20.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 (see `host_vars/` and [secrets](#secrets)).
These are the main playbooks (found under `playbooks/`). See inside each for more details. They can be executed together with `site.yml`:
* `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.
Other playbooks include:
* `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.
* `db_transfer.yml` - Transfer the database directly from one host to another (see [Refreshing a staging server](https://github.com/openfoodfoundation/ofn-install/wiki/Refreshing-a-staging-server))
* `setup_remote_deployment.yml` - Set up a staging server to allow remote triggering of the deploy playbook (eg from a GitHub Action)
* and more...
You may want to use the [ansible option "checkrun"](http://docs.ansible.com/playbooks_checkmode.html) 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//ofn-install.git
```
### Python
It's recommended you set up your Python environment using [Pyenv](https://github.com/pyenv/pyenv).
* Install and configure [pyenv](https://github.com/pyenv/pyenv)
* Install and configure [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv)
* Install the required Python version and install dependencies into a virtualenv for the project:
```
./bin/pyenv-install
```
### 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, and will show an error if they haven't been provided. These can change from time to time, so **always ensure you have the latest before provisioning**.
Secrets can be provided with a parameter like so:
```sh
ansible-playbook playbooks/provision.yml --limit=au_staging -e "@../ofn-secrets/au_staging/secrets.yml" --ask-vault-pass
```
If you have access to the `ofn-secrets` repository, you can fetch them with the `fetch_secrets.yml` playbook. The secrets for each host will be loaded into the relevant directory in `inventory/host_vars/`, then you can go ahead and provision. See the [readme](https://github.com/openfoodfoundation/ofn-secrets/#readme) for more tips on setup.
```sh
ansible-playbook playbooks/fetch_secrets.yml && ansible-playbook playbooks/provision.yml
```
## Code quality
Run the [ansible-lint](https://github.com/willthames/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.