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

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

98       The following is an example configuration for a Squid resource using
99       the crm(8) shell:
100
101           primitive p_Squid ocf:heartbeat:Squid \
102             params \
103               squid_exe=string \
104               squid_conf=string \
105               squid_port=integer \
106             op monitor depth="0" timeout="30s" interval="10s"
107

EXAMPLE PCS

109       The following is an example configuration for a Squid resource using
110       pcs(8)
111
112           pcs resource create p_Squid ocf:heartbeat:Squid \
113             squid_exe=string \
114             squid_conf=string \
115             squid_port=integer \
116             op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="10s"
117

AUTHOR

122       ClusterLabs contributors (see the resource agent source for information
123       about individual authors)
124
125
126
127resource-agents UNKNOWN           01/25/2023            OCF_HEARTBEAT_SQUID(7)