ocf_heartbeat_mysql-proxy(7)

1OCF_HEARTBEAT_MYSQL()                                    OCF_HEARTBEAT_MYSQL()
2
3
4

NAME

6       ocf_heartbeat_mysql-proxy - Manages a MySQL Proxy instance
7

SYNOPSIS

9       mysql-proxy [start | stop | monitor | meta-data | validate-all]
10

DESCRIPTION

12       This script manages MySQL Proxy as an OCF resource in a
13       high-availability setup.
14
15       The default monitor operation will verify that mysql-proxy is running.
16
17       The level 10 monitor operation is left out intentionally for possible
18       future enhancements in conjunction with the admin plugin.
19
20       The level 20 monitor operation will perform a SELECT on a given table
21       to verify that the connection to a back-end server is actually working.
22
23       Tested with MySQL Proxy 0.8.1 and 0.8.3 on Debian 6.0.
24

SUPPORTED PARAMETERS

26       binary
27           Full path to the MySQL Proxy binary. For example,
28           "/usr/sbin/mysql-proxy".
29
30           (optional, string, default "/usr/sbin/mysql-proxy")
31
32       client_binary
33           Location of the MySQL client binary.
34
35           (optional, string, default "mysql")
36
37       defaults_file
38           Full path to a MySQL Proxy configuration file. For example,
39           "/etc/mysql-proxy.conf".
40
41           (optional, string, no default)
42
43       proxy_backend_addresses
44           Address:port of the remote back-end servers (default:
45           127.0.0.1:3306).
46
47           (optional, string, default "127.0.0.1:3306")
48
49       proxy_read_only_backend_addresses
50           Address:port of the remote (read only) slave-server (default: ).
51
52           (optional, string, no default)
53
54       proxy_address
55           Listening address:port of the proxy server (default: :4040). You
56           can also specify a socket like "/tmp/mysql-proxy.sock".
57
58           (optional, string, default ":4040")
59
60       log_level
61           Log all messages of level (error|warning|info|message|debug|) or
62           higher. An empty value disables logging.
63
64           (optional, string, no default)
65
66       keepalive
67           Try to restart the proxy if it crashed (default: ). Valid values:
68           true or false. An empty value equals "false".
69
70           (optional, string, no default)
71
72       plugins
73           Whitespace separated list of plugins to load (default: ). Note: The
74           admin plugin will be auto-loaded in case you specify an admin_*
75           parameter.
76
77           (optional, string, no default)
78
79       admin_address
80           Listening address:port of the admin plugin (default:
81           127.0.0.1:4041). Note: The admin plugin will be auto-loaded in case
82           you specify an admin_* parameter.
83
84           (optional, string, default "127.0.0.1:4041")
85
86       admin_username
87           Username for the admin plugin (default: ). Required since MySQL
88           Proxy 0.8.1, if the admin plugin is loaded. Note: The admin plugin
89           will be auto-loaded in case you specify an admin_* parameter.
90
91           (optional, string, no default)
92
93       admin_password
94           Password for the admin plugin (default: ). Required since MySQL
95           Proxy 0.8.1, if the admin plugin is loaded. Note: The admin plugin
96           will be auto-loaded in case you specify an admin_* parameter.
97
98           (optional, string, no default)
99
100       admin_lua_script
101           Script to execute by the admin plugin. Required since MySQL Proxy
102           0.8.1, if the admin plugin is loaded. Note: The admin plugin will
103           be auto-loaded in case you specify an admin_* parameter.
104
105           (optional, string, no default)
106
107       test_table
108           Table to be tested in monitor statement (in database.table
109           notation)
110
111           (optional, string, default "mysql.user")
112
113       test_user
114           MySQL test user
115
116           (optional, string, no default)
117
118       test_passwd
119           MySQL test user password
120
121           (optional, string, no default)
122
123       parameters
124           The MySQL Proxy daemon may be called with additional parameters.
125           Specify any of them here.
126
127           (optional, string, no default)
128
129       pidfile
130           PID file
131
132           (unique, optional, string, default
133           "/run/resource-agents/mysql-proxy-RESOURCE_ID.pid")
134

SUPPORTED ACTIONS

136       This resource agent supports the following actions (operations):
137
138       start
139           Starts the resource. Suggested minimum timeout: 30s.
140
141       stop
142           Stops the resource. Suggested minimum timeout: 30s.
143
144       reload
145           Suggested minimum timeout: 30s.
146
147       monitor
148           Performs a detailed status check. Suggested minimum timeout: 20s.
149           Suggested interval: 60s.
150
151       validate-all
152           Performs a validation of the resource configuration. Suggested
153           minimum timeout: 30s.
154
155       meta-data
156           Retrieves resource agent metadata (internal use only). Suggested
157           minimum timeout: 5s.
158

EXAMPLE CRM SHELL

160       The following is an example configuration for a mysql-proxy resource
161       using the crm(8) shell:
162
163           primitive p_mysql-proxy ocf:heartbeat:mysql-proxy \
164             op monitor depth="0" timeout="20s" interval="60s"
165

EXAMPLE PCS

167       The following is an example configuration for a mysql-proxy resource
168       using pcs(8)
169
170           pcs resource create p_mysql-proxy ocf:heartbeat:mysql-proxy \
171             op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="60s"
172

AUTHOR

177       ClusterLabs contributors (see the resource agent source for information
178       about individual authors)
179
180
181
182                                                         OCF_HEARTBEAT_MYSQL()