1OCF_HEARTBEAT_MARIAD(7) OCF resource agents OCF_HEARTBEAT_MARIAD(7)
2
6 ocf_heartbeat_mariadb - Manages a MariaDB promotable instance
7
9 mariadb [start | stop | status | monitor | promote | demote | meta-data
10 | validate-all]
11
13 Resource script for MariaDB.
14 Manages a complete promotable replication setup with GTID, for simpler
16 uses look at the mysql resource agent which supports older replication
17 forms which mysql and mariadb have in common.
18 The resource must be setup to use notifications. Set 'notify=true' in
20 the metadata attributes when defining a MariaDB promotable instance.
21 The default behavior is to use uname -n values in the change promoted
23 to command. Other IPs can be specified manually by adding a node
24 attribute ${INSTANCE_ATTR_NAME}_mysql_master_IP giving the IP to use
25 for replication. For example, if the mariadb primitive you are using is
26 p_mariadb, the attribute to set will be p_mariadb_mysql_master_IP.
27
29 binary
30 Location of the MariaDB server binary
31 (optional, string, default "/usr/bin/safe_mysqld")
33 client_binary
35 Location of the MariaDB client binary
36 (optional, string, default "mysql")
38 config
40 Configuration file
41 (optional, string, default "/etc/my.cnf")
43 datadir
45 Directory containing databases
46 (optional, string, default "/var/lib/mysql")
48 user
50 User running MariaDB daemon
51 (optional, string, default "mysql")
53 group
55 Group running MariaDB daemon (for logfile and directory
56 permissions)
57 (optional, string, default "mysql")
59 log
61 The logfile to be used for mysqld.
62 (optional, string, default "/var/log/mysqld.log")
64 node_list
66 All node names of nodes that will execute mariadb. Please separate
67 each node name with a space. This is required for the promoted
68 selection to function.
69 (required, string, no default)
71 pid
73 The pidfile to be used for mysqld.
74 (optional, string, default "/var/run/mysql/mysqld.pid")
76 socket
78 The socket to be used for mysqld.
79 (optional, string, default "/var/lib/mysql/mysql.sock")
81 test_table
83 Table to be tested in monitor statement (in database.table
84 notation)
85 (optional, string, default "mysql.user")
87 test_user
89 MariaDB test user, must have select privilege on test_table
90 (optional, string, default "root")
92 test_passwd
94 MariaDB test user password
95 (optional, string, no default)
97 enable_creation
99 If the MariaDB database does not exist, it will be created
100 (optional, boolean, default 0)
102 additional_parameters
104 Additional parameters which are passed to the mysqld on startup.
105 (e.g. --skip-external-locking or --skip-grant-tables)
106 (optional, string, no default)
108 replication_user
110 MariaDB replication user. This user is used for starting and
111 stopping MariaDB replication, for setting and resetting the
112 promoted host, and for setting and unsetting read-only mode.
113 Because of that, this user must have SUPER, REPLICATION SLAVE,
114 REPLICATION CLIENT, PROCESS and RELOAD privileges on all nodes
115 within the cluster. Mandatory if you define a promotable resource.
116 (optional, string, default "root")
118 replication_passwd
120 MariaDB replication password. Used for replication client and
121 unpromoted. Mandatory if you define a promotable resource.
122 (optional, string, no default)
124 replication_port
126 The port on which the Promoted MariaDB instance is listening.
127 (optional, string, default "3306")
129
131 This resource agent supports the following actions (operations):
132 start
134 Starts the resource. Suggested minimum timeout: 120s.
135 stop
137 Stops the resource. Suggested minimum timeout: 120s.
138 status
140 Performs a status check. Suggested minimum timeout: 60s.
141 monitor
143 Performs a detailed status check. Suggested minimum timeout: 30s.
144 Suggested interval: 20s.
145 monitor (Promoted role)
147 Performs a detailed status check. Suggested minimum timeout: 30s.
148 Suggested interval: 10s.
149 monitor (Unpromoted role)
151 Performs a detailed status check. Suggested minimum timeout: 30s.
152 Suggested interval: 30s.
153 promote
155 Promotes the resource to the Master role. Suggested minimum
156 timeout: 120s.
157 demote
159 Demotes the resource to the Slave role. Suggested minimum timeout:
160 120s.
161 notify
163 Suggested minimum timeout: 90s.
164 validate-all
166 Performs a validation of the resource configuration. Suggested
167 minimum timeout: 5s.
168 meta-data
170 Retrieves resource agent metadata (internal use only). Suggested
171 minimum timeout: 5s.
172
174 The following is an example configuration for a mariadb resource using
175 the crm(8) shell:
176 primitive p_mariadb ocf:heartbeat:mariadb \
178 params \
179 node_list=string \
180 op monitor depth="0" timeout="30s" interval="20s" \
181 op monitor role="Promoted" depth="0" timeout="30s" interval="10s" \
182 op monitor role="Unpromoted" depth="0" timeout="30s" interval="30s"
183 ms ms_mariadb p_mariadb \
185 meta notify="true" interleave="true"
186
188 The following is an example configuration for a mariadb resource using
189 pcs(8)
190 pcs resource create p_mariadb ocf:heartbeat:mariadb \
192 node_list=string \
193 op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="20s" \
194 op monitor role="Promoted" OCF_CHECK_LEVEL="0" timeout="30s" interval="10s" \
195 op monitor role="Unpromoted" OCF_CHECK_LEVEL="0" timeout="30s" interval="30s" promotable
196
198 http://clusterlabs.org/
199
201 ClusterLabs contributors (see the resource agent source for information
202 about individual authors)
203resource-agents UNKNOWN 10/11/2023 OCF_HEARTBEAT_MARIAD(7)