Skip to content

Document runtime roles and health checks#4

Draft
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/engineering-documentation-updates-e407
Draft

Document runtime roles and health checks#4
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/engineering-documentation-updates-e407

Conversation

@cursor

@cursor cursor Bot commented Jul 3, 2026

Copy link
Copy Markdown

Docs added/updated

  • Updated docs/01-deployment-infrastructure/SCALING_POWERHOUSE.md with current RELEASE_ROLE behavior, Redis-backed PubSub/Hammer activation via REDIS_URL, segmented Oban queues, and production gzip status.
  • Updated docs/01-deployment-infrastructure/OBSERVABILITY_MANUAL.md with role-specific /health response examples and status semantics.
  • Updated docs/06-admin-system-operations/POST_DEPLOY_SMOKE_CHECKLIST.md to verify expected release_role after deploys.

Codepaths covered

  • studentplug/lib/studentplug/release_role.ex
  • studentplug/lib/studentplug/application.ex
  • studentplug/lib/studentplug_web/controllers/health_controller.ex
  • studentplug/config/runtime.exs
  • studentplug/config/config.exs
  • studentplug/config/prod.exs

Key knowledge gaps addressed

  • Clarified that single-service production uses unset/all, while split deployments should use web and worker.
  • Documented that Redis behavior is runtime-gated by REDIS_URL and must be present on all nodes before horizontal web scaling.
  • Replaced stale single-queue/worker-health assumptions with the current queue and /health contracts.

Verification

  • git diff --check
Open in Web View Automation 

Co-authored-by: Thabiso <ThabisoX@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant