CINXE.COM

<!doctype html>     <html class="no-js" lang="en"> <head>   <meta http-equiv="Content-Security-Policy" content="default-src 'none'; img-src 'self' https://asciinema.org https://www.google-analytics.com; script-src 'self' 'sha256-h3L/NhdJgGKWmnGRsTCb/wrduwiZ8dYXtCD6USjbTZk=' https://www.googletagmanager.com https://www.google-analytics.com; style-src 'self' 'sha256-CwE3Bg0VYQOIdNAkbB/Btdkhul49qZuwgNCMPgNY5zw=' 'sha256-anQSeQoEnQnBulZOQkDOFf+e6xBIGmqh7M8YFT992co=' https://fonts.googleapis.com; font-src 'self' https://fonts.gstatic.com; form-action 'none'; base-uri 'none'; frame-ancestors 'none';">   <meta http-equiv="X-XSS-Protection" content="1; mode=block"> <meta charset="utf-8"> <title>Examples – mod_cluster</title> <meta name="description" content="Examples"> <meta name="keywords" content="">  <meta name="twitter:title" content="Examples"> <meta name="twitter:description" content="Examples"> <meta name="twitter:card" content="summary_large_image"> <meta name="twitter:image" content="https://www.modcluster.io/images/header_1900x100.jpg">  <meta property="og:locale" content="en_US"> <meta property="og:type" content="article"> <meta property="og:title" content="Examples"> <meta property="og:description" content="Examples"> <meta property="og:url" content="https://www.modcluster.io/examples/"> <meta property="og:site_name" content="mod_cluster"> <meta property="og:image" content="https://www.modcluster.io/images/header_1900x100.jpg">  <link rel="canonical" href="https://www.modcluster.io/examples/"> <link href="https://www.modcluster.io/feed.xml" type="application/atom+xml" rel="alternate" title="mod_cluster Feed">  <meta name="HandheldFriendly" content="True"> <meta name="MobileOptimized" content="320"> <meta name="viewport" content="width=device-width, initial-scale=1.0">  <link rel="stylesheet" href="https://www.modcluster.io/assets/css/main.css"> <meta http-equiv="cleartype" content="on">    <script src="https://www.modcluster.io/assets/js/vendor/modernizr-2.7.1.custom.min.js"></script> <link href='https://fonts.googleapis.com/css?family=PT+Sans+Narrow:400,700%7CPT+Serif:400,700,400italic' rel='stylesheet' type='text/css'>  <link rel="shortcut icon" href="/images/favicon.ico" type="image/x-icon"/> <link rel="apple-touch-icon" href="/images/apple-touch-icon/apple-touch-icon.png"/> <link rel="apple-touch-icon" sizes="57x57" href="/images/apple-touch-icon/apple-touch-icon-57x57.png"/> <link rel="apple-touch-icon" sizes="72x72" href="/images/apple-touch-icon/apple-touch-icon-72x72.png"/> <link rel="apple-touch-icon" sizes="76x76" href="/images/apple-touch-icon/apple-touch-icon-76x76.png"/> <link rel="apple-touch-icon" sizes="114x114" href="/images/apple-touch-icon/apple-touch-icon-114x114.png"/> <link rel="apple-touch-icon" sizes="120x120" href="/images/apple-touch-icon/apple-touch-icon-120x120.png"/> <link rel="apple-touch-icon" sizes="144x144" href="/images/apple-touch-icon/apple-touch-icon-144x144.png"/> <link rel="apple-touch-icon" sizes="152x152" href="/images/apple-touch-icon/apple-touch-icon-152x152.png"/> <link rel="apple-touch-icon" sizes="180x180" href="/images/apple-touch-icon/apple-touch-icon-180x180.png"/> <meta name="apple-mobile-web-app-title" content="mod_cluster"> </head> <body class="page">  <div class="navigation-wrapper"> <div class="site-name"> <a href="https://www.modcluster.io/">mod_cluster</a> </div> <div class="top-navigation"> <nav role="navigation" id="site-nav" class="nav"> <ul> <li><a href="https://www.modcluster.io/" >Introduction</a></li> <li><a href="https://www.modcluster.io/getting-started/" >Getting Started</a></li> <li><a href="https://www.modcluster.io/examples/" >Examples</a></li> <li><a href="https://www.modcluster.io/downloads/" >Downloads</a></li> <li><a href="https://www.modcluster.io/source-code/" >Source Code</a></li> <li><a href="https://docs.modcluster.io" target="_blank">Documentation</a></li> </ul> </nav> </div> </div> <div class="image-wrap"> <img src= "https://www.modcluster.io/images/header_1900x100.jpg" alt="Examples feature image"> </div> <div id="main" role="main"> <div class="article-author-side"> <div itemscope itemtype="http://schema.org/Person"> <img src="https://www.modcluster.io/images/mod_cluster-200x200.png" class="bio-photo" alt="mod_cluster bio photo"> <h3 itemprop="name">mod_cluster</h3> <p>mod_cluster is an intelligent native Apache httpd-based and pure-Java Undertow-based load-balancer</p> <a href="https://github.com/modcluster" class="author-social" target="_blank"><i class="fa fa-fw fa-github"></i> GitHub</a> <a href="https://github.com/modcluster/mod_cluster/releases" class="author-social" target="_blank"><i class="fa fa-fw fa-arrow-circle-down"></i> Download releases</a> <a href="https://issues.redhat.com/projects/MODCLUSTER" class="author-social" target="_blank"><i class="fa fa-fw fa-bug"></i> Issue Tracking</a> <a href="https://docs.modcluster.io" class="author-social" target="_blank"><i class="fa fa-fw fa-book"></i> Documentation</a> <a href="https://github.com/modcluster/mod_cluster/discussions" class="author-social" target="_blank"><i class="fa fa-fw fa-commenting"></i> Discussions</a> <a href="https://lists.jboss.org/mailman/listinfo/mod_cluster-dev" class="author-social" target="_blank"><i class="fa fa-fw fa-send-o"></i> JBoss mailing list</a> <a href="mailto:mod_cluster-dev@lists.jboss.org" class="author-social" target="_blank"><i class="fa fa-fw fa-envelope-o"></i> Drop us a line</a> </div> </div> <article class="page"> <h1>Examples</h1> <div class="article-wrap"> <section id="table-of-contents" class="toc"> <header> <h3><i class="fa fa-book"></i> Index</h3> </header> <div id="drawer"> <ul id="markdown-toc"> <li><a href="#work-in-progress" id="markdown-toc-work-in-progress">WORK IN PROGRESS</a></li> <li><a href="#apache-http-server-examples" id="markdown-toc-apache-http-server-examples">Apache HTTP Server examples</a></li> <li><a href="#wildfly-examples" id="markdown-toc-wildfly-examples">WildFly examples</a></li> <li><a href="#tomcat-examples" id="markdown-toc-tomcat-examples">Tomcat examples</a></li> <li><a href="#jboss-as7-examples" id="markdown-toc-jboss-as7-examples">JBoss AS7 examples</a> <ul> <li><a href="#how-do-i-force-mod_cluster-to-use-https-instead-of-ajp" id="markdown-toc-how-do-i-force-mod_cluster-to-use-https-instead-of-ajp">How do I force mod_cluster to use HTTPS instead of AJP?</a></li> <li><a href="#jboss-as-instances-in-domain-mode-with-mod_cluster-load-balancer" id="markdown-toc-jboss-as-instances-in-domain-mode-with-mod_cluster-load-balancer">JBoss AS instances in Domain mode with mod_cluster load balancer</a></li> </ul> </li> </ul> </div> </section>  <h1 id="work-in-progress">WORK IN PROGRESS</h1> <p>Sorry, this page is work in progress.</p> <h1 id="apache-http-server-examples">Apache HTTP Server examples</h1> <p>Download mod_proxy_cluster sources, compile and run with your own Apache HTTP Server on Linux platform. The following demo deals with compile dependencies and a basic setup including SELinux.</p> <p><a href="https://asciinema.org/a/7563u1eu6o5jlg3a0gk4wv69f"><img src="https://asciinema.org/a/7563u1eu6o5jlg3a0gk4wv69f.png" alt="asciicast" /> </a></p> <p>You can skip directly to compilation on <a href="https://asciinema.org/a/7563u1eu6o5jlg3a0gk4wv69f?t=52">52s mark</a>.</p> <h1 id="wildfly-examples">WildFly examples</h1> <p>Under construction…</p> <h1 id="tomcat-examples">Tomcat examples</h1> <p>Under construction…</p> <h1 id="jboss-as7-examples">JBoss AS7 examples</h1> <p>Under construction…</p> <h2 id="how-do-i-force-mod_cluster-to-use-https-instead-of-ajp">How do I force mod_cluster to use HTTPS instead of AJP?</h2> <p>With JBoss AS7: <a href="https://gist.github.com/Karm/6ac503924a1909564051">mod_cluster.conf & standalone-ha.xml</a></p> <h2 id="jboss-as-instances-in-domain-mode-with-mod_cluster-load-balancer">JBoss AS instances in Domain mode with mod_cluster load balancer</h2> <p>Goal: To have <em>Domain Controller</em> and one <em>Host Controller</em> with one server running on a one box and a second <em>Host Controller</em> with second server running on the second box. Both servers should automatically register to the mod_cluster load balancer running on the third box.</p> <p>This example is valid for JBoss AS 7.x, JBoss EAP 6.x and Apache HTTP Server 2.2.x. It will work for WildFly application server as well. If you would like to use Apache HTTP Server 2.4.x, mind the slight configuration changes regarding <code class="language-plaintext highlighter-rouge">Allow from...</code> vs. <code class="language-plaintext highlighter-rouge">Requires granted</code>.</p> <p>Requirements: 3 virtual machines or physical servers, JBoss AS, Apache HTTP Server and mod_proxy_cluster distributions.</p> <p>First, we are about to install the Apache HTTP Server to act as mod_proxy_cluster load balancer. Please, note the paths, IP addresses and ports are arbitrary unless stated otherwise.</p> <h4 id="apache-http-server">Apache HTTP Server</h4> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Installed in : /opt/load-balancer/jboss-ews-2.x/httpd box IP: 192.168.122.74 </code></pre></div></div> <ol> <li>run <code class="language-plaintext highlighter-rouge">.postinstall</code></li> <li>make sure you have these modules in the appropriate <code class="language-plaintext highlighter-rouge">modules/</code> directory: <ul> <li>mod_slotmem.so</li> <li>mod_proxy_cluster.so</li> <li>mod_manager.so</li> <li>mod_advertise.so</li> </ul> </li> <li>comment out mod_proxy_balancer.so (it’s incompatible with our mod_proxy_cluster.so)</li> <li>for the sake of this example, comment out any Listen directives in httpd.conf</li> <li>LoadModule proxy_ajp_module modules/mod_proxy_ajp.so</li> <li><code class="language-plaintext highlighter-rouge">/opt/load-balancer/jboss-ews-2.x/httpd/conf.d/mod_cluster.conf</code></li> </ol> <figure class="highlight"><pre><code class="language-apacheconf" data-lang="apacheconf"><table class="rouge-table"><tbody><tr><td class="gutter gl"><pre class="lineno">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 </pre></td><td class="code"><pre>LoadModule proxy_cluster_module modules/mod_proxy_cluster.so LoadModule slotmem_module modules/mod_slotmem.so LoadModule manager_module modules/mod_manager.so LoadModule advertise_module modules/mod_advertise.so Listen 192.168.122.74:2181 MemManagerFile "/opt/load-balancer/jboss-ews-2.x/httpd/cache/mod_cluster" ServerName 192.168.122.74:2181 <IfModule manager_module> Listen 192.168.122.74:8847 LogLevel debug <VirtualHost 192.168.122.74:8847> ServerName 192.168.122.74:8847 <Directory /> Order deny,allow Deny from all Allow from all </Directory> AdvertiseGroup 224.0.1.111:23365 EnableMCPMReceive <Location /mcm> SetHandler mod_cluster-manager Order deny,allow Deny from all Allow from all </Location> </VirtualHost> </IfModule> </pre></td></tr></tbody></table></code></pre></figure> <h4 id="jboss-as">JBoss AS</h4> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Unzipped into: /opt/jboss-eap-6.x </code></pre></div></div> <ol> <li>use <code class="language-plaintext highlighter-rouge">/opt/jboss-eap-6.x/bin/add-user.sh</code> to add these 3 users to ManagementRealm <ul> <li>admin</li> <li>machine1</li> <li>machine2 Please, note that machine1 and machine2 user names are not arbitrary. Answer <em>yes</em> to all the questions and use the same passwords (this is just for testing): <code class="language-plaintext highlighter-rouge">R3dHatRulezz.</code> or update the <code class="language-plaintext highlighter-rouge"><secret value="</code> attributes accordingly.</li> </ul> </li> <li>copy <code class="language-plaintext highlighter-rouge">domain</code> directory so as to create the following structure: /opt/jboss-eap-6.x/ ├── domain ├── machine1 │ └── domain └── machine2 └── domain</li> </ol> <h5 id="domain-controller">Domain Controller</h5> <p>Edit <code class="language-plaintext highlighter-rouge">machine1/domain/configuration/domain.xml</code>, so as:</p> <figure class="highlight"><pre><code class="language-xml" data-lang="xml">+++ <span class="nt"><cluster-password></span>${jboss.messaging.cluster.password:jboss}<span class="nt"></cluster-password></span> +++ <span class="nt"><socket-binding-group</span> <span class="na">name=</span><span class="s">"full-ha-sockets"</span> <span class="na">default-interface=</span><span class="s">"public"</span><span class="nt">></span> +++ <span class="nt"><socket-binding</span> <span class="na">name=</span><span class="s">"modcluster"</span> <span class="na">port=</span><span class="s">"0"</span> <span class="na">multicast-address=</span><span class="s">"224.0.1.111"</span> <span class="na">multicast-port=</span><span class="s">"23365"</span><span class="nt">/></span> +++ <span class="nt"></socket-binding-group></span> +++ <span class="nt"><server-groups></span> <span class="nt"><server-group</span> <span class="na">name=</span><span class="s">"main-server-group"</span> <span class="na">profile=</span><span class="s">"full-ha"</span><span class="nt">></span> <span class="nt"><jvm</span> <span class="na">name=</span><span class="s">"default"</span><span class="nt">></span> <span class="nt"><heap</span> <span class="na">size=</span><span class="s">"713m"</span> <span class="na">max-size=</span><span class="s">"713m"</span><span class="nt">/></span> <span class="nt"><permgen</span> <span class="na">max-size=</span><span class="s">"128m"</span><span class="nt">/></span> <span class="nt"></jvm></span> <span class="nt"><socket-binding-group</span> <span class="na">ref=</span><span class="s">"full-ha-sockets"</span><span class="nt">/></span> <span class="nt"></server-group></span> <span class="nt"></server-groups></span> +++</code></pre></figure> <p>Configure the master in <code class="language-plaintext highlighter-rouge">machine1/domain/configuration/host-master.xml</code>:</p> <figure class="highlight"><pre><code class="language-xml" data-lang="xml">+++ <span class="nt"><host</span> <span class="na">name=</span><span class="s">"machine1-master"</span> <span class="na">xmlns=</span><span class="s">"urn:jboss:domain:... +++ <security-realm name="</span><span class="err">ManagementRealm"</span><span class="nt">></span> <span class="nt"><server-identities></span> <span class="nt"><secret</span> <span class="na">value=</span><span class="s">"UjNkSGF0UnVsZXp6Lg=="</span><span class="nt">/></span> <span class="nt"></server-identities></span> +++</code></pre></figure> <h5 id="host-controller-1">Host Controller 1</h5> <p>Configure your Host Controller 1 in <code class="language-plaintext highlighter-rouge">machine1/domain/configuration/host-slave.xml</code>. Please, note the name is not arbitrary, it must match the user names created above.</p> <figure class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><host</span> <span class="na">name=</span><span class="s">"machine1"</span> <span class="na">xmlns=</span><span class="s">"urn:jboss:domain:... +++ <security-realm name="</span><span class="err">ManagementRealm"</span><span class="nt">></span> <span class="nt"><server-identities></span> <span class="nt"><secret</span> <span class="na">value=</span><span class="s">"UjNkSGF0UnVsZXp6Lg=="</span><span class="nt">/></span> <span class="nt"></server-identities></span> +++ <span class="nt"><servers></span> <span class="nt"><server</span> <span class="na">name=</span><span class="s">"server-one"</span> <span class="na">group=</span><span class="s">"main-server-group"</span><span class="nt">/></span> <span class="nt"></servers></span> +++</code></pre></figure> <h5 id="host-controller-2">Host Controller 2</h5> <p>Configure your Host Controller 2 <code class="language-plaintext highlighter-rouge">machine2/domain/configuration/host-slave.xml</code>:</p> <figure class="highlight"><pre><code class="language-xml" data-lang="xml"> +++ <span class="nt"><host</span> <span class="na">name=</span><span class="s">"machine2"</span> <span class="na">xmlns=</span><span class="s">"urn:jboss:domain:... +++ <security-realm name="</span><span class="err">ManagementRealm"</span><span class="nt">></span> <span class="nt"><server-identities></span> <span class="nt"><secret</span> <span class="na">value=</span><span class="s">"UjNkSGF0UnVsZXp6Lg=="</span><span class="nt">/></span> <span class="nt"></server-identities></span> +++ <span class="nt"><servers></span> <span class="nt"><server</span> <span class="na">name=</span><span class="s">"server-two"</span> <span class="na">group=</span><span class="s">"main-server-group"</span><span class="nt">></span> <span class="nt"><socket-bindings</span> <span class="na">port-offset=</span><span class="s">"150"</span><span class="nt">/></span> <span class="nt"></server></span> <span class="nt"></servers></span> +++</code></pre></figure> <h4 id="overview-of-the-current-layout">Overview of the current layout</h4> <figure> <a href="/images/mod_cluster-example-visual-elements-by-red-hat.png"><img src="/images/mod_cluster-example-visual-elements-by-red-hat.png" alt="Schema of the environment" /></a> <figcaption>Clients, balancer and worker nodes.</figcaption> </figure> <h4 id="run">Run!</h4> <p>For the sake of this example, let’s suppose you have the Apache HTTP Server residing on the box 192.168.122.74. Copy your <code class="language-plaintext highlighter-rouge">/opt/jboss-eap-6.x</code> folder to the two boxes that are supposed to act as JBoss AS worker nodes, e.g. 192.168.122.78 and 192.168.122.204.</p> <ol> <li>Make sure your firewalls allow UDP multicast between the nodes and that all the used ports are open</li> <li>Please, check firewalls and network interfaces again, i.e. Apache HTTP Server must be able to access AJP connector on your JBoss AS workers etc.</li> <li>Start Apache HTTP Server on 192.168.122.74 <ul> <li><em>./apachectl start</em> in <em>/opt/load-balancer/jboss-ews-2.x/httpd/sbin</em></li> <li>one might appreciate seeing the mod_cluster messages: <em>tail -f /opt/load-balancer/jboss-ews-2.x/httpd/logs/error_log</em></li> </ul> </li> <li>Start Domain Controller on 192.168.122.78, /opt/jboss-eap-6.x/bin <ul> <li><em>./domain.sh –host-config=host-master.xml -Djboss.domain.base.dir=/opt/jboss-eap-6.x/machine1/domain -Djboss.bind.address.management=192.168.122.78</em></li> </ul> </li> <li>Start Host Controller 1 on 192.168.122.78 <ul> <li><em>./domain.sh -Djboss.domain.base.dir=/opt/jboss-eap-6.x/machine1/domain –host-config=host-slave.xml -Djboss.domain.master.address=192.168.122.78 -Djboss.management.native.port=29999 -Djboss.bind.address.management=192.168.122.78 -Djboss.bind.address=192.168.122.78 -Djboss.bind.address.unsecure=192.168.122.78</em></li> </ul> </li> <li>Start Host Controller 2 on 192.168.122.204 <ul> <li><em>./domain.sh -Djboss.domain.base.dir=/opt/jboss-eap-6.x/machine2/domain –host-config=host-slave.xml -Djboss.domain.master.address=192.168.122.78 -Djboss.bind.address.management=192.168.122.204 -Djboss.bind.address=192.168.122.204 -Djboss.bind.address.unsecure=192.168.122.204</em></li> </ul> </li> <li>Access http://192.168.122.74:8847/mcm and wait dozen of seconds for two worker nodes to appear</li> <li>Deploy/manage/play with Domain Controller http://192.168.122.78:9990/</li> </ol> <hr /> <div class="social-share"> <h4>Share on</h4> <ul> <li> <a href="https://twitter.com/intent/tweet?text=https://www.modcluster.io/examples/" class="twitter" title="Share on Twitter"><i class="fa fa-twitter"></i><span> Twitter</span></a> </li> <li> <a href="https://www.facebook.com/sharer/sharer.php?u=https://www.modcluster.io/examples/" class="facebook" title="Share on Facebook"><i class="fa fa-facebook"></i><span> Facebook</span></a> </li> </ul> </div> </div> </article> </div> <div class="footer-wrap"> <footer> <span><a href="https://www.gnu.org/licenses/lgpl-3.0.en.html">LGPL 3.0</a> — mod_cluster contributors 2025 — Powered by <a href="https://jekyllrb.com" rel="nofollow">Jekyll</a> using the <a href="https://mademistakes.com/minimal-mistakes/" rel="nofollow">Minimal Mistakes</a> theme.</span> </footer> </div>  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-71749425-1" integrity="EBKQYLbbmZRAlEqep3F4fdIsBgoPGWr92mYpPbXfDmyK3FIHy9L9PiXh02C5rfUh" crossorigin="anonymous"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-71749425-1'); </script>   <script src="https://www.modcluster.io/assets/js/vendor/jquery-1.9.1.min.js"></script> <script src="https://www.modcluster.io/assets/js/scripts.min.js"></script> </body> </html>