OCF_HEARTBEAT_SQUID(7)

✨ OCF_HEARTBEAT_SQUID ✨

Bestie, listen up 💅 — this is the manual page for ocf_heartbeat_Squid, a resource agent (that's "RA" if you're in the club 😌) that manages a Squid proxy server instance. It's living in the ocf:heartbeat world, so like, cluster vibes only. 🦋

---

🎀 SYNOPSIS 🎀

Here's the whole entire mood of how you call this thing:

Squid [start | stop | status | monitor | meta-data | validate-all]

Yep. Those are your moves. Slay. 💅

---

🌸 DESCRIPTION 🌸

Okay so this is the resource agent of Squid ✨ — and what it literally does is manage a Squid instance as an HA (high availability) resource. That's it. That's the whole assignment. It's giving reliable, it's giving cluster-ready, we love to see it. 💖

---

🦋 SUPPORTED PARAMETERS 🦋

These are the knobs you can turn, bestie. Some are required (aka mandatory, no skipping 🫶), some are optional. Let's gooo:

• squid_exe — This one is required, no cap. It specifies squid's executable file. Type is string, and there's no default — you gotta hand it over yourself. 💅
• squid_conf — Also required (and unique 👀). This specifies a configuration file for a squid instance managed by this RA. Type string, no default. You must bring it.
• squid_opts — This one's optional. It specifies the start options. Type string, no default. A little extra flavor if you want it. ✨
• squid_pidfile — 🚨 Deprecated — do not use anymore. For real. It's unique and optional, type string, no default, but like... don't. Respect the deprecation. 🙈
• squid_port — Required and unique! This specifies a port number for a squid instance managed by this RA. Also integer, no default. Key detail: if multiple ports are used, you must specify only one of them. Just one. Pick your fav. 💖
• squid_stop_timeout — Optional integer, default is 10. Here's the tea: on stop, a squid shutdown is invoked first. If the resource doesn't stop within this timeout, we resort to stopping processes by sending signals and finally KILLing them. 😭 Dramatic but necessary. It's giving tough love.
• debug_mode — Optional, type string, no default. This RA runs in debug mode when this parameter includes 'x' or 'v'. If 'x' is included, both of STDOUT and STDERR redirect to the logfile specified by "debug_log", and then the builtin shell option 'x' is turned on. It's similar about 'v'. 🔥 (Yes, it says "syslog_ng_conf" in the debug_log description below — that's how the original rolls, we don't question the icons. 👑)
• debug_log — Optional, type string, no default. This specifies a destination file for debug logs and works only if this RA runs in debug mode. Refer to "debug_mode" about debug mode. And here's the cute little rule: if no value is given but is required, it's constructed according to these rules — "/var/log/" as a directory part, the basename of the configuration file given by "syslog_ng_conf" as a basename part, and ".log" as a suffix. Iconic auto-magic. ✨

---

👑 SUPPORTED ACTIONS 👑

This resource agent supports the following actions (operations). Each one comes with its suggested minimum timeout, and some even get a suggested interval. Mark your calendars, bestie 🗓️:

• start — Starts the resource. Suggested minimum timeout: 60s. Let's gooo 🚀
• stop — Stops the resource. Suggested minimum timeout: 120s. Big timeout energy, take your time 💅
• status — Performs a status check. Suggested minimum timeout: 60s. Just checking in on you, bb 🫶
• monitor — Performs a detailed status check. Suggested minimum timeout: 30s. Suggested interval: 10s. The main character of health checks 👑
• meta-data — Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s. Don't touch unless you know, iykyk 🌈
• validate-all — Performs a validation of the resource configuration. Suggested minimum timeout: 5s. Self-care check ✅

---

💜 EXAMPLE CRM SHELL 💜

Okay so here's an example configuration for a Squid resource using the crm(8) shell — copy-paste ready, no cap:

primitive p_Squid ocf:heartbeat:Squid \
  params \
    squid_exe=string \
    squid_conf=string \
    squid_port=integer \
  op monitor depth="0" timeout="30s" interval="10s"

Look at that formatting. Gorgeous. 🎀

---

🌈 EXAMPLE PCS 🌈

And here's the same energy but for pcs(8) — different tool, same slay:

pcs resource create p_Squid ocf:heartbeat:Squid \
  squid_exe=string \
  squid_conf=string \
  squid_port=integer \
  op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="10s"

Notice the OCF_CHECK_LEVEL="0" instead of depth="0" — that's the pcs way, bestie. Fr fr. 💅

---

⭐ SEE ALSO ⭐

• http://clusterlabs.org/ — go check it out, it's giving community, it's giving support 🫶

---

💀 AUTHOR 💀

ClusterLabs contributors — and for the deets on individual authors, see the resource agent source. Respect the contributors, they ate and left no crumbs. 👑🔥

---

A little sign-off for you, bestie: this beauty is from resource-agents UNKNOWN, dated 10/01/2026. Take care of her and she'll take care of your Squid. Mwah. 💖🦋✨