ODK Build is a web-based, drag-and-drop service for creating forms used with data collection tools such as ODK Collect. ODK Build is part of Open Data Kit (ODK), a free and open-source set of tools which help organizations author, field, and manage mobile data collection solutions. Learn more about the Open Data Kit project and its history here and read about example ODK deployments here.
This branch is for committing and tracking a set of deployment scripts that use a combination of Ansible, Nginx, Unicorn, Postgres, and Wal-e to automatically push a fully functional instance of ODK Build, with offsite AWS S3 backups and optional SSL support, to any Ansible target server.
Everything should be set up already; just vagrant up. The Vagrantfile allocates the machine at the local bridge IP 192.168.33.10, which you can hit after successful provisioning to access the application. VMware is supported; simply change ubuntu/xenial64 to velocity42/xenial64.
- We recommend taking a look at the Ansible getting started guide to make sure you understand and are set up for the basics of Ansible.
- Once you are, copy
config/build.yml.sampletoconfig/build.ymland take a look at it for information you need to plug in. - Your target machine must have the following configured:
- Ubuntu 16.x LTS. Other distributions or version may work but are not officially supported.
- An OpenSSH server (
apt-get install openssh-server). - A provisioning user with sudo privileges; this username is in
config/build.ymlasusers.provisioning_user. - Either non-password (
NOPASSWD) sudo on said user, or a password with which to sudo (in which case add--ask-sudo-passto youransible-playbookcommand). - A way to SSH into your target machine with said provisioning user.
- Fetch the required Ansible Galaxy roles:
ansible-galaxy install -r requirements.yml -p roles. - Then run
ansible-playbook -i hosts playbook.ymlto kick it all off. You'll have to create thehostsfile yourself.- Once your machine is successfully set up, you can use
deploy.ymlinstead ofplaybook.ymlto push new versions of Build to your targets.
- Once your machine is successfully set up, you can use
- The
requirements.ymlfile specifies some specific patches that are currently pending merger or publish; if you install from that file you will be okay, but otherwise you'll have to watch out for some bugs:- There is currently an issue with the latest versions of Ansible which necessitate a quick patch of
roles/ANXS.postgresql/tasks/install.yml; see this issue for further information. The change has been merged but has yet to be published to Galaxy. - Pending the merger of a pull request, the wal-e module fails to install due to Python versioning conflicts; the file in question is
roles/Stouts.wale/tasks/install.deb.ymland the diff is here. - Due to changes in Ansible (I believe 2.x), the nginx role is also currently broken. Pending a pull request merger, the syntax in
roles/ANXS.nginx/tasks/sites.ymlis obsolete and needs patching; see this PR for more details.
- There is currently an issue with the latest versions of Ansible which necessitate a quick patch of
- You may run into an nginx error on reloading nginx. If you do, log into the machine and run
systemctl start nginx, then run the ansible playbook again. - You may wish to configure ansible to disable host checking and disable retry files.
Pull requests are welcome! If you have changes to make the setup more robust, deploy easier to more machines, or otherwise improve the development or deployment of ODK Build, please don't hesitate to suggest them as issues or submit pull requests with the relevant changes.
Build is licensed under the Apache 2.0 license.