OCF_HEARTBEAT_SPHINX(7)

📦
version 4.18.0 · 14 versions
, in fedora 43, fedora 44

✨ OCF_HEARTBEAT_SPHINX(7) ✨

okay bestie, welcome to the OCF resource agents section of the man pages 💖 this one's about OCF_HEARTBEAT_SPHINX — and no, it's not about pyramids or riddle-guarding cats, it's about the Sphinx search daemon. sit with me, we're gonna get you fluent fr fr 🦋

🎀 NAME 🎀

ocf_heartbeat_SphinxSearchDaemon — she manages the Sphinx search daemon. that's the whole job description and she does it flawlessly, periodt 💅

🌸 SYNOPSIS 🌸

SphinxSearchDaemon [start | stop | monitor | meta-data | validate-all]

look at her. five little actions. so demure, so mindful 🎀

💖 DESCRIPTION 💖

okay so real talk: this is a searchd Resource Agent. its whole entire vibe is managing the Sphinx Search Daemon. that's it, that's the arc, and honestly? iconic. 👑

✨ SUPPORTED PARAMETERS ✨

these are the little knobs you can turn. every single one of them matters, don't skip any 🫶

  • config — the searchd configuration file. this one is unique (only one of her, she's the main character), it's optional, it's a string, and the default is "/etc/sphinx/sphinx.conf".
  • searchd — the searchd binary itself. optional, a string, default "/usr/local/bin/searchd".
  • search — the Search binary, used for functional testing in the monitor action. optional, a string, default "/usr/local/bin/search".
  • testQuery — the test query for functional testing in the monitor action. and listen, this query does not need to match any documents in the index — like, zero matches is fine, she's not here to be popular. the whole point is just to test whether the search daemon is able to query its indices and respond properly. optional, a string, default "Heartbeat_Monitor_Query_Match_string".

💅 SUPPORTED ACTIONS 💅

this resource agent supports the following actions (operations). each one comes with a suggested minimum timeout, so take notes 📝

  • start — starts the resource. suggested minimum timeout: 20s.
  • stop — stops the resource. suggested minimum timeout: 20s.
  • monitor — performs a detailed status check. suggested minimum timeout: 20s. suggested interval: 10s. she's the nosy friend who checks in constantly and honestly we love her for it 🔍
  • meta-data — retrieves resource agent metadata (internal use only). suggested minimum timeout: 5s.
  • validate-all — performs a validation of the resource configuration. suggested minimum timeout: 20s.

🌈 EXAMPLE CRM SHELL 🌈

here's what it looks like to set up a SphinxSearchDaemon resource using the crm(8) shell — copy it, don't freestyle it bestie:

primitive p_SphinxSearchDaemon ocf:heartbeat:SphinxSearchDaemon \
  op monitor timeout="20s" interval="10s" depth="0"

🦋 EXAMPLE PCS 🦋

and here's the same energy but using pcs(8):

pcs resource create p_SphinxSearchDaemon ocf:heartbeat:SphinxSearchDaemon \
  op monitor timeout="20s" interval="10s" OCF_CHECK_LEVEL="0"

two ways, same slay 💖

⭐ SEE ALSO ⭐

go touch some grass and also read this:

👑 AUTHOR 👑

ClusterLabs contributors (see the resource agent source for information about individual authors). a whole team of legends, no cap 🙌

heads up bestie: this page ships with resource-agents version UNKNOWN, dated 04/08/2026, and it lives at OCF_HEARTBEAT_SPHINX(7). mwah, go forth and daemon responsibly 💋✨
📦 where this page comes from