MySQL Blog Archive
For the latest blogs go to
MySQL InnoDB Cluster - A Hands on Tutorial

Traditionally, setting up high availability (HA) in MySQL has been a challenging task, especially for people without advanced knowledge of MySQL. From understanding concepts and technologies, to the tooling, specific commands and files to execute and edit, there’s a lot of things you need to know even when planning a test deployment (the Quick Start Guide for Group Replication should give you an idea). So many people end up procrastinating setting up HA until disaster strikes and downtime happens.

The MySQL team at Oracle has now released a preview of a solution that aims to make it easy to combine multiple instances of MySQL together in order to provide redundancy for High Availability of the MySQL databases used by your applications.

In this tutorial, we will use the new MySQL Shell to create 3 sandbox instances, create a 3 member Group Replication cluster with them and setup MySQL Router as a proxy to hide the multiple MySQL instances behind a single TCP port. Group Replication provides synchronous replication for InnoDB and built-in automatic failover, while the Router lets applications connect to an appropriate member of the cluster with no changes to their code, other than an update to the MySQL connection parameters.

InnoDB cluster topology

Downloading and Installing Required Packages

In addition to MySQL 5.7.17, you will need to download the MySQL InnoDB cluster package for your system from, which will contain:

  • MySQL Router 2.1.1 labs
  • MySQL Shell 1.0.6 labs with X AdminAPI

The tar archive must be extracted and you can then install the individual packages for each component, through usual platform specific methods.

Deploying Sandbox Instances

The first step is to deploy sandbox MySQL Server instances, so that we can play around and experiment safely, without affecting any existing MySQL databases.

Start MySQL Shell (as your ordinary, non-root OS user):

And then execute:

The argument to deploySandboxInstance() is the TCP port number where MySQL Server should listen for connections. By default, the sandbox is created in a directory named $HOME/mysql-sandboxes/<port> (or C:\Users\<user>\mysql-sandboxes\<port> in Windows).

You will be prompted to pick a MySQL root account password for that instance, this is the password that you will use to connect to that instance in the future.

Note: use the same password for all your sandboxes in the same cluster.

Repeat the above command two more times, using different port numbers each time. This will allow us to create an InnoDB cluster that is tolerant to up to one failure.

Initializing the InnoDB Cluster

Next, we connect the shell to one of the instances we just created, which will be the seed instance. The seed instance is the one that would hold the initial state of the database, which will be replicated to the other instances as they’re added to the cluster. In this case, we’re working with empty sandbox instances, so any of them will do.

Next, create the InnoDB cluster:

The createCluster() command takes one parameter, which is a symbolic name you give to this InnoDB cluster. This will, among other things:

  • Deploy the metadata schema in that instance (mysql.mysql_innodb_cluster_metadata)
  • Verify that its configuration is correct for Group Replication, requiring changes if necessary
  • Register it as the seed instance of the new cluster
  • Create necessary internal accounts, such as the replication user account
  • Start Group Replication

Sandbox instances are pre-configured to work with replication, but if you use a pre-existing instance, it’s possible that some configuration options require changes. createCluster() (and addInstance()) ensures that the settings are correct.

If your server is not already configured for group replication, it may require non-trivial configuration changes, such as enabling the binary log (binlog), ensuring that the binlog format is the correct one and so on. To minimize disruption to a live server, two commands are available to check whether the configuration of a server  is correct and also to reconfigure it: checkLocalInstance() and configLocalInstance(). Additionally, if a configuration change requires the MySQL Server to be restarted, you must do it manually whenever is convenient.

Add Instances to InnoDB Cluster

Now, you need to add replicas to the InnoDB cluster. We use the blank sandbox instances that we created earlier. Often, when a new instance is added to a replica set in a cluster, they will be behind the rest of the ONLINE members and need to catch up to the current state of the seed instance. If the amount of pre-existing data in the seed instance is very large, you may want to clone it or copy that data through a fast method beforehand. The MySQL Shell will soon also provide a mechanism to perform that step with minimal effort. Otherwise, Group Replication will perform a sync automatically (this step is called recovery), re-executing all transactions from the seed, as long as they’re in the MySQL binary log. Since the seed instance in this example has little to no data (ie. just the metadata schema and internal accounts) and have binary logging enabled from the beginning, there’s very little that new replicas need to catch up with. Any transactions that were executed in the seed instance will be re-executed in each added replica.

