ocf_heartbeat_Squid(7)

1OCF_HEARTBEAT_SQUID(7)        OCF resource agents       OCF_HEARTBEAT_SQUID(7)
2
3
4

NAME

6       ocf_heartbeat_Squid - Manages a Squid proxy server instance
7

SYNOPSIS

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

DESCRIPTION

12       The resource agent of Squid. This manages a Squid instance as an HA
13       resource.
14

SUPPORTED PARAMETERS

16       squid_exe
17           This is a required parameter. This parameter specifies squid's
18           executable file.
19
20           (required, string, no default)
21
22       squid_conf
23           This is a required parameter. This parameter specifies a
24           configuration file for a squid instance managed by this RA.
25
26           (unique, required, string, no default)
27
28       squid_pidfile
29           Deprecated - do not use anymore
30
31           (unique, optional, string, no default)
32
33       squid_port
34           This is a required parameter. This parameter specifies a port
35           number for a squid instance managed by this RA. If multiple ports
36           are used, you must specify only one of them.
37
38           (unique, required, integer, no default)
39
40       squid_stop_timeout
41           On stop, a squid shutdown is invoked first. If the resource doesn't
42           stop within this timeout, we resort to stopping processes by
43           sending signals and finally KILLing them.
44
45           (optional, integer, default 10)
46
47       debug_mode
48           This is an optional parameter. This RA runs in debug mode when this
49           parameter includes 'x' or 'v'. If 'x' is included, both of STDOUT
50           and STDERR redirect to the logfile specified by "debug_log", and
51           then the builtin shell option 'x' is turned on. It is similar about
52           'v'.
53
54           (optional, string, no default)
55
56       debug_log
57           This is an optional parameter. This parameter specifies a
58           destination file for debug logs and works only if this RA run in
59           debug mode. Refer to "debug_mode" about debug mode. If no value is
60           given but is required, it's constructed according to the following
61           rules: "/var/log/" as a directory part, the basename of the
62           configuration file given by "syslog_ng_conf" as a basename part,
63           ".log" as a suffix.
64
65           (optional, string, no default)
66

SUPPORTED ACTIONS

68       This resource agent supports the following actions (operations):
69
70       start
71           Starts the resource. Suggested minimum timeout: 60s.
72
73       stop
74           Stops the resource. Suggested minimum timeout: 120s.
75
76       status
77           Performs a status check. Suggested minimum timeout: 60s.
78
79       monitor
80           Performs a detailed status check. Suggested minimum timeout: 30s.
81           Suggested interval: 10s.
82
83       meta-data
84           Retrieves resource agent metadata (internal use only). Suggested
85           minimum timeout: 5s.
86
87       validate-all
88           Performs a validation of the resource configuration. Suggested
89           minimum timeout: 5s.
90

EXAMPLE CRM SHELL

92       The following is an example configuration for a Squid resource using
93       the crm(8) shell:
94
95           primitive p_Squid ocf:heartbeat:Squid \
96             params \
97               squid_exe=string \
98               squid_conf=string \
99               squid_port=integer \
100             op monitor depth="0" timeout="30s" interval="10s"
101

EXAMPLE PCS

103       The following is an example configuration for a Squid resource using
104       pcs(8)
105
106           pcs resource create p_Squid ocf:heartbeat:Squid \
107             squid_exe=string \
108             squid_conf=string \
109             squid_port=integer \
110             op monitor depth="0" timeout="30s" interval="10s"
111

AUTHOR

116       ClusterLabs contributors (see the resource agent source for information
117       about individual authors)
118
119
120
121resource-agents UNKNOWN           03/09/2020            OCF_HEARTBEAT_SQUID(7)