OCF_HEARTBEAT_TOMCAT(7)

💖 ocf_heartbeat_tomcat — the manual, but make it cute 💖

okay bestie, you're holding OCF_HEARTBEAT_TOMCAT(7) and honestly? it's giving "cluster resource but make it servlet energy" 🫶. Sit down, grab a strawberry drink 🍓, and let's get into it.

---

✨ NAME ✨

ocf_heartbeat_tomcat — manages a Tomcat servlet environment instance. yes, that Tomcat. the Java one. the icon 👑

---

🌸 SYNOPSIS 🌸

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

---

🦋 DESCRIPTION 🦋

So basically: this is a resource script for Tomcat 💅. It manages a Tomcat instance as a cluster resource. That's it, that's the whole vibe. Your cluster babysits Tomcat now, no cap.

---

🎀 SUPPORTED PARAMETERS 🎀

This is the main character section, fr fr. Every single knob you can turn:

• tomcat_name — the name of the resource, added as a Java parameter in JAVA_OPTS:

-Dname=<tomcat_name>

to the Tomcat process on start. It's used to make sure the process is still running, and it must be unique. (unique, optional, string, default "tomcat")

• script_log — the log file, used during start and stop operations. (unique, optional, string, default "/var/log/tomcat.log")
• tomcat_stop_timeout — time-out for the stop operation. DEPRECATED, bestie, don't build your life around it. (optional, integer, no default)
• tomcat_suspend_trialcount — maximum number of times to retry the stop operation before suspending and killing Tomcat. DEPRECATED. And lowkey it does not retry. (optional, integer, no default)
• tomcat_user — the user who starts Tomcat. (optional, string, default "root")
• statusurl — URL for state confirmation. (optional, string, default "http://127.0.0.1:8080")
• max_stop_time — 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 the stop operation. When it is over this value, it stops a process in kill commands. Heads up: this parameter is only effective on Tomcat 6 or later. (optional, integer, no default)
• java_home — home directory of Java. required, so like, you gotta. (required, string, no default)
• java_opts — Java JVM options used on start and stop. (optional, string, no default)
• catalina_home — home directory of Tomcat. also required 🫶 (required, string, no default)
• catalina_base — instance directory of Tomcat. (unique, optional, string, no default)
• catalina_out — log file name of Tomcat. (unique, optional, string, default "/logs/catalina.out")
• catalina_pid — a PID file name for Tomcat. (unique, optional, string, no default)
• force_systemd — force use of systemd when available. (optional, string, default "1")
• tomcat_start_script — absolute path to the custom tomcat start script to use. (optional, string, no default)
• tomcat_start_opts — Tomcat start options. (optional, string, no default)
• catalina_opts — Catalina options, for the start operation only. (optional, string, no default)
• catalina_tmpdir — temporary directory of Tomcat. (unique, optional, string, no default)
• catalina_rotate_log — rotate catalina.out flag. (optional, boolean, default NO)
• catalina_rotatetime — catalina.out rotation interval (seconds). (optional, integer, default 86400)
• java_endorsed_dirs — Java_endorsed_dirs of tomcat. (unique, optional, string, no default)
• logging_config — Logging_config of tomcat. (unique, optional, string, no default)
• logging_manager — Logging_manager of tomcat. (unique, optional, string, no default)

---

⭐ SUPPORTED ACTIONS ⭐

This resource agent supports the following actions (operations), and yes every one of them is doing the lord's work:

1. start — starts the resource. Suggested minimum timeout: 60s.
2. stop — stops the resource. Suggested minimum timeout: 120s.
3. status — performs a status check. Suggested minimum timeout: 60s.
4. monitor — performs a detailed status check. Suggested minimum timeout: 30s. Suggested interval: 10s.
5. meta-data — retrieves resource agent metadata (internal use only 🔒). Suggested minimum timeout: 5s.
6. validate-all — performs a validation of the resource configuration. Suggested minimum timeout: 5s.

---

🌈 EXAMPLE CRM SHELL 🌈

Here's what it looks like to set up a tomcat resource using the crm(8) shell:

primitive p_tomcat ocf:heartbeat:tomcat \
  params \
    java_home=string \
    catalina_home=string \
  op monitor depth="0" timeout="30s" interval="10s"

---

💜 EXAMPLE PCS 💜

And the same energy, but with pcs(8):

pcs resource create p_tomcat ocf:heartbeat:tomcat \
  java_home=string \
  catalina_home=string \
  op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="10s"

---

👑 SEE ALSO 👑

http://clusterlabs.org/ — go say hi, they're iconic.

---

💌 AUTHOR 💌

ClusterLabs contributors (see the resource agent source for information about individual authors). absolute legends, every one of them 🫶

---

and that's the whole page, bestie! this was resource-agents UNKNOWN (yes, the version is literally "UNKNOWN", we don't talk about it 💀), dated 04/08/2026, and it lives at OCF_HEARTBEAT_TOMCAT(7). slay, go manage that servlet ✨🎀