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, default "tomcat")
23
24       script_log
25           Log file, used during start and stop operations.
26
27           (unique, optional, string, default "/var/log/tomcat.log")
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, default "http://127.0.0.1:8080")
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, default "/logs/catalina.out")
84
85       catalina_pid
86           A PID file name for Tomcat.
87
88           (unique, optional, string, no default)
89
90       force_systemd
91           Force use of systemd when available.
92
93           (optional, string, default "1")
94
95       tomcat_start_script
96           Absolute path to the custom tomcat start script to use.
97
98           (optional, string, no default)
99
100       tomcat_start_opts
101           Tomcat start options.
102
103           (optional, string, no default)
104
105       catalina_opts
106           Catalina options, for the start operation only.
107
108           (optional, string, no default)
109
110       catalina_tmpdir
111           Temporary directory of Tomcat
112
113           (unique, optional, string, no default)
114
115       catalina_rotate_log
116           Rotate catalina.out flag.
117
118           (optional, boolean, default NO)
119
120       catalina_rotatetime
121           catalina.out rotation interval (seconds).
122
123           (optional, integer, default 86400)
124
125       java_endorsed_dirs
126           Java_endorsed_dirs of tomcat
127
128           (unique, optional, string, no default)
129
130       logging_config
131           Logging_config of tomcat
132
133           (unique, optional, string, no default)
134
135       logging_manager
136           Logging_manager of tomcat
137
138           (unique, optional, string, no default)
139

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

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

EXAMPLE PCS

175       The following is an example configuration for a tomcat resource using
176       pcs(8)
177
178           pcs resource create p_tomcat ocf:heartbeat:tomcat \
179             java_home=string \
180             catalina_home=string \
181             op monitor depth="0" timeout="30s" interval="10s"
182

AUTHOR

187       ClusterLabs contributors (see the resource agent source for information
188       about individual authors)
189
190
191
192resource-agents UNKNOWN           03/09/2020           OCF_HEARTBEAT_TOMCAT(7)