OCF_HEARTBEAT_PGSQLMS(7)

📦
version 2.3.0 · 3 versions
, in debian trixie, ubuntu noble, ubuntu questing

💅 OCF_HEARTBEAT_PGSQLMS(7) — ok so bestie, let's talk about ocf_heartbeat_pgsqlms

It lives in the OCF resource agents manual, and honestly? It's the moment.

✨ NAME ✨

ocf_heartbeat_pgsqlms — a PostgreSQL multi-state resource agent for Pacemaker. Periodt.

🦋 SYNOPSIS 🦋

pgsqlms [start | stop | monitor | promote | demote | notify | reload |
methods | meta-data | validate-all]

That's it, that's the whole vibe check.

🌸 DESCRIPTION 🌸

So basically: this is a resource script for PostgreSQL in replication. It manages PostgreSQL servers using streaming replication as an HA resource. The way it just... handles your failover?? Iconic. No cap.

💖 SUPPORTED PARAMETERS 💖

All of these are optional unless the vibes say otherwise. Let's get into it.

  • pgdata — where your instance's PGDATA actually lives. (optional, string, default "/var/lib/pgsql/data")
  • pghost — the socket directory or IP address you use to connect to the local instance. (optional, string, default "/var/run/postgresql")
  • pgport — the port for connecting to the local instance. (optional, integer, default "5432")
  • bindir — where the PostgreSQL binaries are chilling. (optional, string, default "/usr/bin")
  • system_user — the system owner of your instance's process, aka who runs this thing. (optional, string, default "postgres")
  • recovery_template — ONLY for PostgreSQL 11 and bellow. This is the local template that gets copied as the "PGDATA/recovery.conf" file, and this template file must exist on all nodes. And like... with PostgreSQL 12 and higher? The cluster will straight up refuse to start if this parameter is set or if a template file is found. So don't be messy. (optional, string, default "$PGDATA/recovery.conf.pcmk")
  • maxlag — the maximum lag allowed on a standby before we set a negative master score on it. The math is based on the difference between the current xlog location on the master and the write location on the standby. (optional, integer, default "0" disables this feature)
  • datadir — path to the directory set in "data_directory" from your postgresql.conf file. This parameter has the same default as PostgreSQL itself: the value of the "pgdata" parameter. Unless you have a super special PostgreSQL setup and you genuinely understand this parameter, ignore it. fr fr. (optional, string, default to the value of "pgdata")
  • start_opts — extra arguments handed to the postgres process on startup. Peep "postgres --help" for the available options. Super useful when the postgresql.conf file isn't in the data directory (PGDATA), eg.:
-c config_file=/etc/postgresql/9.3/main/postgresql.conf

(optinal, string, default "")

👑 SUPPORTED ACTIONS 👑

This resource agent supports the following actions (operations):

  • start — starts the resource. Suggested minimum timeout: 60.
  • stop — stops the resource. Suggested minimum timeout: 60.
  • reload — Suggested minimum timeout: 20.
  • promote — promotes the resource to the Master role. Suggested minimum timeout: 30.
  • demote — demotes the resource to the Slave role. Suggested minimum timeout: 120.
  • monitor (Master role) — performs a detailed status check. Suggested minimum timeout: 10. Suggested interval: 15.
  • monitor (Slave role) — performs a detailed status check. Suggested minimum timeout: 10. Suggested interval: 16.
  • notify — Suggested minimum timeout: 60
  • meta-data — retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5.
  • methods — Suggested minimum timeout: 5.
  • validate-all — performs a validation of the resource configuration. Suggested minimum timeout: 5.

🎀 EXAMPLE CRM SHELL 🎀

Here's an example config for a pgsqlms resource using the crm(8) shell, and yes it's a whole meal:

primitive pgsqld pgsqlms                                                 \
  params pgdata="/var/lib/postgresql/9.6/main"                           \
    bindir="/usr/lib/postgresql/9.6/bin"                                 \
    pghost="/var/run/postgresql"                                         \
    recovery_template="/etc/postgresql/9.6/main/recovery.conf.pcmk"      \
    start_opts="-c config_file=/etc/postgresql/9.6/main/postgresql.conf" \
  op start timeout=60s                                                   \
  op stop timeout=60s                                                    \
  op promote timeout=30s                                                 \
  op demote timeout=120s                                                 \
  op monitor interval=15s timeout=10s role="Master"                      \
  op monitor interval=16s timeout=10s role="Slave"                       \
  op notify timeout=60s

ms pgsql-ha pgsqld meta notify=true

🧚 EXAMPLE PCS 🧚

And here's the same energy with pcs(8):

pcs resource create pgsqld ocf:heartbeat:pgsqlms            \
  bindir=/usr/pgsql-9.6/bin pgdata=/var/lib/pgsql/9.6/data  \
  op start timeout=60s                                      \
  op stop timeout=60s                                       \
  op promote timeout=30s                                    \
  op demote timeout=120s                                    \
  op monitor interval=15s timeout=10s role="Master"         \
  op monitor interval=16s timeout=10s role="Slave"          \
  op notify timeout=60s --master notify=true

🔥 SEE ALSO 🔥

💜 AUTHOR 💜

Jehan-Guillaume de Rorthais and Mael Rimbault. Legends, honestly. 🫶

ok that's the whole page, you ate that 🍓 go configure something beautiful 💅

Version 2.3.0 — dated 2024-03-18 — from the OCF resource agents manual. Mwah. 💖

📦 where this page comes from