ocf_heartbeat_rabbitmq-server-ha(7)

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

NAME

6       ocf_heartbeat_rabbitmq-server-ha - Resource agent for RabbitMQ HA
7       cluster
8

SYNOPSIS

10       rabbitmq-server-ha [start | stop | status | monitor | promote | demote
11                          | meta-data | validate-all]
12

DESCRIPTION

14       Resource agent for RabbitMQ promotes a node, then cluster nodes can
15       join it
16

SUPPORTED PARAMETERS

18       binary
19           RabbitMQ binary
20
21           (optional, string, default "/usr/sbin/rabbitmq-server")
22
23       ctl
24           rabbitctl binary
25
26           (optional, string, default "/usr/sbin/rabbitmqctl")
27
28       pid_file
29           RabbitMQ PID file
30
31           (optional, string, default "/var/run/rabbitmq/pid")
32
33       log_dir
34           RabbitMQ log directory
35
36           (optional, string, default "/var/log/rabbitmq")
37
38       username
39           RabbitMQ user name
40
41           (optional, string, default "rabbitmq")
42
43       groupname
44           RabbitMQ group name
45
46           (optional, string, default "rabbitmq")
47
48       admin_user
49           RabbitMQ default admin user for API
50
51           (optional, string, default "guest")
52
53       admin_password
54           RabbitMQ default admin user password for API
55
56           (optional, string, default "guest")
57
58       definitions_dump_file
59           RabbitMQ default definitions dump file
60
61           (optional, string, default "/etc/rabbitmq/definitions")
62
63       command_timeout
64           Timeout command arguments for issued commands termination (value is
65           auto evaluated)
66
67           (optional, string, no default)
68
69       start_time
70           Timeout for start rabbitmq server
71
72           (optional, string, default "7")
73
74       stop_time
75           Timeout for stopping rabbitmq server
76
77           (optional, string, default "7")
78
79       debug
80           The debug flag for agent (/usr/sbin/rabbitmq-server) instance. In
81           the /tmp/ directory will be created rmq-* files for log some
82           operations and ENV values inside OCF-script.
83
84           (optional, boolean, default false)
85
86       mnesia_base
87           Base directory for storing Mnesia files
88
89           (optional, boolean, default /var/lib/rabbitmq/mnesia)
90
91       mnesia_schema_base
92           Parent directory for Mnesia schema directory
93
94           (optional, string, default "/var/lib/rabbitmq")
95
96       host_ip
97           /usr/sbin/rabbitmq-server should listen on this IP address
98
99           (optional, boolean, default 127.0.0.1)
100
101       node_port
102           /usr/sbin/rabbitmq-server should listen on this port
103
104           (optional, boolean, default 5672)
105
106       default_vhost
107           Default virtual host used for monitoring if a node is fully
108           synchronized with the rest of the cluster. In normal operation, the
109           resource agent will wait for queues from this virtual host on this
110           node to be synchronized elsewhere before stopping RabbitMQ. This
111           also means queues in other virtual hosts may not be fully
112           synchronized on stop operations.
113
114           (optional, string, default "/")
115
116       erlang_cookie
117           Erlang cookie for clustering. If specified, will be updated at the
118           mnesia reset
119
120           (optional, boolean, default false)
121
122       erlang_cookie_file
123           Erlang cookie file path where the cookie will be put, if requested
124
125           (optional, boolean, default /var/lib/rabbitmq/.erlang.cookie)
126
127       use_fqdn
128           Either to use FQDN or a shortname for the rabbitmq node
129
130           (optional, boolean, default false)
131
132       fqdn_prefix
133           Optional FQDN prefix for RabbitMQ nodes in cluster. FQDN prefix can
134           be specified to host multiple RabbitMQ instances on a node or in
135           case of RabbitMQ running in dedicated network/interface.
136
137           (optional, string, no default)
138
139       max_rabbitmqctl_timeouts
140           If during monitor call rabbitmqctl times out, the timeout is
141           ignored unless it is Nth timeout in a row. Here N is the value of
142           the current parameter. If too many timeouts happen in a raw, the
143           monitor call will return with error.
144
145           (optional, string, default "3")
146
147       policy_file
148           A path to the shell script to setup RabbitMQ policies
149
150           (optional, string, default "/usr/local/sbin/set_rabbitmq_policy")
151
152       rmq_feature_health_check
153           Since rabbit 3.6.4 list_queues/list_channels-based monitoring
154           should be replaced with "node_health_check" command, as it creates
155           no network load at all.
156
157           (optional, boolean, default true)
158
159       rmq_feature_local_list_queues
160           For rabbit version that implements --local flag for list_queues,
161           this can greatly reduce network overhead in cases when node is
162           stopped/demoted.
163
164           (optional, boolean, default true)
165
166       limit_nofile
167           Soft and hard limit for NOFILE
168
169           (optional, string, default "65535")
170
171       avoid_using_iptables
172           When set to true the iptables calls to block client access become
173           noops. This is useful when we run inside containers.
174
175           (optional, boolean, default false)
176
177       allowed_cluster_nodes
178           When set to anything other than the empty string it must container
179           the list of cluster node names, separated by spaces, where the
180           rabbitmq resource is allowed to run. Tis is needed when rabbitmq is
181           running on a subset of nodes part of a larger cluster. The default
182           ("") is to assume that all nodes part of the cluster will run the
183           rabbitmq resource.
184
185           (optional, string, no default)
186

SUPPORTED ACTIONS

188       This resource agent supports the following actions (operations):
189
190       start
191           Starts the resource. Suggested minimum timeout: 20s.
192
193       stop
194           Stops the resource. Suggested minimum timeout: 20s.
195
196       status
197           Performs a status check. Suggested minimum timeout: 20s.
198
199       monitor
200           Performs a detailed status check. Suggested minimum timeout: 30s.
201           Suggested interval: 5s.
202
203       monitor (Promoted role)
204           Performs a detailed status check. Suggested minimum timeout: 30s.
205           Suggested interval: 3s.
206
207       promote
208           Promotes the resource to the Master role. Suggested minimum
209           timeout: 30s.
210
211       demote
212           Demotes the resource to the Slave role. Suggested minimum timeout:
213           30s.
214
215       notify
216           Suggested minimum timeout: 20s.
217
218       validate-all
219           Performs a validation of the resource configuration. Suggested
220           minimum timeout: 5s.
221
222       meta-data
223           Retrieves resource agent metadata (internal use only). Suggested
224           minimum timeout: 5s.
225

EXAMPLE CRM SHELL

227       The following is an example configuration for a rabbitmq-server-ha
228       resource using the crm(8) shell:
229
230           primitive p_rabbitmq-server-ha ocf:heartbeat:rabbitmq-server-ha \
231             op monitor depth="0" timeout="30s" interval="5s" \
232             op monitor depth="0" timeout="30s" interval="3s" role="Promoted"
233
234           ms ms_rabbitmq-server-ha p_rabbitmq-server-ha \
235             meta notify="true" interleave="true"
236

EXAMPLE PCS

238       The following is an example configuration for a rabbitmq-server-ha
239       resource using pcs(8)
240
241           pcs resource create p_rabbitmq-server-ha ocf:heartbeat:rabbitmq-server-ha \
242             op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="5s" \
243             op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="3s" role="Promoted" promotable
244

AUTHOR

249       ClusterLabs contributors (see the resource agent source for information
250       about individual authors)
251
252
253
254resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_RABBIT(7)