helix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From j...@apache.org
Subject svn commit: r1811630 [11/11] - in /helix/site-content: ./ 0.6.1-incubating-docs/ 0.6.2-incubating-docs/ 0.6.3-docs/ 0.6.4-docs/ 0.6.5-docs/ 0.6.6-docs/ 0.6.7-docs/ 0.6.8-docs/ 0.6.9-docs/ 0.6.9-docs/css/ 0.6.9-docs/images/ 0.6.9-docs/img/ 0.6.9-docs/js...
Date Tue, 10 Oct 2017 00:24:44 GMT
Added: helix/site-content/0.6.9-docs/tutorial_user_def_rebalancer.html
URL: http://svn.apache.org/viewvc/helix/site-content/0.6.9-docs/tutorial_user_def_rebalancer.html?rev=1811630&view=auto
==============================================================================
--- helix/site-content/0.6.9-docs/tutorial_user_def_rebalancer.html (added)
+++ helix/site-content/0.6.9-docs/tutorial_user_def_rebalancer.html Tue Oct 10 00:24:43 2017
@@ -0,0 +1,393 @@
+
+<!DOCTYPE html>
+<!--
+ Generated by Apache Maven Doxia at 2017-10-09
+ 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="./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_user_def_rebalancer project-069-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.9">Helix 0.6.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.6.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.6.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="http://helix.incubator.apache.org/" title="Apache Helix" class="externalLink">Apache
Helix </a></li>
+				<li class="divider">/</li>
+				<li><a href="../" title="Apache Helix">Apache Helix </a></li>
+				<li class="divider">/</li>
+				<li><a href="./" title="Release 0.6.9">Release 0.6.9 </a></li>
+				<li class="divider">/</li>
+				<li>  Tutorial - User-Defined Rebalancing</li>
+				<li class="publishDate version-date pull-right">Last Published: 2017-10-09</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&lt;String&gt; liveParticipants = new ArrayList&lt;String&gt;(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&lt;String&gt; preferenceList = new ArrayList&lt;String&gt;();
+    for (int j = i; j &lt; 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>{
+  &quot;lock_0&quot;: [&quot;Participant_A&quot;],
+  &quot;lock_1&quot;: [&quot;Participant_A&quot;],
+  &quot;lock_2&quot;: [&quot;Participant_A&quot;],
+  &quot;lock_3&quot;: [&quot;Participant_A&quot;],
+  &quot;lock_4&quot;: [&quot;Participant_A&quot;],
+  &quot;lock_5&quot;: [&quot;Participant_A&quot;],
+}
+</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>{
+  &quot;lock_0&quot;: [&quot;Participant_A&quot;],
+  &quot;lock_1&quot;: [&quot;Participant_B&quot;],
+  &quot;lock_2&quot;: [&quot;Participant_A&quot;],
+  &quot;lock_3&quot;: [&quot;Participant_B&quot;],
+  &quot;lock_4&quot;: [&quot;Participant_A&quot;],
+  &quot;lock_5&quot;: [&quot;Participant_B&quot;],
+}
+</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>{
+  &quot;lock_0&quot;: [&quot;Participant_A&quot;],
+  &quot;lock_1&quot;: [&quot;Participant_B&quot;],
+  &quot;lock_2&quot;: [&quot;Participant_C&quot;],
+  &quot;lock_3&quot;: [&quot;Participant_A&quot;],
+  &quot;lock_4&quot;: [&quot;Participant_B&quot;],
+  &quot;lock_5&quot;: [&quot;Participant_C&quot;],
+}
+</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&iuml;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>{
+  &quot;lock_0&quot;: [&quot;Participant_A&quot;],
+  &quot;lock_1&quot;: [&quot;Participant_C&quot;],
+  &quot;lock_2&quot;: [&quot;Participant_A&quot;],
+  &quot;lock_3&quot;: [&quot;Participant_C&quot;],
+  &quot;lock_4&quot;: [&quot;Participant_A&quot;],
+  &quot;lock_5&quot;: [&quot;Participant_C&quot;],
+}
+</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>{
+  &quot;lock_0&quot;: [&quot;Participant_A&quot;],
+  &quot;lock_1&quot;: [&quot;Participant_B&quot;],
+  &quot;lock_2&quot;: [&quot;Participant_C&quot;],
+  &quot;lock_3&quot;: [&quot;Participant_A&quot;],
+  &quot;lock_4&quot;: [&quot;Participant_B&quot;],
+  &quot;lock_5&quot;: [&quot;Participant_C&quot;],
+}
+</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.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.6.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 &copy;2017 <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.6.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.6.9-docs/tutorial_yaml.html
URL: http://svn.apache.org/viewvc/helix/site-content/0.6.9-docs/tutorial_yaml.html?rev=1811630&view=auto
==============================================================================
--- helix/site-content/0.6.9-docs/tutorial_yaml.html (added)
+++ helix/site-content/0.6.9-docs/tutorial_yaml.html Tue Oct 10 00:24:43 2017
@@ -0,0 +1,322 @@
+
+<!DOCTYPE html>
+<!--
+ Generated by Apache Maven Doxia at 2017-10-09
+ 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 - YAML Cluster Setup</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_yaml project-069-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.9">Helix 0.6.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.6.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.6.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="http://helix.incubator.apache.org/" title="Apache Helix" class="externalLink">Apache
Helix </a></li>
+				<li class="divider">/</li>
+				<li><a href="../" title="Apache Helix">Apache Helix </a></li>
+				<li class="divider">/</li>
+				<li><a href="./" title="Release 0.6.9">Release 0.6.9 </a></li>
+				<li class="divider">/</li>
+				<li>  Tutorial - YAML Cluster Setup</li>
+				<li class="publishDate version-date pull-right">Last Published: 2017-10-09</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:_YAML_Cluster_Setup"><a href="./Tutorial.html">Helix
Tutorial</a>: YAML Cluster Setup</h2>
+ </div> 
+ <p>As an alternative to using Helix Admin to set up the cluster, its resources, constraints,
and the state model, Helix supports bootstrapping a cluster configuration based on a YAML
file. Below is an annotated example of such a file for a simple distributed lock manager where
a lock can only be LOCKED or RELEASED, and each lock only allows a single participant to hold
it in the LOCKED state.</p> 
+ <div class="source"> 
+  <pre>clusterName: lock-manager-custom-rebalancer # unique name for the cluster (required)
+resources:
+  - name: lock-group # unique resource name (required)
+    rebalancer: # required
+      mode: USER_DEFINED # required - USER_DEFINED means we will provide our own rebalancer
+      class: org.apache.helix.userdefinedrebalancer.LockManagerRebalancer # required for
USER_DEFINED
+    partitions:
+      count: 12 # number of partitions for the resource (default is 1)
+      replicas: 1 # number of replicas per partition (default is 1)
+    stateModel:
+      name: lock-unlock # model name (required)
+      states: [LOCKED, RELEASED, DROPPED] # the list of possible states (required if model
not built-in)
+      transitions: # the list of possible transitions (required if model not built-in)
+        - name: Unlock
+          from: LOCKED
+          to: RELEASED
+        - name: Lock
+          from: RELEASED
+          to: LOCKED
+        - name: DropLock
+          from: LOCKED
+          to: DROPPED
+        - name: DropUnlock
+          from: RELEASED
+          to: DROPPED
+        - name: Undrop
+          from: DROPPED
+          to: RELEASED
+      initialState: RELEASED # (required if model not built-in)
+    constraints:
+      state:
+        counts: # maximum number of replicas of a partition that can be in each state (required
if model not built-in)
+          - name: LOCKED
+            count: &quot;1&quot;
+          - name: RELEASED
+            count: &quot;-1&quot;
+          - name: DROPPED
+            count: &quot;-1&quot;
+        priorityList: [LOCKED, RELEASED, DROPPED] # states in order of priority (all priorities
equal if not specified)
+      transition: # transitions priority to enforce order that transitions occur
+        priorityList: [Unlock, Lock, Undrop, DropUnlock, DropLock] # all priorities equal
if not specified
+participants: # list of nodes that can serve replicas (optional if dynamic joining is active,
required otherwise)
+  - name: localhost_12001
+    host: localhost
+    port: 12001
+  - name: localhost_12002
+    host: localhost
+    port: 12002
+  - name: localhost_12003
+    host: localhost
+    port: 12003
+</pre> 
+ </div> 
+ <p>Using a file like the one above, the cluster can be set up either with the command
line:</p> 
+ <div class="source"> 
+  <pre>helix/helix-core/target/helix-core/pkg/bin/YAMLClusterSetup.sh localhost:2199
lock-manager-config.yaml
+</pre> 
+ </div> 
+ <p>or with code:</p> 
+ <div class="source"> 
+  <pre>YAMLClusterSetup setup = new YAMLClusterSetup(zkAddress);
+InputStream input =
+    Thread.currentThread().getContextClassLoader()
+        .getResourceAsStream(&quot;lock-manager-config.yaml&quot;);
+YAMLClusterSetup.YAMLClusterConfig config = setup.setupCluster(input);
+</pre> 
+ </div> 
+ <p>Some notes:</p> 
+ <ul> 
+  <li> <p>A rebalancer class is only required for the USER_DEFINED mode. It is
ignored otherwise.</p></li> 
+  <li> <p>Built-in state models, like OnlineOffline, LeaderStandby, and MasterSlave,
or state models that have already been added only require a name for stateModel. If partition
and/or replica counts are not provided, a value of 1 is assumed.</p></li> 
+ </ul> 
+</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.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.6.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 &copy;2017 <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.6.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

