ocf_heartbeat_varnish(7)

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

NAME

6       ocf_heartbeat_varnish - Manage a Varnish instance
7

SYNOPSIS

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

DESCRIPTION

12       The Varnish Resource Agent can manage several varnishd instances
13       throughout the cluster. It does so by creating a unique PID file and
14       requires a unique listen address and name for each instance.
15

SUPPORTED PARAMETERS

17       config
18           The VCL configuration file that Varnish should manage, for example
19           "/etc/varnish/default.vcl".
20
21           (unique, required, string, no default)
22
23       name
24           Override the name of the instance that should be given to Varnish
25           (defaults to the resource identifier).
26
27           (unique, optional, string, default "RESOURCE_ID")
28
29       pid
30           Write the process's PID to the specified file. The default will
31           include the specified name, i.e.:
32           "/var/run/varnish_production.pid". Unlike what this help message
33           shows, it is most likely not necessary to change this parameter.
34
35           (unique, optional, string, default
36           "/var/run/varnishd_RESOURCE_ID.pid")
37
38       listen_address
39           Listen on this address:port, for example "192.168.1.1:80"
40
41           (unique, optional, string, default "0.0.0.0:80")
42
43       mgmt_address
44           Provide a management interface, for example "127.0.0.1:2222"
45
46           (unique, required, string, no default)
47
48       ttl
49           Specify a hard minimum time to live for cached documents.
50
51           (optional, integer, default 600)
52
53       varnish_user
54           Specify the name of an unprivileged user to which the child process
55           should switch before it starts accepting connections.
56
57           (optional, string, default "varnish")
58
59       varnish_group
60           Specify the name of an unprivileged group to which the child
61           process should switch before it starts accepting connections.
62
63           (optional, string, default "varnish")
64
65       backend_type
66           Use the specified storage backend. Valid options are 'malloc' for
67           memory and 'file' for a file backend.
68
69           (optional, string, default "malloc")
70
71       backend_size
72           Specify the size of the backend. For example "1G".
73
74           (optional, string, default "1G")
75
76       backend_file
77           Specify the backend filename if you use backend_type file. For
78           example /var/lib/varnish/mybackend.bin
79
80           (unique, optional, string, default
81           "/var/lib/varnish/RESOURCE_ID.bin")
82
83       threads_pools
84           Number of worker thread pools. Each pool has the minimum, maximum
85           and timeout values configured in the thread_pool_min,
86           thread_pool_max and thread_pool_timeout parameters
87
88           (optional, string, default "2")
89
90       thread_pool_min
91           Start at least min but no more than max worker threads with the
92           specified idle timeout in each pool.
93
94           (optional, string, default "100")
95
96       thread_pool_max
97           Start at least min but no more than max worker threads with the
98           specified idle timeout in each pool.
99
100           (optional, string, default "3000")
101
102       thread_pool_timeout
103           Start at least min but no more than max worker threads with the
104           specified idle timeout in each pool.
105
106           (optional, string, default "120")
107
108       client_binary
109           This is used to control Varnish via a CLI. It's currently only used
110           to check the status of the running child process.
111
112           (optional, string, default "varnishadm")
113
114       maxfiles
115           Maximum number of open files (for ulimit -n)
116
117           (optional, string, default "131072")
118
119       max_locked_memory
120           Locked shared memory limit (for ulimit -l)
121
122           (optional, string, default "82000")
123
124       secret
125           Path to a file containing a secret used for authorizing access to
126           the management port.
127
128           (optional, string, default "/etc/varnish/secret")
129

SUPPORTED ACTIONS

131       This resource agent supports the following actions (operations):
132
133       start
134           Starts the resource. Suggested minimum timeout: 20s.
135
136       stop
137           Stops the resource. Suggested minimum timeout: 20s.
138
139       monitor
140           Performs a detailed status check. Suggested minimum timeout: 20s.
141           Suggested interval: 10s.
142
143       status
144           Performs a status check. Suggested minimum timeout: 20s.
145
146       meta-data
147           Retrieves resource agent metadata (internal use only). Suggested
148           minimum timeout: 5s.
149
150       validate-all
151           Performs a validation of the resource configuration. Suggested
152           minimum timeout: 20s.
153

EXAMPLE CRM SHELL

155       The following is an example configuration for a varnish resource using
156       the crm(8) shell:
157
158           primitive p_varnish ocf:heartbeat:varnish \
159             params \
160               config=string \
161               mgmt_address=string \
162             op monitor timeout="20s" interval="10s" depth="0"
163

EXAMPLE PCS

165       The following is an example configuration for a varnish resource using
166       pcs(8)
167
168           pcs resource create p_varnish ocf:heartbeat:varnish \
169             config=string \
170             mgmt_address=string \
171             op monitor timeout="20s" interval="10s" OCF_CHECK_LEVEL="0"
172

AUTHOR

177       ClusterLabs contributors (see the resource agent source for information
178       about individual authors)
179
180
181
182resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_VARNIS(7)