Single server¶
Deployment is done via Ansible. Currently, only single server deployments are described but you can just as easily deploy the application in a Kubernetes environment.
Warning
The deployment configuration (called a “playbook”) is very simplistic and also contains sensitive values. This makes the playbook more readable but is not following good practices!
Server preparation¶
You can configure the Ansible playbook to install relevant services, do it manually, or have these pre-installed. You will need:
Nginx
Docker
Python3
Python3 PIP
Apart from Docker, you can install all these with something like:
$ sudo apt-get install nginx python3 python3-pip
For Docker, follow the instructions here: https://docs.docker.com/engine/install/
Database¶
Objects API uses PostgreSQL DB with PostGIS extension.
You can enable geerlingguy.postgresql
role in the Ansible playbook to install it
or do it manually following the instructions here: https://postgis.net/install/
You will also need access to, or create, a database. You can create a database with something like:
$ sudo su postgres --command="createuser <db-username> -P"
Enter password for new role:
Enter it again:
$ sudo su postgres --command="createdb <db-name> --owner=<db-username>"
Installation¶
Download the project from Github or just the deployment files.
$ git clone git@github.com:maykinmedia/objects-api.git $ cd objects-api/deployment/single-server/
Setup virtual environment:
$ python3 -m venv env/ $ source env/bin/activate $ pip install ansible
Note
Sometimes, additional or updates packages are needed if they are not installed by the Ansible setup installation. You can do so like this:
$ python -m pip install -U pip $ pip install ordered_set packaging appdirs six
Install Ansible collections:
$ ansible-galaxy collection install -r requirements.yml
Edit the playbook
app.yml
to match your setup. Take special note of all TODO settings and read through all the comments and variables.Run the playbook:
$ ansible-playbook app.yml --become --ask-become-pass