/
AS7config.xml
386 lines (377 loc) · 13.5 KB
/
AS7config.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
[
<!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="java.AS7config">
<title id="java.AS7config.title">AS7 modcluster subsystem Configuration</title>
<section id="ModClusterSubSystem">
<title>ModCluster Subsystem in JBoss AS7</title>
<para>The mod_cluster integration is done via the modcluster subsystem. In AS7 only 1.1.x is supported.
Addition HA is not supported in AS version 7.0.x but in it will be in version 7.1.x and after.
</para>
</section>
<section id="ModClusterSubSystemMiniConfiguration">
<title>ModCluster Subsystem minimal configuration</title>
<para>The minimal configuration is having the modcluster <code>schemaLocation</code> in the <code>schemaLocation</code> list:
<programlisting>urn:jboss:domain:modcluster:1.0 jboss-mod-cluster.xsd</programlisting>
and the <code>extension module</code> in the <code>extensions</code> list:
<programlisting><extension module="org.jboss.as.modcluster"/></programlisting>
and <code>subsystem</code> declaration like:
<programlisting><subsystem xmlns="urn:jboss:domain:modcluster:1.0"/></programlisting>
With that configuration modcluster will listen for advertise on <code>224.0.1.105:23364</code> use the <code>simple-load-provider</code> with
a load factor of 1.
</para>
</section>
<section id="ModClusterSubSystemConfiguration">
<title>ModCluster Subsystem configuration</title>
<section id="AS7ModClusterConfig">
<title>mod-cluster-config Attributes</title>
<para>The attributs correspond to the <link linkend="java.properties">properties</link>
</para>
<para>Proxy Discovery Configuration</para>
<informaltable frame="all">
<tgroup cols="3">
<thead>
<row>
<entry>Attribute</entry>
<entry>Property</entry>
<entry>Default</entry>
</row>
</thead>
<tbody>
<row>
<entry>proxy-list</entry>
<entry>proxyList</entry>
<entry><emphasis>None</emphasis></entry>
</row>
<row>
<entry>proxy-url</entry>
<entry>proxyURL</entry>
<entry><emphasis>None</emphasis></entry>
</row>
<row>
<entry>advertise</entry>
<entry>advertise</entry>
<entry><emphasis>true</emphasis></entry>
</row>
<row>
<entry>advertise-security-key</entry>
<entry>advertiseSecurityKey</entry>
<entry><emphasis>None</emphasis></entry>
</row>
<row>
<entry>excluded-contexts</entry>
<entry>excludedContexts</entry>
<entry><emphasis>None</emphasis></entry>
</row>
<row>
<entry>auto-enable-contexts</entry>
<entry>autoEnableContexts</entry>
<entry><emphasis>true</emphasis></entry>
</row>
<row>
<entry>stop-context-timeout</entry>
<entry>stopContextTimeout</entry>
<entry><emphasis>10 seconds (in seconds)</emphasis></entry>
</row>
<row>
<entry>socket-timeout</entry>
<entry>nodeTimeout</entry>
<entry><emphasis>20 seconds (in milli seconds)</emphasis></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>Proxy Configuration</para>
<informaltable frame="all">
<tgroup cols="3">
<thead>
<row>
<entry>Attribute</entry>
<entry>Property</entry>
<entry>Default</entry>
</row>
</thead>
<tbody>
<row>
<entry>sticky-session</entry>
<entry>stickySession</entry>
<entry><emphasis>true</emphasis></entry>
</row>
<row>
<entry>sticky-session-remove</entry>
<entry>stickySessionRemove</entry>
<entry><emphasis>false</emphasis></entry>
</row>
<row>
<entry>sticky-session-force</entry>
<entry>stickySessionForce</entry>
<entry><emphasis>true</emphasis></entry>
</row>
<row>
<entry>node-timeout</entry>
<entry>workerTimeout</entry>
<entry><emphasis>-1</emphasis></entry>
</row>
<row>
<entry>max-attempts</entry>
<entry>maxAttempts</entry>
<entry><emphasis>1</emphasis></entry>
</row>
<row>
<entry>flush-packets</entry>
<entry>flushPackets</entry>
<entry><emphasis>false</emphasis></entry>
</row>
<row>
<entry>flush-wait</entry>
<entry>flushWait</entry>
<entry><emphasis>-1</emphasis></entry>
</row>
<row>
<entry>ping</entry>
<entry>ping</entry>
<entry><emphasis>10</emphasis></entry>
</row>
<row>
<entry>smax</entry>
<entry>smax</entry>
<entry><emphasis>-1</emphasis> it uses default value</entry>
</row>
<row>
<entry>ttl</entry>
<entry>ttl</entry>
<entry><emphasis>-1</emphasis> it uses default value</entry>
</row>
<row>
<entry>domain</entry>
<entry>loadBalancingGroup</entry>
<entry><emphasis>None</emphasis></entry>
</row>
<row>
<entry>load-balancing-group</entry>
<entry>loadBalancingGroup</entry>
<entry><emphasis>None</emphasis></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>SSL Configuration</para>
<para>SSL configuration part needs to be added here too</para>
</section>
<section id="SimpleLoadProvider">
<title>simple-load-provider Attributes</title>
<para>The simple load provider always send the same load factor. That is the default one. Example:</para>
<programlisting>
<subsystem xmlns="urn:jboss:domain:modcluster:1.0">
<mod-cluster-config>
<simple-load-provider load="1"/>
</mod-cluster-config>
</subsystem>
</programlisting>
<informaltable frame="all">
<tgroup cols="3">
<thead>
<row>
<entry>Attribute</entry>
<entry>Property</entry>
<entry>Default</entry>
</row>
</thead>
<tbody>
<row>
<entry>factor</entry>
<entry>LoadBalancerFactor</entry>
<entry><emphasis>1</emphasis></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
<section id="DynamicLoadProvider">
<title>dynamic-load-provider Attributes</title>
<para>The dynamic load provide allows to have <code>load-metric</code> as well as <code>custom-load-metric</code> defined. For example:</para>
<programlisting>
<subsystem xmlns="urn:jboss:domain:modcluster:1.0">
<mod-cluster-config advertise-socket="mod_cluster">
<dynamic-load-provider history="10" decay="2">
<load-metric type="cpu" weight="2" capacity="1"/>
<load-metric type="sessions" weight="1" capacity="512"/>
<custom-load-metric class="mypackage.myclass" weight="1" capacity="512">
<property name="myproperty" value="myvalue" />
<property name="otherproperty" value="othervalue" />
</custom-load-metric>
</dynamic-load-provider>
</mod-cluster-config>
</subsystem>
</programlisting>
<informaltable frame="all">
<tgroup cols="3">
<thead>
<row>
<entry>Attribute</entry>
<entry>Property</entry>
<entry>Default</entry>
</row>
</thead>
<tbody>
<row>
<entry>history</entry>
<entry>history</entry>
<entry>512</entry>
</row>
<row>
<entry>decay</entry>
<entry>decayFactor</entry>
<entry>512</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
<section id="LoadMetric">
<title>load-metric Configuration</title>
<para>The load-metric are the "classes" collecting information to allow computation of the load factor sent to httpd</para>
<informaltable frame="all">
<tgroup cols="3">
<thead>
<row>
<entry>Attribute</entry>
<entry>Property</entry>
<entry>Default</entry>
</row>
</thead>
<tbody>
<row>
<entry>type</entry>
<entry>A Server-Side Load Metrics</entry>
<entry><emphasis>Mandatory</emphasis></entry>
</row>
<row>
<entry>weight</entry>
<entry>weight</entry>
<entry><emphasis>9</emphasis></entry>
</row>
<row>
<entry>capacity</entry>
<entry>capacity</entry>
<entry><emphasis>512</emphasis></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<section id="CustomLoadMetricType">
<title>Supported load metric types</title>
<informaltable frame="all">
<tgroup cols="2">
<thead>
<row>
<entry>type</entry>
<entry>Corresponding Server-Side Load Metric</entry>
</row>
</thead>
<tbody>
<row>
<entry>cpu</entry>
<entry><link linkend="AverageSystemLoadMetric">AverageSystem</link>LoadMetric</entry>
</row>
<row>
<entry>mem</entry>
<entry><link linkend="SystemMemoryUsageLoadMetric">SystemMemoryUsage</link>LoadMetric</entry>
</row>
<row>
<entry>heap</entry>
<entry><link linkend="HeapMemoryUsageLoadMetric">HeapMemoryUsage</link>LoadMetric</entry>
</row>
<row>
<entry>sessions</entry>
<entry><link linkend="ActiveSessionsLoadMetric">ActiveSessions</link>LoadMetric</entry>
</row>
<row>
<entry>requests</entry>
<entry><link linkend="RequestCountLoadMetric">ActiveSessions</link>LoadMetric</entry>
</row>
<row>
<entry>send-traffic</entry>
<entry><link linkend="SendTrafficLoadMetric">SendTraffic</link>LoadMetric</entry>
</row>
<row>
<entry>receive-traffic</entry>
<entry><link linkend="ReceiveTrafficLoadMetric">ReceiveTraffic</link>LoadMetric</entry>
</row>
<row>
<entry>busyness</entry>
<entry><link linkend="BusyConnectorsLoadMetric">BusyConnectors</link>LoadMetric</entry>
</row>
<row>
<entry>connection-pool</entry>
<entry><link linkend="ConnectionPoolUsageLoadMetric">ConnectionPoolUsage</link>LoadMetric</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
</section>
<section id="CustomLoadMetric">
<title>custom-load-metric Configuration</title>
<para>The custom-load-metric are for user defined "classes" collecting information. They are like the load-metric except <code>type</code>
is replaced by <code>class</code>:</para>
<informaltable frame="all">
<tgroup cols="3">
<thead>
<row>
<entry>Attribute</entry>
<entry>Property</entry>
<entry>Default</entry>
</row>
</thead>
<tbody>
<row>
<entry>class</entry>
<entry>Name of your class</entry>
<entry><emphasis>Mandatory</emphasis></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
<section id="UsingJBossConsole">
<title>load-metric Configuration with the jboss admin console</title>
<para>The load-metric have 4 commands to add / remove metrics</para>
<section id="AddMetric">
<title>add-metric</title>
<para>Allows to add a <code>load-metric</code> to the <code>dynamic-load-provider</code></para>
<para>For example:</para>
<programlisting>
./:add-metric(type=cpu, weight=2, capacity=1)
</programlisting>
</section>
<section id="RemoveMetric">
<title>remove-metric</title>
<para>Allows to remove a <code>load-metric</code> from the <code>dynamic-load-provider</code></para>
<para>For example:</para>
<programlisting>
./:remove-metric(type=cpu)
</programlisting>
</section>
<section id="AddCustomMetric">
<title>add-custom-metric</title>
<para>Allows to add a <code>load-custom-metric</code> to the <code>dynamic-load-provider</code></para>
<para>For example:</para>
<programlisting>
./:add-custom-metric(class=myclass, weight=2, capacity=1, property=[("pool" => "mypool"), ("var" => "myvariable")])
</programlisting>
</section>
<section id="RemoveCustomMetric">
<title>remove-custom-metric</title>
<para>Allows to remove a <code>load-custom-metric</code> from the <code>dynamic-load-provider</code></para>
<para>For example:</para>
<programlisting>
./:remove-custom-metric(class=myclass)
</programlisting>
</section>
</section>
</section>
</chapter>