OCF_HEARTBEAT_MYSQL-PROXY(7)

📦
version 4.18.0+git105.9ea1183 · 15 versions
, in opensuse-leap 16.0

💅 ocf_heartbeat_mysql-proxy 💅

okay bestie, welcome to the OCF_HEARTBEAT_MYSQL() manual page — the resource is ocf_heartbeat_mysql-proxy, and it is literally giving “manages a MySQL Proxy instance” main-character energy. pull up a chair, we’re going through every flag, every timeout, and every little detail together 🫶

🌸 NAME 🌸

ocf_heartbeat_mysql-proxy — manages a MySQL Proxy instance. that’s the whole NAME section, short and iconic ✨

✨ SYNOPSIS ✨

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

🦋 DESCRIPTION 🦋

okay so this script manages MySQL Proxy as an OCF resource in a high-availability setup. no cap.

The default monitor operation will verify that mysql-proxy is running. cute, simple, effective.

The level 10 monitor operation is left out intentionally for possible future enhancements in conjunction with the admin plugin. so if you’re looking for it, don’t come for me — it’s on purpose 💅

The level 20 monitor operation will perform a SELECT on a given table to verify that the connection to a back-end server is actually working. that’s the real vibe check.

Tested with MySQL Proxy 0.8.1 and 0.8.3 on Debian 6.0. iconic time capsule behavior 🎀

💖 SUPPORTED PARAMETERS 💖

every parameter, no skips, periodt. 🍓

  • binary — full path to the MySQL Proxy binary. example: "/usr/sbin/mysql-proxy". type/default tea: optional, string, default "/usr/sbin/mysql-proxy". 💖
  • client_binary — location of the MySQL client binary. type/default tea: optional, string, default "mysql". ✨
  • defaults_file — full path to a MySQL Proxy configuration file. example: "/etc/mysql-proxy.conf". type/default tea: optional, string, no default. 🎀
  • proxy_backend_addresses — Address:port of the remote back-end servers. original says (default: 127.0.0.1:3306). type/default tea: optional, string, default "127.0.0.1:3306". 🦋
  • proxy_read_only_backend_addresses — Address:port of the remote (read only) unpromoted-server. original literally shows (default: ). type/default tea: optional, string, no default. 🌸
  • proxy_address — listening address:port of the proxy server. original says (default: :4040). you can also specify a socket like "/var/run/mysql-proxy.sock". type/default tea: optional, string, default ":4040". 💅
  • log_level — log all messages of level (error|warning|info|message|debug|) or higher. an empty value disables logging. type/default tea: optional, string, no default. 🫶
  • keepalive — try to restart the proxy if it crashed. original says (default: ). valid values: true or false. an empty value equals "false". type/default tea: optional, string, no default. 😭
  • plugins — whitespace separated list of plugins to load. original says (default: ). note: the admin plugin will be auto-loaded in case you specify an admin_* parameter. type/default tea: optional, string, no default. 🔥
  • admin_address — listening address:port of the admin plugin. original says (default: 127.0.0.1:4041). note: the admin plugin will be auto-loaded in case you specify an admin_* parameter. type/default tea: optional, string, default "127.0.0.1:4041". 👑
  • admin_username — username for the admin plugin. original says (default: ). required since MySQL Proxy 0.8.1, if the admin plugin is loaded. note: the admin plugin will be auto-loaded in case you specify an admin_* parameter. type/default tea: optional, string, no default. 🌈
  • admin_password — password for the admin plugin. original says (default: ). required since MySQL Proxy 0.8.1, if the admin plugin is loaded. note: the admin plugin will be auto-loaded in case you specify an admin_* parameter. type/default tea: optional, string, no default. ⭐
  • admin_lua_script — script to execute by the admin plugin. required since MySQL Proxy 0.8.1, if the admin plugin is loaded. note: the admin plugin will be auto-loaded in case you specify an admin_* parameter. type/default tea: optional, string, no default. 💀
  • test_table — table to be tested in monitor statement (in database.table notation). type/default tea: optional, string, default "mysql.user". 🙈
  • test_user — MySQL test user. type/default tea: optional, string, no default. 🍓
  • test_passwd — MySQL test user password. type/default tea: optional, string, no default. 🧚
  • parameters — the MySQL Proxy daemon may be called with additional parameters. specify any of them here. type/default tea: optional, string, no default. 💜
  • pidfile — PID file. type/default tea: unique, optional, string, default "/run/resource-agents/mysql-proxy-RESOURCE_ID.pid". 🎀

🎀 SUPPORTED ACTIONS 🎀

this resource agent supports the following actions (operations):

  • start — starts the resource. suggested minimum timeout: 30s. ✨
  • stop — stops the resource. suggested minimum timeout: 30s. 💖
  • reload — suggested minimum timeout: 30s. 🦋
  • monitor — performs a detailed status check. suggested minimum timeout: 20s. suggested interval: 60s. 🔥
  • validate-all — performs a validation of the resource configuration. suggested minimum timeout: 30s. 🌸
  • meta-data — retrieves resource agent metadata (internal use only). suggested minimum timeout: 5s. 💅

🔥 EXAMPLE CRM SHELL 🔥

the following is an example configuration for a mysql-proxy resource using the crm(8) shell:

primitive p_mysql-proxy ocf:heartbeat:mysql-proxy \
  op monitor depth="0" timeout="20s" interval="60s"

⭐ EXAMPLE PCS ⭐

the following is an example configuration for a mysql-proxy resource using pcs(8):

pcs resource create p_mysql-proxy ocf:heartbeat:mysql-proxy \
  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="60s"

🌈 SEE ALSO 🌈

the link drop: http://clusterlabs.org/ 🫶

👑 AUTHOR 👑

ClusterLabs contributors (see the resource agent source for information about individual authors). 👑

that’s the whole vibe — footer/source-version marker is OCF_HEARTBEAT_MYSQL(), and this page doesn’t print a date, so no timestamp tea here, bestie. mwah 💋

📦 where this page comes from