Add two blank instances to the InnoDB cluster:

And now, we check the current status of the cluster:

This command queries the current status of the InnoDB cluster and produces a short report. The status field for each instance should show either ONLINE or RECOVERING. RECOVERING means that the instance is receiving updates from the seed instance and should eventually switch to ONLINE.

A separate post on how to navigate the InnoDB Cluster is available, explaining how to interpret the different states and how you can affect them.

Another point to note is that one of the instances (the PRIMARY) is marked R/W (read/writable), while the other two are marked R/O (read only). Only the instance marked R/W can execute transactions that update the database. If that instance becomes unreachable for any reason (like a system crash), one of the remaining two instances automatically takes over its place and becomes the new PRIMARY.

Deploy MySQL Router

In order for applications to handle failover, they need to be aware of the topology of the InnoDB cluster. They also need to know, at any time, which of the instances is the PRIMARY. While it’s possible for applications to implement that logic by themselves, MySQL Router can do that for you, with minimal work and no code changes in  applications.

The recommended deployment of MySQL Router is on the same host as the application. In our tutorial, we’re running everything on the same host, so we’ll do that for MySQL Router too. During bootstrap, MySQL Router needs to connect to the cluster and have privileges to query the performance_schema, mysql_innodb_cluster_metadata and create a restricted, read-only account to be used by itself during normal operation.

Assuming MySQL Router is already installed, all we need to do is to bootstrap it with the metadata server, calling mysqlrouter with the following command line option from the system’s shell:

MySQL Router connects to the InnoDB cluster, fetches its metadata and configures itself for use. It will configure itself to run from a self-contained directory, which allows you to deploy multiple instances of the router in the same host without root privileges. The generated configuration creates 4 TCP ports: one for read-write sessions (which redirect connections to the PRIMARY) and one for read-only sessions (which redirect connections to one of the SECONDARY instances, in a round-robin fashion); one set for classic MySQL connections and another for the X protocol.

If your application opens a very high number of database sessions overloading the PRIMARY instance and additionally does not need to perform updates, you can limit them to use read-only sessions and offload the PRIMARY.

Once bootstrapped and configured, start MySQL Router (or setup a service for it to start automatically when the system boots):

You can now connect a MySQL client to one of the incoming MySQL Router ports and see how the client gets transparently connected to one of the InnoDB cluster instances. To see which instance we are actually connected to, we simply query the ‘port’ status variable.

Here we connected to the read-write port (6446), so the Router connected us to the PRIMARY server, which is listening on port 3310. Now, try connecting to the read-only port (6447) and see what you get.

The \sql shell command switches the MySQL Shell from the default JavaScript mode to SQL mode, where you can directly execute SQL statements.

Checking Status of the InnoDB Cluster

To check the status of the InnoDB cluster at a later time, you can get a reference to the InnoDB cluster object by connecting to the cluster through the Router or directly to one of the instances. If you want to make changes to the cluster, you would need to connect to the read-write port of the Router.

Putting the InnoDB Cluster to the Test

Next we want to challenge the InnoDB cluster and test if the failover really works. We are going to kill the PRIMARY instance and see if one of the other instances takes over automatically. For this purpose we use the dba.killLocalInstance() function (in \js mode).

After that we again check (from our test session to the MySQL Router) which instance we are now connected to. The first SELECT fails since the connection to the original PRIMARY was lost. MySQL Shell automatically reconnects for us and we simply execute the command again.

This shows that the InnoDB cluster provided us with automatic failover, that MySQL Router has automatically reconnected us to the new PRIMARY instance, and that we have high availability.

With this, you should be able to get started with MySQL InnoDB clusters and play with High Availability with minimal effort.

If you find issue with the preview or have feature requests, please file a bug report at If you’re not sure about what category to file under, use MySQL Server: Document Store: X Shell