Deployment¶

Purpose¶

Provide a reliable deploy runbook for OpenSESA runtime promotion.

Because OpenSESA is open source and free to use, this runbook is designed for teams operating their own production environments.

Deployment Workflow¶

flowchart LR
    Prep["Prepare Env"] --> Up["Start Deploy Stack"]
    Up --> Migrate["Run Migrations"]
    Migrate --> Static["Collect Static"]
    Static --> Check["Run Django Checks"]
    Check --> Verify["Verify Logs and Critical Flows"]

Step-by-Step¶

1. prepare environment-specific .env
2. pull deploy images
3. start deploy stack
4. apply migrations
5. collect static assets
6. run checks
7. validate runtime and critical workflows

Commands¶

# set this if your deployment compose file uses a different name/path
DEPLOY_COMPOSE_FILE=docker-compose-deploy.yml

docker compose -f "$DEPLOY_COMPOSE_FILE" pull
docker compose -f "$DEPLOY_COMPOSE_FILE" up -d
docker compose -f "$DEPLOY_COMPOSE_FILE" down
docker compose -f "$DEPLOY_COMPOSE_FILE" run --rm <deploy-app-service> python manage.py migrate
docker compose -f "$DEPLOY_COMPOSE_FILE" run --rm <deploy-app-service> python manage.py collectstatic --noinput
docker compose -f "$DEPLOY_COMPOSE_FILE" run --rm <deploy-app-service> python manage.py check
docker compose -f "$DEPLOY_COMPOSE_FILE" logs -f

Image Pull Strategy¶

• use docker compose -f docker-compose-deploy.yml pull before each rollout
• pin explicit image tags in deploy compose for reproducible promotions
• avoid relying on floating tags in production unless your release policy explicitly allows it
• avoid --build in production rollouts when deploying prebuilt/pinned images

Compose File Naming¶

• this guide uses docker-compose-deploy.yml as a conventional deploy file name
• if your environment uses a different file name or location, set DEPLOY_COMPOSE_FILE accordingly

Post-Deploy Validation¶

• login/auth workflows
• key domain pages (requirements, V&V, baseline, ops)
• worker health and queue processing

Failure Modes¶