ocf_heartbeat_galera(7)

1OCF_HEARTBEAT_GALERA(7)       OCF resource agents      OCF_HEARTBEAT_GALERA(7)
2
3
4

NAME

6       ocf_heartbeat_galera - Manages a galera instance
7

SYNOPSIS

9       galera [start | stop | status | monitor | promote | demote | meta-data
10              | validate-all]
11

DESCRIPTION

13       Resource script for managing galera database.
14

SUPPORTED PARAMETERS

16       binary
17           Location of the MySQL server binary
18
19           (optional, string, no default)
20
21       client_binary
22           Location of the MySQL client binary
23
24           (optional, string, no default)
25
26       config
27           Configuration file
28
29           (optional, string, no default)
30
31       datadir
32           Directory containing databases
33
34           (optional, string, no default)
35
36       user
37           User running MySQL daemon
38
39           (optional, string, no default)
40
41       group
42           Group running MySQL daemon (for logfile and directory permissions)
43
44           (optional, string, no default)
45
46       log
47           The logfile to be used for mysqld.
48
49           (optional, string, no default)
50
51       pid
52           The pidfile to be used for mysqld.
53
54           (optional, string, no default)
55
56       socket
57           The socket to be used for mysqld.
58
59           (optional, string, no default)
60
61       enable_creation
62           If the MySQL database does not exist, it will be created
63
64           (optional, boolean, default false)
65
66       additional_parameters
67           Additional parameters which are passed to the mysqld on startup.
68           (e.g. --skip-external-locking or --skip-grant-tables)
69
70           (optional, string, no default)
71
72       wsrep_cluster_address
73           The galera cluster address. This takes the form of:
74           gcomm://node,node,node
75
76           Only nodes present in this node list will be allowed to start a
77           galera instance. The galera node names listed in this address are
78           expected to match valid pacemaker node names. If both names need to
79           differ, you must provide a mapping in option cluster_host_map.
80
81           (required, string, no default)
82
83       cluster_host_map
84           A mapping of pacemaker node names to galera node names.
85
86           To be used when both pacemaker and galera names need to differ,
87           (e.g. when galera names map to IP from a specific network
88           interface) This takes the form of:
89           pcmk1:node.1.galera;pcmk2:node.2.galera;pcmk3:node.3.galera
90
91           where the galera resource started on node pcmk1 would be named
92           node.1.galera in the wsrep_cluster_address
93
94           (optional, string, no default)
95
96       check_user
97           Cluster check user.
98
99           (optional, string, no default)
100
101       check_passwd
102           Cluster check user password. Empty passwords are ignored unless the
103           parameter "check_passwd_use_empty" is set to 1.
104
105           (optional, string, no default)
106
107       check_passwd_use_empty
108           Use an empty "check_passwd" password. If this parameter is set to
109           1, "check_passwd" will be ignored and an empty password is used
110           when calling the "mysql" client binary.
111
112           (optional, boolean, default 0)
113
114       two_node_mode
115           If running in a 2-node pacemaker cluster, rely on pacemaker quorum
116           to allow automatic recovery even when the other node is
117           unreachable. Use it with caution! (and fencing)
118
119           (optional, boolean, default false)
120

SUPPORTED ACTIONS

122       This resource agent supports the following actions (operations):
123
124       start
125           Starts the resource. Suggested minimum timeout: 120s.
126
127       stop
128           Stops the resource. Suggested minimum timeout: 120s.
129
130       status
131           Performs a status check. Suggested minimum timeout: 60s.
132
133       monitor
134           Performs a detailed status check. Suggested minimum timeout: 30s.
135           Suggested interval: 20s.
136
137       monitor (Promoted role)
138           Performs a detailed status check. Suggested minimum timeout: 30s.
139           Suggested interval: 10s.
140
141       monitor (Unpromoted role)
142           Performs a detailed status check. Suggested minimum timeout: 30s.
143           Suggested interval: 30s.
144
145       promote
146           Promotes the resource to the Master role. Suggested minimum
147           timeout: 300s.
148
149       demote
150           Demotes the resource to the Slave role. Suggested minimum timeout:
151           120s.
152
153       validate-all
154           Performs a validation of the resource configuration. Suggested
155           minimum timeout: 5s.
156
157       meta-data
158           Retrieves resource agent metadata (internal use only). Suggested
159           minimum timeout: 5s.
160

EXAMPLE CRM SHELL

162       The following is an example configuration for a galera resource using
163       the crm(8) shell:
164
165           primitive p_galera ocf:heartbeat:galera \
166             params \
167               wsrep_cluster_address=string \
168             op monitor depth="0" timeout="30s" interval="20s" \
169             op monitor role="Promoted" depth="0" timeout="30s" interval="10s" \
170             op monitor role="Unpromoted" depth="0" timeout="30s" interval="30s"
171
172           ms ms_galera p_galera \
173             meta notify="true" interleave="true"
174

EXAMPLE PCS

176       The following is an example configuration for a galera resource using
177       pcs(8)
178
179           pcs resource create p_galera ocf:heartbeat:galera \
180             wsrep_cluster_address=string \
181             op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="20s" \
182             op monitor role="Promoted" OCF_CHECK_LEVEL="0" timeout="30s" interval="10s" \
183             op monitor role="Unpromoted" OCF_CHECK_LEVEL="0" timeout="30s" interval="30s" promotable
184

AUTHOR

189       ClusterLabs contributors (see the resource agent source for information
190       about individual authors)
191
192
193
194resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_GALERA(7)