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 galara instance
7

SYNOPSIS

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

DESCRIPTION

13       Resource script for managing galara 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, default "root")
100
101       check_passwd
102           Cluster check user password
103
104           (optional, string, no default)
105

SUPPORTED ACTIONS

107       This resource agent supports the following actions (operations):
108
109       start
110           Starts the resource. Suggested minimum timeout: 120s.
111
112       stop
113           Stops the resource. Suggested minimum timeout: 120s.
114
115       status
116           Performs a status check. Suggested minimum timeout: 60s.
117
118       monitor
119           Performs a detailed status check. Suggested minimum timeout: 30s.
120           Suggested interval: 20s.
121
122       monitor (Master role)
123           Performs a detailed status check. Suggested minimum timeout: 30s.
124           Suggested interval: 10s.
125
126       monitor (Slave role)
127           Performs a detailed status check. Suggested minimum timeout: 30s.
128           Suggested interval: 30s.
129
130       promote
131           Promotes the resource to the Master role. Suggested minimum
132           timeout: 300s.
133
134       demote
135           Demotes the resource to the Slave role. Suggested minimum timeout:
136           120s.
137
138       validate-all
139           Performs a validation of the resource configuration. Suggested
140           minimum timeout: 5s.
141
142       meta-data
143           Retrieves resource agent metadata (internal use only). Suggested
144           minimum timeout: 5s.
145

EXAMPLE CRM SHELL

147       The following is an example configuration for a galera resource using
148       the crm(8) shell:
149
150           primitive p_galera ocf:heartbeat:galera \
151             params \
152               wsrep_cluster_address=string \
153             op monitor depth="0" timeout="30s" interval="20s" \
154             op monitor role="Master" depth="0" timeout="30s" interval="10s" \
155             op monitor role="Slave" depth="0" timeout="30s" interval="30s"
156
157           ms ms_galera p_galera \
158             meta notify="true" interleave="true"
159

EXAMPLE PCS

161       The following is an example configuration for a galera resource using
162       pcs(8)
163
164           pcs resource create p_galera ocf:heartbeat:galera \
165             wsrep_cluster_address=string \
166             op monitor depth="0" timeout="30s" interval="20s" \
167             op monitor role="Master" depth="0" timeout="30s" interval="10s" \
168             op monitor role="Slave" depth="0" timeout="30s" interval="30s" --master
169

AUTHOR

174       ClusterLabs contributors (see the resource agent source for information
175       about individual authors)
176
177
178
179resource-agents UNKNOWN           10/24/2018           OCF_HEARTBEAT_GALERA(7)