You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@helix.apache.org by lx...@apache.org on 2017/01/20 01:12:30 UTC
svn commit: r1779549 [15/18] - in /helix/site-content: ./
0.6.1-incubating-docs/ 0.6.1-incubating-docs/recipes/
0.6.1-incubating-docs/releasenotes/ 0.6.2-incubating-docs/
0.6.2-incubating-docs/recipes/ 0.6.2-incubating-docs/releasenotes/
0.6.3-docs/ 0....
Added: helix/site-content/0.6.7-docs/tutorial_state.html
URL: http://svn.apache.org/viewvc/helix/site-content/0.6.7-docs/tutorial_state.html?rev=1779549&view=auto
==============================================================================
--- helix/site-content/0.6.7-docs/tutorial_state.html (added)
+++ helix/site-content/0.6.7-docs/tutorial_state.html Fri Jan 20 01:12:25 2017
@@ -0,0 +1,355 @@
+
+<!DOCTYPE html>
+<!--
+ Generated by Apache Maven Doxia at 2017-01-19
+ 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 - State Machine Configuration</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="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/css/bootstrap.min.css" rel="stylesheet" />
+ <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/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_state project-067-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.6.7">Helix 0.6.7 </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.6.7.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.6.7" 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.6.7">Release 0.6.7 </a></li>
+ <li class="divider">/</li>
+ <li> Tutorial - State Machine Configuration</li>
+ <li class="publishDate version-date pull-right">Last Published: 2017-01-19</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:_State_Machine_Configuration"><a href="./Tutorial.html">Helix Tutorial</a>: State Machine Configuration</h2>
+ </div>
+ <p>In this chapter, we'll learn about the state models provided by Helix, and how to create your own custom state model.</p>
+ <div class="section">
+ <h3 id="State_Models">State Models</h3>
+ <p>Helix comes with 3 default state models that are commonly used. It is possible to have multiple state models in a cluster. Every resource that is added should be configured to use a state model that govern its <i>ideal state</i>.</p>
+ <div class="section">
+ <h4 id="MASTER-SLAVE">MASTER-SLAVE</h4>
+ <ul>
+ <li>3 states: OFFLINE, SLAVE, MASTER</li>
+ <li>Maximum number of masters: 1</li>
+ <li>Slaves are based on the replication factor. The replication factor can be specified while adding the resource.</li>
+ </ul>
+ </div>
+ <div class="section">
+ <h4 id="ONLINE-OFFLINE">ONLINE-OFFLINE</h4>
+ <ul>
+ <li>Has 2 states: OFFLINE and ONLINE. This simple state model is a good starting point for most applications.</li>
+ </ul>
+ </div>
+ <div class="section">
+ <h4 id="LEADER-STANDBY">LEADER-STANDBY</h4>
+ <ul>
+ <li>1 Leader and multiple stand-bys. The idea is that exactly one leader accomplishes a designated task, the stand-bys are ready to take over if the leader fails.</li>
+ </ul>
+ </div>
+ </div>
+ <div class="section">
+ <h3 id="Constraints">Constraints</h3>
+ <p>In addition to the state machine configuration, one can specify the constraints of states and transitions.</p>
+ <p>For example, one can say:</p>
+ <ul>
+ <li> <p>MASTER:1 <br />Maximum number of replicas in MASTER state at any time is 1</p></li>
+ <li> <p>OFFLINE-SLAVE:5 <br />Maximum number of OFFLINE-SLAVE transitions that can happen concurrently in the system is 5 in this example.</p></li>
+ </ul>
+ <div class="section">
+ <h4 id="Dynamic_State_Constraints">Dynamic State Constraints</h4>
+ <p>We also support two dynamic upper bounds for the number of replicas in each state:</p>
+ <ul>
+ <li>N: The number of replicas in the state is at most the number of live participants in the cluster</li>
+ <li>R: The number of replicas in the state is at most the specified replica count for the partition</li>
+ </ul>
+ </div>
+ <div class="section">
+ <h4 id="State_Priority">State Priority</h4>
+ <p>Helix uses a greedy approach to satisfy the state constraints. For example, if the state machine configuration says it needs 1 MASTER and 2 SLAVES, but only 1 node is active, Helix must promote it to MASTER. This behavior is achieved by providing the state priority list as [MASTER, SLAVE].</p>
+ </div>
+ <div class="section">
+ <h4 id="State_Transition_Priority">State Transition Priority</h4>
+ <p>Helix tries to fire as many transitions as possible in parallel to reach the stable state without violating constraints. By default, Helix simply sorts the transitions alphabetically and fires as many as it can without violating the constraints. You can control this by overriding the priority order.</p>
+ </div>
+ </div>
+ <div class="section">
+ <h3 id="Special_States">Special States</h3>
+ <p>There are a few Helix-defined states that are important to be aware of.</p>
+ <div class="section">
+ <h4 id="DROPPED">DROPPED</h4>
+ <p>The DROPPED state is used to signify a replica that was served by a given participant, but is no longer served. This allows Helix and its participants to effectively clean up. There are two requirements that every new state model should follow with respect to the DROPPED state:</p>
+ <ul>
+ <li>The DROPPED state must be defined</li>
+ <li>There must be a path to DROPPED for every state in the model</li>
+ </ul>
+ </div>
+ <div class="section">
+ <h4 id="ERROR">ERROR</h4>
+ <p>The ERROR state is used whenever the participant serving a partition encountered an error and cannot continue to serve the partition. HelixAdmin has "reset" functionality to allow for participants to recover from the ERROR state.</p>
+ </div>
+ </div>
+ <div class="section">
+ <h3 id="Annotated_Example">Annotated Example</h3>
+ <p>Below is a complete definition of a Master-Slave state model. Notice the fields marked REQUIRED; these are essential for any state model definition.</p>
+ <div class="source">
+ <pre>StateModelDefinition stateModel = new StateModelDefinition.Builder("MasterSlave")
+ // OFFLINE is the state that the system starts in (initial state is REQUIRED)
+ .initialState("OFFLINE")
+
+ // Lowest number here indicates highest priority, no value indicates lowest priority
+ .addState("MASTER", 1)
+ .addState("SLAVE", 2)
+ .addState("OFFLINE")
+
+ // Note the special inclusion of the DROPPED state (REQUIRED)
+ .addState(HelixDefinedState.DROPPED.toString())
+
+ // No more than one master allowed
+ .upperBound("MASTER", 1)
+
+ // R indicates an upper bound of number of replicas for each partition
+ .dynamicUpperBound("SLAVE", "R")
+
+ // Add some high-priority transitions
+ .addTransition("SLAVE", "MASTER", 1)
+ .addTransition("OFFLINE", "SLAVE", 2)
+
+ // Using the same priority value indicates that these transitions can fire in any order
+ .addTransition("MASTER", "SLAVE", 3)
+ .addTransition("SLAVE", "OFFLINE", 3)
+
+ // Not specifying a value defaults to lowest priority
+ // Notice the inclusion of the OFFLINE to DROPPED transition
+ // Since every state has a path to OFFLINE, they each now have a path to DROPPED (REQUIRED)
+ .addTransition("OFFLINE", HelixDefinedState.DROPPED.toString())
+
+ // Create the StateModelDefinition instance
+ .build();
+
+ // Use the isValid() function to make sure the StateModelDefinition will work without issues
+ Assert.assertTrue(stateModel.isValid());
+</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.6.7.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.6.7" 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 ©2017 <a href="http://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.6.7-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="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/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.6.7-docs/tutorial_task_framework.html
URL: http://svn.apache.org/viewvc/helix/site-content/0.6.7-docs/tutorial_task_framework.html?rev=1779549&view=auto
==============================================================================
--- helix/site-content/0.6.7-docs/tutorial_task_framework.html (added)
+++ helix/site-content/0.6.7-docs/tutorial_task_framework.html Fri Jan 20 01:12:25 2017
@@ -0,0 +1,652 @@
+
+<!DOCTYPE html>
+<!--
+ Generated by Apache Maven Doxia at 2017-01-19
+ 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 - Task Framework</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="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/css/bootstrap.min.css" rel="stylesheet" />
+ <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/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_task_framework project-067-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.6.7">Helix 0.6.7 </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.6.7.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.6.7" 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.6.7">Release 0.6.7 </a></li>
+ <li class="divider">/</li>
+ <li> Tutorial - Task Framework</li>
+ <li class="publishDate version-date pull-right">Last Published: 2017-01-19</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:_Task_Framework"><a href="./Tutorial.html">Helix Tutorial</a>: Task Framework</h2>
+ </div>
+ <p>Task framework, in Helix, provides executable task scheduling and workflow management. In Helix, three layers of task abstraction have been offered to user for defining their logics of dependencies. The graph shows the relationships between three layers. Workflow can contain multiple jobs. One job can depend on other one. Multiple tasks, including same task different partition and different task different partition, can be added in one job. Task framework not only can abstract three layers task logics but also helps doing task assignment and rebalancing. User can create a workflow (or a job queue) at first beginning. Then jobs can be added into workflow. Those jobs contain the executable tasks implemented by user. Once workflow is completed, Helix will schedule the works based on the condition user provided.</p>
+ <p><img src="./images/TaskFrameworkLayers.png" alt="Task Framework flow chart" /></p>
+ <div class="section">
+ <h3 id="Key_Concepts">Key Concepts</h3>
+ <ul>
+ <li>Task is the basic unit in Helix task framework. It can represents the a single runnable logics that user prefer to execute for each partition (distributed units).</li>
+ <li>Job defines one time operation across all the partitions. It contains multiple Tasks and configuration of tasks, such as how many tasks, timeout per task and so on.</li>
+ <li>Workflow is directed acyclic graph represents the relationships and running orders of Jobs. In addition, a workflow can also provide customized configuration, for example, Job dependencies.</li>
+ <li>JobQueue is another type of Workflow. Different from normal one, JobQueue is not terminated until user kill it. Also JobQueue can keep accepting newly coming jobs.</li>
+ </ul>
+ </div>
+ <div class="section">
+ <h3 id="Implement_Your_Task">Implement Your Task</h3>
+ <div class="section">
+ <h4 id="Task_Interface"><a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/Task.java">Task Interface</a></h4>
+ <p>The task interface contains two methods: run and cancel. User can implement his or her own logic in run function and cancel / roll back logic in cancel function.</p>
+ <div class="source">
+ <pre>public class MyTask implements Task {
+ @Override
+ TaskResult run() {
+ // Task logic
+ }
+
+ @Override
+ void cancel() {
+ // Cancel logic
+ }
+}
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="TaskConfig"><a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/TaskConfig.java">TaskConfig</a></h4>
+ <p>In helix, usually an object config represents the abstraction of that object, such as TaskConfig, JobConfig and WorkflowConfig. TaskConfig contains configurable task conditions. TaskConfig does not require to have any input to create a new object:</p>
+ <div class="source">
+ <pre>TaskConfig taskConfig = new TaskConfig(null, null, null, null);
+</pre>
+ </div>
+ <p>For these four fields: * Command: The task command, will use Job command if this is null * ID: Task unique id, will generate a new ID for this task if input is null * TaskTargetPartition: Target partition of a target. Could be null * ConfigMap: Task property key-value map containing all other property stated above, such as command, ID.</p>
+ </div>
+ <div class="section">
+ <h4 id="Share_Content_Across_Tasks_and_Jobs">Share Content Across Tasks and Jobs</h4>
+ <p>Task framework also provides a feature that user can store the key-value data per task, job and workflow. The content stored at workflow layer can shared by different jobs belong to this workflow. Similarly content persisted at job layer can shared by different tasks nested in this job. Currently, user can extend the abstract class <a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/UserContentStore.java">UserContentStore</a> and use two methods putUserContent and getUserContent. It will similar to hash map put and get method except a Scope. The Scope will define which layer this key-value pair to be persisted.</p>
+ <div class="source">
+ <pre>public class MyTask extends UserContentStore implements Task {
+ @Override
+ TaskResult run() {
+ putUserContent("KEY", "WORKFLOWVALUE", SCOPE.WORKFLOW);
+ putUserContent("KEY", "JOBVALUE", SCOPE.JOB);
+ putUserContent("KEY", "TASKVALUE", SCOPE.TASK);
+ String taskValue = getUserContent("KEY", SCOPE.TASK);
+ }
+ ...
+}
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="Return_Task_Results">Return <a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/TaskResult.java">Task Results</a></h4>
+ <p>User can define the TaskResult for a task once it is at final stage (complete or failed). The TaskResult contains two fields: status and info. Status is current Task Status including COMPLETED, CANCELLED, FAILED and FATAL_FAILED. The difference between FAILED and FATAL_FAILED is that once the task defined as FATAL_FAILED, helix will not do the retry for this task and abort it. The other field is information, which is a String type. User can pass any information including error message, description and so on.</p>
+ <div class="source">
+ <pre>TaskResult run() {
+ ....
+ return new TaskResult(TaskResult.Status.FAILED, "ERROR MESSAGE OR OTHER INFORMATION");
+}
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="Task_Retry_and_Abort">Task Retry and Abort</h4>
+ <p>Helix provides retry logics to users. User can specify the how many times allowed to tolerant failure of tasks under a job. It is a method will be introduced in Following Job Section. Another choice offered to user that if user thinks a task is very critical and do not want to do the retry once it is failed, user can return a TaskResult stated above with FATAL_FAILED status. Then Helix will not do the retry for that task.</p>
+ <div class="source">
+ <pre>return new TaskResult(TaskResult.Status.FATAL_FAILED, "DO NOT WANT TO RETRY, ERROR MESSAGE");
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="TaskDriver"><a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/TaskDriver.java">TaskDriver</a></h4>
+ <p>All the control operation related to workflow and job are based on TaskDriver object. TaskDriver offers several APIs to controller, modify and track the tasks. Those APIs will be introduced in each section when they are necessary. TaskDriver object can be created either by <a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/HelixManager.java">HelixManager</a> or <a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/manager/zk/ZkClient.java">ZkClient</a> with cluster name:</p>
+ <div class="source">
+ <pre>HelixManager manager = new ZKHelixManager(CLUSTER_NAME, INSTANCE_NAME, InstanceType.PARTICIPANT, ZK_ADDRESS);
+TaskDriver taskDriver1 = new TaskDriver(manager);
+
+TaskDriver taskDriver2 = new TaskDriver(zkclient, CLUSTER_NAME);
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="Propagate_Task_Error_Message_to_Helix">Propagate Task Error Message to Helix</h4>
+ <p>When task encounter an error, it could be returned by TaskResult. Unfortunately, user can not get this TaskResult object directly. But Helix provides error messages persistent. Thus user can fetch the error messages from Helix via TaskDriver, which introduced above. The error messages will be stored in Info field per Job. Thus user have to get JobContext, which is the job status and result object.</p>
+ <div class="source">
+ <pre>taskDriver.getJobContext("JOBNAME").getInfo();
+</pre>
+ </div>
+ </div>
+ </div>
+ <div class="section">
+ <h3 id="Creating_a_Workflow">Creating a Workflow</h3>
+ <div class="section">
+ <h4 id="One-time_Workflow">One-time Workflow</h4>
+ <p>As common use, one-time workflow will be the default workflow as user created. The first step is to create a WorkflowConfig.Builder object with workflow name. Then all configs can be set in WorkflowConfig.Builder. Once the configuration is done, <a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/WorkflowConfig.java">WorkflowConfig</a> object can be got from WorkflowConfig.Builder object. We have two rules to validate the Workflow configuration: * Expiry time should not be less than 0 * Schedule config should be valid either one-time or a positive interval magnitude (Recurrent workflow) Example:</p>
+ <div class="source">
+ <pre>Workflow.Builder myWorkflowBuilder = new Workflow.Builder("MyWorkflow");
+myWorkflowBuilder.setExpiry(5000L);
+Workflow myWorkflow = myWorkflowBuilder.build();
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="Recurrent_Workflow">Recurrent Workflow</h4>
+ <p>Recurrent workflow is the workflow scheduled periodically. The only config different from One-time workflow is to set a recurrent <a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/ScheduleConfig.java">ScheduleConfig</a>. There two methods in ScheduleConfig can help you to create a ScheduleConfig object: recurringFromNow and recurringFromDate. Both of them needs recurUnit (time unit for recurrent) and recurInteval (magnitude of recurrent interval). Here’s the example:</p>
+ <div class="source">
+ <pre>ScheduleConfig myConfig1 = ScheduleConfig.recurringFFromNow(TimeUnit.MINUTES, 5L);
+ScheduleConfig myConfig2 = ScheduleConfig.recurringFFromDate(Calendar.getInstance.getTime, TimeUnit.HOURS, 10L);
+</pre>
+ </div>
+ <p>Once this schedule config is created. It could be set in the workflow config:</p>
+ <div class="source">
+ <pre>Workflow.Builder myWorkflowBuilder = new Workflow.Builder("MyWorkflow");
+myWorkflowBuilder.setExpiry(2000L)
+ .setScheduleConfig(ScheduleConfig.recurringFromNow(TimeUnit.DAYS, 5));
+Workflow myWorkflow = myWorkflowBuilder.build();
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="Start_a_Workflow">Start a Workflow</h4>
+ <p>Start a workflow is just using taskdrive to start it. Since this is an async call, after start the workflow, user can keep doing actions.</p>
+ <div class="source">
+ <pre>taskDriver.start(myWorkflow);
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="Stop_a_Workflow">Stop a Workflow</h4>
+ <p>Stop workflow can be executed via TaskDriver:</p>
+ <div class="source">
+ <pre>taskDriver.stop(myWorkflow);
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="Resume_a_Workflow">Resume a Workflow</h4>
+ <p>Once the workflow is stopped, it does not mean the workflow is gone. Thus user can resume the workflow that has been stopped. Using TaskDriver resume the workflow:</p>
+ <div class="source">
+ <pre>taskDriver.resume(myWorkflow);
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="Delete_a_Workflow">Delete a Workflow</h4>
+ <p>Simliar to start, stop and resume, delete operation is supported by TaskDriver.</p>
+ <div class="source">
+ <pre>taskDriver.delete(myWorkflow);
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="Add_a_Job">Add a Job</h4>
+ <p>WARNING: Job can only be added to WorkflowConfig.Builder. Once WorkflowConfig built, no job can be added! For creating a Job, please refering following section (Create a Job)</p>
+ <div class="source">
+ <pre>myWorkflowBuilder.addJob("JobName", jobConfigBuilder);
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="Add_a_Job_dependency">Add a Job dependency</h4>
+ <p>Jobs can have dependencies. If one job2 depends job1, job2 will not be scheduled until job1 finished.</p>
+ <div class="source">
+ <pre>myWorkflowBuilder.addParentChildDependency(ParentJobName, ChildJobName);
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="Additional_Workflow_Options">Additional Workflow Options</h4>
+ <table border="0" class="bodyTable table table-striped table-hover">
+ <thead>
+ <tr class="a">
+ <th>Additional Config Options </th>
+ <th>Detail </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr class="b">
+ <td><i>setJobDag(JobDag v)</i> </td>
+ <td>If user already defined the job DAG, it could be set with this method. </td>
+ </tr>
+ <tr class="a">
+ <td><i>setExpiry(long v, TimeUnit unit)</i> </td>
+ <td>Set the expiration time for this workflow. </td>
+ </tr>
+ <tr class="b">
+ <td><i>setFailureThreshold(int failureThreshold)</i> </td>
+ <td>Set the failure threshold for this workflow, once job failures reach this number, the workflow will be failed. </td>
+ </tr>
+ <tr class="a">
+ <td><i>setWorkflowType(String workflowType)</i> </td>
+ <td>Set the user defined workflowType for this workflow. </td>
+ </tr>
+ <tr class="b">
+ <td><i>setTerminable(boolean isTerminable)</i> </td>
+ <td>Set the whether this workflow is terminable or not. </td>
+ </tr>
+ <tr class="a">
+ <td><i>setCapacity(int capacity)</i> </td>
+ <td>Set the number of jobs that workflow can hold before reject further jobs. Only used when workflow is not terminable. </td>
+ </tr>
+ <tr class="b">
+ <td><i>setTargetState(TargetState v)</i> </td>
+ <td>Set the final state of this workflow. </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="section">
+ <h3 id="Creating_a_Queue">Creating a Queue</h3>
+ <p><a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/JobQueue.java">Job queue</a> is another shape of workflow. Here listed different between a job queue and workflow:</p>
+ <table border="0" class="bodyTable table table-striped table-hover">
+ <thead>
+ <tr class="a">
+ <th>Property </th>
+ <th>Workflow </th>
+ <th>Job Queue </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr class="b">
+ <td>Existing time </td>
+ <td>Workflow will be deleted after it is done. </td>
+ <td>Job queue will be there until user delete it. </td>
+ </tr>
+ <tr class="a">
+ <td>Add jobs </td>
+ <td>Once workflow is build, no job can be added. </td>
+ <td>Job queue can keep accepting jobs. </td>
+ </tr>
+ <tr class="b">
+ <td>Parallel run </td>
+ <td>Allows parallel run for jobs without dependencies </td>
+ <td>No parallel run allowed except setting <i>ParallelJobs</i> </td>
+ </tr>
+ </tbody>
+ </table>
+ <p>For creating a job queue, user have to provide queue name and workflow config (please refer above Create a Workflow). Similar to other task object, create a JobQueue.Builder first. Then JobQueue can be validated and generated via build function.</p>
+ <div class="source">
+ <pre>WorkflowConfig.Builder myWorkflowCfgBuilder = new WorkflowConfig.Builder().setWorkFlowType("MyType");
+JobQueue jobQueue = new JobQueue.Builder("MyQueueName").setWorkflowConfig(myWorkflowCfgBuilder.build()).build();
+</pre>
+ </div>
+ <div class="section">
+ <h4 id="Append_Job_to_Queue">Append Job to Queue</h4>
+ <p>WARNING:Different from normal workflow, job for JobQueue can be append even in anytime. Similar to workflow add a job, job can be appended via enqueueJob function via TaskDriver.</p>
+ <div class="source">
+ <pre>jobQueueBuilder.enqueueJob("JobName", jobConfigBuilder);
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="Delete_Job_from_Queue">Delete Job from Queue</h4>
+ <p>Helix allowed user to delete a job from existing queue. We offers delete API in TaskDriver to do this. Delete job from queue and this queue has to be stopped. Then user can resume the job once delete success.</p>
+ <div class="source">
+ <pre>taskDriver.stop("QueueName");
+taskDriver.deleteJob("QueueName", "JobName");
+taskDriver.resume("QueueName");
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="Additional_Option_for_JobQueue">Additional Option for JobQueue</h4>
+ <p><i>setParallelJobs(int parallelJobs)</i> : Set the how many jobs can parallel running, except there is any dependencies.</p>
+ </div>
+ </div>
+ <div class="section">
+ <h3 id="Create_a_Job">Create a Job</h3>
+ <p>Before generate a <a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/JobConfig.java">JobConfig</a> object, user still have to use JobConfig.Builder to build JobConfig.</p>
+ <div class="source">
+ <pre>JobConfig.Builder myJobCfgBuilder = new JobConfig.Builder();
+JobConfig myJobCfg = myJobCfgBuilder.build();
+</pre>
+ </div>
+ <p>Helix has couple rules to validate a job: * Each job must at least have one task to execute. For adding tasks and task rules please refer following section Add Tasks. * Task timeout should not less than zero. * Number of concurrent tasks per instances should not less than one. * Maximum attempts per task should not less than one * There must be a workflow name</p>
+ <div class="section">
+ <h4 id="Add_Tasks">Add Tasks</h4>
+ <p>There are two ways of adding tasks: * Add by TaskConfig. Tasks can be added via adding TaskConfigs. User can create a List of TaskConfigs or add TaskConfigMap, which is a task id to TaskConfig mapping.</p>
+ <div class="source">
+ <pre>TaskConfig taskCfg = new TaskConfig(null, null, null, null);
+List<TaskConfig> taskCfgs = new ArrayList<TaskConfig>();
+myJobCfg.addTaskConfigs(taskCfgs);
+
+Map<String, TaskConfig> taskCfgMap = new HashMap<String, TaskConfig>();
+taskCfgMap.put(taskCfg.getId(), taskCfg);
+myJobCfg.addTaskConfigMap(taskCfgMap);
+</pre>
+ </div>
+ <ul>
+ <li>Add by Job command. If user does not want to specify each TaskConfig, we can create identical tasks based on Job command with number of tasks.</li>
+ </ul>
+ <div class="source">
+ <pre>myJobCfg.setCommand("JobCommand").setNumberOfTasks(10);
+</pre>
+ </div>
+ <p>WARNING: Either user provides TaskConfigs / TaskConfigMap or both of Job command and number tasks (except Targeted Job, refer following section) . Otherwise, validation will be failed.</p>
+ </div>
+ <div class="section">
+ <h4 id="Generic_Job">Generic Job</h4>
+ <p>Generic Job is the default job created. It does not have targeted resource. Thus this generic job could be assigned to one of eligble instances.</p>
+ </div>
+ <div class="section">
+ <h4 id="Targeted_Job">Targeted Job</h4>
+ <p>Targeted Job has set up the target resource. For this kind of job, Job command is necessary, but number of tasks is not. The tasks will depends on the partion number of targeted resource. To set target resource, just put target resource name to JobConfig.Builder.</p>
+ <div class="source">
+ <pre>myJobCfgBuilder.setTargetResource("TargetResourceName");
+</pre>
+ </div>
+ <p>In addition, user can specify the instance target state. For example, if user want to run the Task on “Master” state instance, setTargetPartitionState method can help to set the partition to assign to specific instance.</p>
+ <div class="source">
+ <pre>myJobCfgBuilder.setTargetPartitionState(Arrays.asList(new String[]{"Master", "Slave"}));
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="Instance_Group">Instance Group</h4>
+ <p>Grouping jobs with targeted group of instances feature has been supported. User firstly have to define the instance group tag for instances, which means label some instances with specific tag. Then user can put those tags to a job that only would like to assigned to those instances. For example, customer data only available on instance 1, 2, 3. These three instances can be tagged as “CUSTOMER” and customer data related jobs can set the instance group tag “CUSTOMER”. Thus customer data related jobs will only assign to instance 1, 2, 3. To add instance group tag, just set it in JobConfig.Builder:</p>
+ <div class="source">
+ <pre>jobCfg.setInstanceGroupTag("INSTANCEGROUPTAG");
+</pre>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="Additional_Job_Options">Additional Job Options</h4>
+ <table border="0" class="bodyTable table table-striped table-hover">
+ <thead>
+ <tr class="a">
+ <th>Operation </th>
+ <th>Detail </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr class="b">
+ <td><i>setWorkflow(String workflowName)</i> </td>
+ <td>Set the workflow that this job belongs to </td>
+ </tr>
+ <tr class="a">
+ <td><i>setTargetPartions(List<String> targetPartionNames)</i> </td>
+ <td>Set list of partition names </td>
+ </tr>
+ <tr class="b">
+ <td><i>setTargetPartionStates(Set<String>)</i> </td>
+ <td>Set the partition states </td>
+ </tr>
+ <tr class="a">
+ <td><i>setCommand(String command)</i> </td>
+ <td>Set the job command </td>
+ </tr>
+ <tr class="b">
+ <td><i>setJobCommandConfigMap(Map<String, String> v)</i> </td>
+ <td>Set the job command config maps </td>
+ </tr>
+ <tr class="a">
+ <td><i>setTimeoutPerTask(long v)</i> </td>
+ <td>Set the timeout for each task </td>
+ </tr>
+ <tr class="b">
+ <td><i>setNumConcurrentTasksPerInstance(int v)</i> </td>
+ <td>Set number of tasks can concurrent run on same instance </td>
+ </tr>
+ <tr class="a">
+ <td><i>setMaxAttemptsPerTask(int v)</i> </td>
+ <td>Set times of retry for a task </td>
+ </tr>
+ <tr class="b">
+ <td><i>setFailureThreshold(int v)</i> </td>
+ <td>Set failure tolerance of tasks for this job </td>
+ </tr>
+ <tr class="a">
+ <td><i>setTaskRetryDelay(long v)</i> </td>
+ <td>Set the delay time before a task retry </td>
+ </tr>
+ <tr class="b">
+ <td><i>setIgnoreDependentJobFailure(boolean ignoreDependentJobFailure)</i> </td>
+ <td>Set whether ignore the job failure of parent job of this job </td>
+ </tr>
+ <tr class="a">
+ <td><i>setJobType(String jobType)</i> </td>
+ <td>Set the job type of this job </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="section">
+ <h3 id="Monitor_the_status_of_your_job">Monitor the status of your job</h3>
+ <p>As we introduced the excellent util TaskDriver in Workflow Section, we have extra more functionality that provided to user. The user can synchronized wait Job or Workflow until it reaches certain STATES. The function Helix have API pollForJobState and pollForWorkflowState. For pollForJobState, it accepts arguments: * Workflow name, required * Job name, required * Timeout, not required, will be three minutes if user choose function without timeout argument. Time unit is milisecond. * TaskStates, at least one state. This function can accept multiple TaskState, will end function until one of those TaskState reaches. For example:</p>
+ <div class="source">
+ <pre>taskDriver.pollForJobState("MyWorkflowName", "MyJobName", 180000L, TaskState.FAILED, TaskState.FATAL_FAILED);
+taskDriver.pollForJobState("MyWorkflowName", "MyJobName", TaskState.COMPLETED);
+</pre>
+ </div>
+ <p>For pollForWorkflowState, it accepts similar arguments except Job name. For example:</p>
+ <div class="source">
+ <pre>taskDriver.pollForWorkflowState("MyWorkflowName", 180000L, TaskState.FAILED, TaskState.FATAL_FAILED);
+taskDriver.pollForWorkflowState("MyWorkflowName", TaskState.COMPLETED);
+</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.6.7.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.6.7" 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 ©2017 <a href="http://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.6.7-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="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/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.6.7-docs/tutorial_throttling.html
URL: http://svn.apache.org/viewvc/helix/site-content/0.6.7-docs/tutorial_throttling.html?rev=1779549&view=auto
==============================================================================
--- helix/site-content/0.6.7-docs/tutorial_throttling.html (added)
+++ helix/site-content/0.6.7-docs/tutorial_throttling.html Fri Jan 20 01:12:25 2017
@@ -0,0 +1,258 @@
+
+<!DOCTYPE html>
+<!--
+ Generated by Apache Maven Doxia at 2017-01-19
+ 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 - Throttling</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="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/css/bootstrap.min.css" rel="stylesheet" />
+ <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/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_throttling project-067-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.6.7">Helix 0.6.7 </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.6.7.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.6.7" 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.6.7">Release 0.6.7 </a></li>
+ <li class="divider">/</li>
+ <li> Tutorial - Throttling</li>
+ <li class="publishDate version-date pull-right">Last Published: 2017-01-19</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:_Throttling"><a href="./Tutorial.html">Helix Tutorial</a>: Throttling</h2>
+ </div>
+ <p>In this chapter, we'll learn how to control the parallel execution of cluster tasks. Only a centralized cluster manager with global knowledge (i.e. Helix) is capable of coordinating this decision.</p>
+ <div class="section">
+ <h3 id="Throttling">Throttling</h3>
+ <p>Since all state changes in the system are triggered through transitions, Helix can control the number of transitions that can happen in parallel. Some of the transitions may be lightweight, but some might involve moving data, which is quite expensive from a network and IOPS perspective.</p>
+ <p>Helix allows applications to set a threshold on transitions. The threshold can be set at multiple scopes:</p>
+ <ul>
+ <li>MessageType e.g STATE_TRANSITION</li>
+ <li>TransitionType e.g SLAVE-MASTER</li>
+ <li>Resource e.g database</li>
+ <li>Node i.e per-node maximum transitions in parallel</li>
+ </ul>
+ </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.6.7.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.6.7" 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 ©2017 <a href="http://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.6.7-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="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/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.6.7-docs/tutorial_user_def_rebalancer.html
URL: http://svn.apache.org/viewvc/helix/site-content/0.6.7-docs/tutorial_user_def_rebalancer.html?rev=1779549&view=auto
==============================================================================
--- helix/site-content/0.6.7-docs/tutorial_user_def_rebalancer.html (added)
+++ helix/site-content/0.6.7-docs/tutorial_user_def_rebalancer.html Fri Jan 20 01:12:25 2017
@@ -0,0 +1,391 @@
+
+<!DOCTYPE html>
+<!--
+ Generated by Apache Maven Doxia at 2017-01-19
+ 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 - User-Defined Rebalancing</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="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/css/bootstrap.min.css" rel="stylesheet" />
+ <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/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_user_def_rebalancer project-067-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.6.7">Helix 0.6.7 </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.6.7.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.6.7" 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.6.7">Release 0.6.7 </a></li>
+ <li class="divider">/</li>
+ <li> Tutorial - User-Defined Rebalancing</li>
+ <li class="publishDate version-date pull-right">Last Published: 2017-01-19</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:_User-Defined_Rebalancing"><a href="./Tutorial.html">Helix Tutorial</a>: User-Defined Rebalancing</h2>
+ </div>
+ <p>Even though Helix can compute both the location and the state of replicas internally using a default fully-automatic rebalancer, specific applications may require rebalancing strategies that optimize for different requirements. Thus, Helix allows applications to plug in arbitrary rebalancer algorithms that implement a provided interface. One of the main design goals of Helix is to provide maximum flexibility to any distributed application. Thus, it allows applications to fully implement the rebalancer, which is the core constraint solver in the system, if the application developer so chooses.</p>
+ <p>Whenever the state of the cluster changes, as is the case when participants join or leave the cluster, Helix automatically calls the rebalancer to compute a new mapping of all the replicas in the resource. When using a pluggable rebalancer, the only required step is to register it with Helix. Subsequently, no additional bootstrapping steps are necessary. Helix uses reflection to look up and load the class dynamically at runtime. As a result, it is also technically possible to change the rebalancing strategy used at any time.</p>
+ <p>The Rebalancer interface is as follows:</p>
+ <div class="source">
+ <pre>void init(HelixManager manager);
+
+IdealState computeNewIdealState(String resourceName, IdealState currentIdealState,
+ final CurrentStateOutput currentStateOutput, final ClusterDataCache clusterData);
+</pre>
+ </div>
+ <p>The first parameter is the resource to rebalance, the second is pre-existing ideal mappings, the third is a snapshot of the actual placements and state assignments, and the fourth is a full cache of all of the cluster data available to Helix. Internally, Helix implements the same interface for its own rebalancing routines, so a user-defined rebalancer will be cognizant of the same information about the cluster as an internal implementation. Helix strives to provide applications the ability to implement algorithms that may require a large portion of the entire state of the cluster to make the best placement and state assignment decisions possible.</p>
+ <p>An IdealState is a full representation of the location of each replica of each partition of a given resource. This is a simple representation of the placement that the algorithm believes is the best possible. If the placement meets all defined constraints, this is what will become the actual state of the distributed system.</p>
+ <div class="section">
+ <h3 id="Specifying_a_Rebalancer">Specifying a Rebalancer</h3>
+ <p>For implementations that set up the cluster through existing code, the following HelixAdmin calls will update the Rebalancer class:</p>
+ <div class="source">
+ <pre>IdealState idealState = helixAdmin.getResourceIdealState(clusterName, resourceName);
+idealState.setRebalanceMode(RebalanceMode.USER_DEFINED);
+idealState.setRebalancerClassName(className);
+helixAdmin.setResourceIdealState(clusterName, resourceName, idealState);
+</pre>
+ </div>
+ <p>There are two key fields to set to specify that a pluggable rebalancer should be used. First, the rebalance mode should be set to USER_DEFINED, and second the rebalancer class name should be set to a class that implements Rebalancer and is within the scope of the project. The class name is a fully-qualified class name consisting of its package and its name. Without specification of the USER_DEFINED mode, the user-defined rebalancer class will not be used even if specified. Furthermore, Helix will not attempt to rebalance the resources through its standard routines if its mode is USER_DEFINED, regardless of whether or not a rebalancer class is registered.</p>
+ </div>
+ <div class="section">
+ <h3 id="Example">Example</h3>
+ <p>In the next release (0.7.0), we will provide a full recipe of a user-defined rebalancer in action.</p>
+ <p>Consider the case where partitions are locks in a lock manager and 6 locks are to be distributed evenly to a set of participants, and only one participant can hold each lock. We can define a rebalancing algorithm that simply takes the modulus of the lock number and the number of participants to evenly distribute the locks across participants. Helix allows capping the number of partitions a participant can accept, but since locks are lightweight, we do not need to define a restriction in this case. The following is a succinct implementation of this algorithm.</p>
+ <div class="source">
+ <pre>@Override
+IdealState computeNewIdealState(String resourceName, IdealState currentIdealState,
+ final CurrentStateOutput currentStateOutput, final ClusterDataCache clusterData) {
+ // Get the list of live participants in the cluster
+ List<String> liveParticipants = new ArrayList<String>(clusterData.getLiveInstances().keySet());
+
+ // Count the number of participants allowed to lock each lock (in this example, this is 1)
+ int lockHolders = Integer.parseInt(currentIdealState.getReplicas());
+
+ // Fairly assign the lock state to the participants using a simple mod-based sequential
+ // assignment. For instance, if each lock can be held by 3 participants, lock 0 would be held
+ // by participants (0, 1, 2), lock 1 would be held by (1, 2, 3), and so on, wrapping around the
+ // number of participants as necessary.
+ int i = 0;
+ for (String partition : currentIdealState.getPartitionSet()) {
+ List<String> preferenceList = new ArrayList<String>();
+ for (int j = i; j < i + lockHolders; j++) {
+ int participantIndex = j % liveParticipants.size();
+ String participant = liveParticipants.get(participantIndex);
+ // enforce that a participant can only have one instance of a given lock
+ if (!preferenceList.contains(participant)) {
+ preferenceList.add(participant);
+ }
+ }
+ currentIdealState.setPreferenceList(partition, preferenceList);
+ i++;
+ }
+ return assignment;
+}
+</pre>
+ </div>
+ <p>Here are the IdealState preference lists emitted by the user-defined rebalancer for a 3-participant system whenever there is a change to the set of participants.</p>
+ <ul>
+ <li>Participant_A joins</li>
+ </ul>
+ <div class="source">
+ <pre>{
+ "lock_0": ["Participant_A"],
+ "lock_1": ["Participant_A"],
+ "lock_2": ["Participant_A"],
+ "lock_3": ["Participant_A"],
+ "lock_4": ["Participant_A"],
+ "lock_5": ["Participant_A"],
+}
+</pre>
+ </div>
+ <p>A preference list is a mapping for each resource of partition to the participants serving each replica. The state model is a simple LOCKED/RELEASED model, so participant A holds all lock partitions in the LOCKED state.</p>
+ <ul>
+ <li>Participant_B joins</li>
+ </ul>
+ <div class="source">
+ <pre>{
+ "lock_0": ["Participant_A"],
+ "lock_1": ["Participant_B"],
+ "lock_2": ["Participant_A"],
+ "lock_3": ["Participant_B"],
+ "lock_4": ["Participant_A"],
+ "lock_5": ["Participant_B"],
+}
+</pre>
+ </div>
+ <p>Now that there are two participants, the simple mod-based function assigns every other lock to the second participant. On any system change, the rebalancer is invoked so that the application can define how to redistribute its resources.</p>
+ <ul>
+ <li>Participant_C joins (steady state)</li>
+ </ul>
+ <div class="source">
+ <pre>{
+ "lock_0": ["Participant_A"],
+ "lock_1": ["Participant_B"],
+ "lock_2": ["Participant_C"],
+ "lock_3": ["Participant_A"],
+ "lock_4": ["Participant_B"],
+ "lock_5": ["Participant_C"],
+}
+</pre>
+ </div>
+ <p>This is the steady state of the system. Notice that four of the six locks now have a different owner. That is because of the naïve modulus-based assignmemt approach used by the user-defined rebalancer. However, the interface is flexible enough to allow you to employ consistent hashing or any other scheme if minimal movement is a system requirement.</p>
+ <ul>
+ <li>Participant_B fails</li>
+ </ul>
+ <div class="source">
+ <pre>{
+ "lock_0": ["Participant_A"],
+ "lock_1": ["Participant_C"],
+ "lock_2": ["Participant_A"],
+ "lock_3": ["Participant_C"],
+ "lock_4": ["Participant_A"],
+ "lock_5": ["Participant_C"],
+}
+</pre>
+ </div>
+ <p>On any node failure, as in the case of node addition, the rebalancer is invoked automatically so that it can generate a new mapping as a response to the change. Helix ensures that the Rebalancer has the opportunity to reassign locks as required by the application.</p>
+ <ul>
+ <li>Participant_B (or the replacement for the original Participant_B) rejoins</li>
+ </ul>
+ <div class="source">
+ <pre>{
+ "lock_0": ["Participant_A"],
+ "lock_1": ["Participant_B"],
+ "lock_2": ["Participant_C"],
+ "lock_3": ["Participant_A"],
+ "lock_4": ["Participant_B"],
+ "lock_5": ["Participant_C"],
+}
+</pre>
+ </div>
+ <p>The rebalancer was invoked once again and the resulting IdealState preference lists reflect the steady state.</p>
+ </div>
+ <div class="section">
+ <h3 id="Caveats">Caveats</h3>
+ <ul>
+ <li>The rebalancer class must be available at runtime, or else Helix will not attempt to rebalance at all</li>
+ <li>The Helix controller will only take into account the preference lists in the new IdealState for this release. In 0.7.0, Helix rebalancers will be able to compute the full resource assignment, including the states.</li>
+ <li>Helix does not currently persist the new IdealState computed by the user-defined rebalancer. However, the Helix property store is available for saving any computed state. In 0.7.0, Helix will persist the result of running the rebalancer.</li>
+ </ul>
+ </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.6.7.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.6.7" 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 ©2017 <a href="http://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.6.7-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="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/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