'\" t
.\"     Title: ocf_heartbeat_apache
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 06/07/2017
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.0.0~rc1-4~bpo8+1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_APACHE" "7" "06/07/2017" "resource-agents 4.0.0~rc1-4~bp" "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_apache \- Manages an Apache Web server instance
.SH "SYNOPSIS"
.HP \w'\fBapache\fR\ 'u
\fBapache\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This is the resource agent for the Apache Web server\&. This resource agent operates both version 1\&.x and version 2\&.x Apache servers\&.
.PP
The start operation ends with a loop in which monitor is repeatedly called to make sure that the server started and that it is operational\&. Hence, if the monitor operation does not succeed within the start operation timeout, the apache resource will end with an error status\&.
.PP
The monitor operation by default loads the server status page which depends on the mod_status module and the corresponding configuration file (usually /etc/apache2/mod_status\&.conf)\&. Make sure that the server status page works and that the access is allowed *only* from localhost (address 127\&.0\&.0\&.1)\&. See the statusurl and testregex attributes for more details\&.
.PP
See also http://httpd\&.apache\&.org/
.SH "SUPPORTED PARAMETERS"
.PP
\fBconfigfile\fR
.RS 4
The full pathname of the Apache configuration file\&. This file is parsed to provide defaults for various other resource agent parameters\&.
.sp
(unique, optional, string, default "/etc/httpd/conf/httpd\&.conf")
.RE
.PP
\fBhttpd\fR
.RS 4
The full pathname of the httpd binary (optional)\&.
.sp
(optional, string, default "/usr/sbin/httpd")
.RE
.PP
\fBport\fR
.RS 4
A port number that we can probe for status information using the statusurl\&. This will default to the port number found in the configuration file, or 80, if none can be found in the configuration file\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBstatusurl\fR
.RS 4
The URL to monitor (the apache server status page by default)\&. If left unspecified, it will be inferred from the apache configuration file\&.
.sp
If you set this, make sure that it succeeds *only* from the localhost (127\&.0\&.0\&.1)\&. Otherwise, it may happen that the cluster complains about the resource being active on multiple nodes\&.
.sp
(optional, string, no default)
.RE
.PP
\fBtestregex\fR
.RS 4
Regular expression to match in the output of statusurl\&. Case insensitive\&.
.sp
(optional, string, default "exists, but impossible to show in a human readable format (try grep testregex)")
.RE
.PP
\fBclient\fR
.RS 4
Client to use to query to Apache\&. If not specified, the RA will try to find one on the system\&. Currently, wget and curl are supported\&. For example, you can set this parameter to "curl" if you prefer that to wget\&.
.sp
(optional, string, no default)
.RE
.PP
\fBtesturl\fR
.RS 4
URL to test\&. If it does not start with "http", then it\*(Aqs considered to be relative to the Listen address\&.
.sp
(optional, string, no default)
.RE
.PP
\fBtestregex10\fR
.RS 4
Regular expression to match in the output of testurl\&. Case insensitive\&.
.sp
(optional, string, no default)
.RE
.PP
\fBtestconffile\fR
.RS 4
A file which contains test configuration\&. Could be useful if you have to check more than one web application or in case sensitive info should be passed as arguments (passwords)\&. Furthermore, using a config file is the only way to specify certain parameters\&.
.sp
Please see README\&.webapps for examples and file description\&.
.sp
(optional, string, no default)
.RE
.PP
\fBtestname\fR
.RS 4
Name of the test within the test configuration file\&.
.sp
(optional, string, no default)
.RE
.PP
\fBoptions\fR
.RS 4
Extra options to apply when starting apache\&. See man httpd(8)\&.
.sp
(optional, string, no default)
.RE
.PP
\fBenvfiles\fR
.RS 4
Files (one or more) which contain extra environment variables\&. If you want to prevent script from reading the default file, set this parameter to empty string\&.
.sp
(optional, string, default "/etc/apache2/envvars")
.RE
.PP
\fBuse_ipv6\fR
.RS 4
We will try to detect if the URL (for monitor) is IPv6, but if that doesn\*(Aqt work set this to true to enforce IPv6\&.
.sp
(optional, boolean, default
false)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 40s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 60s\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 30s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 10\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a apache resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_apache ocf:heartbeat:apache \e
  op monitor depth="0" timeout="20s" interval="10" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a apache resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_apache ocf:heartbeat:apache \e
  op monitor depth="0" timeout="20s" interval="10" 
.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