Charmed MySQL

  • By Canonical Data Platform
  • Cloud
Channel Revision Published Runs on
8.0/stable 196 29 Sep 2023
Ubuntu 22.04
8.0/candidate 196 27 Sep 2023
Ubuntu 22.04
8.0/beta 196 25 Sep 2023
Ubuntu 22.04
8.0/edge 196 08 Sep 2023
Ubuntu 22.04
juju deploy mysql --channel 8.0/stable
Show information



How to deploy and manage units

:information_source: Hint: Use Juju 3. Otherwise replace juju run ... with juju run-action --wait ... for Juju 2.9.

Basic Usage

To deploy a single unit of MySQL using its default configuration

juju deploy mysql

It is customary to use MySQL with replication. Hence usually more than one unit (preferably an odd number to prohibit a “split-brain” scenario) is deployed. To deploy MySQL with multiple replicas, specify the number of desired units with the -n option.

juju deploy mysql -n <number_of_cluster_members>

To retrieve primary replica one can use the action get-primary on any of the units running MySQL:

juju run mysql/leader get-primary

Similarly, the primary replica is displayed as a status message in juju status, however one should note that this hook gets called on regular time intervals and the primary may be outdated if the status hook has not been called recently.

Further we highly suggest configuring the status hook to run frequently. In addition to reporting the primary, secondaries, and other statuses, the status hook performs self healing in the case of a network cut. To change the frequency of the update status hook do:

juju model-config update-status-hook-interval=<time(s/m/h)>

Note that this hook executes a read query to MySQL. On a production level server this should be configured to occur at a frequency that doesn’t overload the server with read requests. Similarly the hook should not be configured at too quick of a frequency as this can delay other hooks from running. You can read more about status hooks here.


To scaling-up the cluster, use juju add-unit:

juju add-unit mysql --num-units <amount_of_units_to_add>

To scaling-down the cluster, use juju remove-unit:

juju remove-unit mysql/<unit_id_to_remove>

:warning: Warning: be careful with removing all units! It can destroy your data (Juju storage provider dependent)!

Help us improve this documentation

Most of this documentation can be collaboratively discussed and changed on the respective topic in the doc category of the Charmhub forum. See the documentation guidelines if you’d like to contribute.

Last updated 26 days ago. Help improve this document in the forum.