2.5 Upgrading MySQL Cluster Manager

This section discusses upgrading MySQL Cluster Manager from a previous release to the latest 1.3 release (currently 1.3.0), as well as providing basic guidance on upgrading the bundled MySQL Cluster software.

The basic steps for upgrading a MySQL Cluster Manager installation are listed here:

  1. Install the new version of the MySQL Cluster Manager software in the desired location.

  2. Create a configuration for the new installation such that it uses the previous installation's data.

  3. Stop all running MySQL Cluster Manager agent processes on all hosts.

  4. Start the new agent processes, ensuring that they use the new configuration created previously.

A more detailed explanation is provided of each of these steps in the next few paragraphs. For purposes of example, we assume an upgrade from an existing installation of MySQL Cluster Manager 1.2.5 to a new installation of MySQL Cluster Manager 1.3.0. For a Linux or other Unix-like system, we assume that these are installed in /opt/mcm-1.2.5 and /opt/mcm-1.3.0, respectively; on Windows, we assume the default directories C:\Program Files\MySQL\MySQL Cluster Manager 1.2.5\ and C:\Program Files\MySQL\MySQL Cluster Manager 1.3.0\.

Step 1: Install new MySQL Cluster Manager version.  You can obtain and install a new version of MySQL Cluster Manager in the same way as for a new installation (see Section 2.1, “Obtaining MySQL Cluster Manager”, and Section 2.3, “MySQL Cluster Manager Installation”), with the additional requirement that you should not attempt to install the new version in the same location as the version which you are currently using.

Step 2: Configure new installation.  In order for the new MySQL Cluster Manager agent binaries to manage the same MySQL Cluster instances, they must be able to find the data contained in the agent repository used by the old installation's binaries. This is /opt/mcm_data by default, but can be set using the manager-directory directive in mcmd.ini.

It is simplest for MySQL Cluster Manager software upgrades if the agent repository and the agent configuration file are located externally to the agent installation directory. Suppose the old version of the agent is installed to /opt/mcm-1.2.5, and that it uses the directory /var/opt/mcm for its agent repository and /etc/mcm/mcmd.ini for its configuration file. In this case, to make the new binaries use the same configuration and repository, it is necessary only to start the new mcmd processes such that they use the same configuration file (see Step 4). Otherwise, you should copy the default configuration file to a location outside the installation driectory, such as /etc/mcm/mcmd.ini, as shown here:

shell> cp -r /opt/mcm-1.2.5/etc/mcmd.ini /etc/mcm/mcmd.ini

Then, add the following line to the new copy of the mcmd.ini file:

manager-directory=/var/opt/mcm

After this, you can save and close the file. See also Section 2.4, “MySQL Cluster Manager Configuration File”.

Step 3: Stop all agents.  Stop the agent processes using the old binaries on all hosts making up the management installation. You can stop all agents for a given site, for example mysite, using the stop agents command in the MySQL Cluster Manager client, as shown here:

mcm> stop agents mysite;

You should execute a stop agents command, similar to the one just shown, for each site listed in the output of list sites.

Step 4: Start new MySQL Cluster Manager binaries.  Start the new mcmd agent binaries with the --defaults-file option so that it uses the correct configuration file, like this:

shell> mcmd --defaults-file=/etc/mcm/mcmd.ini &

You should now be able to start the mcm client from the new installation and perform management tasks as usual. Once the client successfully starts and connects to the agent, you can verify that it is running the correct version of the MySQL Cluster Manager software using the version command, as shown here:

mcm> version;
+-----------------------------+
| Version                     |
+-----------------------------+
| MySQL Cluster Manager 1.3.0 |
+-----------------------------+
1 row in set (0.00 sec)

See Chapter 3, Using MySQL Cluster Manager, for more information about performing common cluster management tasks with the mcm client.

Upgrading MySQL Cluster.  Although the MySQL Cluster software typically comes bundled with the MySQL Cluster Manager distribution, it is important to keep in mind that upgrading the MySQL Cluster Manager software does not upgrade any existing MySQL Cluster installations. Since the new MySQL Cluster Manager installation uses the same configuration as the old one, the clusters under its control remain unchanged. If you wish to upgrade a cluster using the bundled MySQL Cluster software, you should move the cluster directory (see Contents of the MySQL Cluster Manager Unix Distribution Archive) and all of its contents to a location outside the MySQL Cluster Manager installation directory. After this, you can use add package and upgrade cluster to upgrade one or more clusters to the new version of the MySQL Cluster software.