OCF_HEARTBEAT_GALERA(7)

💜 ocf_heartbeat_galera — bestie's guide to the Galera resource agent

okay so real talk: this is page OCF_HEARTBEAT_GALERA(7) from the OCF resource agents manual collection, and it's literally the whole lore on ocf_heartbeat_galera. grab a boba, we're getting into it 🧋✨

---

🌸 NAME 🌸

ocf_heartbeat_galera — she manages a galera instance. that's the whole job. no cap. 💅

---

✨ SYNOPSIS ✨

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

---

🦋 DESCRIPTION 🦋

it's a resource script for managing your galera database. iconic behavior, honestly. 👑

---

🎀 SUPPORTED PARAMETERS 🎀

these are the knobs, bestie. every single one. let's go down the list 🫶

• binary — where your MySQL server binary lives. (optional, string, no default)
• client_binary — where your MySQL client binary lives. (optional, string, no default)
• config — the config file, yeah? (optional, string, no default)
• datadir — the directory that's holding all your databases. (optional, string, no default)
• user — the user running the MySQL daemon. (optional, string, no default)
• group — the group running the MySQL daemon (this one handles logfile and directory permissions). (optional, string, no default)
• log — the logfile mysqld should use. (optional, string, no default)
• pid — the pidfile mysqld should use. (optional, string, no default)
• socket — the socket mysqld should use. (optional, string, no default)
• enable_creation — if the MySQL database doesn't exist yet, it gets created. poof, there it is ✨ (optional, boolean, default false)
• additional_parameters — extra params that get passed to mysqld on startup (like --skip-external-locking or --skip-grant-tables). (optional, string, no default)
• wsrep_cluster_address — the galera cluster address, and it takes this form:

gcomm://node,node,node

only the nodes listed here are allowed to start a galera instance — like a VIP list, but make it database 🎟️. the galera node names in this address are expected to match valid pacemaker node names. and if the two names need to differ, you must provide a mapping in the option cluster_host_map. (required, string, no default)

• cluster_host_map — a mapping of pacemaker node names to galera node names 🔁

use this when pacemaker names and galera names need to differ (e.g. when the galera names map to an IP from a specific network interface). it takes this form:

pcmk1:node.1.galera;pcmk2:node.2.galera;pcmk3:node.3.galera

where the galera resource started on node pcmk1 would be named node.1.galera in the wsrep_cluster_address. (optional, string, no default)

• check_user — the cluster check user. (optional, string, no default)
• check_passwd — the cluster check user's password. empty passwords get ignored unless the parameter "check_passwd_use_empty" is set to 1. (optional, string, no default)
• check_passwd_use_empty — use an empty "check_passwd" password. if this is set to 1, then "check_passwd" is ignored and an empty password is used when calling the "mysql" client binary. (optional, boolean, default 0)
• two_node_mode — if you're running in a 2-node pacemaker cluster, this leans on pacemaker quorum so you get automatic recovery even when the other node is unreachable. ⚠️ use it with caution! (and fencing, bestie, fencing) (optional, boolean, default false)

---

⭐ SUPPORTED ACTIONS ⭐

this resource agent supports these actions (operations for the uninitiated). each one comes with a suggested minimum timeout, and two of them want an interval too:

• start — starts the resource. suggested minimum timeout: 120s.
• stop — stops the resource. suggested minimum timeout: 120s.
• status — performs a status check. suggested minimum timeout: 60s.
• monitor — performs a detailed status check. suggested minimum timeout: 30s. suggested interval: 20s.
• monitor (Promoted role) — performs a detailed status check, but for the promoted role. suggested minimum timeout: 30s. suggested interval: 10s.
• promote — promotes the resource to the Master role. 👑 suggested minimum timeout: 300s.
• demote — demotes the resource to the Slave role. suggested minimum timeout: 120s.
• validate-all — performs a validation of the resource configuration. suggested minimum timeout: 5s.
• meta-data — retrieves resource agent metadata (internal use only, don't touch 🙈). suggested minimum timeout: 5s.

---

🌈 EXAMPLE CRM SHELL 🌈

here's what a galera resource config looks like using the crm(8) shell — copy/paste energy, iykyk:

primitive p_galera ocf:heartbeat:galera \
  params \
    wsrep_cluster_address=string \
  op monitor depth="0" timeout="30s" interval="20s" \
  op monitor role="Promoted" depth="0" timeout="30s" interval="10s"

ms ms_galera p_galera \
  meta notify="true" interleave="true"

---

🍓 EXAMPLE PCS 🍓

and here's the same vibe via pcs(8):

pcs resource create p_galera ocf:heartbeat:galera \
  wsrep_cluster_address=string \
  op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="20s" \
  op monitor role="Promoted" OCF_CHECK_LEVEL="0" timeout="30s" interval="10s" promotable

---

🔥 SEE ALSO 🔥

• http://clusterlabs.org/ — go say hi, they're the moment 💖

---

👑 AUTHOR 👑

ClusterLabs contributors (see the resource agent source for information about individual authors). honestly? legends, all of them. 🫶

---

okay that's the whole page, you ate that 💅✨ this was resource-agents version UNKNOWN, dated 10/01/2026, served fresh from the OCF_HEARTBEAT_GALERA(7) girlies. go forth and cluster, bestie 🦋💜