MySQL Router Documentation
The MySQL Router Operator delivers automated operations management from day 0 to day 2 on the MySQL Router Community Edition lightweight middleware that provides transparent routing between your application and back-end MySQL Servers. It is an open source, end-to-end, production-ready data platform component on top of Juju.
MySQL Router is part of InnoDB Cluster, and is lightweight middleware that provides transparent routing between your application and back-end MySQL Servers. It can be used for a wide variety of use cases, such as providing high availability and scalability by effectively routing database traffic to appropriate back-end MySQL Servers. The pluggable architecture also enables developers to extend MySQL Router for custom use cases.
This MySQL Router operator charm comes in two flavours to deploy and operate MySQL Router on physical/virtual machines and Kubernetes. Both offer features identical set of features and simplifies deployment, scaling, configuration and management of MySQL Router in production at scale in a reliable way.
Project and community
This MySQL Router charm is an official distribution of MySQL Router. It’s an open-source project that welcomes community contributions, suggestions, fixes and constructive feedback.
- Read our Code of Conduct
- Join the Discourse forum
- Contribute and report issues
- Explore Canonical Data Fabric solutions
- Contacts us for all further questions
In this documentation
| Tutorials Get started - a hands-on introduction to using Charmed MySQL operator for new users |
How-to guides Step-by-step guides covering key operations and common tasks |
| Reference Technical information - specifications, APIs, architecture |
Explanation Concepts - discussion and clarification of key topics |
Navigation
| Level | Path | Navlink |
|---|---|---|
| 1 | tutorial | Tutorial |
| 2 | t-overview | 1. Introduction |
| 2 | t-setup-environment | 2. Set up the environment |
| 2 | t-deploy-charm | 3. Deploy MySQL Router |
| 2 | t-managing-units | 4. Manage units |
| 2 | t-enable-security | 5. Enable security |
| 2 | t-cleanup-environment | 6. Cleanup environment |
| 1 | how-to | How To |
| 2 | h-setup | Setup |
| 3 | h-deploy-lxd | Deploy on LXD |
| 3 | h-manage-units | Manage units |
| 3 | h-enable-encryption | Enable encryption |
| 3 | h-manage-app | Manage applications |
| 3 | h-external-access | External access |
| 2 | h-monitoring | Monitoring |
| 3 | h-enable-monitoring | Monitoring (COS) |
| 3 | h-enable-tracing | Tracing (COS) |
| 2 | h-upgrade | Upgrade |
| 3 | h-upgrade-intro | Intro |
| 3 | h-upgrade-major | Major upgrade |
| 3 | h-rollback-major | Major rollback |
| 3 | h-upgrade-minor | Minor upgrade |
| 3 | h-rollback-minor | Minor rollback |
| 2 | h-contribute | Contribute |
| 1 | reference | Reference |
| 2 | r-releases-group | Release Notes |
| 3 | r-releases | All releases |
| 3 | r-releases-rev269 | Revision 267/268/269 |
| 3 | r-releases-rev225 | Revision 223/224/225 |
| 3 | r-releases-rev198 | Revision 197/198 |
| 3 | r-releases-rev119 | Revision 118/119 |
| 2 | r-requirements | Requirements |
| 2 | r-testing | Testing |
| 2 | r-contacts | Contacts |
| 1 | explanation | Explanation |
| 2 | e-interfaces | Interfaces/endpoints |
| 2 | e-statuses | Statuses |
| 2 | e-juju-details | Juju |
| 2 | e-legacy-charm | Legacy charm |