Deployment Guide

SEED is intended to be installed on Linux instances in the cloud (e.g., AWS), and on local hardware. SEED Platform does not officially support Windows for production deployment. If this is desired, see the Django notes.

• AWS Setup
  • Prerequisites
  • Python Dependencies
  • JavaScript Dependencies
  • Database Configuration
  • Cache and Message Broker
  • Running Celery the Background Task Worker
• General Linux Setup
  • Prerequisites
  • Configure PostgreSQL
  • Python Dependencies
  • JavaScript Dependencies
  • Django Database Configuration
  • Cache and Message Broker
  • Creating the initial user
  • Running celery the background task worker
  • Running the development web server
  • Running a production web server
  • Environment Variables
  • Mail Services
  • local_untracked.py
• Docker Deployment on AWS
  • Installation
  • Deploying with Docker
• Kubernetes Deployment Guide with Helm
  • Setup
  • Deployment
  • Managing Existing Clusters
  • Other Resources

Migrations

Migrations are handles through Django; however, various versions have customs actions for the migrations. See the migrations page for more information.

Monitoring

Sentry

Sentry can monitor your webservers for any issues. To enable sentry add the following to your local_untracked.py files after setting up your Sentry account on sentry.io.

The RAVEN_CONFIG is used for the backend and the SENTRY_JS_DSN is used for the frontend. At the moment, it is recommended to setup two sentry projects, one for backend and one for frontend.

import sentry_sdk
from sentry_sdk.integrations.django import DjangoIntegration
from sentry_sdk.integrations.celery import CeleryIntegration

sentry_sdk.init(
    dsn="https://<user>@<key>.ingest.sentry.io/<job>",
    integrations=[
        DjangoIntegration(),
        CeleryIntegration(),
    ],

    # Set traces_sample_rate to 1.0 to capture 100%
    # of transactions for performance monitoring.
    # We recommend adjusting this value in production.
    traces_sample_rate=1.0,

    # If you wish to associate users to errors (assuming you are using
    # django.contrib.auth) you may enable sending PII data.
    send_default_pii=True
)

SENTRY_JS_DSN = 'https://<key>@sentry.io/<job_id>'