Skip to content

canonical/mysql-router-operator

Repository files navigation

mysql-router-operator

Charmhub Release Tests Sync docs from Discourse

Description

The Charmed MySQL Router Operator is a database proxy for Group Replicated MySQL clusters.

MySQL Router is a middleware that provides transparent routing of MySQL servers and client applications. More info at MySQL Router.

The proxy sits between the MySQL cluster and a client application, e.g.:

flowchart TD
    id1(Application) --db--> id2(MySQL Router)
    id2 --db--> id3[(MySQL Cluster)]
Loading

Usage

Until the MySQL Router Machine Charm is published, you need to follow the build & deploy instructions from CONTRIBUTING.md to deploy the charm. After building and deploying the charm, it must be couple with the mysql-operator charm, through a relation, e.g.:

juju deploy mysql-operator
juju deploy ./mysqlrouter_ubuntu-20.04-amd64.charm
juju add-relation mysql-operator mysql-router-operator

To more details on how to build and deploy, check CONTRIBUTING.md.

Relations

Relations are defined in metadata.yaml as:

  • Requires: db
  • Provides: db

License

The MySQL Router Operator is free software, distributed under the Apache Software License, version 2.0. See LICENSE for more information.

Security

Security issues in the MySQL Router Operator can be reported through LaunchPad. Please do not file GitHub issues about security issues.

Contributing

Please see the Juju SDK docs for guidelines on enhancements to this charm following best practice guidelines, and CONTRIBUTING.md for developer guidance.