ocf_heartbeat_apache(7)

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

NAME

6       ocf_heartbeat_apache - Manages an Apache Web server instance
7

SYNOPSIS

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

DESCRIPTION

12       This is the resource agent for the Apache Web server. This resource
13       agent operates both version 1.x and version 2.x Apache servers.
14
15       The start operation ends with a loop in which monitor is repeatedly
16       called to make sure that the server started and that it is operational.
17       Hence, if the monitor operation does not succeed within the start
18       operation timeout, the apache resource will end with an error status.
19
20       The monitor operation by default loads the server status page which
21       depends on the mod_status module and the corresponding configuration
22       file (usually /etc/apache2/mod_status.conf). Make sure that the server
23       status page works and that the access is allowed *only* from localhost
24       (address 127.0.0.1). See the statusurl and testregex attributes for
25       more details.
26
27       See also http://httpd.apache.org/
28

SUPPORTED PARAMETERS

30       configfile
31           The full pathname of the Apache configuration file. This file is
32           parsed to provide defaults for various other resource agent
33           parameters.
34
35           (unique, optional, string, default "/etc/httpd/conf/httpd.conf")
36
37       httpd
38           The full pathname of the httpd binary (optional).
39
40           (optional, string, default "/usr/sbin/httpd")
41
42       port
43           A port number that we can probe for status information using the
44           statusurl. This will default to the port number found in the
45           configuration file, or 80, if none can be found in the
46           configuration file.
47
48           (optional, integer, no default)
49
50       statusurl
51           The URL to monitor (the apache server status page by default). If
52           left unspecified, it will be inferred from the apache configuration
53           file.
54
55           If you set this, make sure that it succeeds *only* from the
56           localhost (127.0.0.1). Otherwise, it may happen that the cluster
57           complains about the resource being active on multiple nodes.
58
59           (optional, string, no default)
60
61       testregex
62           Regular expression to match in the output of statusurl. Case
63           insensitive.
64
65           (optional, string, default "exists, but impossible to show in a
66           human readable format (try grep testregex)")
67
68       client
69           Client to use to query to Apache. If not specified, the RA will try
70           to find one on the system. Currently, wget and curl are supported.
71           For example, you can set this parameter to "curl" if you prefer
72           that to wget.
73
74           (optional, string, no default)
75
76       testurl
77           URL to test. If it does not start with "http", then it's considered
78           to be relative to the Listen address.
79
80           (optional, string, no default)
81
82       testregex10
83           Regular expression to match in the output of testurl. Case
84           insensitive.
85
86           (optional, string, no default)
87
88       testconffile
89           A file which contains test configuration. Could be useful if you
90           have to check more than one web application or in case sensitive
91           info should be passed as arguments (passwords). Furthermore, using
92           a config file is the only way to specify certain parameters.
93
94           Please see README.webapps for examples and file description.
95
96           (optional, string, no default)
97
98       testname
99           Name of the test within the test configuration file.
100
101           (optional, string, no default)
102
103       options
104           Extra options to apply when starting apache. See man httpd(8).
105
106           (optional, string, no default)
107
108       envfiles
109           Files (one or more) which contain extra environment variables. If
110           you want to prevent script from reading the default file, set this
111           parameter to empty string.
112
113           (optional, string, default "/etc/apache2/envvars")
114
115       use_ipv6
116           We will try to detect if the URL (for monitor) is IPv6, but if that
117           doesn't work set this to true to enforce IPv6.
118
119           (optional, boolean, default false)
120

SUPPORTED ACTIONS

122       This resource agent supports the following actions (operations):
123
124       start
125           Starts the resource. Suggested minimum timeout: 40s.
126
127       stop
128           Stops the resource. Suggested minimum timeout: 60s.
129
130       status
131           Performs a status check. Suggested minimum timeout: 30s.
132
133       monitor
134           Performs a detailed status check. Suggested minimum timeout: 20s.
135           Suggested interval: 10s.
136
137       meta-data
138           Retrieves resource agent metadata (internal use only). Suggested
139           minimum timeout: 5s.
140
141       validate-all
142           Performs a validation of the resource configuration. Suggested
143           minimum timeout: 5s.
144

EXAMPLE CRM SHELL

146       The following is an example configuration for a apache resource using
147       the crm(8) shell:
148
149           primitive p_apache ocf:heartbeat:apache \
150             op monitor depth="0" timeout="20s" interval="10s"
151

EXAMPLE PCS

153       The following is an example configuration for a apache resource using
154       pcs(8)
155
156           pcs resource create p_apache ocf:heartbeat:apache \
157             op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s"
158

AUTHOR

163       ClusterLabs contributors (see the resource agent source for information
164       about individual authors)
165
166
167
168resource-agents UNKNOWN           03/25/2021           OCF_HEARTBEAT_APACHE(7)