ocf_heartbeat_jboss(7)

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

NAME

6       ocf_heartbeat_jboss - Manages a JBoss application server instance
7

SYNOPSIS

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

DESCRIPTION

12       Resource script for Jboss. It manages a Jboss instance as an HA
13       resource.
14

SUPPORTED PARAMETERS

16       jboss_version
17           The version of JBoss. Default is 5. The usage of JBoss was greatly
18           changed as of JBoss 6. Specify "6" when you use JBoss 6.
19
20           (optional, integer, default 5)
21
22       resource_name
23           The name of the resource. Defaults to the name of the resource
24           instance.
25
26           (unique, optional, string, default "RESOURCE_ID")
27
28       console
29           A destination of the log of jboss run and shutdown script.
30
31           (unique, optional, string, default "/var/log/RESOURCE_ID.log")
32
33       shutdown_timeout
34           Timeout for jboss bin/shutdown.sh. We wait for this timeout to
35           expire, then send the TERM and QUIT signals. Finally, the KILL
36           signal is used to terminate the jboss process. You should set the
37           timeout for the stop operation to a value bigger than the sum of
38           the timeout parameters. See also kill_timeout.
39
40           (optional, integer, default 5)
41
42       kill_timeout
43           If bin/shutdown.sh doesn't stop the jboss process, then we send it
44           TERM and QUIT signals, intermittently and once a second. After this
45           timeout expires, if the process is still live, we use the KILL
46           signal. See also shutdown_timeout.
47
48           (optional, integer, default 10)
49
50       user
51           A user name to start a JBoss.
52
53           (optional, string, default "root")
54
55       statusurl
56           URL to test in the monitor operation.
57
58           (optional, string, default "http://127.0.0.1:8080")
59
60       java_home
61           Home directory of Java. Defaults to the environment variable
62           JAVA_HOME. If it is not set, then define this parameter.
63
64           (optional, string, no default)
65
66       java_opts
67           Java options.
68
69           (optional, string, no default)
70
71       jboss_home
72           Home directory of Jboss.
73
74           (required, string, no default)
75
76       jboss_base_dir
77           Base directory of JBoss. This parameter is not used in JBoss5.
78
79           (optional, string, no default)
80
81       pstring
82           With this string heartbeat matches for the right process to kill.
83
84           (optional, string, default "java -Dprogram.name=run.sh")
85
86       run_command
87           JBoss start command.
88
89           (optional, string, default "/bin/run.sh")
90
91       run_opts
92           Start options to start Jboss with, defaults are from the
93           Jboss-Doku.
94
95           (optional, string, default "-c default")
96
97       shutdown_opts
98           Stop options to stop Jboss with.
99
100           (optional, string, default "-s 127.0.0.1:1099")
101
102       rotate_consolelog
103           Rotate console log flag.
104
105           (optional, boolean, default false)
106
107       rotate_value
108           Console log rotation value (default is 86400 seconds).
109
110           (optional, integer, default 86400)
111
112       rotate_logsuffix
113           Rotate console log suffix.
114
115           (optional, integer, default .%F)
116

SUPPORTED ACTIONS

118       This resource agent supports the following actions (operations):
119
120       start
121           Starts the resource. Suggested minimum timeout: 60s.
122
123       stop
124           Stops the resource. Suggested minimum timeout: 120s.
125
126       status
127           Performs a status check. Suggested minimum timeout: 30s.
128
129       monitor
130           Performs a detailed status check. Suggested minimum timeout: 30s.
131           Suggested interval: 10s.
132
133       meta-data
134           Retrieves resource agent metadata (internal use only). Suggested
135           minimum timeout: 5s.
136
137       validate-all
138           Performs a validation of the resource configuration. Suggested
139           minimum timeout: 5s.
140

EXAMPLE CRM SHELL

142       The following is an example configuration for a jboss resource using
143       the crm(8) shell:
144
145           primitive p_jboss ocf:heartbeat:jboss \
146             params \
147               jboss_home=string \
148             op monitor depth="0" timeout="30s" interval="10s"
149

EXAMPLE PCS

151       The following is an example configuration for a jboss resource using
152       pcs(8)
153
154           pcs resource create p_jboss ocf:heartbeat:jboss \
155             jboss_home=string \
156             op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="10s"
157

AUTHOR

162       ClusterLabs contributors (see the resource agent source for information
163       about individual authors)
164
165
166
167resource-agents UNKNOWN           03/25/2021            OCF_HEARTBEAT_JBOSS(7)