Juju Charm - Mysql InnoDB Cluster
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Aurelien Lourot 311ae13fd5 Documentation improvements 2 weeks ago
actions Stop using AUTOMATIC node whitelist 4 months ago
files Upstream charm 2 years ago
lib clustering: tweak allowlist generation 3 months ago
reactive Stop using AUTOMATIC node whitelist 4 months ago
templates Enable MySQL TLS 1 year ago
tests Test bundles for focal-wallaby and hirsute-wallaby 5 months ago
HACKING.md Documentation corrections 2 years ago
README.md Documentation improvements 2 weeks ago
actions.yaml Stop using AUTOMATIC node whitelist 4 months ago
config.yaml Increase default expel-timeout 1 year ago
icon.svg MySQL InnoDB Cluster Charm 2 years ago
layer.yaml Coordinated delayed action 6 months ago
metadata.yaml Add impish to metadata.yaml 3 months ago
test-requirements.txt Sync release-tools 2 months ago
tox.ini Sync release-tools 10 months ago
wheelhouse.txt Pin Tenacity 2 months ago



The mysql-innodb-cluster charm deploys a MySQL 8 InnoDB clustered database (i.e. MySQL InnoDB Cluster). It is used in conjunction with the mysql-router subordinate charm.

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.



See file config.yaml of the built charm (or see the charm in the Charm Store) for the full list of configuration options, along with their descriptions and default values. See the Juju documentation for details on configuring applications.


MySQL 8 is natively HA and requires at least three database units, which are often containerised. To deploy a three-node cluster to new containers on machines '0', '1', and '2':

juju deploy -n 3 --to lxd:0,lxd:1,lxd:2 mysql-innodb-cluster

A cloud application is joined to the database via an instance of mysql-router. For a pre-existing keystone application:

juju deploy mysql-router keystone-mysql-router
juju add-relation keystone-mysql-router:db-router mysql-innodb-cluster:db-router
juju add-relation keystone-mysql-router:shared-db keystone:shared-db

See Infrastructure high availability in the OpenStack Charms Deployment Guide for more deploy information.

Root password

Passwords are automatically generated and stored by the application leader.

The root password required to use the mysql or mysqlsh utilities locally on the units can be retrieved using the following command:

juju run --unit mysql-innodb-cluster/leader leader-get mysql.passwd


TLS communication between MySQL InnoDB Cluster and its cloud clients is supported out of the box via a self-signed CA certificate bundled within MySQL itself.

A better option is to use a certificate signed by a Vault-based CA. This can be done once Vault has been initialised and has a root CA:

juju add-relation mysql-innodb-cluster:certificates vault:certificates

See the vault charm README for more information.

Adding a unit on a new subnet

When adding a unit to an already formed cluster, and where that unit resides on a subnet different from any existing unit, the following extra actions are needed:

juju run-action --wait mysql-innodb-cluster/leader update-unit-acls
juju run-action --wait mysql-innodb-cluster/leader add-instance address=<address of new unit>


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 --schema mysql-innodb-cluster. If the charm is not deployed then see file actions.yaml.

  • add-instance
  • cluster-rescan
  • cluster-status
  • mysqldump
  • reboot-cluster-from-complete-outage
  • rejoin-instance
  • remove-instance
  • restore-mysqldump
  • set-cluster-option
  • update-unit-acls


The OpenStack Charms project maintains two documentation guides:


Please report bugs on Launchpad.