Juju Charm - Percona XtraDB 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.
Corey Bryant 6338660677 Add Python 3 Train unit tests 2 years ago
actions Bootstrap action after a cold boot 2 years ago
charmhelpers Sync charm-helpers to enable Ubuntu Disco 2 years ago
hooks Display bootstrap grstate after cold boot 2 years ago
keys Initial charm 8 years ago
lib Update tox.ini files from release-tools gold copy 5 years ago
ocf/percona mysql_monitor: Apply patch available in upstream PR #52 6 years ago
templates Add wsrep-slave-threads and gcs-fc-limit 2 years ago
tests Convert to python3 2 years ago
unit_tests Bootstrap action after a cold boot 2 years ago
.coveragerc Tweak coverage settings 6 years ago
.gitignore Redesign cluster buildup process 3 years ago
.gitreview OpenDev Migration Patch 2 years ago
.stestr.conf Replace ostestr with stestr in testing framework. 2 years ago
.zuul.yaml Add Python 3 Train unit tests 2 years ago
Makefile Tests dir no longer need copy of charmhelpers 3 years ago
README.md MySQL asynchronous replication 2 years ago
actions.yaml Bootstrap action after a cold boot 2 years ago
charm-helpers-hooks.yaml Update charm-helpers-hooks.yaml and sync ch 2 years ago
config.yaml wsrep_slave_threads: default to 48 on bionic 2 years ago
copyright [freyes,r=james-page] Ensure VIP is tied to a good mysqld instance. 6 years ago
hardening.yaml Add hardening support 5 years ago
metadata.yaml Convert to python3 2 years ago
requirements.txt Update requirements 3 years ago
revision Rationalize configuration for percona/galera, add generic helpers for parsing mysql configuration options, use mysqlhelper for creation of SST user 8 years ago
setup.cfg Add Python 3 Train unit tests 2 years ago
test-requirements.txt Replace ostestr with stestr in testing framework. 2 years ago
tox.ini Add Python 3 Train unit tests 2 years ago



Percona XtraDB Cluster is a high availability and high scalability solution for MySQL clustering. Percona XtraDB Cluster integrates Percona Server with the Galera library of MySQL high availability solutions in a single product package which enables you to create a cost-effective MySQL cluster.

This charm deploys Percona XtraDB Cluster onto Ubuntu.



To deploy this charm:

juju deploy percona-cluster

Passwords required for the correct operation of the deployment are automatically generated and stored by the lead unit (typically the first unit).

To expand the deployment:

juju add-unit -n 2 percona-cluster

See notes in the 'HA/Clustering' section on safely deploying a PXC cluster in a single action.

The root password for mysql can be retrieved using the following command:

juju run --unit percona-cluster/0 leader-get root-password

This is only usable from within one of the units within the deployment (access to root is restricted to localhost only).

Memory Configuration

Percona Cluster is extremely memory sensitive. Setting memory values too low will give poor performance. Setting them too high will create problems that are very difficult to diagnose. Please take time to evaluate these settings for each deployment environment rather than copying and pasting bundle configurations.

The Percona Cluster charm needs to be able to be deployed in small low memory development environments as well as high performance production environments. The charm configuration opinionated defaults favor the developer environment in order to ease initial testing. Production environments need to consider carefully the memory requirements for the hardware or cloud in use. Consult a MySQL memory calculator [2] to understand the implications of the values.

Between the 5.5 and 5.6 releases a significant default was changed. The performance schema [1] defaulted to on for 5.6 and later. This allocates all the memory that would be required to handle max-connections plus several other memory settings. With 5.5 memory was allocated during runtime as needed.

The charm now makes performance schema configurable and defaults to off (False). With the performance schema turned off memory is allocated when needed during run time. It is important to understand this can lead to run time memory exhaustion if the configuration values are set too high. Consult a MySQL memory calculator [2] to understand the implications of the values.

Particularly consider the max-connections setting, this value is a balance between connection exhaustion and memory exhaustion. Occasionally connection exhaustion occurs in large production HA clouds with max-connections less than 2000. The common practice became to set max-connections unrealistically high near 10k or 20k. In the move to 5.6 on Xenial this became a problem as Percona would fail to start up or behave erratically as memory exhaustion occurred on the host due to performance schema being turned on. Even with the default now turned off this value should be carefully considered against the production requirements and resources available.

[1] http://dev.mysql.com/doc/relnotes/mysql/5.6/en/news-5-6-6.html#mysqld-5-6-6-performance-schema [2] http://www.mysqlcalculator.com/


When more than one unit of the charm is deployed with the hacluster charm the percona charm will bring up an Active/Active cluster. The process of clustering the units together takes some time. Due to the nature of asynchronous hook execution it is possible client relationship hooks may be executed before the cluster is complete. In some cases, this can lead to client charm errors.

To guarantee client relation hooks will not be executed until clustering is completed use the min-cluster-size configuration setting:

juju deploy -n 3 percona-cluster
juju config percona-cluster min-cluster-size=3

