Open edX Setup ‑ Stand‑Up the LMS for the Chatbot Project

[SAUMILDHANKAR]

Description
Provision and configure an Open edX instance (latest LTS, e.g., Olive or Palm) to act as the canonical Learning Management System for the chatbot integration. The Open edX environment will host learning modules, expose APIs/webhooks for sync jobs, and support Auth0‑backed SSO. Deployment should be reproducible (preferably with Tutor) and suitable for a small‑to‑medium production workload.

Action Items

1. Infrastructure & Deployment

   • Select deployment method: self‑host with Tutor (Docker/K8s) or managed provider.
   • Provision cloud resources (CPU/RAM, PostgreSQL, Redis, SMTP, object storage for course files).
   • Automate install scripts via Terraform or Ansible, stored in infra/ folder.

2. Core Configuration

   • Set site name, domain, TLS (Let’s Encrypt or equivalent).
   • Configure Auth0 as an OAuth2/SAML SSO provider (match scopes/claims used by the chatbot).
   • Enable JWT authentication for API access (needed by sync micro‑service).

3. Essential Plugins & Features

   • Enable xAPI / LRS emitter or Open edX Event Bus for real‑time webhook events.
   • Install ecommerce if paid courses are required (optional, flag in README).
   • Set up course discovery and catalog services.

4. Dev & Prod Parity

   • Provide a local Tutor dev stack (docker-compose) mirroring prod settings.
   • Document environment variables, secrets, and bootstrap commands.

5. Sample Content

   • Import or create a demo course “Grant Writing Basics” with 2–3 units and a quiz (aligns with Set up Twilio account and obtain API credentials. #8 “Fetch Grant Learning Modules”).
   • Tag modules with external_id values expected by the chatbot.

6. Observability & Back‑ups

   • Wire logs into centralized logging (e.g., CloudWatch / ELK).
   • Daily DB and file‑storage backups with retention policy.
   • Health‑check endpoint monitored by status page.

7. CI/CD

   • GitHub Actions workflow: build Tutor images, run smoke tests, deploy to staging, then prod on git tag.

8. Documentation

   • Update README.md > Open edX Setup with:

     • Architecture diagram (Open edX + chatbot services + Auth0).
     • One‑command dev spin‑up.
     • Troubleshooting section (SSL, migrations, theming).

   • Add ADR (Architecture Decision Record) describing LMS choice.

Acceptance Criteria

• Running make deploy-edx STAGE=prod (or documented equivalent) provisions a working Open edX site reachable at the configured domain via HTTPS.
• Users can log in with Auth0 credentials and are created/updated in Open edX on first login.
• The demo course is visible, publishable, and quizzes record grades.
• Webhook/xAPI events fire to a test endpoint and contain user/course IDs required by the sync service.
• Automated CI pipeline passes (build, test, deploy) without manual intervention.
• Documentation lets a new team member set up a local Open edX environment in ≤30 minutes.

---

[SAUMILDHANKAR]

This issue needs to be broken down after mentor meeting discussion.

[SAUMILDHANKAR]

• OpenEdx issue is not ready to be worked on yet, based on last week's meeting we need to selectively use code from OpenEdx since we may not use their entire codebase. So, we either need to edit issue Open edX Setup ‑ Stand‑Up the LMS for the Chatbot Project #36 or create a new issue for that.

[SAUMILDHANKAR]

Mark's help for this issue: a lot of the openedx documentation indicates support for python fyi