2.4. MySQL Cluster Manager Configuration File

Before starting the MySQL Cluster Manager agent, you should make any necessary changes to the [mcmd] section of the agent configuration file, supplied with MySQL Cluster Manager as etc/mcmd.ini in the installation directory. On Linux and similar operating systems, you can edit this file in place; on Windows, it is recommended that you save a copy of this file to a convenient location for which the path does not contain any spaces, such as C:\mcm\data.

Note

Prior to MySQL Cluster Manager 1.1.1, this section of the configuration file used the heading [mysql-proxy]. The old name is still supported for backward compatibility, but is now deprecated and is thus subject to removal in a future release of MySQL Cluster Manager. For this reason, you should change any [mysql-proxy] section headings in existing configuration files to [mcmd], when upgrading to MySQL Cluster Manager 1.1.6.

A # character in the MySQL Cluster Manager configuration file indicates the beginning of a comment; the comment continues to the end of the line.

The version of this file that is supplied with MySQL Cluster Manager reads similarly to what is shown here:

[mcmd]

plugins=manager

## manager-port = 1862

## agent-uuid = @@MYSQL_UUID@@

log-file = mcmd.log
log-level = message

## pid-file=@@INSTALLDIR@@@@PLATFORM_PATH_SEPARATOR@@mcmd.pid

## Username and password for manager plugin
## manager-username=
## manager-password=

## Top-level directory for manager plugins information stored on disk
## manager-directory=@@INSTALLDIR@@@@PLATFORM_PATH_SEPARATOR@@mcm_data

The meanings of these settings, along with their types and allowed values, are described in the following table:

SettingType/FormatDefault/Permitted ValuesDescription
pluginsA comma-delimited list of plugin namesTo enable MySQL Cluster Manager, this list must include manager.To enable MySQL Cluster Manager, this must include manager (the default value). For other possibilities, see MySQL Proxy; however, you should be aware that we currently do not test MySQL Cluster Manager with any values for plugins other than manager.
manager-portportDefault: 1862; Range: A legal TC/IP port number.This is used to specify the port used by MySQL Cluster Manager client connections. Normally there is no need to change it from the default value (port 1862), so there is no need to uncomment this line. (Note: Previously this setting could optionally take a host name in addition to the port number, but in MySQL Cluster Manager 1.1.1 and later the host name is no longer accepted.)
agent-uuidA legal UUID valueSet internallyThis value needs to be set explicitly only when configuring multiple agents on the same host; normally, there is no need to uncomment this line.
log-fileA valid path (optional on Linux) and filenameDefault: mcmd.logYou can change this if desired, but there is no need to do so. On Linux and similar operating systems, you can use a relative path; this is in relation to the MySQL Cluster Manager installation directory, and not to the bin or etc subdirectory. On Windows, you must use an absolute path, and it cannot contain any spaces; in addition, and you must replace any backslash (\) characters in the path with forward slashes (/).
log-levelThe log event levelOne of: debug, critical, error, info, message, warning. Default: message.This is the log event severity level; see MySQL Cluster Logging Management Commands, for definitions of the levels, which are the same as these except that ALERT is mapped to critical and the Unix syslog LOG_NOTICE level is used, and mapped to message. The debug, message, and info levels can result in rapid growth of the agent log, so for normal operations, you may prefer to set this to warning or error.
pid-fileA valid path to a process ID (.pid) fileNot normally usedBy uncommenting this line, you can cause a process ID file to be created as mcmd.pid in the MySQL Cluster Manager installation directory, but this is not usually necessary. Not supported on Windows.
manager-usernameThe name of the MySQL Cluster Manager user (optional).Default: adminThe user name used for the MySQL Cluster Manager user account.
manager-passwordThe password for the MySQL Cluster Manager user account (optional).Default: superThe password used for the MySQL Cluster Manager user account.
manager-directoryA valid absolute path. On Linux, if the directory does not exist, it is created; on Windows, the directory must be created if it does not exist. Also on Windows, the path may not contain any spaces, and you must replace any backslash (\) characters with forward slashes (/).Default: mcm_data, in the MySQL Cluster Manager installation directoryThe manager-directory contains collections of MySQL Cluster Manager data files and MySQL Cluster configuration and data files; such a collection is also referred to as an agent repository. More information about repositories and these files is provided later in this section.

Using the manager-username = user_name and manager-password = pass_word options causes the creation of a MySQL user account, having the username user_name and the password pass_word. This account is created with all privileges on the MySQL server including the granting of privileges. (In other words, it is created using GRANT ALL PRIVILEGES ON *.* ... WITH GRANT OPTION.)

Note

The existing MySQL root account is not altered, and the test database is preserved.

License files.  License keys were required for early MySQL Cluster Manager releases. They are not needed in order to use MySQL Cluster Manager version 1.1.6.

MySQL Cluster Manager agent repositories (manager-directory).  The manager-directory contains MySQL Cluster Manager data files as well as a rep directory in MySQL Cluster data files for each MySQL Cluster under MySQL Cluster Manager control are kept. Normally, there is no need to interact with these directories beyond specifying the location of the manager-directory in the agent configuration file (mcmd.ini). However, in the event that an agent reaches an inconsistent state, it is possible to delete the contents of the rep directory, in which case the agent attempts to recover its repository from another agent.

Important

In such cases, you must also delete the checksum file repchksum from the manager-directory. Otherwise, the agent reads this file and raises a checksum error due to the now-empty rep directory.

A minimal agent configuration file as used in production might look like this:

[mcmd]

plugins=manager

manager-port=1862

log-file=mcmd.log

log-level=message

log-file and log-level can also be set using the mcmd startup options --log-file and --log-level, respectively.