You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@helix.apache.org by ol...@apache.org on 2021/11/21 07:08:47 UTC
svn commit: r1895217 [23/31] - in /helix/site-content: ./ 0.8.0-docs/ 0.8.0-docs/recipes/ 0.8.0-docs/releasenotes/ 0.8.1-docs/ 0.8.1-docs/recipes/ 0.8.1-docs/releasenotes/ 0.8.2-docs/ 0.8.2-docs/recipes/ 0.8.2-docs/releasenotes/ 0.8.3-docs/ 0.8.3-docs/...
Added: helix/site-content/0.9.9-docs/tutorial_controller.html
URL: http://svn.apache.org/viewvc/helix/site-content/0.9.9-docs/tutorial_controller.html?rev=1895217&view=auto
==============================================================================
--- helix/site-content/0.9.9-docs/tutorial_controller.html (added)
+++ helix/site-content/0.9.9-docs/tutorial_controller.html Sun Nov 21 07:08:41 2021
@@ -0,0 +1,373 @@
+
+<!DOCTYPE html>
+<!--
+ Generated by Apache Maven Doxia at 2021-11-21
+ Rendered using Maven Reflow Skin 1.0.0 (http://andriusvelykis.github.com/reflow-maven-skin)
+-->
+<html xml:lang="en" lang="en">
+
+ <head>
+ <meta charset="UTF-8" />
+ <title>Apache Helix - Tutorial - Controller</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="description" content="" />
+ <meta http-equiv="content-language" content="en" />
+
+ <link href="./css/bootstrap.min.css" rel="stylesheet" />
+ <link href="./css/bootstrap-responsive.min.css" rel="stylesheet" />
+ <link href="./css/docs.css" rel="stylesheet" />
+ <link href="./css/reflow-skin.css" rel="stylesheet" />
+
+
+ <link href="./css/lightbox.css" rel="stylesheet" />
+
+ <link href="./css/site.css" rel="stylesheet" />
+ <link href="./css/print.css" rel="stylesheet" media="print" />
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+<script type="text/javascript">var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-3211522-12']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();</script>
+ </head>
+
+ <body class="page-tutorial_controller project-099-docs" data-spy="scroll" data-offset="60" data-target="#toc-scroll-target">
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+ <a class="brand" href="..">Apache Helix</a>
+ <div class="nav-collapse">
+ <ul class="nav pull-right">
+ <li><a href="index.html" title="Helix 0.9.9">Helix 0.9.9 </a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Helix <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="download.html" title="Download">Download </a></li>
+ <li><a href="Building.html" title="Building">Building </a></li>
+ <li><a href="releasenotes/release-0.9.9.html" title="Release Notes">Release Notes </a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Hands-On <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="Quickstart.html" title="Quick Start">Quick Start </a></li>
+ <li><a href="Tutorial.html" title="Tutorial">Tutorial </a></li>
+ <li><a href="../javadocs/0.9.9" title="Javadocs">Javadocs </a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Recipes <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager </a></li>
+ <li><a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group </a></li>
+ <li><a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store </a></li>
+ <li><a href="recipes/service_discovery.html" title="Service discovery">Service discovery </a></li>
+ <li><a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution </a></li>
+ </ul>
+ </li>
+ </ul>
+ </div><!--/.nav-collapse -->
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+
+ <!-- Masthead
+ ================================================== -->
+ <header class="jumbotron subhead">
+ <div class="row" id="banner">
+ <div class="span12">
+ <div class="pull-left">
+ <a href="../" id="bannerLeft"><img src="../images/helix-logo.jpg" alt='"''"' /></a>
+ <p class="lead">A cluster management framework for partitioned and replicated distributed resources</p>
+ </div>
+ <div class="pull-right">
+ <a href="http://www.apache.org/" id="bannerRight"><img src="../images/feather_small.gif" alt='"''"' /></a>
+ </div>
+ </div>
+ </div>
+ <div>
+ <ul class="breadcrumb">
+ <li><a href="../" title="Apache Helix">Apache Helix </a></li>
+ <li class="divider">/</li>
+ <li><a href="./" title="Release 0.9.9">Release 0.9.9 </a></li>
+ <li class="divider">/</li>
+ <li> Tutorial - Controller</li>
+ <li class="publishDate version-date pull-right">Last Published: 2021-11-21</li>
+ </ul>
+ </div>
+ </header>
+
+ <div class="main-body">
+ <div class="row">
+ <div class="span12">
+ <div class="body-content">
+<!-- -
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License. -->
+<p></p>
+<div class="section">
+ <div class="page-header">
+ <h2 id="Helix_Tutorial:_Controller"><a href="./Tutorial.html">Helix Tutorial</a>: Controller</h2>
+ </div>
+ <p>Next, let's implement the controller. This is the brain of the cluster. Helix makes sure there is exactly one active controller running the cluster.</p>
+ <div class="section">
+ <h3 id="Start_a_Connection">Start a Connection</h3>
+ <p>The Helix manager requires the following parameters:</p>
+ <ul>
+ <li>clusterName: A logical name to represent the group of nodes</li>
+ <li>instanceName: A logical name of the process creating the manager instance. Generally this is host:port</li>
+ <li>instanceType: Type of the process. This can be one of the following types, in this case use CONTROLLER:
+ <ul>
+ <li>CONTROLLER: Process that controls the cluster, any number of controllers can be started but only one will be active at any given time</li>
+ <li>PARTICIPANT: Process that performs the actual task in the distributed system</li>
+ <li>SPECTATOR: Process that observes the changes in the cluster</li>
+ <li>ADMIN: To carry out system admin actions</li>
+ </ul></li>
+ <li>zkConnectString: Connection string to ZooKeeper. This is of the form host1:port1,host2:port2,host3:port3</li>
+ </ul>
+ <div class="source">
+ <pre>manager = HelixManagerFactory.getZKHelixManager(clusterName,
+ instanceName,
+ instanceType,
+ zkConnectString);
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h3 id="Controller_Code">Controller Code</h3>
+ <p>The Controller needs to know about all changes in the cluster. Helix takes care of this with the default implementation. If you need additional functionality, see GenericHelixController on how to configure the pipeline.</p>
+ <div class="source">
+ <pre>manager = HelixManagerFactory.getZKHelixManager(clusterName,
+ instanceName,
+ InstanceType.CONTROLLER,
+ zkConnectString);
+manager.connect();
+</pre>
+ </div>
+ <p>The snippet above shows how the controller is started. You can also start the controller using command line interface.</p>
+ <div class="source">
+ <pre>cd helix/helix-core/target/helix-core-pkg/bin
+./run-helix-controller.sh --zkSvr <Zookeeper ServerAddress (Required)> --cluster <Cluster name (Required)>
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h3 id="Controller_Deployment_Modes">Controller Deployment Modes</h3>
+ <p>Helix provides multiple options to deploy the controller.</p>
+ <div class="section">
+ <h4 id="STANDALONE">STANDALONE</h4>
+ <p>The Controller can be started as a separate process to manage a cluster. This is the recommended approach. However, since one controller can be a single point of failure, multiple controller processes are required for reliability. Even if multiple controllers are running, only one will be actively managing the cluster at any time and is decided by a leader-election process. If the leader fails, another leader will take over managing the cluster.</p>
+ <p>Even though we recommend this method of deployment, it has the drawback of having to manage an additional service for each cluster. See the Controller as a Service option.</p>
+ </div>
+ <div class="section">
+ <h4 id="EMBEDDED">EMBEDDED</h4>
+ <p>If setting up a separate controller process is not viable, then it is possible to embed the controller as a library in each of the participants.</p>
+ </div>
+ <div class="section">
+ <h4 id="CONTROLLER_AS_A_SERVICE">CONTROLLER AS A SERVICE</h4>
+ <p>One of the cool features we added in Helix was to use a set of controllers to manage a large number of clusters.</p>
+ <p>For example if you have X clusters to be managed, instead of deploying X*3 (3 controllers for fault tolerance) controllers for each cluster, one can deploy just 3 controllers. Each controller can manage X/3 clusters. If any controller fails, the remaining two will manage X/2 clusters.</p>
+ <p>Next, let's implement the controller. This is the brain of the cluster. Helix makes sure there is exactly one active controller running the cluster.</p>
+ </div>
+ </div>
+ <div class="section">
+ <h3 id="Start_the_Helix_agent">Start the Helix agent</h3>
+ <p>It requires the following parameters:</p>
+ <ul>
+ <li>clusterName: A logical name to represent the group of nodes</li>
+ <li>instanceName: A logical name of the process creating the manager instance. Generally this is host:port.</li>
+ <li>instanceType: Type of the process. This can be one of the following types, in this case use CONTROLLER:
+ <ul>
+ <li>CONTROLLER: Process that controls the cluster, any number of controllers can be started but only one will be active at any given time.</li>
+ <li>PARTICIPANT: Process that performs the actual task in the distributed system.</li>
+ <li>SPECTATOR: Process that observes the changes in the cluster.</li>
+ <li>ADMIN: To carry out system admin actions.</li>
+ </ul></li>
+ <li>zkConnectString: Connection string to Zookeeper. This is of the form host1:port1,host2:port2,host3:port3.</li>
+ </ul>
+ <div class="source">
+ <pre> manager = HelixManagerFactory.getZKHelixManager(clusterName,
+ instanceName,
+ instanceType,
+ zkConnectString);
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h3 id="Controller_Code">Controller Code</h3>
+ <p>The Controller needs to know about all changes in the cluster. Helix takes care of this with the default implementation. If you need additional functionality, see GenericHelixController on how to configure the pipeline.</p>
+ <div class="source">
+ <pre> manager = HelixManagerFactory.getZKHelixManager(clusterName,
+ instanceName,
+ InstanceType.CONTROLLER,
+ zkConnectString);
+ manager.connect();
+ GenericHelixController controller = new GenericHelixController();
+ manager.addControllerListener(controller);
+ manager.addInstanceConfigChangeListener(controller);
+ manager.addResourceConfigChangeListener(controller);
+ manager.addClusterfigChangeListener(controller);
+ manager.addLiveInstanceChangeListener(controller);
+ manager.addIdealStateChangeListener(controller);
+</pre>
+ </div>
+ <p>The snippet above shows how the controller is started. You can also start the controller using command line interface.</p>
+ <div class="source">
+ <pre>cd helix/helix-core/target/helix-core-pkg/bin
+./run-helix-controller.sh --zkSvr <Zookeeper ServerAddress (Required)> --cluster <Cluster name (Required)>
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h3 id="Controller_Deployment_Modes">Controller Deployment Modes</h3>
+ <p>Helix provides multiple options to deploy the controller.</p>
+ <div class="section">
+ <h4 id="STANDALONE">STANDALONE</h4>
+ <p>The Controller can be started as a separate process to manage a cluster. This is the recommended approach. However, since one controller can be a single point of failure, multiple controller processes are required for reliability. Even if multiple controllers are running, only one will be actively managing the cluster at any time and is decided by a leader-election process. If the leader fails, another leader will take over managing the cluster.</p>
+ <p>Even though we recommend this method of deployment, it has the drawback of having to manage an additional service for each cluster. See Controller As a Service option.</p>
+ </div>
+ <div class="section">
+ <h4 id="EMBEDDED">EMBEDDED</h4>
+ <p>If setting up a separate controller process is not viable, then it is possible to embed the controller as a library in each of the participants.</p>
+ </div>
+ <div class="section">
+ <h4 id="CONTROLLER_AS_A_SERVICE">CONTROLLER AS A SERVICE</h4>
+ <p>One of the cool features we added in Helix is to use a set of controllers to manage a large number of clusters.</p>
+ <p>For example if you have X clusters to be managed, instead of deploying X*3 (3 controllers for fault tolerance) controllers for each cluster, one can deploy just 3 controllers. Each controller can manage X/3 clusters. If any controller fails, the remaining two will manage X/2 clusters.</p>
+ </div>
+ </div>
+</div>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ </div><!-- /container -->
+
+ <!-- Footer
+ ================================================== -->
+ <footer class="well">
+ <div class="container">
+ <div class="row">
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Get Helix</li>
+ <li>
+ <a href="download.html" title="Download">Download </a>
+ </li>
+ <li>
+ <a href="Building.html" title="Building">Building </a>
+ </li>
+ <li>
+ <a href="releasenotes/release-0.9.9.html" title="Release Notes">Release Notes </a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Hands-On</li>
+ <li>
+ <a href="Quickstart.html" title="Quick Start">Quick Start </a>
+ </li>
+ <li>
+ <a href="Tutorial.html" title="Tutorial">Tutorial </a>
+ </li>
+ <li>
+ <a href="../javadocs/0.9.9" title="Javadocs">Javadocs </a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Recipes</li>
+ <li>
+ <a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager </a>
+ </li>
+ <li>
+ <a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group </a>
+ </li>
+ <li>
+ <a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store </a>
+ </li>
+ <li>
+ <a href="recipes/service_discovery.html" title="Service discovery">Service discovery </a>
+ </li>
+ <li>
+ <a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution </a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </footer>
+
+ <div class="container subfooter">
+ <div class="row">
+ <div class="span12">
+ <p class="pull-right"><a href="#">Back to top</a></p>
+ <p class="copyright">Copyright ©2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</p>
+ <p><a href="http://github.com/andriusvelykis/reflow-maven-skin" title="Reflow Maven skin">Reflow Maven skin</a> by <a href="http://andrius.velykis.lt" target="_blank" title="Andrius Velykis">Andrius Velykis</a>.</p>
+
+<div class="row span16">
+ <div>Apache Helix, Apache, the Apache feather logo, and the Apache Helix project logos are trademarks of The Apache Software Foundation.
+ All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
+ <a href="http://helix.apache.org/0.9.9-docs/privacy-policy.html">Privacy Policy</a>
+</div> </div>
+ </div>
+ </div>
+
+ <!-- Le javascript
+ ================================================== -->
+ <!-- Placed at the end of the document so the pages load faster -->
+
+ <!-- Fallback jQuery loading from Google CDN:
+ http://stackoverflow.com/questions/1014203/best-way-to-use-googles-hosted-jquery-but-fall-back-to-my-hosted-library-on-go -->
+ <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
+ <script type="text/javascript">
+ if (typeof jQuery == 'undefined')
+ {
+ document.write(unescape("%3Cscript src='./js/jquery-1.8.3.min.js' type='text/javascript'%3E%3C/script%3E"));
+ }
+ </script>
+
+ <script src="./js/bootstrap.min.js"></script>
+ <script src="./js/lightbox.js"></script>
+ <script src="./js/jquery.smooth-scroll.min.js"></script>
+ <!-- back button support for smooth scroll -->
+ <script src="./js/jquery.ba-bbq.min.js"></script>
+
+ <script src="./js/reflow-skin.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
Added: helix/site-content/0.9.9-docs/tutorial_health.html
URL: http://svn.apache.org/viewvc/helix/site-content/0.9.9-docs/tutorial_health.html?rev=1895217&view=auto
==============================================================================
--- helix/site-content/0.9.9-docs/tutorial_health.html (added)
+++ helix/site-content/0.9.9-docs/tutorial_health.html Sun Nov 21 07:08:41 2021
@@ -0,0 +1,261 @@
+
+<!DOCTYPE html>
+<!--
+ Generated by Apache Maven Doxia at 2021-11-21
+ Rendered using Maven Reflow Skin 1.0.0 (http://andriusvelykis.github.com/reflow-maven-skin)
+-->
+<html xml:lang="en" lang="en">
+
+ <head>
+ <meta charset="UTF-8" />
+ <title>Apache Helix - Tutorial - Customizing Heath Checks</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="description" content="" />
+ <meta http-equiv="content-language" content="en" />
+
+ <link href="./css/bootstrap.min.css" rel="stylesheet" />
+ <link href="./css/bootstrap-responsive.min.css" rel="stylesheet" />
+ <link href="./css/docs.css" rel="stylesheet" />
+ <link href="./css/reflow-skin.css" rel="stylesheet" />
+
+
+ <link href="./css/lightbox.css" rel="stylesheet" />
+
+ <link href="./css/site.css" rel="stylesheet" />
+ <link href="./css/print.css" rel="stylesheet" media="print" />
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+<script type="text/javascript">var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-3211522-12']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();</script>
+ </head>
+
+ <body class="page-tutorial_health project-099-docs" data-spy="scroll" data-offset="60" data-target="#toc-scroll-target">
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+ <a class="brand" href="..">Apache Helix</a>
+ <div class="nav-collapse">
+ <ul class="nav pull-right">
+ <li><a href="index.html" title="Helix 0.9.9">Helix 0.9.9 </a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Helix <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="download.html" title="Download">Download </a></li>
+ <li><a href="Building.html" title="Building">Building </a></li>
+ <li><a href="releasenotes/release-0.9.9.html" title="Release Notes">Release Notes </a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Hands-On <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="Quickstart.html" title="Quick Start">Quick Start </a></li>
+ <li><a href="Tutorial.html" title="Tutorial">Tutorial </a></li>
+ <li><a href="../javadocs/0.9.9" title="Javadocs">Javadocs </a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Recipes <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager </a></li>
+ <li><a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group </a></li>
+ <li><a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store </a></li>
+ <li><a href="recipes/service_discovery.html" title="Service discovery">Service discovery </a></li>
+ <li><a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution </a></li>
+ </ul>
+ </li>
+ </ul>
+ </div><!--/.nav-collapse -->
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+
+ <!-- Masthead
+ ================================================== -->
+ <header class="jumbotron subhead">
+ <div class="row" id="banner">
+ <div class="span12">
+ <div class="pull-left">
+ <a href="../" id="bannerLeft"><img src="../images/helix-logo.jpg" alt='"''"' /></a>
+ <p class="lead">A cluster management framework for partitioned and replicated distributed resources</p>
+ </div>
+ <div class="pull-right">
+ <a href="http://www.apache.org/" id="bannerRight"><img src="../images/feather_small.gif" alt='"''"' /></a>
+ </div>
+ </div>
+ </div>
+ <div>
+ <ul class="breadcrumb">
+ <li><a href="../" title="Apache Helix">Apache Helix </a></li>
+ <li class="divider">/</li>
+ <li><a href="./" title="Release 0.9.9">Release 0.9.9 </a></li>
+ <li class="divider">/</li>
+ <li> Tutorial - Customizing Heath Checks</li>
+ <li class="publishDate version-date pull-right">Last Published: 2021-11-21</li>
+ </ul>
+ </div>
+ </header>
+
+ <div class="main-body">
+ <div class="row">
+ <div class="span12">
+ <div class="body-content">
+<!-- -
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License. -->
+<p></p>
+<div class="section">
+ <div class="page-header">
+ <h2 id="Helix_Tutorial:_Customizing_Health_Checks"><a href="./Tutorial.html">Helix Tutorial</a>: Customizing Health Checks</h2>
+ </div>
+ <p>In this chapter, we'll learn how to customize health checks based on metrics of your distributed system.</p>
+ <div class="section">
+ <h3 id="Health_Checks">Health Checks</h3>
+ <p>Note: <i>this in currently in development mode, not yet ready for production.</i></p>
+ <p>Helix provides the ability for each node in the system to report health metrics on a periodic basis.</p>
+ <p>Helix supports multiple ways to aggregate these metrics:</p>
+ <ul>
+ <li>SUM</li>
+ <li>AVG</li>
+ <li>EXPONENTIAL DECAY</li>
+ <li>WINDOW</li>
+ </ul>
+ <p>Helix persists the aggregated value only.</p>
+ <p>Applications can define a threshold on the aggregate values according to the SLAs, and when the SLA is violated Helix will fire an alert. Currently Helix only fires an alert, but in a future release we plan to use these metrics to either mark the node dead or load balance the partitions. This feature will be valuable for distributed systems that support multi-tenancy and have a large variation in work load patterns. In addition, this can be used to detect skewed partitions (hotspots) and rebalance the cluster.</p>
+ </div>
+</div>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ </div><!-- /container -->
+
+ <!-- Footer
+ ================================================== -->
+ <footer class="well">
+ <div class="container">
+ <div class="row">
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Get Helix</li>
+ <li>
+ <a href="download.html" title="Download">Download </a>
+ </li>
+ <li>
+ <a href="Building.html" title="Building">Building </a>
+ </li>
+ <li>
+ <a href="releasenotes/release-0.9.9.html" title="Release Notes">Release Notes </a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Hands-On</li>
+ <li>
+ <a href="Quickstart.html" title="Quick Start">Quick Start </a>
+ </li>
+ <li>
+ <a href="Tutorial.html" title="Tutorial">Tutorial </a>
+ </li>
+ <li>
+ <a href="../javadocs/0.9.9" title="Javadocs">Javadocs </a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Recipes</li>
+ <li>
+ <a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager </a>
+ </li>
+ <li>
+ <a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group </a>
+ </li>
+ <li>
+ <a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store </a>
+ </li>
+ <li>
+ <a href="recipes/service_discovery.html" title="Service discovery">Service discovery </a>
+ </li>
+ <li>
+ <a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution </a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </footer>
+
+ <div class="container subfooter">
+ <div class="row">
+ <div class="span12">
+ <p class="pull-right"><a href="#">Back to top</a></p>
+ <p class="copyright">Copyright ©2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</p>
+ <p><a href="http://github.com/andriusvelykis/reflow-maven-skin" title="Reflow Maven skin">Reflow Maven skin</a> by <a href="http://andrius.velykis.lt" target="_blank" title="Andrius Velykis">Andrius Velykis</a>.</p>
+
+<div class="row span16">
+ <div>Apache Helix, Apache, the Apache feather logo, and the Apache Helix project logos are trademarks of The Apache Software Foundation.
+ All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
+ <a href="http://helix.apache.org/0.9.9-docs/privacy-policy.html">Privacy Policy</a>
+</div> </div>
+ </div>
+ </div>
+
+ <!-- Le javascript
+ ================================================== -->
+ <!-- Placed at the end of the document so the pages load faster -->
+
+ <!-- Fallback jQuery loading from Google CDN:
+ http://stackoverflow.com/questions/1014203/best-way-to-use-googles-hosted-jquery-but-fall-back-to-my-hosted-library-on-go -->
+ <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
+ <script type="text/javascript">
+ if (typeof jQuery == 'undefined')
+ {
+ document.write(unescape("%3Cscript src='./js/jquery-1.8.3.min.js' type='text/javascript'%3E%3C/script%3E"));
+ }
+ </script>
+
+ <script src="./js/bootstrap.min.js"></script>
+ <script src="./js/lightbox.js"></script>
+ <script src="./js/jquery.smooth-scroll.min.js"></script>
+ <!-- back button support for smooth scroll -->
+ <script src="./js/jquery.ba-bbq.min.js"></script>
+
+ <script src="./js/reflow-skin.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
Added: helix/site-content/0.9.9-docs/tutorial_messaging.html
URL: http://svn.apache.org/viewvc/helix/site-content/0.9.9-docs/tutorial_messaging.html?rev=1895217&view=auto
==============================================================================
--- helix/site-content/0.9.9-docs/tutorial_messaging.html (added)
+++ helix/site-content/0.9.9-docs/tutorial_messaging.html Sun Nov 21 07:08:41 2021
@@ -0,0 +1,286 @@
+
+<!DOCTYPE html>
+<!--
+ Generated by Apache Maven Doxia at 2021-11-21
+ Rendered using Maven Reflow Skin 1.0.0 (http://andriusvelykis.github.com/reflow-maven-skin)
+-->
+<html xml:lang="en" lang="en">
+
+ <head>
+ <meta charset="UTF-8" />
+ <title>Apache Helix - Tutorial - Messaging</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="description" content="" />
+ <meta http-equiv="content-language" content="en" />
+
+ <link href="./css/bootstrap.min.css" rel="stylesheet" />
+ <link href="./css/bootstrap-responsive.min.css" rel="stylesheet" />
+ <link href="./css/docs.css" rel="stylesheet" />
+ <link href="./css/reflow-skin.css" rel="stylesheet" />
+
+
+ <link href="./css/lightbox.css" rel="stylesheet" />
+
+ <link href="./css/site.css" rel="stylesheet" />
+ <link href="./css/print.css" rel="stylesheet" media="print" />
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+<script type="text/javascript">var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-3211522-12']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();</script>
+ </head>
+
+ <body class="page-tutorial_messaging project-099-docs" data-spy="scroll" data-offset="60" data-target="#toc-scroll-target">
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+ <a class="brand" href="..">Apache Helix</a>
+ <div class="nav-collapse">
+ <ul class="nav pull-right">
+ <li><a href="index.html" title="Helix 0.9.9">Helix 0.9.9 </a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Helix <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="download.html" title="Download">Download </a></li>
+ <li><a href="Building.html" title="Building">Building </a></li>
+ <li><a href="releasenotes/release-0.9.9.html" title="Release Notes">Release Notes </a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Hands-On <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="Quickstart.html" title="Quick Start">Quick Start </a></li>
+ <li><a href="Tutorial.html" title="Tutorial">Tutorial </a></li>
+ <li><a href="../javadocs/0.9.9" title="Javadocs">Javadocs </a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Recipes <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager </a></li>
+ <li><a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group </a></li>
+ <li><a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store </a></li>
+ <li><a href="recipes/service_discovery.html" title="Service discovery">Service discovery </a></li>
+ <li><a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution </a></li>
+ </ul>
+ </li>
+ </ul>
+ </div><!--/.nav-collapse -->
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+
+ <!-- Masthead
+ ================================================== -->
+ <header class="jumbotron subhead">
+ <div class="row" id="banner">
+ <div class="span12">
+ <div class="pull-left">
+ <a href="../" id="bannerLeft"><img src="../images/helix-logo.jpg" alt='"''"' /></a>
+ <p class="lead">A cluster management framework for partitioned and replicated distributed resources</p>
+ </div>
+ <div class="pull-right">
+ <a href="http://www.apache.org/" id="bannerRight"><img src="../images/feather_small.gif" alt='"''"' /></a>
+ </div>
+ </div>
+ </div>
+ <div>
+ <ul class="breadcrumb">
+ <li><a href="../" title="Apache Helix">Apache Helix </a></li>
+ <li class="divider">/</li>
+ <li><a href="./" title="Release 0.9.9">Release 0.9.9 </a></li>
+ <li class="divider">/</li>
+ <li> Tutorial - Messaging</li>
+ <li class="publishDate version-date pull-right">Last Published: 2021-11-21</li>
+ </ul>
+ </div>
+ </header>
+
+ <div class="main-body">
+ <div class="row">
+ <div class="span12">
+ <div class="body-content">
+<!-- -
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License. -->
+<p></p>
+<div class="section">
+ <div class="page-header">
+ <h2 id="Helix_Tutorial:_Messaging"><a href="./Tutorial.html">Helix Tutorial</a>: Messaging</h2>
+ </div>
+ <p>In this chapter, we'll learn about messaging, a convenient feature in Helix for sending messages between nodes of a cluster. This is an interesting feature that is quite useful in practice. It is common that nodes in a distributed system require a mechanism to interact with each other.</p>
+ <div class="section">
+ <h3 id="Example:_Bootstrapping_a_Replica">Example: Bootstrapping a Replica</h3>
+ <p>Consider a search system where the index replica starts up and it does not have an index. A typical solution is to get the index from a common location, or to copy the index from another replica.</p>
+ <p>Helix provides a messaging API for intra-cluster communication between nodes in the system. This API provides a mechanism to specify the message recipient in terms of resource, partition, and state rather than specifying hostnames. Helix ensures that the message is delivered to all of the required recipients. In this particular use case, the instance can specify the recipient criteria as all replicas of the desired partition to bootstrap. Since Helix is aware of the global state of the system, it can send the message to the appropriate nodes. Once the nodes respond, Helix provides the bootstrapping replica with all the responses.</p>
+ <p>This is a very generic API and can also be used to schedule various periodic tasks in the cluster, such as data backups, log cleanup, etc. System Admins can also perform ad-hoc tasks, such as on-demand backups or a system command (such as rm -rf ;) across all nodes of the cluster</p>
+ <div class="source">
+ <pre>ClusterMessagingService messagingService = manager.getMessagingService();
+
+// Construct the Message
+Message requestBackupUriRequest = new Message(
+ MessageType.USER_DEFINE_MSG, UUID.randomUUID().toString());
+requestBackupUriRequest
+ .setMsgSubType(BootstrapProcess.REQUEST_BOOTSTRAP_URL);
+requestBackupUriRequest.setMsgState(MessageState.NEW);
+
+// Set the Recipient criteria: all nodes that satisfy the criteria will receive the message
+Criteria recipientCriteria = new Criteria();
+recipientCriteria.setInstanceName("%");
+recipientCriteria.setRecipientInstanceType(InstanceType.PARTICIPANT);
+recipientCriteria.setResource("MyDB");
+recipientCriteria.setPartition("");
+
+// Should be processed only by process(es) that are active at the time of sending the message
+// This means if the recipient is restarted after message is sent, it will not be processe.
+recipientCriteria.setSessionSpecific(true);
+
+// wait for 30 seconds
+int timeout = 30000;
+
+// the handler that will be invoked when any recipient responds to the message.
+BootstrapReplyHandler responseHandler = new BootstrapReplyHandler();
+
+// this will return only after all recipients respond or after timeout
+int sentMessageCount = messagingService.sendAndWait(recipientCriteria,
+ requestBackupUriRequest, responseHandler, timeout);
+</pre>
+ </div>
+ <p>See HelixManager.DefaultMessagingService in the <a class="externalLink" href="http://helix.apache.org/javadocs/0.9.9/reference/org/apache/helix/messaging/DefaultMessagingService.html">Javadocs</a> for more information.</p>
+ </div>
+</div>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ </div><!-- /container -->
+
+ <!-- Footer
+ ================================================== -->
+ <footer class="well">
+ <div class="container">
+ <div class="row">
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Get Helix</li>
+ <li>
+ <a href="download.html" title="Download">Download </a>
+ </li>
+ <li>
+ <a href="Building.html" title="Building">Building </a>
+ </li>
+ <li>
+ <a href="releasenotes/release-0.9.9.html" title="Release Notes">Release Notes </a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Hands-On</li>
+ <li>
+ <a href="Quickstart.html" title="Quick Start">Quick Start </a>
+ </li>
+ <li>
+ <a href="Tutorial.html" title="Tutorial">Tutorial </a>
+ </li>
+ <li>
+ <a href="../javadocs/0.9.9" title="Javadocs">Javadocs </a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Recipes</li>
+ <li>
+ <a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager </a>
+ </li>
+ <li>
+ <a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group </a>
+ </li>
+ <li>
+ <a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store </a>
+ </li>
+ <li>
+ <a href="recipes/service_discovery.html" title="Service discovery">Service discovery </a>
+ </li>
+ <li>
+ <a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution </a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </footer>
+
+ <div class="container subfooter">
+ <div class="row">
+ <div class="span12">
+ <p class="pull-right"><a href="#">Back to top</a></p>
+ <p class="copyright">Copyright ©2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</p>
+ <p><a href="http://github.com/andriusvelykis/reflow-maven-skin" title="Reflow Maven skin">Reflow Maven skin</a> by <a href="http://andrius.velykis.lt" target="_blank" title="Andrius Velykis">Andrius Velykis</a>.</p>
+
+<div class="row span16">
+ <div>Apache Helix, Apache, the Apache feather logo, and the Apache Helix project logos are trademarks of The Apache Software Foundation.
+ All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
+ <a href="http://helix.apache.org/0.9.9-docs/privacy-policy.html">Privacy Policy</a>
+</div> </div>
+ </div>
+ </div>
+
+ <!-- Le javascript
+ ================================================== -->
+ <!-- Placed at the end of the document so the pages load faster -->
+
+ <!-- Fallback jQuery loading from Google CDN:
+ http://stackoverflow.com/questions/1014203/best-way-to-use-googles-hosted-jquery-but-fall-back-to-my-hosted-library-on-go -->
+ <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
+ <script type="text/javascript">
+ if (typeof jQuery == 'undefined')
+ {
+ document.write(unescape("%3Cscript src='./js/jquery-1.8.3.min.js' type='text/javascript'%3E%3C/script%3E"));
+ }
+ </script>
+
+ <script src="./js/bootstrap.min.js"></script>
+ <script src="./js/lightbox.js"></script>
+ <script src="./js/jquery.smooth-scroll.min.js"></script>
+ <!-- back button support for smooth scroll -->
+ <script src="./js/jquery.ba-bbq.min.js"></script>
+
+ <script src="./js/reflow-skin.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
Added: helix/site-content/0.9.9-docs/tutorial_participant.html
URL: http://svn.apache.org/viewvc/helix/site-content/0.9.9-docs/tutorial_participant.html?rev=1895217&view=auto
==============================================================================
--- helix/site-content/0.9.9-docs/tutorial_participant.html (added)
+++ helix/site-content/0.9.9-docs/tutorial_participant.html Sun Nov 21 07:08:41 2021
@@ -0,0 +1,322 @@
+
+<!DOCTYPE html>
+<!--
+ Generated by Apache Maven Doxia at 2021-11-21
+ Rendered using Maven Reflow Skin 1.0.0 (http://andriusvelykis.github.com/reflow-maven-skin)
+-->
+<html xml:lang="en" lang="en">
+
+ <head>
+ <meta charset="UTF-8" />
+ <title>Apache Helix - Tutorial - Participant</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="description" content="" />
+ <meta http-equiv="content-language" content="en" />
+
+ <link href="./css/bootstrap.min.css" rel="stylesheet" />
+ <link href="./css/bootstrap-responsive.min.css" rel="stylesheet" />
+ <link href="./css/docs.css" rel="stylesheet" />
+ <link href="./css/reflow-skin.css" rel="stylesheet" />
+
+
+ <link href="./css/lightbox.css" rel="stylesheet" />
+
+ <link href="./css/site.css" rel="stylesheet" />
+ <link href="./css/print.css" rel="stylesheet" media="print" />
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+<script type="text/javascript">var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-3211522-12']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();</script>
+ </head>
+
+ <body class="page-tutorial_participant project-099-docs" data-spy="scroll" data-offset="60" data-target="#toc-scroll-target">
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+ <a class="brand" href="..">Apache Helix</a>
+ <div class="nav-collapse">
+ <ul class="nav pull-right">
+ <li><a href="index.html" title="Helix 0.9.9">Helix 0.9.9 </a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Helix <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="download.html" title="Download">Download </a></li>
+ <li><a href="Building.html" title="Building">Building </a></li>
+ <li><a href="releasenotes/release-0.9.9.html" title="Release Notes">Release Notes </a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Hands-On <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="Quickstart.html" title="Quick Start">Quick Start </a></li>
+ <li><a href="Tutorial.html" title="Tutorial">Tutorial </a></li>
+ <li><a href="../javadocs/0.9.9" title="Javadocs">Javadocs </a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Recipes <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager </a></li>
+ <li><a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group </a></li>
+ <li><a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store </a></li>
+ <li><a href="recipes/service_discovery.html" title="Service discovery">Service discovery </a></li>
+ <li><a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution </a></li>
+ </ul>
+ </li>
+ </ul>
+ </div><!--/.nav-collapse -->
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+
+ <!-- Masthead
+ ================================================== -->
+ <header class="jumbotron subhead">
+ <div class="row" id="banner">
+ <div class="span12">
+ <div class="pull-left">
+ <a href="../" id="bannerLeft"><img src="../images/helix-logo.jpg" alt='"''"' /></a>
+ <p class="lead">A cluster management framework for partitioned and replicated distributed resources</p>
+ </div>
+ <div class="pull-right">
+ <a href="http://www.apache.org/" id="bannerRight"><img src="../images/feather_small.gif" alt='"''"' /></a>
+ </div>
+ </div>
+ </div>
+ <div>
+ <ul class="breadcrumb">
+ <li><a href="../" title="Apache Helix">Apache Helix </a></li>
+ <li class="divider">/</li>
+ <li><a href="./" title="Release 0.9.9">Release 0.9.9 </a></li>
+ <li class="divider">/</li>
+ <li> Tutorial - Participant</li>
+ <li class="publishDate version-date pull-right">Last Published: 2021-11-21</li>
+ </ul>
+ </div>
+ </header>
+
+ <div class="main-body">
+ <div class="row">
+ <div class="span12">
+ <div class="body-content">
+<!-- -
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License. -->
+<p></p>
+<div class="section">
+ <div class="page-header">
+ <h2 id="Helix_Tutorial:_Participant"><a href="./Tutorial.html">Helix Tutorial</a>: Participant</h2>
+ </div>
+ <p>In this chapter, we'll learn how to implement a <b>Participant</b>, which is a primary functional component of a distributed system.</p>
+ <div class="section">
+ <h3 id="Start_a_Connection">Start a Connection</h3>
+ <p>The Helix manager is a common component that connects each system component with the controller.</p>
+ <p>It requires the following parameters:</p>
+ <ul>
+ <li>clusterName: A logical name to represent the group of nodes</li>
+ <li>instanceName: A logical name of the process creating the manager instance. Generally this is host:port</li>
+ <li>instanceType: Type of the process. This can be one of the following types, in this case, use PARTICIPANT
+ <ul>
+ <li>CONTROLLER: Process that controls the cluster, any number of controllers can be started but only one will be active at any given time</li>
+ <li>PARTICIPANT: Process that performs the actual task in the distributed system</li>
+ <li>SPECTATOR: Process that observes the changes in the cluster</li>
+ <li>ADMIN: To carry out system admin actions</li>
+ </ul></li>
+ <li>zkConnectString: Connection string to ZooKeeper. This is of the form host1:port1,host2:port2,host3:port3</li>
+ </ul>
+ <p>After the Helix manager instance is created, the only thing that needs to be registered is the state model factory. The methods of the state model will be called when controller sends transitions to the participant. In this example, weâll use the OnlineOffline factory. Other options include:</p>
+ <ul>
+ <li>MasterSlaveStateModelFactory</li>
+ <li>LeaderStandbyStateModelFactory</li>
+ <li>BootstrapHandler</li>
+ </ul>
+ <div class="source">
+ <pre>manager = HelixManagerFactory.getZKHelixManager(clusterName,
+ instanceName,
+ InstanceType.PARTICIPANT,
+ zkConnectString);
+StateMachineEngine stateMach = manager.getStateMachineEngine();
+
+//create a stateModelFactory that returns a statemodel object for each partition.
+stateModelFactory = new OnlineOfflineStateModelFactory();
+stateMach.registerStateModelFactory(stateModelType, stateModelFactory);
+manager.connect();
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h3 id="Example_State_Model_Factory">Example State Model Factory</h3>
+ <p>Helix doesn't know what it means to change from OFFLINE-->ONLINE or ONLINE-->OFFLINE. The following code snippet shows where you insert your system logic for these two state transitions.</p>
+ <div class="source">
+ <pre>public class OnlineOfflineStateModelFactory extends
+ StateModelFactory<StateModel> {
+ @Override
+ public StateModel createNewStateModel(String stateUnitKey) {
+ OnlineOfflineStateModel stateModel = new OnlineOfflineStateModel();
+ return stateModel;
+ }
+ @StateModelInfo(states = "{'OFFLINE','ONLINE'}", initialState = "OFFINE")
+ public static class OnlineOfflineStateModel extends StateModel {
+ @Transition(from = "OFFLINE", to = "ONLINE")
+ public void onBecomeOnlineFromOffline(Message message,
+ NotificationContext context) {
+ System.out.println("OnlineOfflineStateModel.onBecomeOnlineFromOffline()");
+
+ ////////////////////////////////////////////////////////////////////////////////////////////////
+ // Application logic to handle transition //
+ // For example, you might start a service, run initialization, etc //
+ ////////////////////////////////////////////////////////////////////////////////////////////////
+ }
+
+ @Transition(from = "ONLINE", to = "OFFLINE")
+ public void onBecomeOfflineFromOnline(Message message,
+ NotificationContext context) {
+ System.out.println("OnlineOfflineStateModel.onBecomeOfflineFromOnline()");
+
+ ////////////////////////////////////////////////////////////////////////////////////////////////
+ // Application logic to handle transition //
+ // For example, you might shutdown a service, log this event, or change monitoring settings //
+ ////////////////////////////////////////////////////////////////////////////////////////////////
+ }
+ }
+}
+</pre>
+ </div>
+ </div>
+</div>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ </div><!-- /container -->
+
+ <!-- Footer
+ ================================================== -->
+ <footer class="well">
+ <div class="container">
+ <div class="row">
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Get Helix</li>
+ <li>
+ <a href="download.html" title="Download">Download </a>
+ </li>
+ <li>
+ <a href="Building.html" title="Building">Building </a>
+ </li>
+ <li>
+ <a href="releasenotes/release-0.9.9.html" title="Release Notes">Release Notes </a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Hands-On</li>
+ <li>
+ <a href="Quickstart.html" title="Quick Start">Quick Start </a>
+ </li>
+ <li>
+ <a href="Tutorial.html" title="Tutorial">Tutorial </a>
+ </li>
+ <li>
+ <a href="../javadocs/0.9.9" title="Javadocs">Javadocs </a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Recipes</li>
+ <li>
+ <a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager </a>
+ </li>
+ <li>
+ <a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group </a>
+ </li>
+ <li>
+ <a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store </a>
+ </li>
+ <li>
+ <a href="recipes/service_discovery.html" title="Service discovery">Service discovery </a>
+ </li>
+ <li>
+ <a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution </a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </footer>
+
+ <div class="container subfooter">
+ <div class="row">
+ <div class="span12">
+ <p class="pull-right"><a href="#">Back to top</a></p>
+ <p class="copyright">Copyright ©2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</p>
+ <p><a href="http://github.com/andriusvelykis/reflow-maven-skin" title="Reflow Maven skin">Reflow Maven skin</a> by <a href="http://andrius.velykis.lt" target="_blank" title="Andrius Velykis">Andrius Velykis</a>.</p>
+
+<div class="row span16">
+ <div>Apache Helix, Apache, the Apache feather logo, and the Apache Helix project logos are trademarks of The Apache Software Foundation.
+ All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
+ <a href="http://helix.apache.org/0.9.9-docs/privacy-policy.html">Privacy Policy</a>
+</div> </div>
+ </div>
+ </div>
+
+ <!-- Le javascript
+ ================================================== -->
+ <!-- Placed at the end of the document so the pages load faster -->
+
+ <!-- Fallback jQuery loading from Google CDN:
+ http://stackoverflow.com/questions/1014203/best-way-to-use-googles-hosted-jquery-but-fall-back-to-my-hosted-library-on-go -->
+ <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
+ <script type="text/javascript">
+ if (typeof jQuery == 'undefined')
+ {
+ document.write(unescape("%3Cscript src='./js/jquery-1.8.3.min.js' type='text/javascript'%3E%3C/script%3E"));
+ }
+ </script>
+
+ <script src="./js/bootstrap.min.js"></script>
+ <script src="./js/lightbox.js"></script>
+ <script src="./js/jquery.smooth-scroll.min.js"></script>
+ <!-- back button support for smooth scroll -->
+ <script src="./js/jquery.ba-bbq.min.js"></script>
+
+ <script src="./js/reflow-skin.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
Added: helix/site-content/0.9.9-docs/tutorial_propstore.html
URL: http://svn.apache.org/viewvc/helix/site-content/0.9.9-docs/tutorial_propstore.html?rev=1895217&view=auto
==============================================================================
--- helix/site-content/0.9.9-docs/tutorial_propstore.html (added)
+++ helix/site-content/0.9.9-docs/tutorial_propstore.html Sun Nov 21 07:08:41 2021
@@ -0,0 +1,253 @@
+
+<!DOCTYPE html>
+<!--
+ Generated by Apache Maven Doxia at 2021-11-21
+ Rendered using Maven Reflow Skin 1.0.0 (http://andriusvelykis.github.com/reflow-maven-skin)
+-->
+<html xml:lang="en" lang="en">
+
+ <head>
+ <meta charset="UTF-8" />
+ <title>Apache Helix - Tutorial - Application Property Store</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="description" content="" />
+ <meta http-equiv="content-language" content="en" />
+
+ <link href="./css/bootstrap.min.css" rel="stylesheet" />
+ <link href="./css/bootstrap-responsive.min.css" rel="stylesheet" />
+ <link href="./css/docs.css" rel="stylesheet" />
+ <link href="./css/reflow-skin.css" rel="stylesheet" />
+
+
+ <link href="./css/lightbox.css" rel="stylesheet" />
+
+ <link href="./css/site.css" rel="stylesheet" />
+ <link href="./css/print.css" rel="stylesheet" media="print" />
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+<script type="text/javascript">var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-3211522-12']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();</script>
+ </head>
+
+ <body class="page-tutorial_propstore project-099-docs" data-spy="scroll" data-offset="60" data-target="#toc-scroll-target">
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+ <a class="brand" href="..">Apache Helix</a>
+ <div class="nav-collapse">
+ <ul class="nav pull-right">
+ <li><a href="index.html" title="Helix 0.9.9">Helix 0.9.9 </a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Helix <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="download.html" title="Download">Download </a></li>
+ <li><a href="Building.html" title="Building">Building </a></li>
+ <li><a href="releasenotes/release-0.9.9.html" title="Release Notes">Release Notes </a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Hands-On <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="Quickstart.html" title="Quick Start">Quick Start </a></li>
+ <li><a href="Tutorial.html" title="Tutorial">Tutorial </a></li>
+ <li><a href="../javadocs/0.9.9" title="Javadocs">Javadocs </a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Recipes <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager </a></li>
+ <li><a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group </a></li>
+ <li><a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store </a></li>
+ <li><a href="recipes/service_discovery.html" title="Service discovery">Service discovery </a></li>
+ <li><a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution </a></li>
+ </ul>
+ </li>
+ </ul>
+ </div><!--/.nav-collapse -->
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+
+ <!-- Masthead
+ ================================================== -->
+ <header class="jumbotron subhead">
+ <div class="row" id="banner">
+ <div class="span12">
+ <div class="pull-left">
+ <a href="../" id="bannerLeft"><img src="../images/helix-logo.jpg" alt='"''"' /></a>
+ <p class="lead">A cluster management framework for partitioned and replicated distributed resources</p>
+ </div>
+ <div class="pull-right">
+ <a href="http://www.apache.org/" id="bannerRight"><img src="../images/feather_small.gif" alt='"''"' /></a>
+ </div>
+ </div>
+ </div>
+ <div>
+ <ul class="breadcrumb">
+ <li><a href="../" title="Apache Helix">Apache Helix </a></li>
+ <li class="divider">/</li>
+ <li><a href="./" title="Release 0.9.9">Release 0.9.9 </a></li>
+ <li class="divider">/</li>
+ <li> Tutorial - Application Property Store</li>
+ <li class="publishDate version-date pull-right">Last Published: 2021-11-21</li>
+ </ul>
+ </div>
+ </header>
+
+ <div class="main-body">
+ <div class="row">
+ <div class="span12">
+ <div class="body-content">
+<!-- -
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License. -->
+<p></p>
+<div class="section">
+ <div class="page-header">
+ <h2 id="Helix_Tutorial:_Application_Property_Store"><a href="./Tutorial.html">Helix Tutorial</a>: Application Property Store</h2>
+ </div>
+ <p>In this chapter, we'll learn how to use the application property store.</p>
+ <div class="section">
+ <h3 id="Property_Store">Property Store</h3>
+ <p>It is common that an application needs support for distributed, shared data structures. Helix uses ZooKeeper to store the application data and hence provides notifications when the data changes.</p>
+ <p>While you could use ZooKeeper directly, Helix supports caching the data with a write-through cache. This is far more efficient than reading from ZooKeeper for every access.</p>
+ <p>See <a class="externalLink" href="http://helix.apache.org/javadocs/0.9.9/reference/org/apache/helix/store/package-summary.html">HelixManager.getHelixPropertyStore</a> for details.</p>
+ </div>
+</div>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ </div><!-- /container -->
+
+ <!-- Footer
+ ================================================== -->
+ <footer class="well">
+ <div class="container">
+ <div class="row">
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Get Helix</li>
+ <li>
+ <a href="download.html" title="Download">Download </a>
+ </li>
+ <li>
+ <a href="Building.html" title="Building">Building </a>
+ </li>
+ <li>
+ <a href="releasenotes/release-0.9.9.html" title="Release Notes">Release Notes </a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Hands-On</li>
+ <li>
+ <a href="Quickstart.html" title="Quick Start">Quick Start </a>
+ </li>
+ <li>
+ <a href="Tutorial.html" title="Tutorial">Tutorial </a>
+ </li>
+ <li>
+ <a href="../javadocs/0.9.9" title="Javadocs">Javadocs </a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Recipes</li>
+ <li>
+ <a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager </a>
+ </li>
+ <li>
+ <a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group </a>
+ </li>
+ <li>
+ <a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store </a>
+ </li>
+ <li>
+ <a href="recipes/service_discovery.html" title="Service discovery">Service discovery </a>
+ </li>
+ <li>
+ <a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution </a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </footer>
+
+ <div class="container subfooter">
+ <div class="row">
+ <div class="span12">
+ <p class="pull-right"><a href="#">Back to top</a></p>
+ <p class="copyright">Copyright ©2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</p>
+ <p><a href="http://github.com/andriusvelykis/reflow-maven-skin" title="Reflow Maven skin">Reflow Maven skin</a> by <a href="http://andrius.velykis.lt" target="_blank" title="Andrius Velykis">Andrius Velykis</a>.</p>
+
+<div class="row span16">
+ <div>Apache Helix, Apache, the Apache feather logo, and the Apache Helix project logos are trademarks of The Apache Software Foundation.
+ All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
+ <a href="http://helix.apache.org/0.9.9-docs/privacy-policy.html">Privacy Policy</a>
+</div> </div>
+ </div>
+ </div>
+
+ <!-- Le javascript
+ ================================================== -->
+ <!-- Placed at the end of the document so the pages load faster -->
+
+ <!-- Fallback jQuery loading from Google CDN:
+ http://stackoverflow.com/questions/1014203/best-way-to-use-googles-hosted-jquery-but-fall-back-to-my-hosted-library-on-go -->
+ <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
+ <script type="text/javascript">
+ if (typeof jQuery == 'undefined')
+ {
+ document.write(unescape("%3Cscript src='./js/jquery-1.8.3.min.js' type='text/javascript'%3E%3C/script%3E"));
+ }
+ </script>
+
+ <script src="./js/bootstrap.min.js"></script>
+ <script src="./js/lightbox.js"></script>
+ <script src="./js/jquery.smooth-scroll.min.js"></script>
+ <!-- back button support for smooth scroll -->
+ <script src="./js/jquery.ba-bbq.min.js"></script>
+
+ <script src="./js/reflow-skin.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
Added: helix/site-content/0.9.9-docs/tutorial_rebalance.html
URL: http://svn.apache.org/viewvc/helix/site-content/0.9.9-docs/tutorial_rebalance.html?rev=1895217&view=auto
==============================================================================
--- helix/site-content/0.9.9-docs/tutorial_rebalance.html (added)
+++ helix/site-content/0.9.9-docs/tutorial_rebalance.html Sun Nov 21 07:08:41 2021
@@ -0,0 +1,389 @@
+
+<!DOCTYPE html>
+<!--
+ Generated by Apache Maven Doxia at 2021-11-21
+ Rendered using Maven Reflow Skin 1.0.0 (http://andriusvelykis.github.com/reflow-maven-skin)
+-->
+<html xml:lang="en" lang="en">
+
+ <head>
+ <meta charset="UTF-8" />
+ <title>Apache Helix - Tutorial - Rebalancing Algorithms</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="description" content="" />
+ <meta http-equiv="content-language" content="en" />
+
+ <link href="./css/bootstrap.min.css" rel="stylesheet" />
+ <link href="./css/bootstrap-responsive.min.css" rel="stylesheet" />
+ <link href="./css/docs.css" rel="stylesheet" />
+ <link href="./css/reflow-skin.css" rel="stylesheet" />
+
+
+ <link href="./css/lightbox.css" rel="stylesheet" />
+
+ <link href="./css/site.css" rel="stylesheet" />
+ <link href="./css/print.css" rel="stylesheet" media="print" />
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+<script type="text/javascript">var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-3211522-12']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();</script>
+ </head>
+
+ <body class="page-tutorial_rebalance project-099-docs" data-spy="scroll" data-offset="60" data-target="#toc-scroll-target">
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+ <a class="brand" href="..">Apache Helix</a>
+ <div class="nav-collapse">
+ <ul class="nav pull-right">
+ <li><a href="index.html" title="Helix 0.9.9">Helix 0.9.9 </a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Helix <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="download.html" title="Download">Download </a></li>
+ <li><a href="Building.html" title="Building">Building </a></li>
+ <li><a href="releasenotes/release-0.9.9.html" title="Release Notes">Release Notes </a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Hands-On <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="Quickstart.html" title="Quick Start">Quick Start </a></li>
+ <li><a href="Tutorial.html" title="Tutorial">Tutorial </a></li>
+ <li><a href="../javadocs/0.9.9" title="Javadocs">Javadocs </a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Recipes <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager </a></li>
+ <li><a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group </a></li>
+ <li><a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store </a></li>
+ <li><a href="recipes/service_discovery.html" title="Service discovery">Service discovery </a></li>
+ <li><a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution </a></li>
+ </ul>
+ </li>
+ </ul>
+ </div><!--/.nav-collapse -->
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+
+ <!-- Masthead
+ ================================================== -->
+ <header class="jumbotron subhead">
+ <div class="row" id="banner">
+ <div class="span12">
+ <div class="pull-left">
+ <a href="../" id="bannerLeft"><img src="../images/helix-logo.jpg" alt='"''"' /></a>
+ <p class="lead">A cluster management framework for partitioned and replicated distributed resources</p>
+ </div>
+ <div class="pull-right">
+ <a href="http://www.apache.org/" id="bannerRight"><img src="../images/feather_small.gif" alt='"''"' /></a>
+ </div>
+ </div>
+ </div>
+ <div>
+ <ul class="breadcrumb">
+ <li><a href="../" title="Apache Helix">Apache Helix </a></li>
+ <li class="divider">/</li>
+ <li><a href="./" title="Release 0.9.9">Release 0.9.9 </a></li>
+ <li class="divider">/</li>
+ <li> Tutorial - Rebalancing Algorithms</li>
+ <li class="publishDate version-date pull-right">Last Published: 2021-11-21</li>
+ </ul>
+ </div>
+ </header>
+
+ <div class="main-body">
+ <div class="row">
+ <div class="span12">
+ <div class="body-content">
+<!-- -
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License. -->
+<p></p>
+<div class="section">
+ <div class="page-header">
+ <h2 id="Helix_Tutorial:_Rebalancing_Algorithms"><a href="./Tutorial.html">Helix Tutorial</a>: Rebalancing Algorithms</h2>
+ </div>
+ <p>The placement of partitions in a distributed system is essential for the reliability and scalability of the system. For example, when a node fails, it is important that the partitions hosted on that node are reallocated evenly among the remaining nodes. Consistent hashing is one such algorithm that can satisfy this guarantee. Helix provides a variant of consistent hashing based on the RUSH algorithm, among others.</p>
+ <p>This means given a number of partitions, replicas and number of nodes, Helix does the automatic assignment of partition to nodes such that:</p>
+ <ul>
+ <li>Each node has the same number of partitions</li>
+ <li>Replicas of the same partition do not stay on the same node</li>
+ <li>When a node fails, the partitions will be equally distributed among the remaining nodes</li>
+ <li>When new nodes are added, the number of partitions moved will be minimized along with satisfying the above criteria</li>
+ </ul>
+ <p>Helix employs a rebalancing algorithm to compute the <i>ideal state</i> of the system. When the <i>current state</i> differs from the <i>ideal state</i>, Helix uses it as the target state of the system and computes the appropriate transitions needed to bring it to the <i>ideal state</i>.</p>
+ <p>Helix makes it easy to perform this operation, while giving you control over the algorithm. In this section, we'll see how to implement the desired behavior.</p>
+ <p>Helix has four options for rebalancing, in increasing order of customization by the system builder:</p>
+ <ul>
+ <li>FULL_AUTO</li>
+ <li>SEMI_AUTO</li>
+ <li>CUSTOMIZED</li>
+ <li>USER_DEFINED</li>
+ </ul>
+ <div class="source">
+ <pre> |FULL_AUTO | SEMI_AUTO | CUSTOMIZED| USER_DEFINED |
+ ---------------------------------------------------------|
+ LOCATION | HELIX | APP | APP | APP |
+ ---------------------------------------------------------|
+ STATE | HELIX | HELIX | APP | APP |
+ ----------------------------------------------------------
+</pre>
+ </div>
+ <div class="section">
+ <h3 id="FULL_AUTO">FULL_AUTO</h3>
+ <p>When the rebalance mode is set to FULL_AUTO, Helix controls both the location of the replica along with the state. This option is useful for applications where creation of a replica is not expensive.</p>
+ <p>For example, consider this system that uses a MasterSlave state model, with 3 partitions and 2 replicas in the ideal state.</p>
+ <div class="source">
+ <pre>{
+ "id" : "MyResource",
+ "simpleFields" : {
+ "REBALANCE_MODE" : "FULL_AUTO",
+ "NUM_PARTITIONS" : "3",
+ "REPLICAS" : "2",
+ "STATE_MODEL_DEF_REF" : "MasterSlave",
+ }
+ "listFields" : {
+ "MyResource_0" : [],
+ "MyResource_1" : [],
+ "MyResource_2" : []
+ },
+ "mapFields" : {
+ }
+}
+</pre>
+ </div>
+ <p>If there are 3 nodes in the cluster, then Helix will balance the masters and slaves equally. The ideal state is therefore:</p>
+ <div class="source">
+ <pre>{
+ "id" : "MyResource",
+ "simpleFields" : {
+ "NUM_PARTITIONS" : "3",
+ "REPLICAS" : "2",
+ "STATE_MODEL_DEF_REF" : "MasterSlave",
+ },
+ "mapFields" : {
+ "MyResource_0" : {
+ "N1" : "MASTER",
+ "N2" : "SLAVE",
+ },
+ "MyResource_1" : {
+ "N2" : "MASTER",
+ "N3" : "SLAVE",
+ },
+ "MyResource_2" : {
+ "N3" : "MASTER",
+ "N1" : "SLAVE",
+ }
+ }
+}
+</pre>
+ </div>
+ <p>Another typical example is evenly distributing a group of tasks among the currently healthy processes. For example, if there are 60 tasks and 4 nodes, Helix assigns 15 tasks to each node. When one node fails, Helix redistributes its 15 tasks to the remaining 3 nodes, resulting in a balanced 20 tasks per node. Similarly, if a node is added, Helix re-allocates 3 tasks from each of the 4 nodes to the 5th node, resulting in a balanced distribution of 12 tasks per node..</p>
+ </div>
+ <div class="section">
+ <h3 id="SEMI_AUTO">SEMI_AUTO</h3>
+ <p>When the application needs to control the placement of the replicas, use the SEMI_AUTO rebalance mode.</p>
+ <p>Example: In the ideal state below, the partition 'MyResource_0' is constrained to be placed only on node1 or node2. The choice of <i>state</i> is still controlled by Helix. That means MyResource_0.MASTER could be on node1 and MyResource_0.SLAVE on node2, or vice-versa but neither would be placed on node3.</p>
+ <div class="source">
+ <pre>{
+ "id" : "MyResource",
+ "simpleFields" : {
+ "REBALANCE_MODE" : "SEMI_AUTO",
+ "NUM_PARTITIONS" : "3",
+ "REPLICAS" : "2",
+ "STATE_MODEL_DEF_REF" : "MasterSlave",
+ }
+ "listFields" : {
+ "MyResource_0" : [node1, node2],
+ "MyResource_1" : [node2, node3],
+ "MyResource_2" : [node3, node1]
+ },
+ "mapFields" : {
+ }
+}
+</pre>
+ </div>
+ <p>The MasterSlave state model requires that a partition has exactly one MASTER at all times, and the other replicas should be SLAVEs. In this simple example with 2 replicas per partition, there would be one MASTER and one SLAVE. Upon failover, a SLAVE has to assume mastership, and a new SLAVE will be generated.</p>
+ <p>In this mode when node1 fails, unlike in FULL_AUTO mode the partition is <i>not</i> moved from node1 to node3. Instead, Helix will decide to change the state of MyResource_0 on node2 from SLAVE to MASTER, based on the system constraints.</p>
+ </div>
+ <div class="section">
+ <h3 id="CUSTOMIZED">CUSTOMIZED</h3>
+ <p>Helix offers a third mode called CUSTOMIZED, in which the application controls the placement <i>and</i> state of each replica. The application needs to implement a callback interface that Helix invokes when the cluster state changes. Within this callback, the application can recompute the idealstate. Helix will then issue appropriate transitions such that <i>Idealstate</i> and <i>Currentstate</i> converges.</p>
+ <p>Here's an example, again with 3 partitions, 2 replicas per partition, and the MasterSlave state model:</p>
+ <div class="source">
+ <pre>{
+ "id" : "MyResource",
+ "simpleFields" : {
+ "REBALANCE_MODE" : "CUSTOMIZED",
+ "NUM_PARTITIONS" : "3",
+ "REPLICAS" : "2",
+ "STATE_MODEL_DEF_REF" : "MasterSlave",
+ },
+ "mapFields" : {
+ "MyResource_0" : {
+ "N1" : "MASTER",
+ "N2" : "SLAVE",
+ },
+ "MyResource_1" : {
+ "N2" : "MASTER",
+ "N3" : "SLAVE",
+ },
+ "MyResource_2" : {
+ "N3" : "MASTER",
+ "N1" : "SLAVE",
+ }
+ }
+}
+</pre>
+ </div>
+ <p>Suppose the current state of the system is âMyResource_0â -> {N1:MASTER, N2:SLAVE} and the application changes the ideal state to âMyResource_0â -> {N1:SLAVE,N2:MASTER}. While the application decides which node is MASTER and which is SLAVE, Helix will not blindly issue MASTER-->SLAVE to N1 and SLAVE-->MASTER to N2 in parallel, since that might result in a transient state where both N1 and N2 are masters, which violates the MasterSlave constraint that there is exactly one MASTER at a time. Helix will first issue MASTER-->SLAVE to N1 and after it is completed, it will issue SLAVE-->MASTER to N2.</p>
+ </div>
+ <div class="section">
+ <h3 id="USER_DEFINED">USER_DEFINED</h3>
+ <p>For maximum flexibility, Helix exposes an interface that can allow applications to plug in custom rebalancing logic. By providing the name of a class that implements the Rebalancer interface, Helix will automatically call the contained method whenever there is a change to the live participants in the cluster. For more, see <a href="./tutorial_user_def_rebalancer.html">User-Defined Rebalancer</a>.</p>
+ </div>
+ <div class="section">
+ <h3 id="Backwards_Compatibility">Backwards Compatibility</h3>
+ <p>In previous versions, FULL_AUTO was called AUTO_REBALANCE and SEMI_AUTO was called AUTO. Furthermore, they were presented as the IDEAL_STATE_MODE. Helix supports both IDEAL_STATE_MODE and REBALANCE_MODE, but IDEAL_STATE_MODE is now deprecated and may be phased out in future versions.</p>
+ </div>
+</div>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ </div><!-- /container -->
+
+ <!-- Footer
+ ================================================== -->
+ <footer class="well">
+ <div class="container">
+ <div class="row">
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Get Helix</li>
+ <li>
+ <a href="download.html" title="Download">Download </a>
+ </li>
+ <li>
+ <a href="Building.html" title="Building">Building </a>
+ </li>
+ <li>
+ <a href="releasenotes/release-0.9.9.html" title="Release Notes">Release Notes </a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Hands-On</li>
+ <li>
+ <a href="Quickstart.html" title="Quick Start">Quick Start </a>
+ </li>
+ <li>
+ <a href="Tutorial.html" title="Tutorial">Tutorial </a>
+ </li>
+ <li>
+ <a href="../javadocs/0.9.9" title="Javadocs">Javadocs </a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Recipes</li>
+ <li>
+ <a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager </a>
+ </li>
+ <li>
+ <a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group </a>
+ </li>
+ <li>
+ <a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store </a>
+ </li>
+ <li>
+ <a href="recipes/service_discovery.html" title="Service discovery">Service discovery </a>
+ </li>
+ <li>
+ <a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution </a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </footer>
+
+ <div class="container subfooter">
+ <div class="row">
+ <div class="span12">
+ <p class="pull-right"><a href="#">Back to top</a></p>
+ <p class="copyright">Copyright ©2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</p>
+ <p><a href="http://github.com/andriusvelykis/reflow-maven-skin" title="Reflow Maven skin">Reflow Maven skin</a> by <a href="http://andrius.velykis.lt" target="_blank" title="Andrius Velykis">Andrius Velykis</a>.</p>
+
+<div class="row span16">
+ <div>Apache Helix, Apache, the Apache feather logo, and the Apache Helix project logos are trademarks of The Apache Software Foundation.
+ All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
+ <a href="http://helix.apache.org/0.9.9-docs/privacy-policy.html">Privacy Policy</a>
+</div> </div>
+ </div>
+ </div>
+
+ <!-- Le javascript
+ ================================================== -->
+ <!-- Placed at the end of the document so the pages load faster -->
+
+ <!-- Fallback jQuery loading from Google CDN:
+ http://stackoverflow.com/questions/1014203/best-way-to-use-googles-hosted-jquery-but-fall-back-to-my-hosted-library-on-go -->
+ <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
+ <script type="text/javascript">
+ if (typeof jQuery == 'undefined')
+ {
+ document.write(unescape("%3Cscript src='./js/jquery-1.8.3.min.js' type='text/javascript'%3E%3C/script%3E"));
+ }
+ </script>
+
+ <script src="./js/bootstrap.min.js"></script>
+ <script src="./js/lightbox.js"></script>
+ <script src="./js/jquery.smooth-scroll.min.js"></script>
+ <!-- back button support for smooth scroll -->
+ <script src="./js/jquery.ba-bbq.min.js"></script>
+
+ <script src="./js/reflow-skin.js"></script>
+
+ </body>
+</html>
\ No newline at end of file