openstack/charm-mysql-router
Code Issues Proposed changes
aca857a3d3
charm-mysql-router/src
History
Alex Kavanagh aca857a3d3 Release sync for 20.08 
- Classic charms: sync charm-helpers.
- Classic ceph based charms:  also sync charms.ceph
- Reactive charms: trigger a rebuild
- sync tox.ini
- sync requirements.txt and test-requirements.txt

Change-Id: Ie1f68f07abe763195de55f0e2f86e481b125d837
2020-07-27 20:55:09 +01:00
..
actions Use systemd to start/stop mysqlrouter 2020-01-07 16:16:11 -08:00
files Release sync for 20.08 2020-07-27 20:55:09 +01:00
lib Enable MySQL TLS 2020-07-01 13:11:29 -07:00
reactive Scale-in of mysql innodb cluster nodes 2020-05-20 08:25:04 -07:00
templates Increase number of file descriptors for mysqlrouter process 2020-05-22 09:33:51 +02:00
tests Add Groovy test bundles 2020-07-10 17:43:01 +02:00
actions.yaml Use systemd to start/stop mysqlrouter 2020-01-07 16:16:11 -08:00
config.yaml Create and use the mysql system user 2019-12-13 15:27:22 -08:00
HACKING.md Upstream charm 2019-10-17 09:41:43 -07:00
icon.svg Required files 2019-10-04 14:12:47 -07:00
layer.yaml Upstream charm 2019-10-17 09:41:43 -07:00
metadata.yaml Updates for 20.08 cycle start for groovy and libs 2020-06-02 14:33:21 +01:00
README.md Update README for supported status 2020-05-20 18:24:21 -04:00
test-requirements.txt Upstream charm 2019-10-17 09:41:43 -07:00
tox.ini Upstream charm 2019-10-17 09:41:43 -07:00
wheelhouse.txt Enable MySQL TLS 2020-07-01 13:11:29 -07:00

README.md

Overview

The mysql-router charm provides a MySQL 8 Router; it proxies database requests from a principle application to a MySQL 8 InnoDB Cluster. MySQL Router handles cluster communication and understands the cluster schema.

It is a subordinate charm that is used in conjunction with the mysql-innodb-cluster charm. It is also used with a principle charm that supports the 'mysql-shared' interface. The current list of such charms can be obtained from the Charm Store (the charms officially supported by the OpenStack Charms project are published by 'openstack-charmers').

Important

: The eoan series is the first series supported by the mysql-innodb-cluster and mysql-router charms. These charms replace the percona-cluster charm starting with the focal series.

Usage

The charm is deployed as a subordinate to a principle application and then related to the central mysql-innodb-cluster application:

principle charm A <---> mysql-router A <--->
principle charm B <---> mysql-router B <---> mysql-innodb-cluster
principle charm C <---> mysql-router C <--->

Configuration

See file config.yaml for the full list of configuration options, along with their descriptions and default values.

Deployment

To deploy a MySQL 8 Router:

juju deploy mysql-router

Add a relation to a principle application (via the shared-db endpoint):

juju add-relation keystone:shared-db mysql-router:shared-db

Then add a relation to the mysql-innodb-cluster application (via the db-router endpoint):

juju add-relation msyql-router:db-router mysql-innodb-cluster:db-router

Scale out is accomplished by adding units to the principle application:

juju add-unit keystone

Actions

This section lists Juju actions supported by the charm. Actions allow specific operations to be performed on a per-unit basis. To display action descriptions run juju actions mysql-router. If the charm is not deployed then see file actions.yaml.

  • stop-mysqlrouter
  • start-mysqlrouter
  • restart-mysqlrouter

Bugs

Please report bugs on Launchpad.

For general charm questions refer to the OpenStack Charm Guide.