You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@helix.apache.org by ka...@apache.org on 2013/11/23 08:11:30 UTC
svn commit: r1544749 [2/23] - in /incubator/helix/site-content: ./
apidocs/reference/org/apache/helix/manager/zk/ helix-admin-webapp/
helix-agent/ helix-core/ helix-examples/ images/ involved/ recipes/
recipes/distributed-lock-manager/ recipes/rabbitmq...
Modified: incubator/helix/site-content/Publications.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/Publications.html?rev=1544749&r1=1544748&r2=1544749&view=diff
==============================================================================
--- incubator/helix/site-content/Publications.html (original)
+++ incubator/helix/site-content/Publications.html Sat Nov 23 07:11:13 2013
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2013-11-15
+ | Generated by Apache Maven Doxia at 2013-11-22
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20131115" />
+ <meta name="Date-Revision-yyyymmdd" content="20131122" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Helix - Publications</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -64,6 +64,23 @@
</ul>
</li>
<li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="site-releases/0.7.0-incubating-site/index.html" title="0.7.0-incubating (beta)">0.7.0-incubating (beta)</a>
+</li>
+
+ <li> <a href="site-releases/0.6.2-incubating-site/index.html" title="0.6.2-incubating (stable)">0.6.2-incubating (stable)</a>
+</li>
+
+ <li> <a href="site-releases/0.6.1-incubating-site/index.html" title="0.6.1-incubating">0.6.1-incubating</a>
+</li>
+
+ <li> <a href="site-releases/trunk-site/index.html" title="trunk">trunk</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Helix 0.7.0-incubating <b class="caret"></b></a>
<ul class="dropdown-menu">
@@ -78,19 +95,16 @@
</ul>
</li>
<li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Helix 0.6.2-incubating <b class="caret"></b></a>
<ul class="dropdown-menu">
- <li> <a href="site-releases/0.7.0-incubating-site/index.html" title="0.7.0-incubating">0.7.0-incubating</a>
+ <li> <a href="site-releases/0.6.2-incubating-site/Quickstart.html" title="Quick Start">Quick Start</a>
</li>
- <li> <a href="site-releases/0.6.2-incubating-site/index.html" title="0.6.2-incubating">0.6.2-incubating</a>
+ <li> <a href="site-releases/0.6.2-incubating-site/Tutorial.html" title="Tutorial">Tutorial</a>
</li>
- <li> <a href="site-releases/0.6.1-incubating-site/index.html" title="0.6.1-incubating">0.6.1-incubating</a>
-</li>
-
- <li> <a href="site-releases/trunk-site/index.html" title="trunk">trunk</a>
+ <li> <a href="site-releases/0.6.2-incubating-site/download.html" title="Download">Download</a>
</li>
</ul>
</li>
@@ -216,6 +230,35 @@
<a href="#"><i class="none"></i>Publications</a>
</li>
+ <li class="nav-header">Releases</li>
+
+ <li>
+
+ <a href="site-releases/0.7.0-incubating-site/index.html" title="0.7.0-incubating (beta)">
+ <i class="none"></i>
+ 0.7.0-incubating (beta)</a>
+ </li>
+
+ <li>
+
+ <a href="site-releases/0.6.2-incubating-site/index.html" title="0.6.2-incubating (stable)">
+ <i class="none"></i>
+ 0.6.2-incubating (stable)</a>
+ </li>
+
+ <li>
+
+ <a href="site-releases/0.6.1-incubating-site/index.html" title="0.6.1-incubating">
+ <i class="none"></i>
+ 0.6.1-incubating</a>
+ </li>
+
+ <li>
+
+ <a href="site-releases/trunk-site/index.html" title="trunk">
+ <i class="none"></i>
+ trunk</a>
+ </li>
<li class="nav-header">Helix 0.7.0-incubating</li>
<li>
@@ -238,34 +281,27 @@
<i class="none"></i>
Download</a>
</li>
- <li class="nav-header">Releases</li>
+ <li class="nav-header">Helix 0.6.2-incubating</li>
<li>
- <a href="site-releases/0.7.0-incubating-site/index.html" title="0.7.0-incubating">
- <i class="none"></i>
- 0.7.0-incubating</a>
- </li>
-
- <li>
-
- <a href="site-releases/0.6.2-incubating-site/index.html" title="0.6.2-incubating">
+ <a href="site-releases/0.6.2-incubating-site/Quickstart.html" title="Quick Start">
<i class="none"></i>
- 0.6.2-incubating</a>
+ Quick Start</a>
</li>
<li>
- <a href="site-releases/0.6.1-incubating-site/index.html" title="0.6.1-incubating">
+ <a href="site-releases/0.6.2-incubating-site/Tutorial.html" title="Tutorial">
<i class="none"></i>
- 0.6.1-incubating</a>
+ Tutorial</a>
</li>
<li>
- <a href="site-releases/trunk-site/index.html" title="trunk">
+ <a href="site-releases/0.6.2-incubating-site/download.html" title="Download">
<i class="none"></i>
- trunk</a>
+ Download</a>
</li>
<li class="nav-header">Get Involved</li>
Added: incubator/helix/site-content/Quickstart.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/Quickstart.html?rev=1544749&view=auto
==============================================================================
--- incubator/helix/site-content/Quickstart.html (added)
+++ incubator/helix/site-content/Quickstart.html Sat Nov 23 07:11:13 2013
@@ -0,0 +1,840 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2013-11-07
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20131107" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Apache Helix - Quickstart</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<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="topBarEnabled">
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container"><div class="nav-collapse">
+
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Helix <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="index.html" title="Introduction">Introduction</a>
+</li>
+
+ <li> <a href="Concepts.html" title="Core concepts">Core concepts</a>
+</li>
+
+ <li> <a href="Architecture.html" title="Architecture">Architecture</a>
+</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="releasenotes/release-0.6.1-incubating.html" title="release 0.6.1-incubating">release 0.6.1-incubating</a>
+</li>
+
+ <li> <a href="download.html" title="Download">Download</a>
+</li>
+
+ <li> <a href="IRC.html" title="IRC">IRC</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>
+
+ <li> <a href="recipes/user_def_rebalancer.html" title="User-Defined Rebalancer Example">User-Defined Rebalancer Example</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Involved <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="issue-tracking.html" title="Issues">Issues</a>
+</li>
+
+ <li> <a href="team-list.html" title="Team">Team</a>
+</li>
+
+ <li> <a href="source-repository.html" title="Sources">Sources</a>
+</li>
+
+ <li> <a href="integration.html" title="Continuous Integration">Continuous Integration</a>
+</li>
+
+ <li> <a href="involved/building.html" title="Building Guide">Building Guide</a>
+</li>
+
+ <li> <a href="releasing.html" title="Release Guide">Release Guide</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+ <form id="search-form" action="http://www.google.com/search" method="get" class="navbar-search pull-right" >
+
+ <input value="helix.incubator.apache.org" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
+
+
+
+
+ <ul class="nav pull-right"><li>
+
+ <a href="https://twitter.com/ApacheHelix" class="twitter-follow-button" data-show-count="false" data-align="right" data-size="large" data-show-screen-name="true" data-lang="en">Follow ApacheHelix</a>
+ <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+
+ </li></ul>
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="./" id="bannerLeft">
+ <img src="images/helix-logo.jpg" />
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org/" id="bannerRight">
+ <img src="http://incubator.apache.org/images/egg-logo.png" />
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li id="projectVersion">Version: 0.6.2-incubating-SNAPSHOT</li>
+ | <li class="">
+ <a href="./" title="Apache Helix">
+ Apache Helix</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class=""> Quickstart</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2013-11-07</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <!-- -
+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">
+<h2>Get Helix<a name="Get_Helix"></a></h2>
+<p>First, let's get Helix, either build it, or download.</p>
+<div class="section">
+<h3>Build<a name="Build"></a></h3>
+
+<div class="source">
+<pre>git clone https://git-wip-us.apache.org/repos/asf/incubator-helix.git
+cd incubator-helix
+git checkout tags/helix-0.6.1-incubating
+./build
+cd helix-core/target/helix-core-pkg/bin //This folder contains all the scripts used in following sections
+chmod +x *
+</pre></div></div>
+<div class="section">
+<h3>Download<a name="Download"></a></h3>
+<p>Download the 0.6.1-incubating release package <a href="./download.html">here</a> </p></div></div>
+<div class="section">
+<h2>Overview<a name="Overview"></a></h2>
+<p>In this Quickstart, we'll set up a master-slave replicated, partitioned system. Then we'll demonstrate how to add a node, rebalance the partitions, and show how Helix manages failover.</p></div>
+<div class="section">
+<h2>Let's Do It<a name="Lets_Do_It"></a></h2>
+<p>Helix provides command line interfaces to set up the cluster and view the cluster state. The best way to understand how Helix views a cluster is to build a cluster.</p>
+<div class="section">
+<div class="section">
+<h4>First, get to the tools directory<a name="First_get_to_the_tools_directory"></a></h4>
+<p>If you built the code</p>
+
+<div class="source">
+<pre>cd incubator-helix/helix-core/target/helix-core-pkg/bin
+</pre></div>
+<p>If you downloaded the release package, extract it.</p></div></div></div>
+<div class="section">
+<h2>Short Version<a name="Short_Version"></a></h2>
+<p>You can observe the components working together in this demo, which does the following:</p>
+
+<ul>
+
+<li>Create a cluster</li>
+
+<li>Add 2 nodes (participants) to the cluster</li>
+
+<li>Set up a resource with 6 partitions and 2 replicas: 1 Master, and 1 Slave per partition</li>
+
+<li>Show the cluster state after Helix balances the partitions</li>
+
+<li>Add a third node</li>
+
+<li>Show the cluster state. Note that the third node has taken mastership of 2 partitions.</li>
+
+<li>Kill the third node (Helix takes care of failover)</li>
+
+<li>Show the cluster state. Note that the two surviving nodes take over mastership of the partitions from the failed node</li>
+</ul>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5>Run the demo<a name="Run_the_demo"></a></h5>
+
+<div class="source">
+<pre>cd incubator-helix/helix-core/target/helix-core-pkg/bin
+./quickstart.sh
+</pre></div></div>
+<div class="section">
+<h5>2 nodes are set up and the partitions rebalanced<a name="a2_nodes_are_set_up_and_the_partitions_rebalanced"></a></h5>
+<p>The cluster state is as follows:</p>
+
+<div class="source">
+<pre>CLUSTER STATE: After starting 2 nodes
+ localhost_12000 localhost_12001
+ MyResource_0 M S
+ MyResource_1 S M
+ MyResource_2 M S
+ MyResource_3 M S
+ MyResource_4 S M
+ MyResource_5 S M
+</pre></div>
+<p>Note there is one master and one slave per partition.</p></div>
+<div class="section">
+<h5>A third node is added and the cluster rebalanced<a name="A_third_node_is_added_and_the_cluster_rebalanced"></a></h5>
+<p>The cluster state changes to:</p>
+
+<div class="source">
+<pre>CLUSTER STATE: After adding a third node
+ localhost_12000 localhost_12001 localhost_12002
+ MyResource_0 S M S
+ MyResource_1 S S M
+ MyResource_2 M S S
+ MyResource_3 S S M
+ MyResource_4 M S S
+ MyResource_5 S M S
+</pre></div>
+<p>Note there is one master and <i>two</i> slaves per partition. This is expected because there are three nodes.</p></div>
+<div class="section">
+<h5>Finally, a node is killed to simulate a failure<a name="Finally_a_node_is_killed_to_simulate_a_failure"></a></h5>
+<p>Helix makes sure each partition has a master. The cluster state changes to:</p>
+
+<div class="source">
+<pre>CLUSTER STATE: After the 3rd node stops/crashes
+ localhost_12000 localhost_12001 localhost_12002
+ MyResource_0 S M -
+ MyResource_1 S M -
+ MyResource_2 M S -
+ MyResource_3 M S -
+ MyResource_4 M S -
+ MyResource_5 S M -
+</pre></div></div></div></div></div>
+<div class="section">
+<h2>Long Version<a name="Long_Version"></a></h2>
+<p>Now you can run the same steps by hand. In the detailed version, we'll do the following:</p>
+
+<ul>
+
+<li>Define a cluster</li>
+
+<li>Add two nodes to the cluster</li>
+
+<li>Add a 6-partition resource with 1 master and 2 slave replicas per partition</li>
+
+<li>Verify that the cluster is healthy and inspect the Helix view</li>
+
+<li>Expand the cluster: add a few nodes and rebalance the partitions</li>
+
+<li>Failover: stop a node and verify the mastership transfer</li>
+</ul>
+<div class="section">
+<h3>Install and Start Zookeeper<a name="Install_and_Start_Zookeeper"></a></h3>
+<p>Zookeeper can be started in standalone mode or replicated mode.</p>
+<p>More info is available at </p>
+
+<ul>
+
+<li><a class="externalLink" href="http://zookeeper.apache.org/doc/r3.3.3/zookeeperStarted.html">http://zookeeper.apache.org/doc/r3.3.3/zookeeperStarted.html</a></li>
+
+<li><a class="externalLink" href="http://zookeeper.apache.org/doc/trunk/zookeeperAdmin.html#sc_zkMulitServerSetup">http://zookeeper.apache.org/doc/trunk/zookeeperAdmin.html#sc_zkMulitServerSetup</a></li>
+</ul>
+<p>In this example, let's start zookeeper in local mode.</p>
+<div class="section">
+<div class="section">
+<h5>start zookeeper locally on port 2199<a name="start_zookeeper_locally_on_port_2199"></a></h5>
+
+<div class="source">
+<pre>./start-standalone-zookeeper.sh 2199 &
+</pre></div></div></div></div>
+<div class="section">
+<h3>Define the Cluster<a name="Define_the_Cluster"></a></h3>
+<p>The helix-admin tool is used for cluster administration tasks. In the Quickstart, we'll use the command line interface. Helix supports a REST interface as well.</p>
+<p>zookeeper_address is of the format host:port e.g localhost:2199 for standalone or host1:port,host2:port for multi-node.</p>
+<p>Next, we'll set up a cluster MYCLUSTER cluster with these attributes:</p>
+
+<ul>
+
+<li>3 instances running on localhost at ports 12913,12914,12915</li>
+
+<li>One database named myDB with 6 partitions</li>
+
+<li>Each partition will have 3 replicas with 1 master, 2 slaves</li>
+
+<li>zookeeper running locally at localhost:2199</li>
+</ul>
+<div class="section">
+<div class="section">
+<h5>Create the cluster MYCLUSTER<a name="Create_the_cluster_MYCLUSTER"></a></h5>
+
+<div class="source">
+<pre>## helix-admin.sh --zkSvr <zk_address> --addCluster <clustername>
+./helix-admin.sh --zkSvr localhost:2199 --addCluster MYCLUSTER
+</pre></div></div>
+<div class="section">
+<h5>Add nodes to the cluster<a name="Add_nodes_to_the_cluster"></a></h5>
+<p>In this case we'll add three nodes: localhost:12913, localhost:12914, localhost:12915</p>
+
+<div class="source">
+<pre>## helix-admin.sh --zkSvr <zk_address> --addNode <clustername> <host:port>
+./helix-admin.sh --zkSvr localhost:2199 --addNode MYCLUSTER localhost:12913
+./helix-admin.sh --zkSvr localhost:2199 --addNode MYCLUSTER localhost:12914
+./helix-admin.sh --zkSvr localhost:2199 --addNode MYCLUSTER localhost:12915
+</pre></div></div></div>
+<div class="section">
+<h4>Define the resource and partitioning<a name="Define_the_resource_and_partitioning"></a></h4>
+<p>In this example, the resource is a database, partitioned 6 ways. (In a production system, it's common to over-partition for better load balancing. Helix has been used in production to manage hundreds of databases each with 10s or 100s of partitions running on 10s of physical nodes.)</p>
+<div class="section">
+<h5>Create a database with 6 partitions using the MasterSlave state model.<a name="Create_a_database_with_6_partitions_using_the_MasterSlave_state_model."></a></h5>
+<p>Helix ensures there will be exactly one master for each partition.</p>
+
+<div class="source">
+<pre>## helix-admin.sh --zkSvr <zk_address> --addResource <clustername> <resourceName> <numPartitions> <StateModelName>
+./helix-admin.sh --zkSvr localhost:2199 --addResource MYCLUSTER myDB 6 MasterSlave
+</pre></div></div>
+<div class="section">
+<h5>Now we can let Helix assign partitions to nodes.<a name="Now_we_can_let_Helix_assign_partitions_to_nodes."></a></h5>
+<p>This command will distribute the partitions amongst all the nodes in the cluster. In this example, each partition has 3 replicas.</p>
+
+<div class="source">
+<pre>## helix-admin.sh --zkSvr <zk_address> --rebalance <clustername> <resourceName> <replication factor>
+./helix-admin.sh --zkSvr localhost:2199 --rebalance MYCLUSTER myDB 3
+</pre></div>
+<p>Now the cluster is defined in Zookeeper. The nodes (localhost:12913, localhost:12914, localhost:12915) and resource (myDB, with 6 partitions using the MasterSlave model). And the <i>ideal state</i> has been calculated, assuming a replication factor of 3.</p></div>
+<div class="section">
+<h5>Start the Helix Controller<a name="Start_the_Helix_Controller"></a></h5>
+<p>Now that the cluster is defined in Zookeeper, the Helix controller can manage the cluster.</p>
+
+<div class="source">
+<pre>## Start the cluster manager, which will manage MYCLUSTER
+./run-helix-controller.sh --zkSvr localhost:2199 --cluster MYCLUSTER 2>&1 > /tmp/controller.log &
+</pre></div></div>
+<div class="section">
+<h5>Start up the cluster to be managed<a name="Start_up_the_cluster_to_be_managed"></a></h5>
+<p>We've started up Zookeeper, defined the cluster, the resources, the partitioning, and started up the Helix controller. Next, we'll start up the nodes of the system to be managed. Each node is a Participant, which is an instance of the system component to be managed. Helix assigns work to Participants, keeps track of their roles and health, and takes action when a node fails.</p>
+
+<div class="source">
+<pre># start up each instance. These are mock implementations that are actively managed by Helix
+./start-helix-participant.sh --zkSvr localhost:2199 --cluster MYCLUSTER --host localhost --port 12913 --stateModelType MasterSlave 2>&1 > /tmp/participant_12913.log
+./start-helix-participant.sh --zkSvr localhost:2199 --cluster MYCLUSTER --host localhost --port 12914 --stateModelType MasterSlave 2>&1 > /tmp/participant_12914.log
+./start-helix-participant.sh --zkSvr localhost:2199 --cluster MYCLUSTER --host localhost --port 12915 --stateModelType MasterSlave 2>&1 > /tmp/participant_12915.log
+</pre></div></div></div>
+<div class="section">
+<h4>Inspect the Cluster<a name="Inspect_the_Cluster"></a></h4>
+<p>Now, let's see the Helix view of our cluster. We'll work our way down as follows:</p>
+
+<div class="source">
+<pre>Clusters -> MYCLUSTER -> instances -> instance detail
+ -> resources -> resource detail
+ -> partitions
+</pre></div>
+<p>A single Helix controller can manage multiple clusters, though so far, we've only defined one cluster. Let's see:</p>
+
+<div class="source">
+<pre>## List existing clusters
+./helix-admin.sh --zkSvr localhost:2199 --listClusters
+
+Existing clusters:
+MYCLUSTER
+</pre></div>
+<p>Now, let's see the Helix view of MYCLUSTER</p>
+
+<div class="source">
+<pre>## helix-admin.sh --zkSvr <zk_address> --listClusterInfo <clusterName>
+./helix-admin.sh --zkSvr localhost:2199 --listClusterInfo MYCLUSTER
+
+Existing resources in cluster MYCLUSTER:
+myDB
+Instances in cluster MYCLUSTER:
+localhost_12915
+localhost_12914
+localhost_12913
+</pre></div>
+<p>Let's look at the details of an instance</p>
+
+<div class="source">
+<pre>## ./helix-admin.sh --zkSvr <zk_address> --listInstanceInfo <clusterName> <InstanceName>
+./helix-admin.sh --zkSvr localhost:2199 --listInstanceInfo MYCLUSTER localhost_12913
+
+InstanceConfig: {
+ "id" : "localhost_12913",
+ "mapFields" : {
+ },
+ "listFields" : {
+ },
+ "simpleFields" : {
+ "HELIX_ENABLED" : "true",
+ "HELIX_HOST" : "localhost",
+ "HELIX_PORT" : "12913"
+ }
+}
+</pre></div>
+<div class="section">
+<h5>Query info of a resource<a name="Query_info_of_a_resource"></a></h5>
+
+<div class="source">
+<pre>## helix-admin.sh --zkSvr <zk_address> --listResourceInfo <clusterName> <resourceName>
+./helix-admin.sh --zkSvr localhost:2199 --listResourceInfo MYCLUSTER myDB
+
+IdealState for myDB:
+{
+ "id" : "myDB",
+ "mapFields" : {
+ "myDB_0" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "MASTER",
+ "localhost_12915" : "SLAVE"
+ },
+ "myDB_1" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "SLAVE",
+ "localhost_12915" : "MASTER"
+ },
+ "myDB_2" : {
+ "localhost_12913" : "MASTER",
+ "localhost_12914" : "SLAVE",
+ "localhost_12915" : "SLAVE"
+ },
+ "myDB_3" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "SLAVE",
+ "localhost_12915" : "MASTER"
+ },
+ "myDB_4" : {
+ "localhost_12913" : "MASTER",
+ "localhost_12914" : "SLAVE",
+ "localhost_12915" : "SLAVE"
+ },
+ "myDB_5" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "MASTER",
+ "localhost_12915" : "SLAVE"
+ }
+ },
+ "listFields" : {
+ "myDB_0" : [ "localhost_12914", "localhost_12913", "localhost_12915" ],
+ "myDB_1" : [ "localhost_12915", "localhost_12913", "localhost_12914" ],
+ "myDB_2" : [ "localhost_12913", "localhost_12915", "localhost_12914" ],
+ "myDB_3" : [ "localhost_12915", "localhost_12913", "localhost_12914" ],
+ "myDB_4" : [ "localhost_12913", "localhost_12914", "localhost_12915" ],
+ "myDB_5" : [ "localhost_12914", "localhost_12915", "localhost_12913" ]
+ },
+ "simpleFields" : {
+ "REBALANCE_MODE" : "SEMI_AUTO",
+ "NUM_PARTITIONS" : "6",
+ "REPLICAS" : "3",
+ "STATE_MODEL_DEF_REF" : "MasterSlave",
+ "STATE_MODEL_FACTORY_NAME" : "DEFAULT"
+ }
+}
+
+ExternalView for myDB:
+{
+ "id" : "myDB",
+ "mapFields" : {
+ "myDB_0" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "MASTER",
+ "localhost_12915" : "SLAVE"
+ },
+ "myDB_1" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "SLAVE",
+ "localhost_12915" : "MASTER"
+ },
+ "myDB_2" : {
+ "localhost_12913" : "MASTER",
+ "localhost_12914" : "SLAVE",
+ "localhost_12915" : "SLAVE"
+ },
+ "myDB_3" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "SLAVE",
+ "localhost_12915" : "MASTER"
+ },
+ "myDB_4" : {
+ "localhost_12913" : "MASTER",
+ "localhost_12914" : "SLAVE",
+ "localhost_12915" : "SLAVE"
+ },
+ "myDB_5" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "MASTER",
+ "localhost_12915" : "SLAVE"
+ }
+ },
+ "listFields" : {
+ },
+ "simpleFields" : {
+ "BUCKET_SIZE" : "0"
+ }
+}
+</pre></div>
+<p>Now, let's look at one of the partitions:</p>
+
+<div class="source">
+<pre>## helix-admin.sh --zkSvr <zk_address> --listPartitionInfo <clusterName> <resource> <partition>
+./helix-admin.sh --zkSvr localhost:2199 --listPartitionInfo MYCLUSTER myDB myDB_0
+</pre></div></div></div>
+<div class="section">
+<h4>Expand the Cluster<a name="Expand_the_Cluster"></a></h4>
+<p>Next, we'll show how Helix does the work that you'd otherwise have to build into your system. When you add capacity to your cluster, you want the work to be evenly distributed. In this example, we started with 3 nodes, with 6 partitions. The partitions were evenly balanced, 2 masters and 4 slaves per node. Let's add 3 more nodes: localhost:12916, localhost:12917, localhost:12918</p>
+
+<div class="source">
+<pre>./helix-admin.sh --zkSvr localhost:2199 --addNode MYCLUSTER localhost:12916
+./helix-admin.sh --zkSvr localhost:2199 --addNode MYCLUSTER localhost:12917
+./helix-admin.sh --zkSvr localhost:2199 --addNode MYCLUSTER localhost:12918
+</pre></div>
+<p>And start up these instances:</p>
+
+<div class="source">
+<pre># start up each instance. These are mock implementations that are actively managed by Helix
+./start-helix-participant.sh --zkSvr localhost:2199 --cluster MYCLUSTER --host localhost --port 12916 --stateModelType MasterSlave 2>&1 > /tmp/participant_12916.log
+./start-helix-participant.sh --zkSvr localhost:2199 --cluster MYCLUSTER --host localhost --port 12917 --stateModelType MasterSlave 2>&1 > /tmp/participant_12917.log
+./start-helix-participant.sh --zkSvr localhost:2199 --cluster MYCLUSTER --host localhost --port 12918 --stateModelType MasterSlave 2>&1 > /tmp/participant_12918.log
+</pre></div>
+<p>And now, let Helix do the work for you. To shift the work, simply rebalance. After the rebalance, each node will have one master and two slaves.</p>
+
+<div class="source">
+<pre>./helix-admin.sh --zkSvr localhost:2199 --rebalance MYCLUSTER myDB 3
+</pre></div></div>
+<div class="section">
+<h4>View the cluster<a name="View_the_cluster"></a></h4>
+<p>OK, let's see how it looks:</p>
+
+<div class="source">
+<pre>./helix-admin.sh --zkSvr localhost:2199 --listResourceInfo MYCLUSTER myDB
+
+IdealState for myDB:
+{
+ "id" : "myDB",
+ "mapFields" : {
+ "myDB_0" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "SLAVE",
+ "localhost_12917" : "MASTER"
+ },
+ "myDB_1" : {
+ "localhost_12916" : "SLAVE",
+ "localhost_12917" : "SLAVE",
+ "localhost_12918" : "MASTER"
+ },
+ "myDB_2" : {
+ "localhost_12913" : "MASTER",
+ "localhost_12917" : "SLAVE",
+ "localhost_12918" : "SLAVE"
+ },
+ "myDB_3" : {
+ "localhost_12915" : "MASTER",
+ "localhost_12917" : "SLAVE",
+ "localhost_12918" : "SLAVE"
+ },
+ "myDB_4" : {
+ "localhost_12916" : "MASTER",
+ "localhost_12917" : "SLAVE",
+ "localhost_12918" : "SLAVE"
+ },
+ "myDB_5" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "MASTER",
+ "localhost_12915" : "SLAVE"
+ }
+ },
+ "listFields" : {
+ "myDB_0" : [ "localhost_12917", "localhost_12913", "localhost_12914" ],
+ "myDB_1" : [ "localhost_12918", "localhost_12917", "localhost_12916" ],
+ "myDB_2" : [ "localhost_12913", "localhost_12917", "localhost_12918" ],
+ "myDB_3" : [ "localhost_12915", "localhost_12917", "localhost_12918" ],
+ "myDB_4" : [ "localhost_12916", "localhost_12917", "localhost_12918" ],
+ "myDB_5" : [ "localhost_12914", "localhost_12915", "localhost_12913" ]
+ },
+ "simpleFields" : {
+ "REBALANCE_MODE" : "SEMI_AUTO",
+ "NUM_PARTITIONS" : "6",
+ "REPLICAS" : "3",
+ "STATE_MODEL_DEF_REF" : "MasterSlave",
+ "STATE_MODEL_FACTORY_NAME" : "DEFAULT"
+ }
+}
+
+ExternalView for myDB:
+{
+ "id" : "myDB",
+ "mapFields" : {
+ "myDB_0" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "SLAVE",
+ "localhost_12917" : "MASTER"
+ },
+ "myDB_1" : {
+ "localhost_12916" : "SLAVE",
+ "localhost_12917" : "SLAVE",
+ "localhost_12918" : "MASTER"
+ },
+ "myDB_2" : {
+ "localhost_12913" : "MASTER",
+ "localhost_12917" : "SLAVE",
+ "localhost_12918" : "SLAVE"
+ },
+ "myDB_3" : {
+ "localhost_12915" : "MASTER",
+ "localhost_12917" : "SLAVE",
+ "localhost_12918" : "SLAVE"
+ },
+ "myDB_4" : {
+ "localhost_12916" : "MASTER",
+ "localhost_12917" : "SLAVE",
+ "localhost_12918" : "SLAVE"
+ },
+ "myDB_5" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "MASTER",
+ "localhost_12915" : "SLAVE"
+ }
+ },
+ "listFields" : {
+ },
+ "simpleFields" : {
+ "BUCKET_SIZE" : "0"
+ }
+}
+</pre></div>
+<p>Mission accomplished. The partitions are nicely balanced.</p></div>
+<div class="section">
+<h4>How about Failover?<a name="How_about_Failover"></a></h4>
+<p>Building a fault tolerant system isn't trivial, but with Helix, it's easy. Helix detects a failed instance, and triggers mastership transfer automatically.</p>
+<p>First, let’s fail an instance. In this example, we'll kill localhost:12918 to simulate a failure.</p>
+<p>We lost localhost:12918, so myDB_1 lost its MASTER. Helix can fix that, it will transfer mastership to a healthy node that is currently a SLAVE, say localhost:12197. Helix balances the load as best as it can, given there are 6 partitions on 5 nodes. Let's see:</p>
+
+<div class="source">
+<pre>./helix-admin.sh --zkSvr localhost:2199 --listResourceInfo MYCLUSTER myDB
+
+IdealState for myDB:
+{
+ "id" : "myDB",
+ "mapFields" : {
+ "myDB_0" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "SLAVE",
+ "localhost_12917" : "MASTER"
+ },
+ "myDB_1" : {
+ "localhost_12916" : "SLAVE",
+ "localhost_12917" : "SLAVE",
+ "localhost_12918" : "MASTER"
+ },
+ "myDB_2" : {
+ "localhost_12913" : "MASTER",
+ "localhost_12917" : "SLAVE",
+ "localhost_12918" : "SLAVE"
+ },
+ "myDB_3" : {
+ "localhost_12915" : "MASTER",
+ "localhost_12917" : "SLAVE",
+ "localhost_12918" : "SLAVE"
+ },
+ "myDB_4" : {
+ "localhost_12916" : "MASTER",
+ "localhost_12917" : "SLAVE",
+ "localhost_12918" : "SLAVE"
+ },
+ "myDB_5" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "MASTER",
+ "localhost_12915" : "SLAVE"
+ }
+ },
+ "listFields" : {
+ "myDB_0" : [ "localhost_12917", "localhost_12913", "localhost_12914" ],
+ "myDB_1" : [ "localhost_12918", "localhost_12917", "localhost_12916" ],
+ "myDB_2" : [ "localhost_12913", "localhost_12918", "localhost_12917" ],
+ "myDB_3" : [ "localhost_12915", "localhost_12918", "localhost_12917" ],
+ "myDB_4" : [ "localhost_12916", "localhost_12917", "localhost_12918" ],
+ "myDB_5" : [ "localhost_12914", "localhost_12915", "localhost_12913" ]
+ },
+ "simpleFields" : {
+ "REBALANCE_MODE" : "SEMI_AUTO",
+ "NUM_PARTITIONS" : "6",
+ "REPLICAS" : "3",
+ "STATE_MODEL_DEF_REF" : "MasterSlave",
+ "STATE_MODEL_FACTORY_NAME" : "DEFAULT"
+ }
+}
+
+ExternalView for myDB:
+{
+ "id" : "myDB",
+ "mapFields" : {
+ "myDB_0" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "SLAVE",
+ "localhost_12917" : "MASTER"
+ },
+ "myDB_1" : {
+ "localhost_12916" : "SLAVE",
+ "localhost_12917" : "MASTER"
+ },
+ "myDB_2" : {
+ "localhost_12913" : "MASTER",
+ "localhost_12917" : "SLAVE"
+ },
+ "myDB_3" : {
+ "localhost_12915" : "MASTER",
+ "localhost_12917" : "SLAVE"
+ },
+ "myDB_4" : {
+ "localhost_12916" : "MASTER",
+ "localhost_12917" : "SLAVE"
+ },
+ "myDB_5" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "MASTER",
+ "localhost_12915" : "SLAVE"
+ }
+ },
+ "listFields" : {
+ },
+ "simpleFields" : {
+ "BUCKET_SIZE" : "0"
+ }
+}
+</pre></div>
+<p>As we've seen in this Quickstart, Helix takes care of partitioning, load balancing, elasticity, failure detection and recovery.</p>
+<div class="section">
+<h5>ZooInspector<a name="ZooInspector"></a></h5>
+<p>You can view all of the underlying data by going direct to zookeeper. Use ZooInspector that comes with zookeeper to browse the data. This is a java applet (make sure you have X windows)</p>
+<p>To start zooinspector run the following command from <zk_install_directory>/contrib/ZooInspector</p>
+
+<div class="source">
+<pre>java -cp zookeeper-3.3.3-ZooInspector.jar:lib/jtoaster-1.0.4.jar:../../lib/log4j-1.2.15.jar:../../zookeeper-3.3.3.jar org.apache.zookeeper.inspector.ZooInspector
+</pre></div></div></div>
+<div class="section">
+<h4>Next<a name="Next"></a></h4>
+<p>Now that you understand the idea of Helix, read the <a href="./tutorial.html">tutorial</a> to learn how to choose the right state model and constraints for your system, and how to implement it. In many cases, the built-in features meet your requirements. And best of all, Helix is a customizable framework, so you can plug in your own behavior, while retaining the automation provided by Helix.</p></div></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<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.incubator.apache.org/privacy-policy.html">Privacy Policy</a>
+</div>
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
\ No newline at end of file
Added: incubator/helix/site-content/Tutorial.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/Tutorial.html?rev=1544749&view=auto
==============================================================================
--- incubator/helix/site-content/Tutorial.html (added)
+++ incubator/helix/site-content/Tutorial.html Sat Nov 23 07:11:13 2013
@@ -0,0 +1,424 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2013-11-07
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20131107" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Apache Helix - Tutorial</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<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="topBarEnabled">
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container"><div class="nav-collapse">
+
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Helix <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="index.html" title="Introduction">Introduction</a>
+</li>
+
+ <li> <a href="Concepts.html" title="Core concepts">Core concepts</a>
+</li>
+
+ <li> <a href="Architecture.html" title="Architecture">Architecture</a>
+</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="releasenotes/release-0.6.1-incubating.html" title="release 0.6.1-incubating">release 0.6.1-incubating</a>
+</li>
+
+ <li> <a href="download.html" title="Download">Download</a>
+</li>
+
+ <li> <a href="IRC.html" title="IRC">IRC</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>
+
+ <li> <a href="recipes/user_def_rebalancer.html" title="User-Defined Rebalancer Example">User-Defined Rebalancer Example</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Involved <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="issue-tracking.html" title="Issues">Issues</a>
+</li>
+
+ <li> <a href="team-list.html" title="Team">Team</a>
+</li>
+
+ <li> <a href="source-repository.html" title="Sources">Sources</a>
+</li>
+
+ <li> <a href="integration.html" title="Continuous Integration">Continuous Integration</a>
+</li>
+
+ <li> <a href="involved/building.html" title="Building Guide">Building Guide</a>
+</li>
+
+ <li> <a href="releasing.html" title="Release Guide">Release Guide</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+ <form id="search-form" action="http://www.google.com/search" method="get" class="navbar-search pull-right" >
+
+ <input value="helix.incubator.apache.org" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
+
+
+
+
+ <ul class="nav pull-right"><li>
+
+ <a href="https://twitter.com/ApacheHelix" class="twitter-follow-button" data-show-count="false" data-align="right" data-size="large" data-show-screen-name="true" data-lang="en">Follow ApacheHelix</a>
+ <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+
+ </li></ul>
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="./" id="bannerLeft">
+ <img src="images/helix-logo.jpg" />
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org/" id="bannerRight">
+ <img src="http://incubator.apache.org/images/egg-logo.png" />
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li id="projectVersion">Version: 0.6.2-incubating-SNAPSHOT</li>
+ | <li class="">
+ <a href="./" title="Apache Helix">
+ Apache Helix</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class=""> Tutorial</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2013-11-07</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <!-- -
+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>
+<h1>Helix Tutorial</h1>
+<p>In this tutorial, we will cover the roles of a Helix-managed cluster, and show the code you need to write to integrate with it. In many cases, there is a simple default behavior that is often appropriate, but you can also customize the behavior.</p>
+<p>Convention: we first cover the <i>basic</i> approach, which is the easiest to implement. Then, we’ll describe <i>advanced</i> options, which give you more control over the system behavior, but require you to write more code.</p>
+<div class="section">
+<div class="section">
+<h3>Prerequisites<a name="Prerequisites"></a></h3>
+
+<ol style="list-style-type: decimal">
+
+<li>Read <a href="./Concepts.html">Concepts/Terminology</a> and <a href="./Architecture.html">Architecture</a></li>
+
+<li>Read the <a href="./Quickstart.html">Quickstart guide</a> to learn how Helix models and manages a cluster</li>
+
+<li>Install Helix source. See: <a href="./Quickstart.html">Quickstart</a> for the steps.</li>
+</ol></div>
+<div class="section">
+<h3>Tutorial Outline<a name="Tutorial_Outline"></a></h3>
+
+<ol style="list-style-type: decimal">
+
+<li><a href="./tutorial_participant.html">Participant</a></li>
+
+<li><a href="./tutorial_spectator.html">Spectator</a></li>
+
+<li><a href="./tutorial_controller.html">Controller</a></li>
+
+<li><a href="./tutorial_rebalance.html">Rebalancing Algorithms</a></li>
+
+<li><a href="./tutorial_user_def_rebalancer.html">User-Defined Rebalancing</a></li>
+
+<li><a href="./tutorial_state.html">State Machines</a></li>
+
+<li><a href="./tutorial_messaging.html">Messaging</a></li>
+
+<li><a href="./tutorial_health.html">Customized health check</a></li>
+
+<li><a href="./tutorial_throttling.html">Throttling</a></li>
+
+<li><a href="./tutorial_propstore.html">Application Property Store</a></li>
+
+<li><a href="./tutorial_admin.html">Admin Interface</a></li>
+
+<li><a href="./tutorial_yaml.html">YAML Cluster Setup</a></li>
+</ol></div>
+<div class="section">
+<h3>Preliminaries<a name="Preliminaries"></a></h3>
+<p>First, we need to set up the system. Let's walk through the steps in building a distributed system using Helix.</p></div>
+<div class="section">
+<h3>Start Zookeeper<a name="Start_Zookeeper"></a></h3>
+<p>This starts a zookeeper in standalone mode. For production deployment, see <a class="externalLink" href="http://zookeeper.apache.org">Apache Zookeeper</a> for instructions.</p>
+
+<div class="source">
+<pre> ./start-standalone-zookeeper.sh 2199 &
+</pre></div></div>
+<div class="section">
+<h3>Create a cluster<a name="Create_a_cluster"></a></h3>
+<p>Creating a cluster will define the cluster in appropriate znodes on zookeeper. </p>
+<p>Using the java API:</p>
+
+<div class="source">
+<pre> // Create setup tool instance
+ // Note: ZK_ADDRESS is the host:port of Zookeeper
+ String ZK_ADDRESS = "localhost:2199";
+ admin = new ZKHelixAdmin(ZK_ADDRESS);
+
+ String CLUSTER_NAME = "helix-demo";
+ //Create cluster namespace in zookeeper
+ admin.addCluster(CLUSTER_NAME);
+</pre></div>
+<p>OR</p>
+<p>Using the command-line interface:</p>
+
+<div class="source">
+<pre> ./helix-admin.sh --zkSvr localhost:2199 --addCluster helix-demo
+</pre></div></div>
+<div class="section">
+<h3>Configure the nodes of the cluster<a name="Configure_the_nodes_of_the_cluster"></a></h3>
+<p>First we'll add new nodes to the cluster, then configure the nodes in the cluster. Each node in the cluster must be uniquely identifiable. The most commonly used convention is hostname:port.</p>
+
+<div class="source">
+<pre> String CLUSTER_NAME = "helix-demo";
+ int NUM_NODES = 2;
+ String hosts[] = new String[]{"localhost","localhost"};
+ String ports[] = new String[]{7000,7001};
+ for (int i = 0; i < NUM_NODES; i++)
+ {
+
+ InstanceConfig instanceConfig = new InstanceConfig(hosts[i]+ "_" + ports[i]);
+ instanceConfig.setHostName(hosts[i]);
+ instanceConfig.setPort(ports[i]);
+ instanceConfig.setInstanceEnabled(true);
+
+ //Add additional system specific configuration if needed. These can be accessed during the node start up.
+ instanceConfig.getRecord().setSimpleField("key", "value");
+ admin.addInstance(CLUSTER_NAME, instanceConfig);
+
+ }
+</pre></div></div>
+<div class="section">
+<h3>Configure the resource<a name="Configure_the_resource"></a></h3>
+<p>A <i>resource</i> represents the actual task performed by the nodes. It can be a database, index, topic, queue or any other processing entity. A <i>resource</i> can be divided into many sub-parts known as <i>partitions</i>.</p>
+<div class="section">
+<h4>Define the <i>state model</i> and <i>constraints</i><a name="Define_the_state_model_and_constraints"></a></h4>
+<p>For scalability and fault tolerance, each partition can have one or more replicas. The <i>state model</i> allows one to declare the system behavior by first enumerating the various STATES, and the TRANSITIONS between them. A simple model is ONLINE-OFFLINE where ONLINE means the task is active and OFFLINE means it's not active. You can also specify how many replicas must be in each state, these are known as <i>constraints</i>. For example, in a search system, one might need more than one node serving the same index to handle the load.</p>
+<p>The allowed states: </p>
+
+<ul>
+
+<li>MASTER</li>
+
+<li>SLAVE</li>
+
+<li>OFFLINE</li>
+</ul>
+<p>The allowed transitions: </p>
+
+<ul>
+
+<li>OFFLINE to SLAVE</li>
+
+<li>SLAVE to OFFLINE</li>
+
+<li>SLAVE to MASTER</li>
+
+<li>MASTER to SLAVE</li>
+</ul>
+<p>The constraints:</p>
+
+<ul>
+
+<li>no more than 1 MASTER per partition</li>
+
+<li>the rest of the replicas should be slaves</li>
+</ul>
+<p>The following snippet shows how to declare the <i>state model</i> and <i>constraints</i> for the MASTER-SLAVE model.</p>
+
+<div class="source">
+<pre> StateModelDefinition.Builder builder = new StateModelDefinition.Builder(STATE_MODEL_NAME);
+
+ // Add states and their rank to indicate priority. A lower rank corresponds to a higher priority
+ builder.addState(MASTER, 1);
+ builder.addState(SLAVE, 2);
+ builder.addState(OFFLINE);
+
+ // Set the initial state when the node starts
+ builder.initialState(OFFLINE);
+
+ // Add transitions between the states.
+ builder.addTransition(OFFLINE, SLAVE);
+ builder.addTransition(SLAVE, OFFLINE);
+ builder.addTransition(SLAVE, MASTER);
+ builder.addTransition(MASTER, SLAVE);
+
+ // set constraints on states.
+
+ // static constraint: upper bound of 1 MASTER
+ builder.upperBound(MASTER, 1);
+
+ // dynamic constraint: R means it should be derived based on the replication factor for the cluster
+ // this allows a different replication factor for each resource without
+ // having to define a new state model
+ //
+ builder.dynamicUpperBound(SLAVE, "R");
+
+ StateModelDefinition statemodelDefinition = builder.build();
+ admin.addStateModelDef(CLUSTER_NAME, STATE_MODEL_NAME, myStateModel);
+</pre></div></div>
+<div class="section">
+<h4>Assigning partitions to nodes<a name="Assigning_partitions_to_nodes"></a></h4>
+<p>The final goal of Helix is to ensure that the constraints on the state model are satisfied. Helix does this by assigning a STATE to a partition (such as MASTER, SLAVE), and placing it on a particular node.</p>
+<p>There are 3 assignment modes Helix can operate on</p>
+
+<ul>
+
+<li>FULL_AUTO: Helix decides the placement and state of a partition.</li>
+
+<li>SEMI_AUTO: Application decides the placement but Helix decides the state of a partition.</li>
+
+<li>CUSTOMIZED: Application controls the placement and state of a partition.</li>
+</ul>
+<p>For more info on the assignment modes, see <a href="./tutorial_rebalance.html">Rebalancing Algorithms</a> section of the tutorial.</p>
+
+<div class="source">
+<pre> String RESOURCE_NAME = "MyDB";
+ int NUM_PARTITIONS = 6;
+ STATE_MODEL_NAME = "MasterSlave";
+ String MODE = "SEMI_AUTO";
+ int NUM_REPLICAS = 2;
+
+ admin.addResource(CLUSTER_NAME, RESOURCE_NAME, NUM_PARTITIONS, STATE_MODEL_NAME, MODE);
+ admin.rebalance(CLUSTER_NAME, RESOURCE_NAME, NUM_REPLICAS);
+</pre></div></div></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<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.incubator.apache.org/privacy-policy.html">Privacy Policy</a>
+</div>
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
\ No newline at end of file
Modified: incubator/helix/site-content/UseCases.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/UseCases.html?rev=1544749&r1=1544748&r2=1544749&view=diff
==============================================================================
--- incubator/helix/site-content/UseCases.html (original)
+++ incubator/helix/site-content/UseCases.html Sat Nov 23 07:11:13 2013
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2013-11-15
+ | Generated by Apache Maven Doxia at 2013-11-22
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20131115" />
+ <meta name="Date-Revision-yyyymmdd" content="20131122" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Helix - Use Cases</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -64,6 +64,23 @@
</ul>
</li>
<li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="site-releases/0.7.0-incubating-site/index.html" title="0.7.0-incubating (beta)">0.7.0-incubating (beta)</a>
+</li>
+
+ <li> <a href="site-releases/0.6.2-incubating-site/index.html" title="0.6.2-incubating (stable)">0.6.2-incubating (stable)</a>
+</li>
+
+ <li> <a href="site-releases/0.6.1-incubating-site/index.html" title="0.6.1-incubating">0.6.1-incubating</a>
+</li>
+
+ <li> <a href="site-releases/trunk-site/index.html" title="trunk">trunk</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Helix 0.7.0-incubating <b class="caret"></b></a>
<ul class="dropdown-menu">
@@ -78,19 +95,16 @@
</ul>
</li>
<li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Helix 0.6.2-incubating <b class="caret"></b></a>
<ul class="dropdown-menu">
- <li> <a href="site-releases/0.7.0-incubating-site/index.html" title="0.7.0-incubating">0.7.0-incubating</a>
+ <li> <a href="site-releases/0.6.2-incubating-site/Quickstart.html" title="Quick Start">Quick Start</a>
</li>
- <li> <a href="site-releases/0.6.2-incubating-site/index.html" title="0.6.2-incubating">0.6.2-incubating</a>
+ <li> <a href="site-releases/0.6.2-incubating-site/Tutorial.html" title="Tutorial">Tutorial</a>
</li>
- <li> <a href="site-releases/0.6.1-incubating-site/index.html" title="0.6.1-incubating">0.6.1-incubating</a>
-</li>
-
- <li> <a href="site-releases/trunk-site/index.html" title="trunk">trunk</a>
+ <li> <a href="site-releases/0.6.2-incubating-site/download.html" title="Download">Download</a>
</li>
</ul>
</li>
@@ -218,6 +232,35 @@
<i class="none"></i>
Publications</a>
</li>
+ <li class="nav-header">Releases</li>
+
+ <li>
+
+ <a href="site-releases/0.7.0-incubating-site/index.html" title="0.7.0-incubating (beta)">
+ <i class="none"></i>
+ 0.7.0-incubating (beta)</a>
+ </li>
+
+ <li>
+
+ <a href="site-releases/0.6.2-incubating-site/index.html" title="0.6.2-incubating (stable)">
+ <i class="none"></i>
+ 0.6.2-incubating (stable)</a>
+ </li>
+
+ <li>
+
+ <a href="site-releases/0.6.1-incubating-site/index.html" title="0.6.1-incubating">
+ <i class="none"></i>
+ 0.6.1-incubating</a>
+ </li>
+
+ <li>
+
+ <a href="site-releases/trunk-site/index.html" title="trunk">
+ <i class="none"></i>
+ trunk</a>
+ </li>
<li class="nav-header">Helix 0.7.0-incubating</li>
<li>
@@ -240,34 +283,27 @@
<i class="none"></i>
Download</a>
</li>
- <li class="nav-header">Releases</li>
+ <li class="nav-header">Helix 0.6.2-incubating</li>
<li>
- <a href="site-releases/0.7.0-incubating-site/index.html" title="0.7.0-incubating">
- <i class="none"></i>
- 0.7.0-incubating</a>
- </li>
-
- <li>
-
- <a href="site-releases/0.6.2-incubating-site/index.html" title="0.6.2-incubating">
+ <a href="site-releases/0.6.2-incubating-site/Quickstart.html" title="Quick Start">
<i class="none"></i>
- 0.6.2-incubating</a>
+ Quick Start</a>
</li>
<li>
- <a href="site-releases/0.6.1-incubating-site/index.html" title="0.6.1-incubating">
+ <a href="site-releases/0.6.2-incubating-site/Tutorial.html" title="Tutorial">
<i class="none"></i>
- 0.6.1-incubating</a>
+ Tutorial</a>
</li>
<li>
- <a href="site-releases/trunk-site/index.html" title="trunk">
+ <a href="site-releases/0.6.2-incubating-site/download.html" title="Download">
<i class="none"></i>
- trunk</a>
+ Download</a>
</li>
<li class="nav-header">Get Involved</li>