corosync.conf.5 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917
  1. .\"/*
  2. .\" * Copyright (c) 2005 MontaVista Software, Inc.
  3. .\" * Copyright (c) 2006-2018 Red Hat, Inc.
  4. .\" *
  5. .\" * All rights reserved.
  6. .\" *
  7. .\" * Author: Steven Dake (sdake@redhat.com)
  8. .\" *
  9. .\" * This software licensed under BSD license, the text of which follows:
  10. .\" *
  11. .\" * Redistribution and use in source and binary forms, with or without
  12. .\" * modification, are permitted provided that the following conditions are met:
  13. .\" *
  14. .\" * - Redistributions of source code must retain the above copyright notice,
  15. .\" * this list of conditions and the following disclaimer.
  16. .\" * - Redistributions in binary form must reproduce the above copyright notice,
  17. .\" * this list of conditions and the following disclaimer in the documentation
  18. .\" * and/or other materials provided with the distribution.
  19. .\" * - Neither the name of the MontaVista Software, Inc. nor the names of its
  20. .\" * contributors may be used to endorse or promote products derived from this
  21. .\" * software without specific prior written permission.
  22. .\" *
  23. .\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  24. .\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25. .\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26. .\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  27. .\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28. .\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29. .\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  30. .\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  31. .\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  32. .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  33. .\" * THE POSSIBILITY OF SUCH DAMAGE.
  34. .\" */
  35. .TH COROSYNC_CONF 5 2019-01-16 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
  36. .SH NAME
  37. corosync.conf - corosync executive configuration file
  38. .SH SYNOPSIS
  39. /etc/corosync/corosync.conf
  40. .SH DESCRIPTION
  41. The corosync.conf instructs the corosync executive about various parameters
  42. needed to control the corosync executive. Empty lines and lines starting with
  43. # character are ignored. The configuration file consists of bracketed top level
  44. directives. The possible directive choices are:
  45. .TP
  46. totem { }
  47. This top level directive contains configuration options for the totem protocol.
  48. .TP
  49. logging { }
  50. This top level directive contains configuration options for logging.
  51. .TP
  52. quorum { }
  53. This top level directive contains configuration options for quorum.
  54. .TP
  55. nodelist { }
  56. This top level directive contains configuration options for nodes in cluster.
  57. .TP
  58. system { }
  59. This top level directive contains configuration options related to system.
  60. .TP
  61. resources { }
  62. This top level directive contains configuration options for resources.
  63. .PP
  64. The
  65. .B interface sub-directive of totem is optional for UDP and knet transports.
  66. For knet, multiple interface subsections define parameters for each knet link on the
  67. system.
  68. For UDPU an interface section is not needed and it is recommended that the nodelist
  69. is used to define cluster nodes.
  70. .TP
  71. linknumber
  72. This specifies the link number for the interface. When using the knet
  73. protocol, each interface should specify separate link numbers to uniquely
  74. identify to the membership protocol which interface to use for which link.
  75. The linknumber must start at 0. For UDP the only supported linknumber is 0.
  76. .TP
  77. knet_link_priority
  78. This specifies the priority for the link when knet is used in 'passive'
  79. mode. (see link_mode below)
  80. .TP
  81. knet_ping_interval
  82. This specifies the interval between knet link pings.
  83. knet_ping_interval and knet_ping_timeout
  84. are a pair, if one is specified the other should be too, otherwise one will be calculated from
  85. the token timeout and one will be taken from the config file.
  86. (default is token timeout / (knet_pong_count*2))
  87. .TP
  88. knet_ping_timeout
  89. If no ping is received within this time, the knet link is declared dead.
  90. knet_ping_interval and knet_ping_timeout
  91. are a pair, if one is specified the other should be too, otherwise one will be calculated from
  92. the token timeout and one will be taken from the config file.
  93. (default is token timeout / knet_pong_count)
  94. .TP
  95. knet_ping_precision
  96. How many values of latency are used to calculate
  97. the average link latency. (default 2048 samples)
  98. .TP
  99. knet_pong_count
  100. How many valid ping/pongs before a link is marked UP. (default 5)
  101. .TP
  102. knet_transport
  103. Which IP transport knet should use. valid values are "sctp" or "udp". (default: udp)
  104. .TP
  105. bindnetaddr (udp only)
  106. This specifies the network address the corosync executive should bind
  107. to when using udp.
  108. bindnetaddr (udp only)
  109. should be an IP address configured on the system, or a network
  110. address.
  111. For example, if the local interface is 192.168.5.92 with netmask
  112. 255.255.255.0, you should set bindnetaddr to 192.168.5.92 or 192.168.5.0.
  113. If the local interface is 192.168.5.92 with netmask 255.255.255.192,
  114. set bindnetaddr to 192.168.5.92 or 192.168.5.64, and so forth.
  115. This may also be an IPV6 address, in which case IPV6 networking will be used.
  116. In this case, the exact address must be specified and there is no automatic
  117. selection of the network interface within a specific subnet as with IPv4.
  118. If IPv6 networking is used, the nodeid field in nodelist must be specified.
  119. .TP
  120. broadcast (udp only)
  121. This is optional and can be set to yes. If it is set to yes, the broadcast
  122. address will be used for communication. If this option is set, mcastaddr
  123. should not be set.
  124. .TP
  125. mcastaddr (udp only)
  126. This is the multicast address used by corosync executive. The default
  127. should work for most networks, but the network administrator should be queried
  128. about a multicast address to use. Avoid 224.x.x.x because this is a "config"
  129. multicast address.
  130. This may also be an IPV6 multicast address, in which case IPV6 networking
  131. will be used. If IPv6 networking is used, the nodeid field in nodelist must
  132. be specified.
  133. It's not necessary to use this option if cluster_name option is used. If both options
  134. are used, mcastaddr has higher priority.
  135. .TP
  136. mcastport (udp only)
  137. This specifies the UDP port number. It is possible to use the same multicast
  138. address on a network with the corosync services configured for different
  139. UDP ports.
  140. Please note corosync uses two UDP ports mcastport (for mcast receives) and
  141. mcastport - 1 (for mcast sends).
  142. If you have multiple clusters on the same network using the same mcastaddr
  143. please configure the mcastports with a gap.
  144. .TP
  145. ttl (udp only)
  146. This specifies the Time To Live (TTL). If you run your cluster on a routed
  147. network then the default of "1" will be too small. This option provides
  148. a way to increase this up to 255. The valid range is 0..255.
  149. .PP
  150. .PP
  151. Within the
  152. .B totem
  153. directive, there are seven configuration options of which one is required,
  154. five are optional, and one is required when IPV6 is configured in the interface
  155. subdirective. The required directive controls the version of the totem
  156. configuration. The optional option unless using IPV6 directive controls
  157. identification of the processor. The optional options control secrecy and
  158. authentication, the network mode of operation and maximum network MTU
  159. field.
  160. .TP
  161. version
  162. This specifies the version of the configuration file. Currently the only
  163. valid version for this directive is 2.
  164. .PP
  165. clear_node_high_bit
  166. This configuration option is optional and is only relevant when no nodeid is
  167. specified. Some corosync clients require a signed 32 bit nodeid that is greater
  168. than zero however by default corosync uses all 32 bits of the IPv4 address space
  169. when generating a nodeid. Set this option to yes to force the high bit to be
  170. zero and therefore ensure the nodeid is a positive signed 32 bit integer.
  171. WARNING: Cluster behavior is undefined if this option is enabled on only
  172. a subset of the cluster (for example during a rolling upgrade).
  173. .TP
  174. crypto_model
  175. This specifies which cryptographic library should be used by knet. Options
  176. are nss and openssl.
  177. The default is nss.
  178. .TP
  179. crypto_hash
  180. This specifies which HMAC authentication should be used to authenticate all
  181. messages. Valid values are none (no authentication), md5, sha1, sha256,
  182. sha384 and sha512. Encrypted transmission is only supported for
  183. the knet transport.
  184. The default is none.
  185. .TP
  186. crypto_cipher
  187. This specifies which cipher should be used to encrypt all messages.
  188. Valid values are none (no encryption), aes256, aes192, aes128 and 3des.
  189. Enabling crypto_cipher, requires also enabling of crypto_hash. Encrypted
  190. transmission is only supported for the knet transport.
  191. The default is none.
  192. .TP
  193. keyfile
  194. This specifies the fully qualified path to the shared key used to
  195. authenticate and encrypt data used within the Totem protocol.
  196. The default is /etc/corosync/authkey.
  197. .TP
  198. key
  199. Shared key stored in configuration instead of authkey file. This option
  200. has lower precedence than keyfile option so it's
  201. used only when keyfile is not specified.
  202. Using this option is not recommended for security reasons.
  203. .TP
  204. link_mode
  205. This specifies the Kronosnet mode, which may be passive, active, or
  206. rr (round-robin).
  207. .B passive:
  208. the active link with the lowest priority will be used. If one or more
  209. links share the same priority the one with the lowest link ID will
  210. be used.
  211. .B active:
  212. All active links will be used simultaneously to send traffic.
  213. link priority is ignored.
  214. .B rr:
  215. Round-Robin policy. Each packet will be sent to the next active link in
  216. order.
  217. If only one interface directive is specified, passive is automatically chosen.
  218. The maximum number of interface directives that is allowed with Kronosnet
  219. is 8. For other transports it is 1.
  220. .TP
  221. netmtu
  222. This specifies the network maximum transmit unit. To set this value beyond
  223. 1500, the regular frame MTU, requires ethernet devices that support large, or
  224. also called jumbo, frames. If any device in the network doesn't support large
  225. frames, the protocol will not operate properly. The hosts must also have their
  226. mtu size set from 1500 to whatever frame size is specified here.
  227. Please note while some NICs or switches claim large frame support, they support
  228. 9000 MTU as the maximum frame size including the IP header. Setting the netmtu
  229. and host MTUs to 9000 will cause totem to use the full 9000 bytes of the frame.
  230. Then Linux will add a 18 byte header moving the full frame size to 9018. As a
  231. result some hardware will not operate properly with this size of data. A netmtu
  232. of 8982 seems to work for the few large frame devices that have been tested.
  233. Some manufacturers claim large frame support when in fact they support frame
  234. sizes of 4500 bytes.
  235. When sending multicast traffic, if the network frequently reconfigures, chances are
  236. that some device in the network doesn't support large frames.
  237. Choose hardware carefully if intending to use large frame support.
  238. The default is 1500.
  239. .TP
  240. transport
  241. This directive controls the transport mechanism used.
  242. The default is knet. The transport type can also be set to udpu or udp.
  243. Only knet allows crypto or multiple interfaces per node.
  244. .TP
  245. cluster_name
  246. This specifies the name of cluster and it's used for automatic generating
  247. of multicast address.
  248. .TP
  249. config_version
  250. This specifies version of config file. This is converted to unsigned 64-bit int.
  251. By default it's 0. Option is used to prevent joining old nodes with not
  252. up-to-date configuration. If value is not 0, and node is going for first time
  253. (only for first time, join after split doesn't follow this rules)
  254. from single-node membership to multiple nodes membership, other nodes
  255. config_versions are collected. If current node config_version is not
  256. equal to highest of collected versions, corosync is terminated.
  257. .TP
  258. ip_version
  259. This specifies version of IP to ask DNS resolver for.
  260. The value can be one of
  261. .B ipv4
  262. (look only for an IPv4 address)
  263. ,
  264. .B ipv6
  265. (check only IPv6 address)
  266. ,
  267. .B ipv4-6
  268. (look for all address families and use first IPv4 address found in the list if there is such address,
  269. otherwise use first IPv6 address) and
  270. .B ipv6-4
  271. (look for all address families and use first IPv6 address found in the list if there is such address,
  272. otherwise use first IPv4 address).
  273. Default (if unspecified) is
  274. .B ipv6-4
  275. for knet and udpu transports and
  276. .B ipv4
  277. for udp.
  278. The knet transport supports IPv4 and IPv6 addresses concurrently,
  279. provided they are consistent on each link.
  280. Within the
  281. .B totem
  282. directive, there are several configuration options which are used to control
  283. the operation of the protocol. It is generally not recommended to change any
  284. of these values without proper guidance and sufficient testing. Some networks
  285. may require larger values if suffering from frequent reconfigurations. Some
  286. applications may require faster failure detection times which can be achieved
  287. by reducing the token timeout.
  288. .TP
  289. token
  290. This timeout is used directly or as a base for real token timeout calculation (explained in
  291. .B token_coefficient
  292. section). Token timeout specifies in milliseconds until a token loss is declared after not
  293. receiving a token. This is the time spent detecting a failure of a processor
  294. in the current configuration. Reforming a new configuration takes about 50
  295. milliseconds in addition to this timeout.
  296. For real token timeout used by totem it's possible to read cmap value of
  297. .B runtime.config.totem.token
  298. key.
  299. Be careful to use the same timeout values on each of the nodes in the cluster
  300. or unpredictable results may occur.
  301. The default is 1000 milliseconds.
  302. .TP
  303. token_warning
  304. Specifies the interval between warnings that the token has not been received. The
  305. value is a percentage of the token timeout and can be set to 0 to disable
  306. warnings.
  307. The default is 75%.
  308. .TP
  309. token_coefficient
  310. This value is used only when
  311. .B nodelist
  312. section is specified and contains at least 3 nodes. If so, real token timeout
  313. is then computed as token + (number_of_nodes - 2) * token_coefficient.
  314. This allows cluster to scale without manually changing token timeout
  315. every time new node is added. This value can be set to 0 resulting
  316. in effective removal of this feature.
  317. The default is 650 milliseconds.
  318. .TP
  319. token_retransmit
  320. This timeout specifies in milliseconds after how long before receiving a token
  321. the token is retransmitted. This will be automatically calculated if token
  322. is modified. It is not recommended to alter this value without guidance from
  323. the corosync community.
  324. The default is 238 milliseconds.
  325. .TP
  326. knet_compression_model
  327. The (optional) type of compression used by Kronosnet. The values available depend on
  328. the build and also avaialable libraries. Typically zlib and lz4 will be available
  329. but bzip2 and others could also be allowed. The default is 'none'
  330. .TP
  331. knet_compression_threshold
  332. Tells knet to NOT compress any packets that are smaller than the value
  333. indicated. Default 100 bytes.
  334. Set to 0 to reset to the default.
  335. Set to 1 to compress everything.
  336. .TP
  337. knet_compression_level
  338. Many compression libraries allow tuning of compression parameters. For example
  339. 0 or 1 ... 9 are commonly used to determine the level of compression. This value
  340. is passed unmodified to the compression library so it is recommended to consult
  341. the library's documentation for more detailed information.
  342. .TP
  343. hold
  344. This timeout specifies in milliseconds how long the token should be held by
  345. the representative when the protocol is under low utilization. It is not
  346. recommended to alter this value without guidance from the corosync community.
  347. The default is 180 milliseconds.
  348. .TP
  349. token_retransmits_before_loss_const
  350. This value identifies how many token retransmits should be attempted before
  351. forming a new configuration. If this value is set, retransmit and hold will
  352. be automatically calculated from retransmits_before_loss and token.
  353. The default is 4 retransmissions.
  354. .TP
  355. join
  356. This timeout specifies in milliseconds how long to wait for join messages in
  357. the membership protocol.
  358. The default is 50 milliseconds.
  359. .TP
  360. send_join
  361. This timeout specifies in milliseconds an upper range between 0 and send_join
  362. to wait before sending a join message. For configurations with less than
  363. 32 nodes, this parameter is not necessary. For larger rings, this parameter
  364. is necessary to ensure the NIC is not overflowed with join messages on
  365. formation of a new ring. A reasonable value for large rings (128 nodes) would
  366. be 80msec. Other timer values must also change if this value is changed. Seek
  367. advice from the corosync mailing list if trying to run larger configurations.
  368. The default is 0 milliseconds.
  369. .TP
  370. consensus
  371. This timeout specifies in milliseconds how long to wait for consensus to be
  372. achieved before starting a new round of membership configuration. The minimum
  373. value for consensus must be 1.2 * token. This value will be automatically
  374. calculated at 1.2 * token if the user doesn't specify a consensus value.
  375. For two node clusters, a consensus larger than the join timeout but less than
  376. token is safe. For three node or larger clusters, consensus should be larger
  377. than token. There is an increasing risk of odd membership changes, which still
  378. guarantee virtual synchrony, as node count grows if consensus is less than
  379. token.
  380. The default is 1200 milliseconds.
  381. .TP
  382. merge
  383. This timeout specifies in milliseconds how long to wait before checking for
  384. a partition when no multicast traffic is being sent. If multicast traffic
  385. is being sent, the merge detection happens automatically as a function of
  386. the protocol.
  387. The default is 200 milliseconds.
  388. .TP
  389. downcheck
  390. This timeout specifies in milliseconds how long to wait before checking
  391. that a network interface is back up after it has been downed.
  392. The default is 1000 milliseconds.
  393. .TP
  394. fail_recv_const
  395. This constant specifies how many rotations of the token without receiving any
  396. of the messages when messages should be received may occur before a new
  397. configuration is formed.
  398. The default is 2500 failures to receive a message.
  399. .TP
  400. seqno_unchanged_const
  401. This constant specifies how many rotations of the token without any multicast
  402. traffic should occur before the hold timer is started.
  403. The default is 30 rotations.
  404. .TP
  405. heartbeat_failures_allowed
  406. [HeartBeating mechanism]
  407. Configures the optional HeartBeating mechanism for faster failure detection. Keep in
  408. mind that engaging this mechanism in lossy networks could cause faulty loss declaration
  409. as the mechanism relies on the network for heartbeating.
  410. So as a rule of thumb use this mechanism if you require improved failure in low to
  411. medium utilized networks.
  412. This constant specifies the number of heartbeat failures the system should tolerate
  413. before declaring heartbeat failure e.g 3. Also if this value is not set or is 0 then the
  414. heartbeat mechanism is not engaged in the system and token rotation is the method
  415. of failure detection
  416. The default is 0 (disabled).
  417. .TP
  418. max_network_delay
  419. [HeartBeating mechanism]
  420. This constant specifies in milliseconds the approximate delay that your network takes
  421. to transport one packet from one machine to another. This value is to be set by system
  422. engineers and please don't change if not sure as this effects the failure detection
  423. mechanism using heartbeat.
  424. The default is 50 milliseconds.
  425. .TP
  426. window_size
  427. This constant specifies the maximum number of messages that may be sent on one
  428. token rotation. If all processors perform equally well, this value could be
  429. large (300), which would introduce higher latency from origination to delivery
  430. for very large rings. To reduce latency in large rings(16+), the defaults are
  431. a safe compromise. If 1 or more slow processor(s) are present among fast
  432. processors, window_size should be no larger than 256000 / netmtu to avoid
  433. overflow of the kernel receive buffers. The user is notified of this by
  434. the display of a retransmit list in the notification logs. There is no loss
  435. of data, but performance is reduced when these errors occur.
  436. The default is 50 messages.
  437. .TP
  438. max_messages
  439. This constant specifies the maximum number of messages that may be sent by one
  440. processor on receipt of the token. The max_messages parameter is limited to
  441. 256000 / netmtu to prevent overflow of the kernel transmit buffers.
  442. The default is 17 messages.
  443. .TP
  444. miss_count_const
  445. This constant defines the maximum number of times on receipt of a token
  446. a message is checked for retransmission before a retransmission occurs. This
  447. parameter is useful to modify for switches that delay multicast packets
  448. compared to unicast packets. The default setting works well for nearly all
  449. modern switches.
  450. The default is 5 messages.
  451. .TP
  452. knet_pmtud_interval
  453. How often the knet PMTUd runs to look for network MTU changes.
  454. Value in seconds, default: 30
  455. .PP
  456. Within the
  457. .B logging
  458. directive, there are several configuration options which are all optional.
  459. .PP
  460. The following 3 options are valid only for the top level logging directive:
  461. .TP
  462. timestamp
  463. This specifies that a timestamp is placed on all log messages. It can be one
  464. of off (no timestamp), on (second precision timestamp) or
  465. hires (millisecond precision timestamp - only when supported by LibQB).
  466. The default is hires (or on if hires is not supported).
  467. .TP
  468. fileline
  469. This specifies that file and line should be printed.
  470. The default is off.
  471. .TP
  472. function_name
  473. This specifies that the code function name should be printed.
  474. The default is off.
  475. .TP
  476. blackbox
  477. This specifies that blackbox functionality should be enabled.
  478. The default is on.
  479. .PP
  480. The following options are valid both for top level logging directive
  481. and they can be overridden in logger_subsys entries.
  482. .TP
  483. to_stderr
  484. .TP
  485. to_logfile
  486. .TP
  487. to_syslog
  488. These specify the destination of logging output. Any combination of
  489. these options may be specified. Valid options are
  490. .B yes
  491. and
  492. .B no.
  493. The default is syslog and stderr.
  494. Please note, if you are using to_logfile and want to rotate the file, use logrotate(8)
  495. with the option
  496. .B
  497. copytruncate.
  498. eg.
  499. .ne 18
  500. .RS
  501. .nf
  502. .ft CW
  503. /var/log/corosync.log {
  504. missingok
  505. compress
  506. notifempty
  507. daily
  508. rotate 7
  509. copytruncate
  510. }
  511. .ft
  512. .fi
  513. .RE
  514. .TP
  515. logfile
  516. If the
  517. .B to_logfile
  518. directive is set to
  519. .B yes
  520. , this option specifies the pathname of the log file.
  521. No default.
  522. .TP
  523. logfile_priority
  524. This specifies the logfile priority for this particular subsystem. Ignored if debug is on.
  525. Possible values are: alert, crit, debug (same as debug = on), emerg, err, info, notice, warning.
  526. The default is: info.
  527. .TP
  528. syslog_facility
  529. This specifies the syslog facility type that will be used for any messages
  530. sent to syslog. options are daemon, local0, local1, local2, local3, local4,
  531. local5, local6 & local7.
  532. The default is daemon.
  533. .TP
  534. syslog_priority
  535. This specifies the syslog level for this particular subsystem. Ignored if debug is on.
  536. Possible values are: alert, crit, debug (same as debug = on), emerg, err, info, notice, warning.
  537. The default is: info.
  538. .TP
  539. debug
  540. This specifies whether debug output is logged for this particular logger. Also can contain
  541. value trace, what is highest level of debug information.
  542. The default is off.
  543. .PP
  544. Within the
  545. .B logging
  546. directive, logger_subsys directives are optional.
  547. .PP
  548. Within the
  549. .B logger_subsys
  550. sub-directive, all of the above logging configuration options are valid and
  551. can be used to override the default settings.
  552. The subsys entry, described below, is mandatory to identify the subsystem.
  553. .TP
  554. subsys
  555. This specifies the subsystem identity (name) for which logging is specified. This is the
  556. name used by a service in the log_init() call. E.g. 'CPG'. This directive is
  557. required.
  558. .PP
  559. Within the
  560. .B quorum
  561. directive it is possible to specify the quorum algorithm to use with the
  562. .TP
  563. provider
  564. directive. At the time of writing only corosync_votequorum is supported.
  565. See votequorum(5) for configuration options.
  566. .PP
  567. Within the
  568. .B nodelist
  569. directive it is possible to specify specific information about nodes in cluster. Directive
  570. can contain only
  571. .B node
  572. sub-directive, which specifies every node that should be a member of the membership, and where
  573. non-default options are needed. Every node must have at least ring0_addr field filled.
  574. Every node that should be a member of the membership must be specified.
  575. Possible options are:
  576. .TP
  577. ringX_addr
  578. This specifies IP or network hostname address of the particular node.
  579. X is a link number.
  580. .TP
  581. nodeid
  582. This configuration option is required for each node for Kronosnet mode.
  583. It is a 32 bit value specifying the node identifier delivered to the
  584. cluster membership service. The node identifier value of zero is
  585. reserved and should not be used. If knet is set, this field must be set.
  586. .TP
  587. name
  588. This option is used mainly with knet transport to identify local node.
  589. It's also used by client software (pacemaker).
  590. Algorithm for identifying local node is following:
  591. .RS
  592. .IP 1.
  593. Looks up $HOSTNAME in the nodelist
  594. .IP 2.
  595. If this fails strip the domain name from $HOSTNAME and looks up
  596. that in the nodelist
  597. .IP 3.
  598. If this fails look in the nodelist for a fully-qualified name whose
  599. short version matches the short version of $HOSTNAME
  600. .IP 4.
  601. If all this fails then search the interfaces list for an address that
  602. matches a name in the nodelist
  603. .RE
  604. .PP
  605. Within the
  606. .B system
  607. directive it is possible to specify system options.
  608. Possible options are:
  609. .TP
  610. qb_ipc_type
  611. This specifies type of IPC to use. Can be one of native (default), shm and socket.
  612. Native means one of shm or socket, depending on what is supported by OS. On systems
  613. with support for both, SHM is selected. SHM is generally faster, but need to allocate
  614. ring buffer file in /dev/shm.
  615. .TP
  616. sched_rr
  617. Should be set to yes (default) if corosync should try to set round robin realtime
  618. scheduling with maximal priority to itself. When setting of scheduler fails, fallback to set
  619. maximal priority.
  620. .TP
  621. priority
  622. Set priority of corosync process. Valid only when sched_rr is set to no.
  623. Can be ether numeric value with similar meaning as
  624. .BR nice (1)
  625. or
  626. .B max
  627. /
  628. .B min
  629. meaning maximal / minimal priority (so minimal / maximal nice value).
  630. .TP
  631. move_to_root_cgroup
  632. Should be set to yes (default) if corosync should try to move itself to root
  633. cgroup. This feature is available only for systems with cgroups with RT
  634. sched enabled (Linux with CONFIG_RT_GROUP_SCHED kernel option).
  635. .TP
  636. state_dir
  637. Existing directory where corosync should chdir into. Corosync stores
  638. important state files and blackboxes there.
  639. The default is /var/lib/corosync.
  640. .PP
  641. Within the
  642. .B resources
  643. directive it is possible to specify options for resources.
  644. Possible option is:
  645. .TP
  646. watchdog_device
  647. (Valid only if Corosync was compiled with watchdog support.)
  648. .br
  649. Watchdog device to use, for example /dev/watchdog.
  650. If unset, empty or "off", no watchdog is used.
  651. .IP
  652. In a cluster with properly configured power fencing a watchdog
  653. provides no additional value. On the other hand, slow watchdog
  654. communication may incur multi-second delays in the Corosync main loop,
  655. potentially breaking down membership. IPMI watchdogs are particularly
  656. notorious in this regard: read about kipmid_max_busy_us in IPMI.txt in
  657. the Linux kernel documentation.
  658. .SH "TO ADD A NEW NODE TO THE CLUSTER"
  659. For example to add a node with address 10.24.38.108 with nodeid 3. The node has the name NEW
  660. (in DNS or /etc/hosts) and is not currently running corosync. The current corosync.conf nodelist
  661. looks like this:
  662. .PP
  663. .nf
  664. .RS
  665. nodelist {
  666. node {
  667. nodeid: 1
  668. ring0_addr: 10.24.38.101
  669. name: node1
  670. }
  671. node {
  672. nodeid: 2
  673. ring0_addr: 10.24.38.102
  674. name: node2
  675. }
  676. }
  677. .RE
  678. .fi
  679. .PP
  680. Add a new entry for the node below the existing nodes. Node entries don't have
  681. to be in nodeid order, but it will help keep you sane. So the nodelist now looks like this:
  682. .PP
  683. .nf
  684. .RS
  685. nodelist {
  686. node {
  687. nodeid: 1
  688. ring0_addr: 10.24.38.101
  689. name: node1
  690. }
  691. node {
  692. nodeid: 2
  693. ring0_addr: 10.24.38.102
  694. name: node2
  695. }
  696. node {
  697. nodeid: 3
  698. ring0_addr: 10.24.38.108
  699. name: NEW
  700. }
  701. }
  702. .RE
  703. .fi
  704. .PP
  705. .PP
  706. This file must then be copied onto all three nodes - the existing two nodes, and the new one.
  707. On one of the existing corosync nodes, tell corosync to re-read the updated config file into memory:
  708. .PP
  709. .nf
  710. .RS
  711. corosync-cfgtool -R
  712. .RE
  713. .fi
  714. .PP
  715. This command only needs to be run on one node in the cluster. You may then start corosync on the NEW node
  716. and it should join the cluster. If this doesn't work as expected then check the communications between all
  717. three nodes is working, and check the syslog files on all nodes for more information. It's important to note
  718. that the key bit of information about a node failing to join might be on a different node than you expect.
  719. .SH "TO REMOVE A NODE FROM THE CLUSTER"
  720. This is the reverse procedure to 'Adding a node' above. First you need to shut down the node you will
  721. be removing from the cluster.
  722. .PP
  723. .nf
  724. .RS
  725. corosync-cfgtool -H
  726. .RE
  727. .fi
  728. .PP
  729. Then delete the nodelist stanza from corosync.conf and finally update corosync on the remaining nodes by
  730. running
  731. .PP
  732. .nf
  733. .RS
  734. corosync-cfgtool -R
  735. .RE
  736. .fi
  737. .TP
  738. on one of them.
  739. .SH "ADDRESS RESOLUTION"
  740. corosync resolves ringX_addr names/IP addresses using the getaddrinfo(3) call with respect
  741. of totem.ip_version setting.
  742. getaddrinfo() function uses a sophisticated algorithm to sort node addresses into a preferred
  743. order and corosync always chooses the first address in that list of the required family.
  744. As such it is essential that your DNS or /etc/hosts files are correctly configured so that
  745. all addresses for ringX appear on the same network (or are reachable with minimal hops)
  746. and over the same IP protocol. If this is not the case then some nodes might not be able
  747. to join the cluster. It is possible to override the search order used
  748. by getaddrinfo() using the configuration file /etc/gai.conf(5) if necessary,
  749. but this is not recommended.
  750. If there is any doubt about the order of addresses returned from getaddrinfo() then it might be simpler to use
  751. IP addresses (v4 or v6) in the ringX_addr field.
  752. .SH "FILES"
  753. .TP
  754. /etc/corosync/corosync.conf
  755. The corosync executive configuration file.
  756. .SH "SEE ALSO"
  757. .BR corosync_overview (7),
  758. .BR votequorum (5),
  759. .BR corosync-qdevice (8),
  760. .BR logrotate (8)
  761. .BR getaddrinfo (3)
  762. .BR gai.conf (5)
  763. .PP