gee-gateway

A REST API designed to be used by CEO (Collect Earth Online) to interface with Google Earth Engine.

INSTALLATION

Follow this guide for your operating system. https://chriswarrick.com/blog/2016/02/10/deploying-python-web-apps-with-nginx-and-uwsgi-emperor/

The following is a shorthand version for Debian / Ubuntu

Global packages

# Verify no need for uwsgi-emperor
sudo apt install python3 python3-venv uwsgi uwsgi-plugin-python3 nginx-full

GEE User account

# Create common user
sudo mkdir /opt/gee-gateway
sudo groupadd gee
sudo useradd -s /bin/bash -g gee -d /opt/gee-gateway gee
sudo chown -R gee:gee /opt/gee-gateway
sudo su - gee
# You should be in /opt/gee-gateway

Python virtual environment

git clone https://github.com/SERVIR/gee-gateway.git
cd gee-gateway/
python3 -m venv --prompt ceo venv/
source venv/bin/activate
pip install -r requirements.txt
pip install earthengine-api --upgrade
deactivate

CONFIGURATION

CONFIG FILES

Edit the gee-gateway configuration file gee-gateway/config.py

Copy and configure the nginx config file gee-gateway/nginx_files/gee.conf into /etc/nginx/sites-available/gee.conf

sudo cp nginx_files/gee.conf /etc/nginx/sites-available/gee.conf
sudo ln -s /etc/nginx/sites-available/gee.conf /etc/nginx/sites-enabled/
sudo nano /etc/nginx/sites-available/gee.conf
sudo service nginx restart

Copy uwsgi service file gee-gateway/nginx_files/gee-uwsgi.service to /etc/systemd/system/gee-uwsgi.service and update path to gee-uwsgi.ini

sudo cp nginx_files/gee-uwsgi.service /etc/systemd/system/gee-uwsgi.service
sudo nano /etc/systemd/system/gee-uwsgi.service

PERMISSIONS

Set the owner of the gee-gateway folder to the same as uid/gid in gee-gateway.ini

sudo chown -R ceo:ceo gee-gateway/

HTTPS/HTTP

HTTP access for 127.0.0.1 is required when running next to ceo. The nginx.conf template includes a skeleton for HTTP.

To have nginx reload when certificates are renewed by certbot, place a script file in /etc/letsencrypt/renewal-hooks/deploy. The sh file will need executable writes. Inside that file place the following line:

systemctl reload nginx

EXECUTION

Enable

sudo systemctl daemon-reload
sudo systemctl enable nginx gee-uwsgi
sudo systemctl reload nginx

Start, Stop, Restart (note that nginx and gee-uwsgi are two different processes)

sudo systemctl start nginx gee-uwsgi
sudo systemctl stop nginx gee-uwsgi
sudo systemctl restart nginx gee-uwsgi

LOGS

sudo less +G /var/log/nginx/error.log
sudo journalctl -e -u gee-uwsgi

USE

Navigate to https://localhost:8888/ to interact with the web ui.

Have running alongside CEO.

curl https://localhost:8888/timeSeriesIndex -d '{"collectionNameTimeSeries":"LANDSAT/LC8_L1T_32DAY_NDWI","geometry":[[98.6270686247256,12.804422919455547],[98.62753901527437,12.804422919455547],[98.62753901527437,12.804714380460211],[98.6270686247256,12.804714380460211],[98.6270686247256,12.804422919455547]],"indexName":"NDWI","dateFromTimeSeries":"2015-01-01","dateToTimeSeries":"2017-12-31","reducer":"","scale":30,"point":[98.62730382,12.80456865],"start":"","end":"","band":"","dataType":""}'

curl https://localhost/geo-dash/gateway-request -d '{"collectionNameTimeSeries":"LANDSAT/LC8_L1T_32DAY_NDWI","geometry":[[98.6270686247256,12.804422919455547],[98.62753901527437,12.804422919455547],[98.62753901527437,12.804714380460211],[98.6270686247256,12.804714380460211],[98.6270686247256,12.804422919455547]],"indexName":"NDWI","dateFromTimeSeries":"2015-01-01","dateToTimeSeries":"2017-12-31","reducer":"","scale":30,"path":"timeSeriesIndex","point":[98.62730382,12.80456865],"start":"","end":"","band":"","dataType":""}'