'\" t
.\"     Title: ocf_heartbeat_Squid
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/13/2024
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.13.0-1+b1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_SQUID" "7" "03/13/2024" "resource-agents 4.13.0-1+b1" "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_Squid \- Manages a Squid proxy server instance
.SH "SYNOPSIS"
.HP \w'\fBSquid\fR\ 'u
\fBSquid\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
The resource agent of Squid\&. This manages a Squid instance as an HA resource\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBsquid_exe\fR
.RS 4
This is a required parameter\&. This parameter specifies squid\*(Aqs executable file\&.
.sp
(required, string, no default)
.RE
.PP
\fBsquid_conf\fR
.RS 4
This is a required parameter\&. This parameter specifies a configuration file for a squid instance managed by this RA\&.
.sp
(unique, required, string, no default)
.RE
.PP
\fBsquid_opts\fR
.RS 4
This is a optional parameter\&. This parameter specifies the start options\&.
.sp
(optional, string, no default)
.RE
.PP
\fBsquid_pidfile\fR
.RS 4
Deprecated \- do not use anymore
.sp
(unique, optional, string, no default)
.RE
.PP
\fBsquid_port\fR
.RS 4
This is a required parameter\&. This parameter specifies a port number for a squid instance managed by this RA\&. If multiple ports are used, you must specify only one of them\&.
.sp
(unique, required, integer, no default)
.RE
.PP
\fBsquid_stop_timeout\fR
.RS 4
On stop, a squid shutdown is invoked first\&. If the resource doesn\*(Aqt stop within this timeout, we resort to stopping processes by sending signals and finally KILLing them\&.
.sp
(optional, integer, default
10)
.RE
.PP
\fBdebug_mode\fR
.RS 4
This is an optional parameter\&. This RA runs in debug mode when this parameter includes \*(Aqx\*(Aq or \*(Aqv\*(Aq\&. If \*(Aqx\*(Aq is included, both of STDOUT and STDERR redirect to the logfile specified by "debug_log", and then the builtin shell option \*(Aqx\*(Aq is turned on\&. It is similar about \*(Aqv\*(Aq\&.
.sp
(optional, string, no default)
.RE
.PP
\fBdebug_log\fR
.RS 4
This is an optional parameter\&. This parameter specifies a destination file for debug logs and works only if this RA run in debug mode\&. Refer to "debug_mode" about debug mode\&. If no value is given but is required, it\*(Aqs constructed according to the following rules: "/var/log/" as a directory part, the basename of the configuration file given by "syslog_ng_conf" as a basename part, "\&.log" as a suffix\&.
.sp
(optional, string, no default)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 60s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 120s\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 60s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 30s\&. Suggested interval: 10s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a Squid resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_Squid ocf:heartbeat:Squid \e
  params \e
    squid_exe=\fIstring\fR \e
    squid_conf=\fIstring\fR \e
    squid_port=\fIinteger\fR \e
  op monitor depth="0" timeout="30s" interval="10s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a Squid resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_Squid ocf:heartbeat:Squid \e
  squid_exe=\fIstring\fR \e
  squid_conf=\fIstring\fR \e
  squid_port=\fIinteger\fR \e
  op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="10s" 
.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