docs: update README and LAB with EC2 support details#44
Conversation
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis pull request updates project documentation to support AWS EC2 deployment via CloudFormation alongside the existing local Docker setup. Changes include EC2-specific instructions, CloudFormation stack references, and expanded troubleshooting guidance for both local and cloud environments. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Pull request overview
Updates Module 10 database lab documentation to reflect the new EC2/CloudFormation deployment option alongside local Docker usage, and removes the presentation-focused section from the module overview.
Changes:
- Document
cloudformation.yamlas part of the visualizer lab structure and add EC2-specific guidance for accessing the visualizer. - Add EC2 cleanup and troubleshooting notes (stack deletion + common EC2 failure modes).
- Remove the “Presentation” section from the module README.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| 10-databases/visualizer/LAB-VISUALIZER.md | Adds CloudFormation template to the lab structure list, clarifies browser URL for local vs EC2, and expands cleanup/troubleshooting with EC2 notes. |
| 10-databases/README.md | Updates prerequisites/architecture text for EC2 support, adds an EC2 quick start path, expands troubleshooting, and removes the presentation section. |
| | Animation stuck | Previous operation running | Wait for it to finish or refresh the page | | ||
| | Port 3306 in use | Local MySQL running | Stop local MySQL or change port in docker-compose | | ||
| | Cassandra OOM crash | Not enough Docker memory | Allocate at least 4 GB RAM in Docker Desktop | | ||
| | EC2 page does not load | Stack still initializing | Wait 5-10 min after CREATE_COMPLETE for Docker setup | |
There was a problem hiding this comment.
The troubleshooting row advises waiting 5–10 minutes after CREATE_COMPLETE for Docker setup, but earlier the Quick Start says the stack completes in ~5–10 minutes (and LAB instructions suggest only a short extra wait after completion). Please make the timing guidance consistent to avoid confusion.
| | EC2 page does not load | Stack still initializing | Wait 5-10 min after CREATE_COMPLETE for Docker setup | | |
| | EC2 page does not load | Stack still initializing | Wait a few minutes after `CREATE_COMPLETE` for Docker setup | |
| - **Docker Desktop** installed and running (includes Docker Compose) | ||
| - A web browser (Chrome, Firefox, or Safari) | ||
| - Basic SQL knowledge (SELECT, INSERT, UPDATE) | ||
| - No cloud account required for the main lab | ||
| - No cloud account required for local Docker; AWS Academy credentials | ||
| required for the EC2 option |
There was a problem hiding this comment.
The Prerequisites list still implies Docker Desktop is required, but the doc now supports an EC2 (browser-only) path. Consider splitting prerequisites by environment (Local vs EC2) or rewording this section so EC2 readers don’t think they need Docker Desktop.
|
|
||
| **EC2 (AWS Academy):** Upload `visualizer/cloudformation.yaml` to | ||
| CloudFormation. When the stack completes (~5-10 min), open the | ||
| **VisualizerURL** from the Outputs tab. |
There was a problem hiding this comment.
This section introduces an EC2 quick start, but the README’s Cleanup section below still only shows running ./cleanup.sh (local). To keep the EC2 option reproducible end-to-end, add a brief EC2 cleanup note here (e.g., delete the CloudFormation stack).
| **VisualizerURL** from the Outputs tab. | |
| **VisualizerURL** from the Outputs tab. When you finish the lab, | |
| delete the CloudFormation stack to clean up the EC2 deployment. |
| | Replica shows `--` in sidebar | Replication not configured | Re-run `./setup.sh` | | ||
| | EXPLAIN shows `rows: 1` | Table stats stale | Run `ANALYZE TABLE access_log;` in the console | | ||
| | Animation stuck | Previous operation still running | Wait for it to finish or refresh the page | | ||
| | EC2 page does not load | Stack still initializing | Wait 5-10 min after CREATE_COMPLETE for Docker setup | |
There was a problem hiding this comment.
The troubleshooting guidance says to wait 5–10 minutes after CREATE_COMPLETE, but earlier in the EC2 setup flow the stack creation itself is estimated at 5–10 minutes and then suggests waiting “another minute” if the page doesn’t load. Please align these so readers don’t get conflicting timing expectations (e.g., “wait a couple minutes after CREATE_COMPLETE” or similar).
| | EC2 page does not load | Stack still initializing | Wait 5-10 min after CREATE_COMPLETE for Docker setup | | |
| | EC2 page does not load | Stack still initializing | Wait a couple of minutes after CREATE_COMPLETE for Docker setup | |
Update docs to reflect EC2 CloudFormation support, remove Presentation section, add EC2 troubleshooting.
Summary by CodeRabbit