3.4 MySQL Cluster Manager Configuration File

Note

The MySQL Cluster Manager 8.0 has a new format for its configuration file. Make sure that the new format is used if you are upgrading from an earlier series.

The mcmd configuration file allows you to configure mcmd with its application options. A sample configuration file is provided with the MySQL Cluster Manager distribution at mcmd8.0.27/doc/sample_mcmd.conf. Edit the [mcmd] section of the file and save it as mcmd.conf at a desired location, which you will provide to mcmd with the --config option when you start the agent. If the option is not used, mcmd looks for the configuration file at these default locations, in the following order of priority:

  • mcmd-installation-directory/mcmd.conf

  • mcmd-installation-directory/mcmd.ini

  • For Linux systems: OS-user's-home-directory/mcmd.conf

    For Windows systems: C:\Users\user\AppData\Roaming/mcmd.conf

  • For Linux systems: OS-user's-home-directory/mcmd.ini

    For Windows systems: C:\Users\user\AppData\Roaming/mcmd.ini

Notes
  • For Linux platforms: The configuration file must have proper file permissions: mcmd refuses to start if the configuration file has permissions more open than just read and write for just the owner and the group owner (that is, more open than 660 in numeric notation for permissions).

  • For Windows platforms: It is recommended that you save the configuration file to a convenient location for which the path does not contain any spaces, such as C:\mcm\data.

The format of the configuration file follows that of the MySQL Router configuration file; see Configuration File Syntax for an explanation of the file format.

The following is the sample configuration file; uncomment and adjust the values of the listed options, or add other options:

# Copyright (c) 2018, 2021, Oracle and/or its affiliates.
#
# MySQL Cluster Manager sample configuration
#

#[DEFAULT]
#logging_folder = /var/log
#data_folder = /var/lib/mcm_data
#pid_file = mcmd.pid

[logger]
#level = INFO
#filename = mcmd.log

# The MySQL Cluster Manager plugin
[mcmd]
#mcmd_user = mcmd
#mcmd_password = super
#bind_address = ::
#bind_port = 1862
#xcom_port = 18620
#copy_port = 0

For more information about the options that can be set in the agent configuration file, see Section 4.1, “mcmd, the MySQL Cluster Manager Agent”.