Mysql Innodb Cluster

juju deploy mysql-innodb-cluster

20.10 20.04 LTS 19.10

Discuss this charm

Share your thoughts on this charm with the community on discourse.

Join the discussion


The mysql-innodb-cluster charm deploys a MySQL 8 InnoDB clustered database. It is used in conjunction with the mysql-router 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.


The charm is intended for deploying a cluster (minimum of three nodes) and therefore does not deploy on a single unit.


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


To deploy a three-node cluster:

juju deploy -n 3 mysql-innodb-cluster

The name of the cluster can be customized at deploy time:

juju deploy -n 3 mysql-innodb-cluster --config cluster-name myCluster

Add a relation to a MySQL 8 Router (via the db-router endpoint):

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

A relation can be made to charms that use the shared-db endpoint, however this should be considered deprecated:

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

Nodes can be added to the cluster as Read Only nodes:

juju add-unit mysql-innodb-cluster

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


TLS communication between MySQL InnoDB Cluster and its cloud clients is supported.

Due to the circular dependency between the vault and mysql-innodb-cluster applications, the enablement of this feature can only be done post-deployment (once vault has been initialised and has a root Certificate Authority).

Enable database TLS communication with this relation:

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


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-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


Please report bugs on Launchpad.

For general charm questions refer to the OpenStack Charm Guide.