'\" t
.\"     Title: ocf_heartbeat_tomcat
.\"    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_TOMCAT" "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_tomcat \- Manages a Tomcat servlet environment instance
.SH "SYNOPSIS"
.HP \w'\fBtomcat\fR\ 'u
\fBtomcat\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource script for Tomcat\&. It manages a Tomcat instance as a cluster resource\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBtomcat_name\fR
.RS 4
The name of the resource, added as a Java parameter in JAVA_OPTS:
.sp
\-Dname=<tomcat_name> to Tomcat process on start\&. Used to ensure process is still running and must be unique\&.
.sp
(unique, optional, string, no default)
.RE
.PP
\fBscript_log\fR
.RS 4
Log file, used during start and stop operations\&.
.sp
(unique, optional, string, no default)
.RE
.PP
\fBtomcat_stop_timeout\fR
.RS 4
Time\-out for stop operation\&. DEPRECATED
.sp
(optional, integer, no default)
.RE
.PP
\fBtomcat_suspend_trialcount\fR
.RS 4
Maximum number of times to retry stop operation before suspending and killing Tomcat\&. DEPRECATED\&. Does not retry\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBtomcat_user\fR
.RS 4
The user who starts Tomcat\&.
.sp
(optional, string, default "root")
.RE
.PP
\fBstatusurl\fR
.RS 4
URL for state confirmation\&.
.sp
(optional, string, no default)
.RE
.PP
\fBmax_stop_time\fR
.RS 4
Number of seconds to wait during a stop before drastic measures (force kill) are used on the tomcat process\&. This number MUST be less than your cluster stop timeout for the resource\&. The default value is five seconds before the timeout value of stop operation\&. When it is over this value, it stops a process in kill commands\&. This parameter is only effective on Tomcat 6 or later\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBjava_home\fR
.RS 4
Home directory of Java\&.
.sp
(required, string, no default)
.RE
.PP
\fBjava_opts\fR
.RS 4
Java JVM options used on start and stop\&.
.sp
(optional, string, no default)
.RE
.PP
\fBcatalina_home\fR
.RS 4
Home directory of Tomcat\&.
.sp
(required, string, no default)
.RE
.PP
\fBcatalina_base\fR
.RS 4
Instance directory of Tomcat
.sp
(unique, optional, string, no default)
.RE
.PP
\fBcatalina_out\fR
.RS 4
Log file name of Tomcat
.sp
(unique, optional, string, no default)
.RE
.PP
\fBcatalina_pid\fR
.RS 4
A PID file name for Tomcat\&.
.sp
(unique, optional, string, no default)
.RE
.PP
\fBforce_systemd\fR
.RS 4
Force use of systemd when available\&.
.sp
(optional, string, default "0")
.RE
.PP
\fBtomcat_start_script\fR
.RS 4
Absolute path to the custom tomcat start script to use\&.
.sp
(optional, string, no default)
.RE
.PP
\fBtomcat_start_opts\fR
.RS 4
Tomcat start options\&.
.sp
(optional, string, no default)
.RE
.PP
\fBcatalina_opts\fR
.RS 4
Catalina options, for the start operation only\&.
.sp
(optional, string, no default)
.RE
.PP
\fBcatalina_tmpdir\fR
.RS 4
Temporary directory of Tomcat
.sp
(unique, optional, string, no default)
.RE
.PP
\fBcatalina_rotate_log\fR
.RS 4
Rotate catalina\&.out flag\&.
.sp
(optional, boolean, default
NO)
.RE
.PP
\fBcatalina_rotatetime\fR
.RS 4
catalina\&.out rotation interval (seconds)\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBjava_endorsed_dirs\fR
.RS 4
Java_endorsed_dirs of tomcat
.sp
(unique, optional, string, no default)
.RE
.PP
\fBlogging_config\fR
.RS 4
Logging_config of tomcat
.sp
(unique, optional, string, no default)
.RE
.PP
\fBlogging_manager\fR
.RS 4
Logging_manager of tomcat
.sp
(unique, optional, string, no default)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 60s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 120s\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 60\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 30s\&. Suggested interval: 10s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.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 tomcat resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_tomcat ocf:heartbeat:tomcat \e
  params \e
    java_home=\fIstring\fR \e
    catalina_home=\fIstring\fR \e
  op monitor depth="0" timeout="30s" interval="10s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a tomcat resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_tomcat ocf:heartbeat:tomcat \e
  java_home=\fIstring\fR \e
  catalina_home=\fIstring\fR \e
  op monitor depth="0" timeout="30s" interval="10s" 
.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