You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@helix.apache.org by ki...@apache.org on 2013/05/21 02:45:05 UTC
svn commit: r1484629 [1/23] - in /incubator/helix/site-content: ./
apidocs/reference/org/apache/helix/agent/
apidocs/reference/org/apache/helix/manager/zk/
apidocs/reference/org/apache/helix/recipes/rabbitmq/ helix-admin-webapp/
helix-agent/ helix-core...
Author: kishoreg
Date: Tue May 21 00:45:01 2013
New Revision: 1484629
URL: http://svn.apache.org/r1484629
Log:
Site checkin for project Apache Helix
Added:
incubator/helix/site-content/tutorial_admin.html
incubator/helix/site-content/tutorial_controller.html
incubator/helix/site-content/tutorial_health.html
incubator/helix/site-content/tutorial_messaging.html
incubator/helix/site-content/tutorial_participant.html
incubator/helix/site-content/tutorial_propstore.html
incubator/helix/site-content/tutorial_rebalance.html
incubator/helix/site-content/tutorial_spectator.html
incubator/helix/site-content/tutorial_state.html
incubator/helix/site-content/tutorial_throttling.html
incubator/helix/site-content/xref-test/org/apache/helix/manager/zk/TestZkClient.html
Modified:
incubator/helix/site-content/Architecture.html
incubator/helix/site-content/Concepts.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/task_dag_execution.html
incubator/helix/site-content/recipes/team-list.html
incubator/helix/site-content/releasenotes/release-0.6.0-incubating.html
incubator/helix/site-content/releasenotes/release-0.6.1-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/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/TestAutoRebalance.html
incubator/helix/site-content/xref-test/org/apache/helix/integration/TestAutoRebalancePartitionLimit.html
incubator/helix/site-content/xref-test/org/apache/helix/integration/TestCustomizedIdealStateRebalancer.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/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/manager/zk/package-frame.html
incubator/helix/site-content/xref-test/org/apache/helix/manager/zk/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/TestDefaultMessagingService.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/monitoring/mbeans/TestClusterStatusMonitor.html
incubator/helix/site-content/xref-test/org/apache/helix/monitoring/mbeans/TestResourceMonitor.html
incubator/helix/site-content/xref-test/org/apache/helix/monitoring/mbeans/package-frame.html
incubator/helix/site-content/xref-test/org/apache/helix/monitoring/mbeans/package-summary.html
incubator/helix/site-content/xref/allclasses-frame.html
incubator/helix/site-content/xref/org/apache/helix/manager/zk/DefaultSchedulerMessageHandlerFactory.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/webapp/resources/SchedulerTasksResource.html
Modified: incubator/helix/site-content/Architecture.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/Architecture.html?rev=1484629&r1=1484628&r2=1484629&view=diff
==============================================================================
--- incubator/helix/site-content/Architecture.html (original)
+++ incubator/helix/site-content/Architecture.html Tue May 21 00:45:01 2013
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at May 14, 2013
+ | Generated by Apache Maven Doxia at May 20, 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="20130514" />
+ <meta name="Date-Revision-yyyymmdd" content="20130520" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Helix - </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -49,22 +49,19 @@
<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> <a href="Concepts.html" title="Core concepts">Core concepts</a>
</li>
- <li> <a href="Tutorial.html" title="Tutorial">Tutorial</a>
+ <li> <a href="Architecture.html" title="Architecture">Architecture</a>
</li>
- <li> <a href="Architecture.html" title="Architecture">Architecture</a>
+ <li> <a href="Quickstart.html" title="Quick Start">Quick Start</a>
</li>
- <li> <a href="Features.html" title="Features">Features</a>
+ <li> <a href="Tutorial.html" title="Tutorial">Tutorial</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> <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>
@@ -171,7 +168,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2013-05-14</li>
+ <li id="publishDate" class="pull-right">Last Published: 2013-05-20</li>
</ul>
</div>
Modified: incubator/helix/site-content/Concepts.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/Concepts.html?rev=1484629&r1=1484628&r2=1484629&view=diff
==============================================================================
--- incubator/helix/site-content/Concepts.html (original)
+++ incubator/helix/site-content/Concepts.html Tue May 21 00:45:01 2013
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at May 14, 2013
+ | Generated by Apache Maven Doxia at May 20, 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="20130514" />
+ <meta name="Date-Revision-yyyymmdd" content="20130520" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Helix - </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -49,22 +49,19 @@
<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> <a href="Concepts.html" title="Core concepts">Core concepts</a>
</li>
- <li> <a href="Tutorial.html" title="Tutorial">Tutorial</a>
+ <li> <a href="Architecture.html" title="Architecture">Architecture</a>
</li>
- <li> <a href="Architecture.html" title="Architecture">Architecture</a>
+ <li> <a href="Quickstart.html" title="Quick Start">Quick Start</a>
</li>
- <li> <a href="Features.html" title="Features">Features</a>
+ <li> <a href="Tutorial.html" title="Tutorial">Tutorial</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> <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>
@@ -171,7 +168,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2013-05-14</li>
+ <li id="publishDate" class="pull-right">Last Published: 2013-05-20</li>
</ul>
</div>
Modified: incubator/helix/site-content/Features.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/Features.html?rev=1484629&r1=1484628&r2=1484629&view=diff
==============================================================================
--- incubator/helix/site-content/Features.html (original)
+++ incubator/helix/site-content/Features.html Tue May 21 00:45:01 2013
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at May 14, 2013
+ | Generated by Apache Maven Doxia at May 20, 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="20130514" />
+ <meta name="Date-Revision-yyyymmdd" content="20130520" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Helix - </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -49,22 +49,19 @@
<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> <a href="Concepts.html" title="Core concepts">Core concepts</a>
</li>
- <li> <a href="Tutorial.html" title="Tutorial">Tutorial</a>
+ <li> <a href="Architecture.html" title="Architecture">Architecture</a>
</li>
- <li> <a href="Architecture.html" title="Architecture">Architecture</a>
+ <li> <a href="Quickstart.html" title="Quick Start">Quick Start</a>
</li>
- <li> <a href="Features.html" title="Features">Features</a>
+ <li> <a href="Tutorial.html" title="Tutorial">Tutorial</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> <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>
@@ -171,7 +168,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2013-05-14</li>
+ <li id="publishDate" class="pull-right">Last Published: 2013-05-20</li>
</ul>
</div>
Modified: incubator/helix/site-content/Quickstart.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/Quickstart.html?rev=1484629&r1=1484628&r2=1484629&view=diff
==============================================================================
--- incubator/helix/site-content/Quickstart.html (original)
+++ incubator/helix/site-content/Quickstart.html Tue May 21 00:45:01 2013
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at May 14, 2013
+ | Generated by Apache Maven Doxia at May 20, 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="20130514" />
+ <meta name="Date-Revision-yyyymmdd" content="20130520" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Helix - </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -49,22 +49,19 @@
<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> <a href="Concepts.html" title="Core concepts">Core concepts</a>
</li>
- <li> <a href="Tutorial.html" title="Tutorial">Tutorial</a>
+ <li> <a href="Architecture.html" title="Architecture">Architecture</a>
</li>
- <li> <a href="Architecture.html" title="Architecture">Architecture</a>
+ <li> <a href="Quickstart.html" title="Quick Start">Quick Start</a>
</li>
- <li> <a href="Features.html" title="Features">Features</a>
+ <li> <a href="Tutorial.html" title="Tutorial">Tutorial</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> <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>
@@ -171,7 +168,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2013-05-14</li>
+ <li id="publishDate" class="pull-right">Last Published: 2013-05-20</li>
</ul>
</div>
@@ -196,102 +193,305 @@ software distributed under the License i
"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. --><div class="section"><h2>Build/Download Helix<a name="BuildDownload_Helix"></a></h2><div class="section"><h3>Build<a name="Build"></a></h3><p>Jump to download section to skip building code</p>
+under the License. --><div class="section"><h2>Get Helix<a name="Get_Helix"></a></h2><p>First, let's get Helix, either build or download.</p><div class="section"><h3>Build<a name="Build"></a></h3>
<div class="source"><pre class="prettyprint">git clone https://git-wip-us.apache.org/repos/asf/incubator-helix.git
cd incubator-helix
mvn install package -DskipTests
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 Helix<a name="Download_Helix"></a></h3><p>Instead of building the package from the code, you can download the 0.6.0-incubating release package from <a class="externalLink" href="https://dist.apache.org/repos/dist/dev/incubator/helix/0.6.0-incubating/binaries/helix-core-0.6.0-incubating-pkg.tar">here</a> </p></div></div><div class="section"><h2>Short Version<a name="Short_Version"></a></h2>
-<div class="source"><pre class="prettyprint">cd helix-core/target/helix-core-pkg/bin
chmod +x *
-./quickstart.sh
-</pre></div><p>This gives an overview of Helix Apis and how it facilitates Automatic Partition Management, Failure Handling and Cluster Expansion. </p><p>The quick start does the following</p>
+</pre></div></div><div class="section"><h3>Download<a name="Download"></a></h3><p>Download the 0.6.1-incubating release package <a class="externalLink" href="https://dist.apache.org/repos/dist/dev/incubator/helix/0.6.1-incubating/binaries/helix-core-0.6.1-incubating-pkg.tar">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><p>The steps:</p>
<ul>
- <li>Add a cluster</li>
- <li>Add two nodes</li>
- <li>Add a resource with 6 partitions with 1 master and 1 slave replica.</li>
- <li>Shows the cluster state after all nodes are up.</li>
- <li>Add a node and see the partitions get rebalanced</li>
- <li>Shows cluster state after the rebalance</li>
- <li>Stop a node and see that master ship transfer occurs.</li>
- <li>Shows cluster state after node is stopped.</li>
-</ul></div><div class="section"><h2>Long Version<a name="Long_Version"></a></h2><p>Helix provides command line interfaces to setup the cluster and also view the cluster state. Follow the steps below to get a better understanding of the steps involved to setup a distributed system.</p><div class="section"><h3>Install/Start zookeeper<a name="InstallStart_zookeeper"></a></h3><p>Zookeeper can be started in standalone mode or replicated mode.</p><p>More info is available at </p>
+ <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><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 class="prettyprint">cd helix/helix-core/target/helix-core-pkg/bin
+</pre></div><p>If you downloaded the release package, extract it.</p>
+<div class="source"><pre class="prettyprint">cd helix-core-pkg/bin
+</pre></div></div></div><div class="section"><h3>Install/Start zookeeper<a name="InstallStart_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, we will start zookeeper in local mode.</p></div><div class="section"><h3>Cluster setup<a name="Cluster_setup"></a></h3><p>helix-admin tool is used for cluster administration tasks. Apart from a 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>In the following section we will see how one can set up a mock mycluster cluster with </p>
+</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 class="prettyprint">./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 12913, 12914,12915</li>
- <li>One database named MyDB with 6 partitions</li>
+ <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><p>Note that this mock cluster does not have any functionality apart from handling Helix callbacks.</p></div><div class="section"><h3>Steps<a name="Steps"></a></h3>
-<ul>
- <li>If you built the code</li>
-</ul>
-<div class="source"><pre class="prettyprint">cd helix/helix-core/target/helix-core-pkg
-</pre></div>
-<ul>
- <li>If you downloaded the release package, extract it.</li>
-</ul>
-<div class="source"><pre class="prettyprint">cd helix-core-pkg
-</pre></div><div class="section"><div class="section"><h5>start zookeeper locally at port 2199<a name="start_zookeeper_locally_at_port_2199"></a></h5>
-<div class="source"><pre class="prettyprint">./start-standalone-zookeeper.sh 2199 &
-</pre></div></div><div class="section"><h5>create the cluster mycluster<a name="create_the_cluster_mycluster"></a></h5>
-<div class="source"><pre class="prettyprint">## helix-admin.sh --zkSvr localhost:2199 --addCluster <clustername>
-./helix-admin.sh --zkSvr localhost:2199 --addCluster mycluster
-</pre></div></div><div class="section"><h5>Create a database with 6 partitions using MasterSlave state model. This ensures there will be one master for each partition<a name="Create_a_database_with_6_partitions_using_MasterSlave_state_model._This_ensures_there_will_be_one_master_for_each_partition"></a></h5>
-<div class="source"><pre class="prettyprint">### helix-admin.sh --zkSvr localhost:2199 --addResource <clustername> <resourceName> <numPartitions> <StateModelName>
-./helix-admin.sh --zkSvr localhost:2199 --addResource mycluster myDB 6 MasterSlave
-</pre></div></div><div class="section"><h5>Add nodes to the cluster, in this case we add three nodes, hostname:port is host and port on which the service will start<a name="Add_nodes_to_the_cluster_in_this_case_we_add_three_nodes_hostname:port_is_host_and_port_on_which_the_service_will_start"></a></h5>
+</ul><div class="section"><div class="section"><h5>Create the cluster MYCLUSTER<a name="Create_the_cluster_MYCLUSTER"></a></h5>
+<div class="source"><pre class="prettyprint">## 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 class="prettyprint">## 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 class="section"><h5>After adding nodes assign partitions to nodes. This command will distribute the partitions amongst all the nodes in the cluster. Each partition will have 3 replicas<a name="After_adding_nodes_assign_partitions_to_nodes._This_command_will_distribute_the_partitions_amongst_all_the_nodes_in_the_cluster._Each_partition_will_have_3_replicas"></a></h5>
-<div class="source"><pre class="prettyprint"> helix-admin.sh --rebalance <clustername> <resourceName> <replication factor>
-./helix-admin.sh --zkSvr localhost:2199 --rebalance mycluster myDB 3
-</pre></div></div><div class="section"><h5>Start Helix Controller<a name="Start_Helix_Controller"></a></h5>
-<div class="source"><pre class="prettyprint">#This will start the cluster manager which will manage <mycluster>
-./run-helix-controller --zkSvr localhost:2199 --cluster mycluster 2>&1 > /tmp/controller.log &
-</pre></div></div><div class="section"><h5>Start Example Participant, This is a dummy participant where the transitions are no-ops.<a name="Start_Example_Participant_This_is_a_dummy_participant_where_the_transitions_are_no-ops."></a></h5>
-<div class="source"><pre class="prettyprint">./start-helix-participant.sh --help
-# start process 1 process corresponding to every host port added during cluster setup
-./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><div class="section"><h3>Inspect Cluster Data<a name="Inspect_Cluster_Data"></a></h3><p>At any time, we can get the cluster status on zookeeper and view the partition assignment and current state of each partition.</p><p>Command line tool</p><div class="section"><div class="section"><h5>List existing clusters<a name="List_existing_clusters"></a></h5>
-<div class="source"><pre class="prettyprint">./helix-admin.sh --zkSvr localhost:2199 --listClusters
-</pre></div></div><div class="section"><h5>Query info of a cluster<a name="Query_info_of_a_cluster"></a></h5>
-<div class="source"><pre class="prettyprint">#helix-admin.sh --zkSvr localhost:2199 --listClusterInfo <clusterName>
-./helix-admin.sh --zkSvr localhost:2199 --listClusterInfo mycluster
-</pre></div></div><div class="section"><h5>List Instances in a cluster<a name="List_Instances_in_a_cluster"></a></h5>
-<div class="source"><pre class="prettyprint">## helix-admin.sh --zkSvr localhost:2199 --listInstances <clusterName>
- ./helix-admin.sh --zkSvr localhost:2199 --listInstances mycluster
-</pre></div></div><div class="section"><h5>Query info of a Instance in a cluster<a name="Query_info_of_a_Instance_in_a_cluster"></a></h5>
-<div class="source"><pre class="prettyprint">#./helix-admin.sh --zkSvr localhost:2199 --listInstanceInfo <clusterName InstanceName>
- ./helix-admin.sh --zkSvr localhost:2199 --listInstanceInfo mycluster localhost_12913
- ./helix-admin.sh --zkSvr localhost:2199 --listInstanceInfo mycluster localhost_12914
- ./helix-admin.sh --zkSvr localhost:2199 --listInstanceInfo mycluster localhost_12915
-</pre></div></div><div class="section"><h5>List resourceGroups hosted in a cluster<a name="List_resourceGroups_hosted_in_a_cluster"></a></h5>
-<div class="source"><pre class="prettyprint">## helix-admin.sh --zkSvr localhost:2199 --listResources <clusterName>
-./helix-admin.sh --zkSvr localhost:2199 --listResources mycluster
-</pre></div></div><div class="section"><h5>Query info of a resource<a name="Query_info_of_a_resource"></a></h5>
-<div class="source"><pre class="prettyprint">## helix-admin.sh --zkSvr localhost:2199 --listResourceInfo <clusterName resourceName>
-./helix-admin.sh --zkSvr localhost:2199 --listResourceInfo mycluster myDB
-</pre></div></div><div class="section"><h5>Query info about a partition<a name="Query_info_about_a_partition"></a></h5>
-<div class="source"><pre class="prettyprint">## helix-admin.sh --zkSvr localhost:2199 --listResourceInfo <clusterName partition>
+./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 class="prettyprint">## 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 class="prettyprint">## 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 class="prettyprint">## 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 class="prettyprint"># 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 class="prettyprint">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 class="prettyprint">## 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 class="prettyprint">## 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 class="prettyprint">## ./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 class="prettyprint">## 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" : {
+ "IDEAL_STATE_MODE" : "AUTO",
+ "NUM_PARTITIONS" : "6",
+ "REPLICAS" : "3",
+ "STATE_MODEL_DEF_REF" : "MasterSlave",
+ "STATE_MODEL_FACTORY_NAME" : "DEFAULT"
+ }
+}
+
+ExternalView for myDB:
+{
+ "id" : "myDB",
+ "mapFields" : {
+ },
+ "listFields" : {
+ },
+ "simpleFields" : {
+ "BUCKET_SIZE" : "0"
+ }
+}
+</pre></div><p>Now, let's look at one of the partitions:</p>
+<div class="source"><pre class="prettyprint">## helix-admin.sh --zkSvr <zk_address> --listResourceInfo <clusterName> <partition>
./helix-admin.sh --zkSvr localhost:2199 --listResourceInfo mycluster myDB_0
-</pre></div></div><div class="section"><h5>List all state models in the cluster<a name="List_all_state_models_in_the_cluster"></a></h5>
-<div class="source"><pre class="prettyprint"># helix-admin.sh --zkSvr localhost:2199 --listStateModels <clusterName>
-./helix-admin.sh --zkSvr localhost:2199 --listStateModels mycluster
-</pre></div></div><div class="section"><h5>Query info about a state model in a cluster<a name="Query_info_about_a_state_model_in_a_cluster"></a></h5>
-<div class="source"><pre class="prettyprint">## helix-admin.sh --zkSvr localhost:2199 --listStateModel <clusterName stateModelName>
-./helix-admin.sh --zkSvr localhost:2199 --listStateModel mycluster MasterSlave
-</pre></div></div><div class="section"><h5>ZOOINSPECTOR<a name="ZOOINSPECTOR"></a></h5><p>Use ZooInspector that comes with zookeeper to browse the data. This is a java applet ( make sure you have X windows) To start zooinspector run the following command from <zk_install_directory>/contrib/ZooInspector</p>
+</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 class="prettyprint">./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 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 class="prettyprint">./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 class="prettyprint">./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" : {
+ "IDEAL_STATE_MODE" : "AUTO",
+ "NUM_PARTITIONS" : "6",
+ "REPLICAS" : "3",
+ "STATE_MODEL_DEF_REF" : "MasterSlave",
+ "STATE_MODEL_FACTORY_NAME" : "DEFAULT"
+ }
+}
+
+ExternalView for myDB:
+{
+ "id" : "myDB",
+ "mapFields" : {
+ },
+ "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, lets fail an instance:</p><p><i>KILL A NODE (need to find the pid via listInstanceInfo)</i></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 class="prettyprint">./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" : "MASTER"
+ "localhost_12918" : "OFFLINE"
+ },
+ "myDB_2" : {
+ "localhost_12913" : "MASTER",
+ "localhost_12917" : "SLAVE",
+ "localhost_12918" : "OFFLINE"
+ },
+ "myDB_3" : {
+ "localhost_12915" : "MASTER",
+ "localhost_12917" : "SLAVE",
+ "localhost_12918" : "OFFLINE"
+ },
+ "myDB_4" : {
+ "localhost_12916" : "MASTER",
+ "localhost_12917" : "SLAVE",
+ "localhost_12918" : "OFFLINE"
+ },
+ "myDB_5" : {
+ "localhost_12913" : "SLAVE",
+ "localhost_12914" : "MASTER",
+ "localhost_12915" : "SLAVE"
+ }
+ },
+ "listFields" : {
+ "myDB_0" : [ "localhost_12917", "localhost_12913", "localhost_12914" ],
+ "myDB_1" : [ "localhost_12917", "localhost_12916", "localhost_12918" ],
+ "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" : {
+ "IDEAL_STATE_MODE" : "AUTO",
+ "NUM_PARTITIONS" : "6",
+ "REPLICAS" : "3",
+ "STATE_MODEL_DEF_REF" : "MasterSlave",
+ "STATE_MODEL_FACTORY_NAME" : "DEFAULT"
+ }
+}
+
+ExternalView for myDB:
+{
+ "id" : "myDB",
+ "mapFields" : {
+ },
+ "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 class="prettyprint">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></div>
+</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>
Modified: incubator/helix/site-content/Tutorial.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/Tutorial.html?rev=1484629&r1=1484628&r2=1484629&view=diff
==============================================================================
--- incubator/helix/site-content/Tutorial.html (original)
+++ incubator/helix/site-content/Tutorial.html Tue May 21 00:45:01 2013
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at May 14, 2013
+ | Generated by Apache Maven Doxia at May 20, 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="20130514" />
+ <meta name="Date-Revision-yyyymmdd" content="20130520" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Helix - </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -49,22 +49,19 @@
<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> <a href="Concepts.html" title="Core concepts">Core concepts</a>
</li>
- <li> <a href="Tutorial.html" title="Tutorial">Tutorial</a>
+ <li> <a href="Architecture.html" title="Architecture">Architecture</a>
</li>
- <li> <a href="Architecture.html" title="Architecture">Architecture</a>
+ <li> <a href="Quickstart.html" title="Quick Start">Quick Start</a>
</li>
- <li> <a href="Features.html" title="Features">Features</a>
+ <li> <a href="Tutorial.html" title="Tutorial">Tutorial</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> <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>
@@ -171,7 +168,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2013-05-14</li>
+ <li id="publishDate" class="pull-right">Last Published: 2013-05-20</li>
</ul>
</div>
@@ -196,17 +193,37 @@ software distributed under the License i
"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>Lets walk through the steps in building a distributed system using Helix.</p><div class="section"><div class="section"><h3>Start zookeeper<a name="Start_zookeeper"></a></h3><p>This starts a zookeeper in standalone mode. For production deployment, see [Apache Zookeeper] page for instructions.</p>
+under the License. --><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, well 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_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>
+</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 class="prettyprint"> ./start-standalone-zookeeper.sh 2199 &
-</pre></div></div><div class="section"><h3>Create cluster<a name="Create_cluster"></a></h3><p>Creating a cluster will create appropriate znodes on zookeeper. </p>
-<div class="source"><pre class="prettyprint"> //Create setuptool instance
+</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 class="prettyprint"> // 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(clusterName);
-</pre></div><p>OR</p>
+ admin.addCluster(CLUSTER_NAME);
+</pre></div><p>OR</p><p>Using the command-line interface:</p>
<div class="source"><pre class="prettyprint"> ./helix-admin.sh --zkSvr localhost:2199 --addCluster helix-demo
-</pre></div></div><div class="section"><h3>Configure nodes<a name="Configure_nodes"></a></h3><p>Add new nodes to the cluster, configure new nodes in the cluster. Each node in the cluster must be uniquely identifiable. Most commonly used convention is hostname:port.</p>
+</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 class="prettyprint"> String CLUSTER_NAME = "helix-demo";
int NUM_NODES = 2;
String hosts[] = new String[]{"localhost","localhost"};
@@ -218,20 +235,35 @@ under the License. --><p>Lets walk throu
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 class="prettyprint"> StateModelDefinition.Builder builder = new StateModelDefinition.Builder(STATE_MODEL_NAME);
-</pre></div></div><div class="section"><h3>Configure the resource<a name="Configure_the_resource"></a></h3><p>Resource represents the actual task performed by the nodes. It can be a database, index, topic, queue or any other processing. A Resource can be divided into many sub parts called as partitions. </p><div class="section"><h4>Define state model and constraints<a name="Define_state_model_and_constraints"></a></h4><p>For scalability and fault tolerance each partition can have one or more replicas. State model allows one to declare the system behavior by first enumerating the various STATES and TRANSITIONS between them. A simple model is ONLINE-OFFLINE where ONLINE means the task is active and OFFLINE means its not active. You can also specify how of replicas must be in each state. For example In a Search System, one might need more than one node serving the same index. Helix allows one to express this via constraints on each STATE. </p><p>The following snippet shows how
to declare the state model and constraints for MASTER-SLAVE model.</p>
-<div class="source"><pre class="prettyprint"> StateModelDefinition.Builder builder = new StateModelDefinition.Builder(
- STATE_MODEL_NAME);
- // Add states and their rank to indicate priority. Lower the rank higher the
- // priority
+ // 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);
@@ -242,165 +274,33 @@ under the License. --><p>Lets walk throu
builder.addTransition(MASTER, SLAVE);
// set constraints on states.
- // static constraint
+
+ // static constraint: upper bound of 1 MASTER
builder.upperBound(MASTER, 1);
- // dynamic constraint, R means it should be derived based on the replica,
- // this allows use different replication factor for each resource without
- //having to define a new state model
+
+ // 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 and placing it on a particular node.</p><p>There are 3 assignment modes Helix can operate on</p>
+</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>AUTO_REBALANCE: Helix decides the placement and state of a partition.</li>
<li>AUTO: Application decides the placement but Helix decides the state of a partition.</li>
<li>CUSTOM: Application controls the placement and state of a partition.</li>
-</ul><p>For more info on the modes see the <i>partition placement</i> section on <a href="./Features.html">Features</a> page.</p>
-<div class="source"><pre class="prettyprint"> String RESOURCE_NAME="MyDB";
- int NUM_PARTITIONs=6;
+</ul><p>For more info on the assignment modes, see <a href="./tutorial_rebalance.html">Rebalancing Algorithms</a> of the tutorial.</p>
+<div class="source"><pre class="prettyprint"> String RESOURCE_NAME = "MyDB";
+ int NUM_PARTITIONS = 6;
STATE_MODEL_NAME = "MasterSlave";
String MODE = "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 class="section"><h3>Starting a Helix based process<a name="Starting_a_Helix_based_process"></a></h3><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></div><div class="section"><h3>Participant<a name="Participant"></a></h3><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<StateModel> {
- @Override
- public StateModel createNewStateModel(String stateUnitKey) {
- OnlineOfflineStateModel stateModel = new OnlineOfflineStateModel();
- return stateModel;
- }
- @StateModelInfo(states = "{'OFFLINE','ONLINE'}", initialState = "OFFINE")
- public static class OnlineOfflineStateModel extends StateModel {
- @Transition(from = "OFFLINE", to = "ONLINE")
- public void onBecomeOnlineFromOffline(Message message,
- NotificationContext context) {
- System.out
- .println("OnlineOfflineStateModel.onBecomeOnlineFromOffline()");
- //Application logic to handle transition
- }
- @Transition(from = "ONLINE", to = "OFFLINE")
- public void onBecomeOfflineFromOnline(Message message,
- NotificationContext context) {
- System.out
- .println("OnlineOfflineStateModel.onBecomeOfflineFromOnline()");
- //Application logic to handle transition
- }
- }
-}
-</pre></div></div><div class="section"><h3>Controller Code<a name="Controller_Code"></a></h3><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 <ZookeeperServerAddress(Required)> --cluster <Cluster name (Required)>
-</pre></div><p>See controller deployment modes section in <a href="./Features.html">Features</a> page for different ways to deploy the controller.</p></div><div class="section"><h3>Spectator Code<a name="Spectator_Code"></a></h3><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("DBNAME", "PARITION_NAME", "PARTITION_STATE");
-</pre></div></div><div class="section"><h3>Zookeeper znode layout.<a name="Zookeeper_znode_layout."></a></h3><p>See <i>Helix znode layout</i> section in <a href="./Architecture.html">Architecture</a> page.</p></div><div class="section"><h3>Helix Admin operations<a name="Helix_Admin_operations"></a></h3><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 <ZookeeperServerAddress(Required)>
-
-Add a new cluster
- --addCluster <clusterName>
-
-Add a new Instance to a cluster
- --addNode <clusterName InstanceAddress(host:port)>
-
-Add a State model to a cluster
- --addStateModelDef <clusterName <filename>>
-
-Add a resource to a cluster
- --addResource <clusterName resourceName partitionNum stateModelRef <mode(AUTO_REBALANCE|AUTO|CUSTOM)>>
-
-Upload an IdealState(Partition to Node Mapping)
- --addIdealState <clusterName resourceName <filename>>
-
-Delete a cluster
- --dropCluster <clusterName>
-
-Delete a resource
- --dropResource <clusterName resourceName> Drop an existing resource from a cluster
-
-Drop an existing Instance from a cluster
- --dropNode <clusterName InstanceAddress(host:port)>
-
-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 <clusterName>
-
-Enable/disable a Instance. Useful to take a faulty node out of the cluster.
- --enableInstance <clusterName InstanceName true/false>
-
-Enable/disable a partition
- --enablePartition <clusterName instanceName resourceName partitionName true/false>
-
-
- --listClusterInfo <clusterName> Query info of a cluster
- --listClusters List existing clusters
- --listInstanceInfo <clusterName InstanceName> Query info of a Instance in a cluster
- --listInstances <clusterName> List Instances in a cluster
- --listPartitionInfo <clusterName resourceName partitionName> Query info of a partition
- --listResourceInfo <clusterName resourceName> Query info of a resource
- --listResources <clusterName> List resources hosted in a cluster
- --listStateModel <clusterName stateModelName> Query info of a state model in a cluster
- --listStateModels <clusterName> Query info of state models in a cluster
-
-</pre></div></div></div>
+</pre></div></div></div></div>
</div>
</div>