DM-master Configuration File

This document introduces the configuration of DM-master, including a configuration file template and a description of each configuration parameter in this file.

Configuration file template

The following is a configuration file template of DM-master.

  1. name = "dm-master"
  3. # log configuration
  4. log-level = "info"
  5. log-file = "dm-master.log"
  7. # DM-master listening address
  8. master-addr = ":8261"
  9. advertise-addr = "127.0.0.1:8261"
  11. # URLs for peer traffic
  12. peer-urls = "http://127.0.0.1:8291"
  13. advertise-peer-urls = "http://127.0.0.1:8291"
  15. # cluster configuration
  16. initial-cluster = "master1=http://127.0.0.1:8291,master2=http://127.0.0.1:8292,master3=http://127.0.0.1:8293"
  17. join = ""
  19. ssl-ca = "/path/to/ca.pem"
  20. ssl-cert = "/path/to/cert.pem"
  21. ssl-key = "/path/to/key.pem"
  22. cert-allowed-cn = ["dm"]
  24. secret-key-path = "/path/to/secret/key"

Configuration parameters

This section introduces the configuration parameters of DM-master.

Global configuration

ParameterDescription
nameThe name of the DM-master.
log-levelSpecifies a log level from debug, info, warn, error, and fatal. The default log level is info.
log-fileSpecifies the log file directory. If the parameter is not specified, the logs are printed onto the standard output.
master-addrSpecifies the address of DM-master which provides services. You can omit the IP address and specify the port number only, such as “:8261”.
advertise-addrSpecifies the address that DM-master advertises to the outside world.
peer-urlsSpecifies the peer URL of the DM-master node.
advertise-peer-urlsSpecifies the peer URL that DM-master advertises to the outside world. The value of advertise-peer-urls is by default the same as that of peer-urls.
initial-clusterThe value of initial-cluster is the combination of the advertise-peer-urls value of all DM-master nodes in the initial cluster.
joinThe value of join is the combination of the advertise-peer-urls value of the existed DM-master nodes in the cluster. If the DM-master node is newly added, replace initial-cluster with join.
ssl-caThe path of the file that contains list of trusted SSL CAs for DM-master to connect with other components.
ssl-certThe path of the file that contains X509 certificate in PEM format for DM-master to connect with other components.
ssl-keyThe path of the file that contains X509 key in PEM format for DM-master to connect with other components.
cert-allowed-cnCommon Name list.
secret-key-pathThe file path of the secret key, which is used to encrypt and decrypt upstream and downstream passwords. The file must contain a 64-character hexadecimal AES-256 secret key.