Modified: helix/site-content/0.7.0-incubating-docs/dependency-convergence.html
URL: http://svn.apache.org/viewvc/helix/site-content/0.7.0-incubating-docs/dependency-convergence.html?rev=1811630&r1=1811629&r2=1811630&view=diff
==============================================================================
--- helix/site-content/0.7.0-incubating-docs/dependency-convergence.html (original)
+++ helix/site-content/0.7.0-incubating-docs/dependency-convergence.html Tue Oct 10 00:24:43
2017
@@ -175,7 +175,7 @@
   <thead> 
    <tr class="a"> 
     <th>Number of sub-projects:</th> 
-    <td>11</td> 
+    <td>12</td> 
    </tr> 
   </thead> 
   <caption> 
@@ -208,6 +208,7 @@
            <li><a class="externalLink" href="http://helix.apache.org/0.6.6-docs">org.apache.helix:0.6.6-docs</a></li>

            <li><a class="externalLink" href="http://helix.apache.org/0.6.7-docs">org.apache.helix:0.6.7-docs</a></li>

            <li><a class="externalLink" href="http://helix.apache.org/0.6.8-docs">org.apache.helix:0.6.8-docs</a></li>

+           <li><a class="externalLink" href="http://helix.apache.org/0.6.9-docs">org.apache.helix:0.6.9-docs</a></li>

            <li><a class="externalLink" href="http://helix.apache.org/0.7.0-incubating-docs">org.apache.helix:0.7.0-incubating-docs</a></li>

            <li><a class="externalLink" href="http://helix.apache.org/0.7.1-docs">org.apache.helix:0.7.1-docs</a></li>

           </ol></td> 

