helix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kisho...@apache.org
Subject svn commit: r1479756 [1/39] - in /incubator/helix/site-content: ./ apidocs/reference/org/apache/helix/ apidocs/reference/org/apache/helix/agent/ apidocs/reference/org/apache/helix/manager/zk/ apidocs/reference/org/apache/helix/messaging/handling/ apido...
Date Tue, 07 May 2013 03:11:00 GMT
Author: kishoreg
Date: Tue May  7 03:10:53 2013
New Revision: 1479756

URL: http://svn.apache.org/r1479756
Log:
Site checkin for project Apache Helix

Added:
    incubator/helix/site-content/ApiUsage.html
    incubator/helix/site-content/Concepts.html
    incubator/helix/site-content/Sample_App.html
    incubator/helix/site-content/apidocs/reference/org/apache/helix/ConfigScope.ConfigScopeProperty.html
    incubator/helix/site-content/apidocs/reference/org/apache/helix/ConfigScope.html
    incubator/helix/site-content/apidocs/reference/org/apache/helix/ConfigScopeBuilder.html
    incubator/helix/site-content/apidocs/reference/org/apache/helix/messaging/handling/HelixTask.TimeoutCancelTask.html
    incubator/helix/site-content/apidocs/reference/org/apache/helix/model/ClusterConstraints.ConstraintItem.html
    incubator/helix/site-content/apidocs/reference/org/apache/helix/model/IdealState.AutoModeBuilder.html
    incubator/helix/site-content/apidocs/reference/org/apache/helix/model/IdealState.CustomBuilder.html
    incubator/helix/site-content/apidocs/reference/org/apache/helix/model/IdealState.SemiAutoBuilder.html
    incubator/helix/site-content/apidocs/reference/org/apache/helix/participant/statemachine/StateTransitionTableBuilder.html
    incubator/helix/site-content/apidocs/reference/org/apache/helix/tools/IdealStateCalculatorForStorageNode.html
    incubator/helix/site-content/apidocs/reference/org/apache/helix/tools/PropertiesReader.html
    incubator/helix/site-content/involved/release.html
    incubator/helix/site-content/xref-test/org/apache/helix/ExternalCommand.html
    incubator/helix/site-content/xref-test/org/apache/helix/TestZkBasis.html
    incubator/helix/site-content/xref-test/org/apache/helix/integration/TestGroupMessage.html
    incubator/helix/site-content/xref/org/apache/helix/ConfigScope.html
    incubator/helix/site-content/xref/org/apache/helix/ConfigScopeBuilder.html
    incubator/helix/site-content/xref/org/apache/helix/participant/statemachine/StateTransitionTableBuilder.html
    incubator/helix/site-content/xref/org/apache/helix/tools/IdealStateCalculatorForStorageNode.html
    incubator/helix/site-content/xref/org/apache/helix/tools/PropertiesReader.html
