'\" t
.\"     Title: ocf_heartbeat_SphinxSearchDaemon
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 06/07/2017
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.0.0~rc1-4~bpo8+1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_SPHINX" "7" "06/07/2017" "resource-agents 4.0.0~rc1-4~bp" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_SphinxSearchDaemon \- Manages the Sphinx search daemon\&.
.SH "SYNOPSIS"
.HP \w'\fBSphinxSearchDaemon\fR\ 'u
\fBSphinxSearchDaemon\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This is a searchd Resource Agent\&. It manages the Sphinx Search Daemon\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBconfig\fR
.RS 4
searchd configuration file
.sp
(unique, optional, string, default "/etc/sphinx/sphinx\&.conf")
.RE
.PP
\fBsearchd\fR
.RS 4
searchd binary
.sp
(optional, string, default "/usr/local/bin/searchd")
.RE
.PP
\fBsearch\fR
.RS 4
Search binary for functional testing in the monitor action\&.
.sp
(optional, string, default "/usr/local/bin/search")
.RE
.PP
\fBtestQuery\fR
.RS 4
Test query for functional testing in the monitor action\&. The query does not need to match any documents in the index\&. The purpose is merely to test whether the search daemon is is able to query its indices and respond properly\&.
.sp
(optional, string, default "Heartbeat_Monitor_Query_Match_string")
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20\&. Suggested interval: 10\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 20s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a SphinxSearchDaemon resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_SphinxSearchDaemon ocf:heartbeat:SphinxSearchDaemon \e
  op monitor timeout="20" interval="10" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a SphinxSearchDaemon resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_SphinxSearchDaemon ocf:heartbeat:SphinxSearchDaemon \e
  op monitor timeout="20" interval="10" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR