Charmed MySQL documentation¶
Charmed MySQL is an open-source software operator that deploys and operates MySQL Community Edition relational databases on machines or Kubernetes with Juju.
This operator is built with the latest Ops framework and replaces the legacy MariaDB, OSM MariaDB, Percona cluster and MySQL InnoDB cluster operators.
Charmed MySQL includes features such as cluster-to-cluster replication, TLS encryption, password rotation, backups, and easy integration with other applications both inside and outside of Juju. It meets the need of deploying MySQL in a structured and consistent manner while allowing the user flexibility in configuration, simplifying reliable management of MySQL in production environments.
In this documentation¶
This documentation contains practical information about installing and operate Charmed MySQL. It covers instructions for both VM and K8s substrates.
Get started¶
Learn about what’s in the charm, how to set up your environment, and perform the most common operations.
Charm overview: Architecture • System requirements • Release notes
Deploy MySQL: Guided tutorial • Quickstart
Key operations: Scale your cluster • Manage user credentials • Create a backup
Production deployments¶
Advanced deployments and operations focused on production scenarios and high availability.
Advanced deployments: Terraform • Airgapped • Multiple availability zones • Cluster-cluster replication
Networking: Juju spaces • TLS encryption • External network access
Upgrades and data migration: In-place upgrades • Cluster and data migration
Troubleshooting: Overview and tools • Known scenarios • Logs
Charm developers¶
Make your charm compatible with MySQL: Interfaces and endpoints • How to integrate with your charm with MySQL
Learn more about the charm: Internal users • Roles • Architecture
How this documentation is organised¶
This documentation uses the Diátaxis documentation structure:
The Tutorial provides step-by-step guidance for a beginner through the basics of a deployment in a local machine.
How-to guides are more focused, and assume you already have basic familiarity with the product.
Reference contains structured information for quick lookup, such as system requirements and configuration parameters
Explanation gives more background and context about key topics
Project and community¶
Charmed MySQL is an open-source project that welcomes community contributions, suggestions, fixes and constructive feedback.