Skip to content

docs: update README and LAB with EC2 support details#44

Merged
gamaware merged 1 commit into
mainfrom
fix/readme-ec2-updates
Apr 14, 2026
Merged

docs: update README and LAB with EC2 support details#44
gamaware merged 1 commit into
mainfrom
fix/readme-ec2-updates

Conversation

@gamaware
Copy link
Copy Markdown
Owner

@gamaware gamaware commented Apr 14, 2026

Update docs to reflect EC2 CloudFormation support, remove Presentation section, add EC2 troubleshooting.

Summary by CodeRabbit

  • Documentation
    • Added EC2 and AWS Academy deployment path alongside existing Docker setup
    • Introduced CloudFormation-based infrastructure instructions
    • Updated Quick Start guide to include EC2 deployment steps
    • Expanded troubleshooting section with EC2-specific failure scenarios
    • Removed standalone presentation section reference

Copilot AI review requested due to automatic review settings April 14, 2026 03:49
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 14, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6ae8535d-bacd-43e5-8870-382e01e30382

📥 Commits

Reviewing files that changed from the base of the PR and between 88028b1 and 9aa6e49.

📒 Files selected for processing (2)
  • 10-databases/README.md
  • 10-databases/visualizer/LAB-VISUALIZER.md

📝 Walkthrough

Walkthrough

This 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

Cohort / File(s) Summary
Documentation Updates
10-databases/README.md, 10-databases/visualizer/LAB-VISUALIZER.md
Added EC2/AWS Academy CloudFormation deployment instructions alongside existing local Docker setup. Updated Quick Start to reference CloudFormation VisualizerURL output, expanded Troubleshooting with EC2-specific failure modes (initialization delays, Learner Lab prerequisites), added Cleanup steps for CloudFormation stacks, and removed standalone presentation section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Cloud paths unfold with mighty CloudFormation,
Where EC2 instances dance in AWSellation,
Local Docker flows and remote stacks now aligned,
Documentation blooms—both Earth and Cloud refined!
The troubleshooting garden grows, with care in every line. 🌱

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/readme-ec2-updates

Comment @coderabbitai help to get the list of available commands and usage tips.

@gamaware gamaware merged commit 36957a4 into main Apr 14, 2026
13 of 17 checks passed
@gamaware gamaware deleted the fix/readme-ec2-updates branch April 14, 2026 03:50
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.yaml as 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.

Comment thread 10-databases/README.md
| 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 |
Copy link

Copilot AI Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
| 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 |

Copilot uses AI. Check for mistakes.
Comment thread 10-databases/README.md
Comment on lines 46 to +50
- **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
Copy link

Copilot AI Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment thread 10-databases/README.md

**EC2 (AWS Academy):** Upload `visualizer/cloudformation.yaml` to
CloudFormation. When the stack completes (~5-10 min), open the
**VisualizerURL** from the Outputs tab.
Copy link

Copilot AI Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Suggested change
**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.

Copilot uses AI. Check for mistakes.
| 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 |
Copy link

Copilot AI Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Suggested change
| 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 |

Copilot uses AI. Check for mistakes.
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.

2 participants