Modified: helix/site-content/0.7.1-docs/dependency-convergence.html
URL: http://svn.apache.org/viewvc/helix/site-content/0.7.1-docs/dependency-convergence.html?rev=1811630&r1=1811629&r2=1811630&view=diff
==============================================================================
--- helix/site-content/0.7.1-docs/dependency-convergence.html (original)
+++ helix/site-content/0.7.1-docs/dependency-convergence.html Tue Oct 10 00:24:43 2017
@@ -175,7 +175,7 @@
   <thead> 
    <tr class="a"> 
     <th>Number of sub-projects:</th> 
-    <td>11</td> 
+    <td>12</td> 
    </tr> 
   </thead> 
   <caption> 
@@ -208,6 +208,7 @@
            <li><a class="externalLink" href="http://helix.apache.org/0.6.6-docs">org.apache.helix:0.6.6-docs</a></li>

            <li><a class="externalLink" href="http://helix.apache.org/0.6.7-docs">org.apache.helix:0.6.7-docs</a></li>

            <li><a class="externalLink" href="http://helix.apache.org/0.6.8-docs">org.apache.helix:0.6.8-docs</a></li>

+           <li><a class="externalLink" href="http://helix.apache.org/0.6.9-docs">org.apache.helix:0.6.9-docs</a></li>

            <li><a class="externalLink" href="http://helix.apache.org/0.7.0-incubating-docs">org.apache.helix:0.7.0-incubating-docs</a></li>

            <li><a class="externalLink" href="http://helix.apache.org/0.7.1-docs">org.apache.helix:0.7.1-docs</a></li>

           </ol></td> 

