mbon-dashboard-server

Server software stack for MBON server serving early-alert dashboards.

Contents:

For detailed documentation please see ./documentation/.

Project Structure Overview

docker-compose.yml handles most configuration. The subdirectories (eg erddap, nginx, etc) contain container-specific files.

Setup

General Setup Notes

In general you will configure your stack by:

1. Modifying docker-compose.yml and container-specific configuration files inside of ./erddap/, ./grafana/, etc. Directions for this is included within a README.md file inside of each directory. Changes made to these files should be version controlled using git.
2. Setting up docker volumes so that data can persist when containers are recreated. Volumes are generally too large for git, so you should manage backups of these directories. A strategy for this is not included.
3. Setting passwords & configuration in .env. This file should not be added to git for security reasons. A backup strategy for this file is not included.

It is suggested that you configure each container one-at-a-time. To do this simply comment out the relevant sections of docker-compose.yml.

Setup Checklist

1. fork this repo & clone your fork to local machine
2. install docker & docker-compose
3. add permissions to run docker for current user
   1. sudo usermod -aG docker ${USER}
4. adjust settings
   1. set passwords in the environment .env file.
      • see the documentation/example_env_file for an example.
   2. connect ERDDAP to your data - see ./erddap/README.md
   3. load data into InfluxDB - see ./influxdb/README.md
   4. modify grafana dashboards - see ./grafana/README.md
   5. create data dir for PostgreSQL - see ./postgres/README.md
5. run initialization containers:
   1. docker-compose -f docker-compose-init.yml up -d
   2. wait a few minutes
   3. docker-compose -f docker-compose-init.yml down
6. start everything up: docker-compose up --build -d
7. test it out (assuming your hostname is "localhost")
   1. http://localhost/ should show "welcome to nginx"
   2. http://localhost:8080/ should show a 404 from tomcat
   3. http://localhost:8080/erddap should show ERDDAP's page
   4. http://localhost:8086/ should show "404 page not found" from InfluxDB
   5. http://localhost:3000/login should show grafana login
   6. http://localhost:5000 should show a data submission form from mbon_data_uploader
8. configure grafana
   • import dashboards from github/USF-IMaRS/grafana-dashboards using these instructions.

Basic Workflow

The workflow here is to do any non-site-specific work on the master branch. Each client installation then has a client-* branch coming off of the master branch. To update a client branch to use the latest master git rebase is used.

Editing master

1. modify docker-compose.yml or files within container folders
2. docker-compose up --build -d to update what's running
3. git pull then git commit your changes
   • do not commit your .env or hostname changes to erddap/setup.xml

Editing client branch

1. same as above
2. same as above
3. git checkout client-fknms
4. git rebase master
5. resolve any merge issues
6. git push -f origin client-fknms
   • !!! be careful with force pushing; it deletes history