Runbooks: API

How to deploy a new API version

• Build a new ooni/api docker image

From inside ooni/api run:

ooni/sysadmin/scripts/docker-build

It will build a docker image and upload it to docker hub.

• From inside ooni/sysadmin edit oomsm_tag inside of ansible/roles/ooni-measurements/vars/main.yml (https://github.com/ooni/sysadmin/blob/master/ansible/roles/ooni-measurements/vars/main.yml#L3) with the version of the docker image

• Commit this change and push to ooni/sysadmin

• Run from inside ooni/sysadmin/ansible: ./play deploy-api.yml -t api

• Connect to https://api.ooni.io/api/v1/measurements and check that everything works

Checking logs

sudo journalctl -f CONTAINER_NAME=oomsm-web

The following key-value pairs are set:

  CONTAINER_NAME=oomsm-web
  CONTAINER_TAG=api-20200309-b63f75ac
  IMAGE_NAME=openobservatory/api:20200309-b63f75ac

Example truncated output:

Mar 16 12:55:07 ams-api.ooni.nu api-20200309-b63f75ac[10997]: server closed the connection unexpectedly
Mar 16 12:55:07 ams-api.ooni.nu api-20200309-b63f75ac[10997]:         This probably means the server terminated abnormally
Mar 16 12:55:07 ams-api.ooni.nu api-20200309-b63f75ac[10997]:         before or while processing the request.
Mar 16 12:55:07 ams-api.ooni.nu api-20200309-b63f75ac[10997]:  [SQL: 'SELECT coalesce ...

Monitoring

https://mon.ooni.nu/grafana/d/FNVKM2-Wk/api-and-amsdb\?orgId\=1\&refresh\=5m