-
Notifications
You must be signed in to change notification settings - Fork 2
Add MySQL documentation with production HA guidance #257
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
- Updated README.md with MySQL support in features and config - Expanded database-selection.md with MySQL comparison and production HA guidance - Enhanced internal/database/README.md with MySQL references - Updated getting-started/configuration.md with MySQL configuration - Added MySQL to docs/README.md quick reference - Updated Helm chart and deployment docs with MySQL and HA warnings - Added CHANGELOG entry for MySQL documentation Co-authored-by: mfittko <[email protected]>
- Updated quickstart.md with MySQL build options and setup - Enhanced architecture.md with MySQL database support - Added production HA warnings to docker-compose docs - Updated deployment architecture diagrams to include MySQL Co-authored-by: mfittko <[email protected]>
- Updated installation.md with MySQL build instructions - Enhanced deployment/index.md with MySQL quick start examples - Added database-specific build tag examples throughout - Ensured all deployment paths mention MySQL support Co-authored-by: mfittko <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds comprehensive MySQL documentation to complete the MySQL epic (#240), integrating MySQL alongside SQLite and PostgreSQL across all user-facing documentation with a strong emphasis on production deployment best practices and high-availability guidance.
Key changes:
- Added MySQL to all database comparison tables and configuration guides with consistent connection string formats and build tag documentation
- Included production HA warnings across deployment documentation, clarifying that in-cluster MySQL/PostgreSQL StatefulSets are development/testing only
- Provided cloud provider examples (Aurora, RDS, Cloud SQL, Azure) for production MySQL deployments
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
CHANGELOG.md |
Added entry documenting MySQL documentation updates |
README.md |
Updated database support section to include MySQL with connection pool settings and build requirements |
docs/README.md |
Added MySQL Docker Compose guide link and updated database selection guide description |
docs/getting-started/quickstart.md |
Added MySQL build options and startup examples with Docker Compose profile |
docs/getting-started/installation.md |
Added MySQL build instructions and startup commands with connection string examples |
docs/getting-started/configuration.md |
Added comprehensive MySQL configuration section with connection string format, TLS options, and version compatibility |
docs/deployment/index.md |
Added Helm quick start example for production MySQL deployment with external database |
docs/deployment/helm.md |
Added MySQL external deployment section with HA warning and build requirements |
docs/database/docker-compose-postgres.md |
Added production HA warning for PostgreSQL Docker Compose setup |
docs/database/docker-compose-mysql.md |
Added production HA warning for MySQL Docker Compose setup |
docs/database/database-selection.md |
Expanded comparison table to include MySQL, added comprehensive MySQL section with configuration, cloud examples, and production deployment guidance |
docs/architecture/architecture.md |
Updated database layer description and deployment diagrams to include MySQL support and build tags |
deploy/helm/llm-proxy/README.md |
Enhanced HA warnings for both PostgreSQL and MySQL in-cluster StatefulSets with specific managed service recommendations |
internal/database/README.md |
Updated architecture diagrams, comparison table, and file structure to include MySQL support |
Comprehensive documentation for MySQL database backend support, completing the MySQL epic (#240). Adds MySQL alongside SQLite and PostgreSQL across all user-facing documentation with emphasis on production deployment best practices.
Core Changes
Database Selection & Configuration
-tags mysql)Getting Started
Deployment
Production HA Guidance
Added warnings across all deployment docs:
Applied to:
deploy/helm/llm-proxy/README.md(MySQL and PostgreSQL sections)docs/database/database-selection.mddocs/database/docker-compose-{mysql,postgres}.mddocs/deployment/helm.mdBuild Tag Documentation
Connection String Examples
Files changed: 14 (README, CHANGELOG, 8 docs/, 2 deploy/, 2 internal/)
Dependencies: Completes after #247 (driver), #248 (migrations), #253 (compose), #255 (helm), #256 (tests)
Original prompt
This section details on the original issue you should resolve
<issue_title>[MySQL] Documentation Updates</issue_title>
<issue_description>## Summary
Update all relevant documentation to include MySQL as a supported database backend, including configuration guides, deployment instructions, and architectural documentation.
Parent Epic
Part of #240 - Add MySQL as Optional Database Backend
🆕 Additional Items from PR Review
Single-Replica StatefulSet HA Guidance
During the review of PR sofatutor/llm-proxy#255 (Helm Chart MySQL Support), an important documentation item was identified:
The in-cluster MySQL StatefulSet is hardcoded to
replicas: 1. The documentation must include clear guidance that:Files requiring this note:
deploy/helm/llm-proxy/README.md- MySQL sectiondocs/database/database-selection.md- MySQL comparisondocs/deployment/kubernetes.md- MySQL deployment sectionThe in-cluster MySQL option should be clearly positioned as development/testing only.
Documentation Structure
flowchart TB subgraph CoreDocs["Core Documentation"] README["README.md"] DOCSIDX["docs/README.md"] end subgraph GettingStarted["Getting Started"] CONFIG["configuration.md"] QUICK["quickstart.md"] end subgraph DatabaseDocs["Database Documentation"] DBSEL["database-selection.md"] DCMYSQL["docker-compose-mysql.md (NEW)"] DBREADME["internal/database/README.md"] end subgraph DeployDocs["Deployment Documentation"] DOCKER["deployment/docker.md"] K8S["deployment/kubernetes.md"] HELMRM["helm/README.md"] end subgraph ArchDocs["Architecture Documentation"] ARCHIDX["architecture/index.md"] ARCHDB["architecture/database.md"] end subgraph ConfigDocs["Configuration"] ENVEX[".env.example"] ENVDOC["environment-variables.md"] end CoreDocs --> GettingStarted GettingStarted --> DatabaseDocs DatabaseDocs --> DeployDocs DeployDocs --> ArchDocs ConfigDocs --> DatabaseDocsDetailed Task Breakdown
Phase 1: Core Documentation
README.mdREADME.mdREADME.mddocs/README.mdPhase 2: Getting Started Guides
docs/getting-started/configuration.mddocs/getting-started/quickstart.mddocs/getting-started/configuration.mdPhase 3: Database Documentation
docs/database/database-selection.mddocs/database/database-selection.mddocs/database/docker-compose-mysql.mdinternal/database/README.mdPhase 4: Deployment Documentation
docs/deployment/docker.mddocs/deployment/kubernetes.mddeploy/helm/llm-proxy/README.mddocs/deployment/docker.mddeploy/helm/llm-proxy/README.mdPhase 5: Architecture Documentation
docs/architecture/index.mddocs/architecture/database.mdPhase 6: Configuration Documentation
.env.exampledocs/configuration/environment-variables.mdPhase 7: Changelog and Release Notes
CHANGELOG.md💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.