When min-cluster-size is not set the charm will still cluster, however, there are no guarantees client relation hooks will not execute before it is complete.

Single unit deployments behave as expected.

There are two mutually exclusive high availability options: using virtual IP(s) or DNS. In both cases, a relationship to hacluster is required which provides the corosync back end HA functionality.

To use virtual IP(s) the clustered nodes must be on the same subnet such that the VIP is a valid IP on the subnet for one of the node's interfaces and each node has an interface in said subnet. The VIP becomes a highly-available API endpoint.

At a minimum, the config option 'vip' must be set in order to use virtual IP HA. If multiple networks are being used, a VIP should be provided for each network, separated by spaces. Optionally, vip_iface or vip_cidr may be specified.

To use DNS high availability there are several prerequisites. However, DNS HA does not require the clustered nodes to be on the same subnet. Currently the DNS HA feature is only available for MAAS 2.0 or greater environments. MAAS 2.0 requires Juju 2.0 or greater. The clustered nodes must have static or "reserved" IP addresses registered in MAAS. The DNS hostname(s) must be pre-registered in MAAS before use with DNS HA.

At a minimum, the config option 'dns-ha' must be set to true, the 'os-access-hostname' must be set, and the 'access' binding must be defined in order to use DNS HA.

The charm will throw an exception in the following circumstances: If neither 'vip' nor 'dns-ha' is set and the charm is related to hacluster If both 'vip' and 'dns-ha' are set, as they are mutually exclusive If 'dns-ha' is set and 'os-access-hostname' is not set If the 'access' binding is not set and 'dns-ha' is set, consumers of the db may not be allowed to connect

MySQL asynchronous replication

This charm supports MySQL asynchronous replication feature which can be used to replicate databases between multiple Percona XtraDB Clusters. In order to setup master-slave replication of "example1" and "example2" databases between "pxc1" and "pxc2" applications, first configure mandatory options:

juju config pxc1 databases-to-replicate="database1:table1,table2;database2"
juju config pxc2 databases-to-replicate="database1:table1,table2;database2"
juju config pxc1 cluster-id=1
juju config pxc2 cluster-id=2

and then relate them:

juju relate pxc1:master pxc2:slave

In order to setup master-master replication, add another relation:

juju relate pxc2:master pxc1:slave

In the same way circular replication can be setup between multiple clusters.

Network Space support

This charm supports the use of Juju Network Spaces, allowing the charm to be bound to network space configurations managed directly by Juju. This is only supported with Juju 2.0 and above.

You can ensure that database connections and cluster peer communication are bound to specific network spaces by binding the appropriate interfaces:

juju deploy percona-cluster --bind "shared-db=internal-space,cluster=internal-space"

alternatively these can also be provided as part of a juju native bundle configuration:

  charm: cs:xenial/percona-cluster
  num_units: 1
    shared-db: internal-space
    cluster: internal-space

The 'cluster' endpoint binding is used to determine which network space units within the percona-cluster deployment should use for communication with each other; the 'shared-db' endpoint binding is used to determine which network space should be used for access to MySQL databases services from other charms.

NOTE: Spaces must be configured in the underlying provider prior to attempting to use them.

NOTE: Existing deployments using the access-network configuration option will continue to function; this option is preferred over any network space binding provided for the 'shared-db' relation if set.


Note that Percona XtraDB Cluster is not a 'scale-out' MySQL solution; reads and writes are channelled through a single service unit and synchronously replicated to other nodes in the cluster; reads/writes are as slow as the slowest node you have in your deployment.

Series Upgrade


  1. Take a backup of all the databases
juju run-action mysql/N backup
  • Get that backup off the mysql/N unit and somehwere safe.
juju scp -- -r mysql/N:/opt/backups/mysql /path/to/local/backup/dir
  1. Pause all non-leader units and corresponding hacluster units. The leader node will remain up for the time being. This is to ensure the leader has the latest sequence number and will be considered the most up to date by the cluster.
juju run-action hacluster/N pause
juju run-action percona-cluster/N pause
  1. Prepare the leader node
juju upgrade-series prepare $MACHINE_NUMBER $SERIES
  1. Administratively perform the upgrade.
  • do-release-upgrade plus any further steps administratively required steps for an upgrade.
  1. Reboot

  2. Complete the series upgrade on the leader:

juju upgrade-series complete $MACHINE_NUMBER
  1. Administratively validate the leader node database is up and running
  • Connect to the database and check for expected data
  1. Upgrade the non-leader nodes one at a time following the same pattern summarized bellow:
  • juju upgrade-series prepare $MACHINE_NUMBER $SERIES
  • Administratively Upgrade
  • Reboot
  • juju upgrade-series complete $MACHINE_NUMBER
  • Validate
  1. Finalize the upgrade Run action on leader node. This action informs each node of the cluster the upgrade process is complete cluster wide. This also updates mysql configuration with all peers in the cluster.
juju run-action mysql/N complete-cluster-series-upgrade
  1. Set future instance to the new series and set the source origin
juju set-series percona-cluster xenial
juju config mysql source=distro