Modified:
    incubator/helix/site-content/Architecture.html
    incubator/helix/site-content/Features.html
    incubator/helix/site-content/Quickstart.html
    incubator/helix/site-content/Tutorial.html
    incubator/helix/site-content/UseCases.html
    incubator/helix/site-content/apidocs/reference/org/apache/helix/agent/ProcessMonitorThread.html
    incubator/helix/site-content/apidocs/reference/org/apache/helix/manager/zk/ZkCacheEventThread.html
    incubator/helix/site-content/apidocs/reference/org/apache/helix/recipes/rabbitmq/ConsumerThread.html
    incubator/helix/site-content/checkstyle-aggregate.html
    incubator/helix/site-content/checkstyle.rss
    incubator/helix/site-content/dependencies.html
    incubator/helix/site-content/dependency-convergence.html
    incubator/helix/site-content/dependency-info.html
    incubator/helix/site-content/dependency-management.html
    incubator/helix/site-content/distribution-management.html
    incubator/helix/site-content/download.html
    incubator/helix/site-content/helix-admin-webapp/dependencies.html
    incubator/helix/site-content/helix-admin-webapp/dependency-convergence.html
    incubator/helix/site-content/helix-admin-webapp/dependency-info.html
    incubator/helix/site-content/helix-admin-webapp/dependency-management.html
    incubator/helix/site-content/helix-admin-webapp/distribution-management.html
    incubator/helix/site-content/helix-admin-webapp/index.html
    incubator/helix/site-content/helix-admin-webapp/integration.html
    incubator/helix/site-content/helix-admin-webapp/issue-tracking.html
    incubator/helix/site-content/helix-admin-webapp/license.html
    incubator/helix/site-content/helix-admin-webapp/mail-lists.html
    incubator/helix/site-content/helix-admin-webapp/plugin-management.html
    incubator/helix/site-content/helix-admin-webapp/plugins.html
    incubator/helix/site-content/helix-admin-webapp/project-info.html
    incubator/helix/site-content/helix-admin-webapp/project-reports.html
    incubator/helix/site-content/helix-admin-webapp/project-summary.html
    incubator/helix/site-content/helix-admin-webapp/sonar.html
    incubator/helix/site-content/helix-admin-webapp/source-repository.html
    incubator/helix/site-content/helix-admin-webapp/team-list.html
    incubator/helix/site-content/helix-agent/dependencies.html
    incubator/helix/site-content/helix-agent/dependency-convergence.html
    incubator/helix/site-content/helix-agent/dependency-info.html
    incubator/helix/site-content/helix-agent/dependency-management.html
    incubator/helix/site-content/helix-agent/distribution-management.html
    incubator/helix/site-content/helix-agent/index.html
    incubator/helix/site-content/helix-agent/integration.html
    incubator/helix/site-content/helix-agent/issue-tracking.html
    incubator/helix/site-content/helix-agent/license.html
    incubator/helix/site-content/helix-agent/mail-lists.html
    incubator/helix/site-content/helix-agent/plugin-management.html
    incubator/helix/site-content/helix-agent/plugins.html
    incubator/helix/site-content/helix-agent/project-info.html
    incubator/helix/site-content/helix-agent/project-reports.html
    incubator/helix/site-content/helix-agent/project-summary.html
    incubator/helix/site-content/helix-agent/sonar.html
    incubator/helix/site-content/helix-agent/source-repository.html
    incubator/helix/site-content/helix-agent/team-list.html
    incubator/helix/site-content/helix-core/dependencies.html
    incubator/helix/site-content/helix-core/dependency-convergence.html
    incubator/helix/site-content/helix-core/dependency-info.html
    incubator/helix/site-content/helix-core/dependency-management.html
    incubator/helix/site-content/helix-core/distribution-management.html
    incubator/helix/site-content/helix-core/index.html
    incubator/helix/site-content/helix-core/integration.html
    incubator/helix/site-content/helix-core/issue-tracking.html
    incubator/helix/site-content/helix-core/license.html
    incubator/helix/site-content/helix-core/mail-lists.html
    incubator/helix/site-content/helix-core/plugin-management.html
    incubator/helix/site-content/helix-core/plugins.html
    incubator/helix/site-content/helix-core/project-info.html
    incubator/helix/site-content/helix-core/project-reports.html
    incubator/helix/site-content/helix-core/project-summary.html
    incubator/helix/site-content/helix-core/sonar.html
    incubator/helix/site-content/helix-core/source-repository.html
    incubator/helix/site-content/helix-core/team-list.html
    incubator/helix/site-content/index.html
    incubator/helix/site-content/integration.html
    incubator/helix/site-content/involved/building.html
    incubator/helix/site-content/issue-tracking.html
    incubator/helix/site-content/jira-report.html
    incubator/helix/site-content/license.html
    incubator/helix/site-content/mail-lists.html
    incubator/helix/site-content/mockservice/dependencies.html
    incubator/helix/site-content/mockservice/dependency-convergence.html
    incubator/helix/site-content/mockservice/dependency-info.html
    incubator/helix/site-content/mockservice/dependency-management.html
    incubator/helix/site-content/mockservice/distribution-management.html
    incubator/helix/site-content/mockservice/index.html
    incubator/helix/site-content/mockservice/integration.html
    incubator/helix/site-content/mockservice/issue-tracking.html
    incubator/helix/site-content/mockservice/license.html
    incubator/helix/site-content/mockservice/mail-lists.html
    incubator/helix/site-content/mockservice/plugin-management.html
    incubator/helix/site-content/mockservice/plugins.html
    incubator/helix/site-content/mockservice/project-info.html
    incubator/helix/site-content/mockservice/project-reports.html
    incubator/helix/site-content/mockservice/project-summary.html
    incubator/helix/site-content/mockservice/sonar.html
    incubator/helix/site-content/mockservice/source-repository.html
    incubator/helix/site-content/mockservice/team-list.html
    incubator/helix/site-content/modules.html
    incubator/helix/site-content/plugin-management.html
    incubator/helix/site-content/plugins.html
    incubator/helix/site-content/privacy-policy.html
    incubator/helix/site-content/project-info.html
    incubator/helix/site-content/project-reports.html
    incubator/helix/site-content/project-summary.html
    incubator/helix/site-content/recipes/dependencies.html
    incubator/helix/site-content/recipes/dependency-convergence.html
    incubator/helix/site-content/recipes/dependency-info.html
    incubator/helix/site-content/recipes/dependency-management.html
    incubator/helix/site-content/recipes/distributed-lock-manager/dependencies.html
    incubator/helix/site-content/recipes/distributed-lock-manager/dependency-convergence.html
    incubator/helix/site-content/recipes/distributed-lock-manager/dependency-info.html
    incubator/helix/site-content/recipes/distributed-lock-manager/dependency-management.html
    incubator/helix/site-content/recipes/distributed-lock-manager/distribution-management.html
    incubator/helix/site-content/recipes/distributed-lock-manager/index.html
    incubator/helix/site-content/recipes/distributed-lock-manager/integration.html
    incubator/helix/site-content/recipes/distributed-lock-manager/issue-tracking.html
    incubator/helix/site-content/recipes/distributed-lock-manager/license.html
    incubator/helix/site-content/recipes/distributed-lock-manager/mail-lists.html
    incubator/helix/site-content/recipes/distributed-lock-manager/plugin-management.html
    incubator/helix/site-content/recipes/distributed-lock-manager/plugins.html
    incubator/helix/site-content/recipes/distributed-lock-manager/project-info.html
    incubator/helix/site-content/recipes/distributed-lock-manager/project-reports.html
    incubator/helix/site-content/recipes/distributed-lock-manager/project-summary.html
    incubator/helix/site-content/recipes/distributed-lock-manager/sonar.html
    incubator/helix/site-content/recipes/distributed-lock-manager/source-repository.html
    incubator/helix/site-content/recipes/distributed-lock-manager/team-list.html
    incubator/helix/site-content/recipes/distribution-management.html
    incubator/helix/site-content/recipes/index.html
    incubator/helix/site-content/recipes/integration.html
    incubator/helix/site-content/recipes/issue-tracking.html
    incubator/helix/site-content/recipes/license.html
    incubator/helix/site-content/recipes/lock_manager.html
    incubator/helix/site-content/recipes/mail-lists.html
    incubator/helix/site-content/recipes/modules.html
    incubator/helix/site-content/recipes/plugin-management.html
    incubator/helix/site-content/recipes/plugins.html
    incubator/helix/site-content/recipes/project-info.html
    incubator/helix/site-content/recipes/project-reports.html
    incubator/helix/site-content/recipes/project-summary.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/dependencies.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/dependency-convergence.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/dependency-info.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/dependency-management.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/distribution-management.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/index.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/integration.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/issue-tracking.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/license.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/mail-lists.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/plugin-management.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/plugins.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/project-info.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/project-reports.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/project-summary.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/sonar.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/source-repository.html
    incubator/helix/site-content/recipes/rabbitmq-consumer-group/team-list.html
    incubator/helix/site-content/recipes/rabbitmq_consumer_group.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/dependencies.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/dependency-convergence.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/dependency-info.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/dependency-management.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/distribution-management.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/index.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/integration.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/issue-tracking.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/license.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/mail-lists.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/plugin-management.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/plugins.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/project-info.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/project-reports.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/project-summary.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/sonar.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/source-repository.html
    incubator/helix/site-content/recipes/rsync-replicated-file-system/team-list.html
    incubator/helix/site-content/recipes/rsync_replicated_file_store.html
    incubator/helix/site-content/recipes/service-discovery/dependencies.html
    incubator/helix/site-content/recipes/service-discovery/dependency-convergence.html
    incubator/helix/site-content/recipes/service-discovery/dependency-info.html
    incubator/helix/site-content/recipes/service-discovery/dependency-management.html
    incubator/helix/site-content/recipes/service-discovery/distribution-management.html
    incubator/helix/site-content/recipes/service-discovery/index.html
    incubator/helix/site-content/recipes/service-discovery/integration.html
    incubator/helix/site-content/recipes/service-discovery/issue-tracking.html
    incubator/helix/site-content/recipes/service-discovery/license.html
    incubator/helix/site-content/recipes/service-discovery/mail-lists.html
    incubator/helix/site-content/recipes/service-discovery/plugin-management.html
    incubator/helix/site-content/recipes/service-discovery/plugins.html
    incubator/helix/site-content/recipes/service-discovery/project-info.html
    incubator/helix/site-content/recipes/service-discovery/project-reports.html
    incubator/helix/site-content/recipes/service-discovery/project-summary.html
    incubator/helix/site-content/recipes/service-discovery/sonar.html
    incubator/helix/site-content/recipes/service-discovery/source-repository.html
    incubator/helix/site-content/recipes/service-discovery/team-list.html
    incubator/helix/site-content/recipes/service_discovery.html
    incubator/helix/site-content/recipes/sonar.html
    incubator/helix/site-content/recipes/source-repository.html
    incubator/helix/site-content/recipes/task-execution/dependencies.html
    incubator/helix/site-content/recipes/task-execution/dependency-convergence.html
    incubator/helix/site-content/recipes/task-execution/dependency-info.html
    incubator/helix/site-content/recipes/task-execution/dependency-management.html
    incubator/helix/site-content/recipes/task-execution/distribution-management.html
    incubator/helix/site-content/recipes/task-execution/index.html
    incubator/helix/site-content/recipes/task-execution/integration.html
    incubator/helix/site-content/recipes/task-execution/issue-tracking.html
    incubator/helix/site-content/recipes/task-execution/license.html
    incubator/helix/site-content/recipes/task-execution/mail-lists.html
    incubator/helix/site-content/recipes/task-execution/plugin-management.html
    incubator/helix/site-content/recipes/task-execution/plugins.html
    incubator/helix/site-content/recipes/task-execution/project-info.html
    incubator/helix/site-content/recipes/task-execution/project-reports.html
    incubator/helix/site-content/recipes/task-execution/project-summary.html
    incubator/helix/site-content/recipes/task-execution/sonar.html
    incubator/helix/site-content/recipes/task-execution/source-repository.html
    incubator/helix/site-content/recipes/task-execution/team-list.html
    incubator/helix/site-content/recipes/team-list.html
    incubator/helix/site-content/releasenotes/release-0.6.0-incubating.html
    incubator/helix/site-content/releasing.html
    incubator/helix/site-content/sonar.html
    incubator/helix/site-content/source-repository.html
    incubator/helix/site-content/team-list.html
    incubator/helix/site-content/xref-test/allclasses-frame.html
    incubator/helix/site-content/xref-test/org/apache/helix/ZkTestHelper.html
    incubator/helix/site-content/xref-test/org/apache/helix/agent/TestHelixAgent.html
    incubator/helix/site-content/xref-test/org/apache/helix/healthcheck/TestSimpleAlert.html
    incubator/helix/site-content/xref-test/org/apache/helix/healthcheck/TestSimpleWildcardAlert.html
    incubator/helix/site-content/xref-test/org/apache/helix/healthcheck/package-frame.html
    incubator/helix/site-content/xref-test/org/apache/helix/healthcheck/package-summary.html
    incubator/helix/site-content/xref-test/org/apache/helix/integration/TestMessagingService.html
    incubator/helix/site-content/xref-test/org/apache/helix/integration/TestSchedulerMessage.html
    incubator/helix/site-content/xref-test/org/apache/helix/integration/TestZkCallbackHandlerLeak.html
    incubator/helix/site-content/xref-test/org/apache/helix/integration/TestZkReconnect.html
    incubator/helix/site-content/xref-test/org/apache/helix/integration/package-frame.html
    incubator/helix/site-content/xref-test/org/apache/helix/integration/package-summary.html
    incubator/helix/site-content/xref-test/org/apache/helix/messaging/TestAsyncCallback.html
    incubator/helix/site-content/xref-test/org/apache/helix/messaging/TestAsyncCallbackSvc.html
    incubator/helix/site-content/xref-test/org/apache/helix/messaging/handling/TestConfigThreadpoolSize.html
    incubator/helix/site-content/xref-test/org/apache/helix/messaging/package-frame.html
    incubator/helix/site-content/xref-test/org/apache/helix/messaging/package-summary.html
    incubator/helix/site-content/xref-test/org/apache/helix/package-frame.html
    incubator/helix/site-content/xref-test/org/apache/helix/package-summary.html
    incubator/helix/site-content/xref/allclasses-frame.html
    incubator/helix/site-content/xref/org/apache/helix/CMConnector.html
    incubator/helix/site-content/xref/org/apache/helix/manager/zk/CallbackHandler.html
    incubator/helix/site-content/xref/org/apache/helix/manager/zk/ZKHelixManager.html
    incubator/helix/site-content/xref/org/apache/helix/messaging/handling/CurrentStateUpdate.html
    incubator/helix/site-content/xref/org/apache/helix/messaging/handling/GroupMessageHandler.html
    incubator/helix/site-content/xref/org/apache/helix/messaging/handling/HelixStateTransitionHandler.html
    incubator/helix/site-content/xref/org/apache/helix/messaging/handling/package-frame.html
    incubator/helix/site-content/xref/org/apache/helix/messaging/handling/package-summary.html
    incubator/helix/site-content/xref/org/apache/helix/servicediscovery/MyService.html
    incubator/helix/site-content/xref/org/apache/helix/servicediscovery/ServiceDiscovery.html
    incubator/helix/site-content/xref/org/apache/helix/servicediscovery/ServiceDiscoveryDemo.html
    incubator/helix/site-content/xref/org/apache/helix/servicediscovery/ServiceMetadata.html

Added: incubator/helix/site-content/ApiUsage.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/ApiUsage.html?rev=1479756&view=auto
==============================================================================
--- incubator/helix/site-content/ApiUsage.html (added)
+++ incubator/helix/site-content/ApiUsage.html Tue May  7 03:10:53 2013
@@ -0,0 +1,659 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at Jan 25, 2013
+ | 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="20130125" />
+    <meta http-equiv="Content-Language" content="en" />
+    <title>Apache Helix - </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>
+
+    
+            </head>
+        <body class="topBarEnabled">
+          
+                
+                    
+                
+
+    <div id="topbar" class="navbar navbar-fixed-top ">
+      <div class="navbar-inner">
+                <div class="container-fluid">
+        <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+        </a>
+                
+                                <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="About">About</a>
+</li>
+                  
+                      <li>      <a href="Quickstart.html"  title="Quick Start">Quick Start</a>
+</li>
+                  
+                      <li>      <a href="ApiUsage.html"  title="Api Usage">Api Usage</a>
+</li>
+                  
+                      <li>      <a href="Architecture.html"  title="Architecture">Architecture</a>
+</li>
+                  
+                      <li>      <a href="Features.html"  title="Features">Features</a>
+</li>
+                  
+                      <li>      <a href="releasenotes/release-0.6.0-incubating.html"  title="Current release 0.6.0-incubating">Current release 0.6.0-incubating</a>
+</li>
+                  
+                      <li>      <a href="jira-report.html"  title="Current Version Change Log">Current Version Change Log</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>
+                          </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>
+                <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li class="dropdown-submenu">
+                                      <a href="project-info.html"  title="Project Information">Project Information</a>
+              <ul class="dropdown-menu">
+                                  <li>      <a href="index.html"  title="About">About</a>
+</li>
+                                  <li>      <a href="project-summary.html"  title="Project Summary">Project Summary</a>
+</li>
+                                  <li>      <a href="dependency-info.html"  title="Dependency Information">Dependency Information</a>
+</li>
+                                  <li>      <a href="modules.html"  title="Project Modules">Project Modules</a>
+</li>
+                                  <li>      <a href="license.html"  title="Project License">Project License</a>
+</li>
+                                  <li>      <a href="team-list.html"  title="Project Team">Project Team</a>
+</li>
+                                  <li>      <a href="source-repository.html"  title="Source Repository">Source Repository</a>
+</li>
+                                  <li>      <a href="issue-tracking.html"  title="Issue Tracking">Issue Tracking</a>
+</li>
+                                  <li>      <a href="mail-lists.html"  title="Mailing Lists">Mailing Lists</a>
+</li>
+                                  <li>      <a href="dependency-management.html"  title="Dependency Management">Dependency Management</a>
+</li>
+                                  <li>      <a href="dependencies.html"  title="Dependencies">Dependencies</a>
+</li>
+                                  <li>      <a href="dependency-convergence.html"  title="Dependency Convergence">Dependency Convergence</a>
+</li>
+                                  <li>      <a href="integration.html"  title="Continuous Integration">Continuous Integration</a>
+</li>
+                                  <li>      <a href="plugin-management.html"  title="Plugin Management">Plugin Management</a>
+</li>
+                                  <li>      <a href="plugins.html"  title="Project Plugins">Project Plugins</a>
+</li>
+                                  <li>      <a href="distribution-management.html"  title="Distribution Management">Distribution Management</a>
+</li>
+                              </ul>
+            </li>
+                  
+                      <li class="dropdown-submenu">
+                                      <a href="project-reports.html"  title="Project Reports">Project Reports</a>
+              <ul class="dropdown-menu">
+                                  <li>      <a href="jira-report.html"  title="JIRA Report">JIRA Report</a>
+</li>
+                                  <li>      <a href="xref/index.html"  title="Source Xref">Source Xref</a>
+</li>
+                                  <li>      <a href="xref-test/index.html"  title="Test Source Xref">Test Source Xref</a>
+</li>
+                                  <li>      <a href="apidocs/index.html"  title="JavaDocs">JavaDocs</a>
+</li>
+                                  <li>      <a href="checkstyle-aggregate.html"  title="Checkstyle">Checkstyle</a>
+</li>
+                                  <li>      <a href="sonar.html"  title="Sonar">Sonar</a>
+</li>
+                              </ul>
+            </li>
+                          </ul>
+      </li>
+                <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li>      <a href="http://www.apache.org/foundation/how-it-works.html"  title="How Apache Works">How Apache Works</a>
+</li>
+                  
+                      <li>      <a href="http://www.apache.org/foundation/"  title="Foundation">Foundation</a>
+</li>
+                  
+                      <li>      <a href="http://www.apache.org/foundation/sponsorship.html"  title="Sponsoring Apache">Sponsoring Apache</a>
+</li>
+                  
+                      <li>      <a href="http://www.apache.org/foundation/thanks.html"  title="Thanks">Thanks</a>
+</li>
+                          </ul>
+      </li>
+                  </ul>
+          
+          
+          
+                   
+                      </div>
+          
+        </div>
+      </div>
+    </div>
+    
+        <div class="container-fluid">
+          <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 class="">
+                    <a href="./" title="Apache Helix">
+        Apache Helix</a>
+        </li>
+      <li class="divider ">/</li>
+        <li class=""></li>
+        
+                
+                    
+                  <li id="publishDate" class="pull-right">Last Published: 2013-01-25</li> <li class="divider pull-right">|</li>
+              <li id="projectVersion" class="pull-right">Version: 0.6.1-incubating-SNAPSHOT</li>
+            
+                            </ul>
+      </div>
+
+            
+      <div class="row-fluid">
+        <div id="leftColumn" class="span3">
+          <div class="well sidebar-nav">
+                
+                    
+                <ul class="nav nav-list">
+                    <li class="nav-header">Helix</li>
+                                
+      <li>
+    
+                          <a href="index.html" title="About">
+          <i class="none"></i>
+        About</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="Quickstart.html" title="Quick Start">
+          <i class="none"></i>
+        Quick Start</a>
+            </li>
+                  
+      <li class="active">
+    
+            <a href="#"><i class="none"></i>Api Usage</a>
+          </li>
+                  
+      <li>
+    
+                          <a href="Architecture.html" title="Architecture">
+          <i class="none"></i>
+        Architecture</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="Features.html" title="Features">
+          <i class="none"></i>
+        Features</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="releasenotes/release-0.6.0-incubating.html" title="Current release 0.6.0-incubating">
+          <i class="none"></i>
+        Current release 0.6.0-incubating</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="jira-report.html" title="Current Version Change Log">
+          <i class="none"></i>
+        Current Version Change Log</a>
+            </li>
+                              <li class="nav-header">Recipes</li>
+                                
+      <li>
+    
+                          <a href="recipes/lock_manager.html" title="Distributed lock manager">
+          <i class="none"></i>
+        Distributed lock manager</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">
+          <i class="none"></i>
+        Rabbit MQ consumer group</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">
+          <i class="none"></i>
+        Rsync replicated file store</a>
+            </li>
+                              <li class="nav-header">Get Involved</li>
+                                
+      <li>
+    
+                          <a href="mail-lists.html" title="Mailing Lists">
+          <i class="none"></i>
+        Mailing Lists</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="issue-tracking.html" title="Issues">
+          <i class="none"></i>
+        Issues</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="team-list.html" title="Team">
+          <i class="none"></i>
+        Team</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="source-repository.html" title="Sources">
+          <i class="none"></i>
+        Sources</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="integration.html" title="Continuous Integration">
+          <i class="none"></i>
+        Continuous Integration</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="involved/building.html" title="Building Guide">
+          <i class="none"></i>
+        Building Guide</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="releasing.html" title="Release Guide">
+          <i class="none"></i>
+        Release Guide</a>
+            </li>
+                              <li class="nav-header">Project Documentation</li>
+                                                                                                                                                                                                                                                                                                                                                                
+      <li>
+    
+                          <a href="project-info.html" title="Project Information">
+          <i class="icon-chevron-right"></i>
+        Project Information</a>
+                  </li>
+                                                                                                                                                              
+      <li>
+    
+                          <a href="project-reports.html" title="Project Reports">
+          <i class="icon-chevron-right"></i>
+        Project Reports</a>
+                  </li>
+                              <li class="nav-header">ASF</li>
+                                
+      <li>
+    
+                          <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works">
+          <i class="none"></i>
+        How Apache Works</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="http://www.apache.org/foundation/" class="externalLink" title="Foundation">
+          <i class="none"></i>
+        Foundation</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache">
+          <i class="none"></i>
+        Sponsoring Apache</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+          <i class="none"></i>
+        Thanks</a>
+            </li>
+            </ul>
+                
+                    
+                            <form id="search-form" action="http://www.google.com/search" method="get" >
+    
+  <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>
+          
+          <hr class="divider" />
+
+           <div id="poweredBy">
+                            <div class="clear"></div>
+                            <div class="clear"></div>
+                            <div class="clear"></div>
+                             <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>
+                  </div>
+          </div>
+        </div>
+        
+                
+        <div id="bodyColumn"  class="span9" >
+                                  
+            <!-- -
+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. --><h1>Create an instance of Manager</h1><p>The first step of using the Helix api will be creating a Helix manager instance. It requires the following parameters:</p>
+<ul>
+  <li>clusterName: A logical name to represent the group of nodes</li>
+  <li>instanceName: A logical name of the process creating the manager instance. Generally this is host:port.</li>
+  <li>instanceType: Type of the process. This can be one of the following types:
+  <ul>
+    <li>CONTROLLER: Process that controls the cluster, any number of controllers can be started but only one will be active at any given time.</li>
+    <li>PARTICIPANT: Process that performs the actual task in the distributed system.</li>
+    <li>SPECTATOR: Process that observes the changes in the cluster.</li>
+    <li>ADMIN: To carry out system admin actions.</li>
+  </ul></li>
+  <li>zkConnectString: Connection string to Zookeeper. This is of the form host1:port1,host2:port2,host3:port3.</li>
+</ul>
+<div class="source"><pre class="prettyprint">      manager = HelixManagerFactory.getZKHelixManager(clusterName,
+                                                      instanceName,
+                                                      instanceType,
+                                                      zkConnectString);
+</pre></div><h1>Setting up a cluster</h1><p>Initial setup of a cluster, involves creating appropriate znodes in the zookeeper. </p>
+<div class="source"><pre class="prettyprint">    //Create setuptool instance
+    ClusterSetupTool setupTool = new ClusterSetupTool(zkConnectString);
+    //Create cluster namespace in zookeeper
+    setupTool.addCluster(clusterName, true);
+    //Add six Participant instances, each instance must have a unique id. host:port is the standard convention
+    String instances[] = new String[6];
+    for (int i = 0; i &lt; storageInstanceInfoArray.length; i++)
+    {
+      instance[i] = &quot;localhost:&quot; + (8900 + i);
+    }
+    setupTool.addInstancesToCluster(clusterName, instances);
+    //add the resource with 10 partitions to the cluster. Using MasterSlave state model. 
+    //See the section on how to configure a application specific state model
+    setupTool.addResourceToCluster(clusterName, &quot;TestDB&quot;, 10, &quot;MasterSlave&quot;);
+    //This will do the assignment of partitions to instances. Assignment algorithm is based on consistent hashing and RUSH. 
+    //See how to do custom partition assignment
+    setupTool.rebalanceResource(clusterName, &quot;TestDB&quot;, 3);
+</pre></div><div class="section"><h2>Participant<a name="Participant"></a></h2><p>Starting up a participant is pretty straightforward. After the Helix manager instance is created, only thing that needs to be registered is the state model factory. The Methods on the State Model will be called when controller sends transitions to the Participant.</p>
+<div class="source"><pre class="prettyprint">      manager = HelixManagerFactory.getZKHelixManager(clusterName,
+                                                          instanceName,
+                                                          InstanceType.PARTICIPANT,
+                                                          zkConnectString);
+     StateMachineEngine stateMach = manager.getStateMachineEngine();
+     //create a stateModelFactory that returns a statemodel object for each partition. 
+     stateModelFactory = new OnlineOfflineStateModelFactory();     
+     stateMach.registerStateModelFactory(stateModelType, stateModelFactory);
+     manager.connect();
+</pre></div>
+<div class="source"><pre class="prettyprint">public class OnlineOfflineStateModelFactory extends
+		StateModelFactory&lt;StateModel&gt; {
+	@Override
+	public StateModel createNewStateModel(String stateUnitKey) {
+		OnlineOfflineStateModel stateModel = new OnlineOfflineStateModel();
+		return stateModel;
+	}
+	@StateModelInfo(states = &quot;{'OFFLINE','ONLINE'}&quot;, initialState = &quot;OFFINE&quot;)
+	public static class OnlineOfflineStateModel extends StateModel {
+        @Transition(from = &quot;OFFLINE&quot;, to = &quot;ONLINE&quot;)
+		public void onBecomeOnlineFromOffline(Message message,
+				NotificationContext context) {
+			System.out
+					.println(&quot;OnlineOfflineStateModel.onBecomeOnlineFromOffline()&quot;);
+			//Application logic to handle transition 
+		}
+        @Transition(from = &quot;ONLINE&quot;, to = &quot;OFFLINE&quot;)
+		public void onBecomeOfflineFromOnline(Message message,
+				NotificationContext context) {
+			System.out
+						.println(&quot;OnlineOfflineStateModel.onBecomeOfflineFromOnline()&quot;);
+			//Application logic to handle transition
+		}
+	}
+}
+</pre></div></div><div class="section"><h2>Controller Code<a name="Controller_Code"></a></h2><p>Controller needs to know about all changes in the cluster. Helix comes with default implementation to handle all changes in the cluster. If you have a need to add additional functionality, see GenericHelixController on how to configure the pipeline.</p>
+<div class="source"><pre class="prettyprint">      manager = HelixManagerFactory.getZKHelixManager(clusterName,
+                                                          instanceName,
+                                                          InstanceType.CONTROLLER,
+                                                          zkConnectString);
+     manager.connect();
+     GenericHelixController controller = new GenericHelixController();
+     manager.addConfigChangeListener(controller);
+     manager.addLiveInstanceChangeListener(controller);
+     manager.addIdealStateChangeListener(controller);
+     manager.addExternalViewChangeListener(controller);
+     manager.addControllerListener(controller);
+</pre></div><p>This above snippet shows how the controller is started. You can also start the controller using command line interface.</p>
+<div class="source"><pre class="prettyprint">cd helix
+mvn clean install -Dmaven.test.skip=true
+cd helix-core/target/helix-core-pkg/bin
+chmod +x *
+./run-helix-controller.sh --zkSvr &lt;ZookeeperServerAddress(Required)&gt;  --cluster &lt;Cluster name (Required)&gt;
+</pre></div></div><div class="section"><h2>Spectator Code<a name="Spectator_Code"></a></h2><p>A spectator simply observes all cluster is notified when the state of the system changes. Helix consolidates the state of entire cluster in one Znode called ExternalView. Helix provides a default implementation RoutingTableProvider that caches the cluster state and updates it when there is a change in the cluster</p>
+<div class="source"><pre class="prettyprint">manager = HelixManagerFactory.getZKHelixManager(clusterName,
+                                                          instanceName,
+                                                          InstanceType.PARTICIPANT,
+                                                          zkConnectString);
+manager.connect();
+RoutingTableProvider routingTableProvider = new RoutingTableProvider();
+manager.addExternalViewChangeListener(routingTableProvider);
+
+</pre></div><p>In order to figure out who is serving a partition, here are the apis</p>
+<div class="source"><pre class="prettyprint">instances = routingTableProvider.getInstances(&quot;DBNAME&quot;, &quot;PARITION_NAME&quot;, &quot;PARTITION_STATE&quot;);
+</pre></div></div><div class="section"><h2>Helix Admin operations<a name="Helix_Admin_operations"></a></h2><p>Helix provides multiple ways to administer the cluster. It has a command line interface and also a REST interface.</p>
+<div class="source"><pre class="prettyprint">cd helix
+mvn clean install -Dmaven.test.skip=true
+cd helix-core/target/helix-core-pkg/bin
+chmod +x *
+./helix-admin.sh --help
+Provide zookeeper address. Required for all commands  
+   --zkSvr &lt;ZookeeperServerAddress(Required)&gt;       
+
+Add a new cluster                                                          
+   --addCluster &lt;clusterName&gt;                              
+
+Add a new Instance to a cluster                                    
+   --addNode &lt;clusterName InstanceAddress(host:port)&gt;                                      
+
+Add a State model to a cluster                                     
+   --addStateModelDef &lt;clusterName &lt;filename&gt;&gt;    
+
+Add a resource to a cluster            
+   --addResource &lt;clusterName resourceName partitionNum stateModelRef &lt;mode(AUTO_REBALANCE|AUTO|CUSTOM)&gt;&gt;      
+
+Upload an IdealState(Partition to Node Mapping)                                         
+   --addIdealState &lt;clusterName resourceName &lt;filename&gt;&gt;            
+
+Delete a cluster
+   --dropCluster &lt;clusterName&gt;                                                                         
+
+Delete a resource
+   --dropResource &lt;clusterName resourceName&gt;                                                           Drop an existing resource from a cluster
+
+Drop an existing Instance from a cluster    
+   --dropNode &lt;clusterName InstanceAddress(host:port)&gt;                    
+
+Enable/disable the entire cluster, this will basically pause the controller which means no transitions will be trigger, but the existing node sin the cluster continue to function 
+   --enableCluster &lt;clusterName&gt;
+
+Enable/disable a Instance. Useful to take a faulty node out of the cluster.
+   --enableInstance &lt;clusterName InstanceName true/false&gt;
+
+Enable/disable a partition
+   --enablePartition &lt;clusterName instanceName resourceName partitionName true/false&gt;
+
+
+   --listClusterInfo &lt;clusterName&gt;                                                                     Query info of a cluster
+   --listClusters                                                                                      List existing clusters
+   --listInstanceInfo &lt;clusterName InstanceName&gt;                                                       Query info of a Instance in a cluster
+   --listInstances &lt;clusterName&gt;                                                                       List Instances in a cluster
+   --listPartitionInfo &lt;clusterName resourceName partitionName&gt;                                        Query info of a partition
+   --listResourceInfo &lt;clusterName resourceName&gt;                                                       Query info of a resource
+   --listResources &lt;clusterName&gt;                                                                       List resources hosted in a cluster
+   --listStateModel &lt;clusterName stateModelName&gt;                                                       Query info of a state model in a cluster
+   --listStateModels &lt;clusterName&gt;                                                                     Query info of state models in a cluster
+
+</pre></div></div><div class="section"><h2>Idealstate modes and configuration<a name="Idealstate_modes_and_configuration"></a></h2>
+<ul>
+  <li>AUTO mode: Partition to Node assignment is pre-generated using consistent hashing</li>
+</ul>
+<div class="source"><pre class="prettyprint">  setupTool.addResourceToCluster(clusterName, resourceName, partitionNumber, &quot;MasterSlave&quot;)
+  setupTool.rebalanceStorageCluster(clusterName, resourceName, replicas)
+</pre></div>
+<ul>
+  <li>AUTO_REBALANCE mode: Partition to Node assignment is generated dynamically by cluster manager based on the nodes that are currently up and running</li>
+</ul>
+<div class="source"><pre class="prettyprint"> setupTool.addResourceToCluster(clusterName, resourceName, partitionNumber, &quot;MasterSlave&quot;, &quot;AUTO_REBALANCE&quot;)
+ setupTool.rebalanceStorageCluster(clusterName, resourceName, replicas)
+</pre></div>
+<ul>
+  <li>CUSTOMIZED mode: Allows one to set the is pre-generated from a JSON format file</li>
+</ul><p><tt>
+ setupTool.addIdealState(clusterName, resourceName, idealStateJsonFile)
+</tt></p></div><div class="section"><h2>Configuring state model<a name="Configuring_state_model"></a></h2>
+<div class="source"><pre class="prettyprint">StateModelConfigGenerator generator = new StateModelConfigGenerator();
+ZnRecord stateModelConfig = generator.generateConfigForOnlineOffline();
+StateModelDefinition stateModelDef = new StateModelDefinition(stateModelConfig);
+ClusterSetup setupTool = new ClusterSetup(zkConnectString);
+setupTool.addStateModelDef(cluster,stateModelName,stateModelDef);
+</pre></div><p>See StateModelConfigGenerator to get more info on creating custom state model.</p></div><div class="section"><h2>Messaging Api usage<a name="Messaging_Api_usage"></a></h2><p>See BootstrapProcess.java in examples package to see how Participants can exchange messages with each other.</p>
+<div class="source"><pre class="prettyprint">      ClusterMessagingService messagingService = manager.getMessagingService();
+      //CONSTRUCT THE MESSAGE
+      Message requestBackupUriRequest = new Message(
+          MessageType.USER_DEFINE_MSG, UUID.randomUUID().toString());
+      requestBackupUriRequest
+          .setMsgSubType(BootstrapProcess.REQUEST_BOOTSTRAP_URL);
+      requestBackupUriRequest.setMsgState(MessageState.NEW);
+      //SET THE RECIPIENT CRITERIA, All nodes that satisfy the criteria will receive the message
+      Criteria recipientCriteria = new Criteria();
+      recipientCriteria.setInstanceName(&quot;*&quot;);
+      recipientCriteria.setRecipientInstanceType(InstanceType.PARTICIPANT);
+      recipientCriteria.setResource(&quot;MyDB&quot;);
+      recipientCriteria.setPartition(&quot;&quot;);
+      //Should be processed only the process that is active at the time of sending the message. 
+      //This means if the recipient is restarted after message is sent, it will not be processed.
+      recipientCriteria.setSessionSpecific(true);
+      // wait for 30 seconds
+      int timeout = 30000;
+      //The handler that will be invoked when any recipient responds to the message.
+      BootstrapReplyHandler responseHandler = new BootstrapReplyHandler();
+      //This will return only after all recipients respond or after timeout.
+      int sentMessageCount = messagingService.sendAndWait(recipientCriteria,
+          requestBackupUriRequest, responseHandler, timeout);
+</pre></div><p>For more details on MessagingService see ClusterMessagingService</p></div>
+                  </div>
+            </div>
+          </div>
+
+    <hr/>
+
+    <footer>
+            <div class="container-fluid">
+              <div class="row span12">Copyright &copy;                    2013
+                        <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+            All Rights Reserved.      
+                    
+      </div>
+
+        
+        
+                </div>
+    </footer>
+  </body>
+</html>
\ No newline at end of file