Modified: helix/site-content/dependency-convergence.html
URL: http://svn.apache.org/viewvc/helix/site-content/dependency-convergence.html?rev=1811630&r1=1811629&r2=1811630&view=diff
==============================================================================
--- helix/site-content/dependency-convergence.html (original)
+++ helix/site-content/dependency-convergence.html Tue Oct 10 00:24:43 2017
@@ -216,7 +216,7 @@
   <thead> 
    <tr class="a"> 
     <th>Number of sub-projects:</th> 
-    <td>11</td> 
+    <td>12</td> 
    </tr> 
   </thead> 
   <caption> 
@@ -249,6 +249,7 @@
            <li><a class="externalLink" href="http://helix.apache.org/0.6.6-docs">org.apache.helix:0.6.6-docs</a></li>

            <li><a class="externalLink" href="http://helix.apache.org/0.6.7-docs">org.apache.helix:0.6.7-docs</a></li>

            <li><a class="externalLink" href="http://helix.apache.org/0.6.8-docs">org.apache.helix:0.6.8-docs</a></li>

+           <li><a class="externalLink" href="http://helix.apache.org/0.6.9-docs">org.apache.helix:0.6.9-docs</a></li>

            <li><a class="externalLink" href="http://helix.apache.org/0.7.0-incubating-docs">org.apache.helix:0.7.0-incubating-docs</a></li>

            <li><a class="externalLink" href="http://helix.apache.org/0.7.1-docs">org.apache.helix:0.7.1-docs</a></li>

           </ol></td> 

Modified: helix/site-content/modules.html
URL: http://svn.apache.org/viewvc/helix/site-content/modules.html?rev=1811630&r1=1811629&r2=1811630&view=diff
==============================================================================
--- helix/site-content/modules.html (original)
+++ helix/site-content/modules.html Tue Oct 10 00:24:43 2017
@@ -209,10 +209,14 @@
     <td>Helix is a generic cluster management framework used for the automatic management
of partitioned, replicated and distributed resources hosted on a cluster of nodes.</td>

    </tr> 
    <tr class="b"> 
-    <td><a href="0.7.0-incubating-docs/index.html">Apache Helix :: Website ::
0.7.0-incubating</a></td> 
+    <td><a href="0.6.9-docs/index.html">Apache Helix :: Website :: 0.6.9</a></td>

     <td>Helix is a generic cluster management framework used for the automatic management
of partitioned, replicated and distributed resources hosted on a cluster of nodes.</td>

    </tr> 
    <tr class="a"> 
+    <td><a href="0.7.0-incubating-docs/index.html">Apache Helix :: Website ::
0.7.0-incubating</a></td> 
+    <td>Helix is a generic cluster management framework used for the automatic management
of partitioned, replicated and distributed resources hosted on a cluster of nodes.</td>

+   </tr> 
+   <tr class="b"> 
     <td><a href="0.7.1-docs/index.html">Apache Helix :: Website :: 0.7.1</a></td>

     <td>Helix is a generic cluster management framework used for the automatic management
of partitioned, replicated and distributed resources hosted on a cluster of nodes.</td>

    </tr> 



Mime
View raw message