ocf_heartbeat_tomcat(7)

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

NAME

6       ocf_heartbeat_tomcat - Manages a Tomcat servlet environment instance
7

SYNOPSIS

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

DESCRIPTION

12       Resource script for Tomcat. It manages a Tomcat instance as a cluster
13       resource.
14

SUPPORTED PARAMETERS

16       tomcat_name
17           The name of the resource, added as a Java parameter in JAVA_OPTS:
18
19           -Dname=<tomcat_name> to Tomcat process on start. Used to ensure
20           process is still running and must be unique.
21
22           (unique, optional, string, no default)
23
24       script_log
25           Log file, used during start and stop operations.
26
27           (unique, optional, string, no default)
28
29       tomcat_stop_timeout
30           Time-out for stop operation. DEPRECATED
31
32           (optional, integer, no default)
33
34       tomcat_suspend_trialcount
35           Maximum number of times to retry stop operation before suspending
36           and killing Tomcat. DEPRECATED. Does not retry.
37
38           (optional, integer, no default)
39
40       tomcat_user
41           The user who starts Tomcat.
42
43           (optional, string, default "root")
44
45       statusurl
46           URL for state confirmation.
47
48           (optional, string, no default)
49
50       max_stop_time
51           Number of seconds to wait during a stop before drastic measures
52           (force kill) are used on the tomcat process. This number MUST be
53           less than your cluster stop timeout for the resource. The default
54           value is five seconds before the timeout value of stop operation.
55           When it is over this value, it stops a process in kill commands.
56           This parameter is only effective on Tomcat 6 or later.
57
58           (optional, integer, no default)
59
60       java_home
61           Home directory of Java.
62
63           (required, string, no default)
64
65       java_opts
66           Java JVM options used on start and stop.
67
68           (optional, string, no default)
69
70       catalina_home
71           Home directory of Tomcat.
72
73           (required, string, no default)
74
75       catalina_base
76           Instance directory of Tomcat
77
78           (unique, optional, string, no default)
79
80       catalina_out
81           Log file name of Tomcat
82
83           (unique, optional, string, no default)
84
85       catalina_pid
86           A PID file name for Tomcat.
87
88           (unique, optional, string, no default)
89
90       tomcat_start_script
91           Absolute path to the custom tomcat start script to use.
92
93           (optional, string, no default)
94
95       tomcat_start_opts
96           Tomcat start options.
97
98           (optional, string, no default)
99
100       catalina_opts
101           Catalina options, for the start operation only.
102
103           (optional, string, no default)
104
105       catalina_tmpdir
106           Temporary directory of Tomcat
107
108           (unique, optional, string, no default)
109
110       catalina_rotate_log
111           Rotate catalina.out flag.
112
113           (optional, boolean, default NO)
114
115       catalina_rotatetime
116           catalina.out rotation interval (seconds).
117
118           (optional, integer, no default)
119
120       java_endorsed_dirs
121           Java_endorsed_dirs of tomcat
122
123           (unique, optional, string, no default)
124
125       logging_config
126           Logging_config of tomcat
127
128           (unique, optional, string, no default)
129
130       logging_manager
131           Logging_manager of tomcat
132
133           (unique, optional, string, no default)
134

SUPPORTED ACTIONS

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

EXAMPLE

160       The following is an example configuration for a tomcat resource using
161       the crm(8) shell:
162
163           primitive p_tomcat ocf:heartbeat:tomcat \
164             params \
165               java_home=string \
166               catalina_home=string \
167             op monitor depth="0" timeout="30s" interval="10s"
168

AUTHOR

173       Linux-HA contributors (see the resource agent source for information
174       about individual authors)
175
176
177
178resource-agents 3.9.2             03/24/2017           OCF_HEARTBEAT_TOMCAT(7)