Modified: incubator/helix/site-content/Architecture.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/Architecture.html?rev=1479756&r1=1479755&r2=1479756&view=diff
==============================================================================
--- incubator/helix/site-content/Architecture.html (original)
+++ incubator/helix/site-content/Architecture.html Tue May  7 03:10:53 2013
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia at Apr 27, 2013
+ | Generated by Apache Maven Doxia at May 6, 2013
  | 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="20130427" />
+    <meta name="Date-Revision-yyyymmdd" content="20130506" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Apache Helix - </title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -52,6 +52,9 @@
                       <li>      <a href="Quickstart.html"  title="Quick Start">Quick Start</a>
 </li>
                   
+                      <li>      <a href="Concepts.html"  title="Core concept">Core concept</a>
+</li>
+                  
                       <li>      <a href="Tutorial.html"  title="Tutorial">Tutorial</a>
 </li>
                   
@@ -162,7 +165,7 @@
                 
                 
             
-                  <li id="publishDate" class="pull-right">Last Published: 2013-04-27</li> 
+                  <li id="publishDate" class="pull-right">Last Published: 2013-05-06</li> 
             
                             </ul>
       </div>

Added: incubator/helix/site-content/Concepts.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/Concepts.html?rev=1479756&view=auto
==============================================================================
--- incubator/helix/site-content/Concepts.html (added)
+++ incubator/helix/site-content/Concepts.html Tue May  7 03:10:53 2013
@@ -0,0 +1,384 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at May 6, 2013
+ | 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="20130506" />
+    <meta http-equiv="Content-Language" content="en" />
+    <title>Apache Helix - </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="Quickstart.html"  title="Quick Start">Quick Start</a>
+</li>
+                  
+                      <li>      <a href="Concepts.html"  title="Core concept">Core concept</a>
+</li>
+                  
+                      <li>      <a href="Tutorial.html"  title="Tutorial">Tutorial</a>
+</li>
+                  
+                      <li>      <a href="Architecture.html"  title="Architecture">Architecture</a>
+</li>
+                  
+                      <li>      <a href="Features.html"  title="Features">Features</a>
+</li>
+                  
+                      <li>      <a href="releasenotes/release-0.6.0-incubating.html"  title="release 0.6.0-incubating">release 0.6.0-incubating</a>
+</li>
+                  
+                      <li>      <a href="download.html"  title="Download">Download</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>
+                          </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.1-incubating-SNAPSHOT</li>
+                  |             <li class="">
+                    <a href="./" title="Apache Helix">
+        Apache Helix</a>
+        </li>
+      <li class="divider ">/</li>
+        <li class=""></li>
+                
+                
+            
+                  <li id="publishDate" class="pull-right">Last Published: 2013-05-06</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>Helix is based on the simple fact that a given task has the following attributes associated with it </p>
+<ul>
+  <li>Location of the task, for example it runs on Node N1</li>
+  <li>State, for examples its running, stopped etc.</li>
+</ul><p>A task is referred to as a resource. </p><div class="section"><div class="section"><h3>IDEALSTATE<a name="IDEALSTATE"></a></h3><p>Ideal state simply allows one to map tasks to location and state. A standard way of expressing this in Helix is</p>
+<div class="source"><pre class="prettyprint">  &quot;TASK_NAME&quot; : {
+    &quot;LOCATION&quot; : &quot;STATE&quot;
+  }
+
+</pre></div><p>Consider a simple case where you want to launch a task myTask on node N1. The idealstate for this can be expressed as follows</p>
+<div class="source"><pre class="prettyprint">{
+  &quot;id&quot; : &quot;MyTask&quot;,
+  &quot;mapFields&quot; : {
+    &quot;myTask&quot; : {
+      &quot;N1&quot; : &quot;ONLINE&quot;,
+    }
+  }
+}
+</pre></div><div class="section"><h4>PARTITION<a name="PARTITION"></a></h4><p>If this task get too big to fit on one box, you might want to divide it into subTasks. Each subTask is referred to as partition in Helix. Lets say you want to divide the task into 3 subTasks/partitions, the idealstate can be changed as shown below. </p><p>myTask_0, myTask_1, myTask_2 are logical names representing the partitions of myTask. Each tasks runs on N1,N2 and N3 respectively.</p>
+<div class="source"><pre class="prettyprint">{
+  &quot;id&quot; : &quot;myTask&quot;,
+  &quot;simpleFields&quot; : {
+    &quot;NUM_PARTITIONS&quot; : &quot;3&quot;,
+  }
+ &quot;mapFields&quot; : {
+    &quot;myTask_0&quot; : {
+      &quot;N1&quot; : &quot;ONLINE&quot;,
+    },
+    &quot;myTask_1&quot; : {
+      &quot;N2&quot; : &quot;ONLINE&quot;,
+    },
+    &quot;myTask_2&quot; : {
+      &quot;N3&quot; : &quot;ONLINE&quot;,
+    }
+  }
+}
+</pre></div></div><div class="section"><h4>REPLICA<a name="REPLICA"></a></h4><p>Partitioning allows one to split the data/task into multiple subparts. But lets say the request rate each partition increases. The common solution is to have multiple copies for each partition. Helix refers to the copy of a partition as replica. Adding replica also increases the availability of the system during failures. One can see this methodology employed often in Search systems. The index is divided into shard and each shard has multiple copies.</p><p>Lets say you want to add one additional replica for each task. The idealstate can simply be changed as shown below. </p><p>For increasing the availability of the system, its better to place replica of given partition on different nodes.</p>
+<div class="source"><pre class="prettyprint">{
+  &quot;id&quot; : &quot;myIndex&quot;,
+  &quot;simpleFields&quot; : {
+    &quot;NUM_PARTITIONS&quot; : &quot;3&quot;,
+    &quot;REPLICAS&quot; : &quot;2&quot;,
+  },
+ &quot;mapFields&quot; : {
+    &quot;myIndex_0&quot; : {
+      &quot;N1&quot; : &quot;ONLINE&quot;,
+      &quot;N2&quot; : &quot;ONLINE&quot;
+    },
+    &quot;myIndex_1&quot; : {
+      &quot;N2&quot; : &quot;ONLINE&quot;,
+      &quot;N3&quot; : &quot;ONLINE&quot;
+    },
+    &quot;myIndex_2&quot; : {
+      &quot;N3&quot; : &quot;ONLINE&quot;,
+      &quot;N1&quot; : &quot;ONLINE&quot;
+    }
+  }
+}
+</pre></div></div><div class="section"><h4>STATE<a name="STATE"></a></h4><p>Now lets take a slightly complicated scenario where a task represents a database. Unlike an index which is in general read only, database supports both reads and write. Keeping the data consistent among the replica is crucial in distributed data stores. One commonly applied technique is to assign one replica as MASTER and remaining as SLAVE. All writes go to MASTER and are then replicated to SLAVE.</p><p>Helix allows one to assign different states to each replica. Lets say you have two mysql instances N1 and N2 where one will serve as MASTER and another as SLAVE. The ideal state can be changed to</p>
+<div class="source"><pre class="prettyprint">{
+  &quot;id&quot; : &quot;myDB&quot;,
+  &quot;simpleFields&quot; : {
+    &quot;NUM_PARTITIONS&quot; : &quot;1&quot;,
+    &quot;REPLICAS&quot; : &quot;2&quot;,
+  },
+  &quot;mapFields&quot; : {
+    &quot;myDB&quot; : {
+      &quot;N1&quot; : &quot;MASTER&quot;,
+      &quot;N2&quot; : &quot;SLAVE&quot;,
+    }
+  }
+}
+
+</pre></div></div></div><div class="section"><h3>STATE MACHINE and TRANSITIONS<a name="STATE_MACHINE_and_TRANSITIONS"></a></h3><p>Idealstate allows one to exactly specify the desired state of the cluster. Given an idealstate, Helix takes up the responsibility of ensuring that cluster reaches idealstate. Helix CONTROLLER reads the idealstate and then commands the PARTICIPANT to take appropriate actions to move from one state to another until it matches Idealstate. These actions are referred to as transitions in Helix.</p><p>Next logical question is, how does the CONTROLLER compute the transitions required to get to idealstate. This is where finite state machine concept comes in. Helix allows applications to plug in FSM. A state machine consists of the following</p>
+<ul>
+  <li>STATE : Describes the role of a replica</li>
+  <li>TRANSITION: An action that allows a replica to move from one STATE to another, thus changing its role.</li>
+</ul><p>Here is an example of MASTERSLAVE state machine,</p>
+<div class="source"><pre class="prettyprint">          OFFLINE  | SLAVE  |  MASTER  
+         _____________________________
+        |          |        |         |
+OFFLINE |   N/A    | SLAVE  | SLAVE   |
+        |__________|________|_________|
+        |          |        |         |
+SLAVE   |  OFFLINE |   N/A  | MASTER  |
+        |__________|________|_________|
+        |          |        |         |
+MASTER  | SLAVE    | SLAVE  |   N/A   |
+        |__________|________|_________|
+
+</pre></div><p>Helix allows each resource to be associated with one state machine. This means you can have one resource as a index and another as database in the same cluster. One can associate each resource with a state machine as follows</p>
+<div class="source"><pre class="prettyprint">{
+  &quot;id&quot; : &quot;myDB&quot;,
+  &quot;simpleFields&quot; : {
+    &quot;NUM_PARTITIONS&quot; : &quot;1&quot;,
+    &quot;REPLICAS&quot; : &quot;2&quot;,
+    &quot;STATE_MODEL_DEF_REF&quot; : &quot;MasterSlave&quot;,
+  },
+  &quot;mapFields&quot; : {
+    &quot;myDB&quot; : {
+      &quot;N1&quot; : &quot;MASTER&quot;,
+      &quot;N2&quot; : &quot;SLAVE&quot;,
+    }
+  }
+}
+
+</pre></div></div><div class="section"><h3>CURRENT STATE<a name="CURRENT_STATE"></a></h3><p>Currentstate of a resource simply represents its actual state at a PARTICIPANT. In the below example, </p>
+<ul>
+  <li>INSTANCE_NAME : Unique name representing the process.</li>
+  <li>SESSION_ID: Id that is automatically assigned every time a process joins the cluster.</li>
+</ul>
+<div class="source"><pre class="prettyprint">{
+  &quot;id&quot;:&quot;MyResource&quot;
+  ,&quot;simpleFields&quot;:{
+    ,&quot;SESSION_ID&quot;:&quot;13d0e34675e0002&quot;
+    ,&quot;INSTANCE_NAME&quot;:&quot;node1&quot;
+    ,&quot;STATE_MODEL_DEF&quot;:&quot;MasterSlave&quot;
+  }
+  ,&quot;mapFields&quot;:{
+    &quot;MyResource_0&quot;:{
+      &quot;CURRENT_STATE&quot;:&quot;SLAVE&quot;
+    }
+    ,&quot;MyResource_1&quot;:{
+      &quot;CURRENT_STATE&quot;:&quot;MASTER&quot;
+    }
+    ,&quot;MyResource_2&quot;:{
+      &quot;CURRENT_STATE&quot;:&quot;MASTER&quot;
+    }
+  }
+}
+</pre></div><p>Each node in the cluster has its own Current state.</p></div><div class="section"><h3>EXTERNAL VIEW<a name="EXTERNAL_VIEW"></a></h3><p>In order to communicate with the PARTICIPANTs, external clients need to know the current state of each of the PARTICIPANT. The external clients are referred to as SPECTATORS. In order to make the life of SPECTATOR simple, Helix provides EXTERNALVIEW that is an aggregated view of the current state across all nodes. The EXTERNALVIEW has similar format as IDEALSTATE.</p>
+<div class="source"><pre class="prettyprint">{
+  &quot;id&quot;:&quot;MyResource&quot;,
+  &quot;mapFields&quot;:{
+    &quot;MyResource_0&quot;:{
+      &quot;N1&quot;:&quot;SLAVE&quot;,
+      &quot;N2&quot;:&quot;MASTER&quot;,
+      &quot;N3&quot;:&quot;OFFLINE&quot;
+    },
+    &quot;MyResource_1&quot;:{
+      &quot;N1&quot;:&quot;MASTER&quot;,
+      &quot;N2&quot;:&quot;SLAVE&quot;,
+      &quot;N3&quot;:&quot;ERROR&quot;
+    },
+    &quot;MyResource_2&quot;:{
+      &quot;N1&quot;:&quot;MASTER&quot;,
+      &quot;N2&quot;:&quot;SLAVE&quot;,
+      &quot;N3&quot;:&quot;SLAVE&quot;
+    }
+  }
+}
+</pre></div></div><div class="section"><h3>REBALANCER<a name="REBALANCER"></a></h3><p>The core component of Helix is the CONTROLLER which runs the REBALANCER algorithm on every cluster event. Cluster event can be one of the following</p>
+<ul>
+  <li>Nodes start/stop and soft/hard failures</li>
+  <li>New nodes are added/removed</li>
+  <li>Ideal state changes</li>
+</ul><p>There are few more like config changes etc but the key point to take away is there are many ways to trigger the rebalancer.</p><p>When a rebalancer is run it simply does the following</p>
+<ul>
+  <li>Compares the idealstate and current state</li>
+  <li>Computes the transitions required to reach the idealstate.</li>
+  <li>Issues the transitions to PARTICIPANT</li>
+</ul><p>The above steps happen for every change in the system. Once current state matches the idealstate the system is considered stable which implies IDEALSTATE = CURRENTSTATE = EXTERNALVIEW</p></div><div class="section"><h3>DYNAMIC IDEALSTATE<a name="DYNAMIC_IDEALSTATE"></a></h3><p>One of the things that makes Helix powerful is that idealstate can be changed dynamically. This means one can listen to cluster events like node failures and dynamically change the ideal state. Helix will then take care of triggering the respective transitions in the system.</p><p>Helix comes with few algorithms to automatically compute the idealstate based on the constraints. For e.g. if you have a resource 3 partitions and 2 replicas, Helix can automatically compute the idealstate based on the nodes that are currently active. See features page to find out more about various execution modes of Helix like AUTO_REBALANCE, AUTO and CUSTOM. </p></div></div>
+                  </div>
+          </div>
+
+    <hr/>
+
+    <footer>
+            <div class="container">
+              <div class="row span12">Copyright &copy;                    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



Mime
View raw message