Added: helix/site-content/1.0.3-docs/tutorial_task_framework.html URL: http://svn.apache.org/viewvc/helix/site-content/1.0.3-docs/tutorial_task_framework.html?rev=1900184&view=auto ============================================================================== --- helix/site-content/1.0.3-docs/tutorial_task_framework.html (added) +++ helix/site-content/1.0.3-docs/tutorial_task_framework.html Sat Apr 23 04:22:15 2022 @@ -0,0 +1,541 @@ +<!DOCTYPE html> + + +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/markdown/tutorial_task_framework.md at 2022-04-23 + | Rendered using Apache Maven Fluido Skin 1.11.0-SNAPSHOT +--> +<html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> + <title>Apache Helix – Tutorial - Task Framework</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.0-SNAPSHOT.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + <script src="./js/apache-maven-fluido-1.11.0-SNAPSHOT.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"> + <header 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">Get Helix <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="download.html" title="Download">Download</a></li> + <li><a href="Building.html" title="Building">Building</a></li> + <li><a href="releasenotes/release-1.0.3.html" title="Release Notes">Release Notes</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Hands-On <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="Quickstart.html" title="Quick Start">Quick Start</a></li> + <li><a href="Tutorial.html" title="Tutorial">Tutorial</a></li> + <li><a href="../javadocs/1.0.3" title="Javadocs">Javadocs</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Recipes <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager</a></li> + <li><a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group</a></li> + <li><a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store</a></li> + <li><a href="recipes/service_discovery.html" title="Service discovery">Service discovery</a></li> + <li><a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution</a></li> + </ul> + </li> + </ul> + <ul class="nav pull-right"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">External Links <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="index.html" title="Helix 1.0.3">Helix 1.0.3</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div class="container-fluid"> + <header> + <div id="banner"> + <div class="pull-left"><a href="http://helix.apache.org/"; id="bannerLeft"><img src="../images/helix-logo.jpg" alt=""/></a></div> + <div class="pull-right"><a href="http://www.apache.org/"; id="bannerRight"><img src="../images/feather_small.gif" alt=""/></a></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="http://helix.apache.org/"; class="externalLink" title="Apache Helix">Apache Helix</a><span class="divider">/</span></li> + <li class=""><a href="../" title="Apache Helix">Apache Helix</a><span class="divider">/</span></li> + <li class=""><a href="./" title="Release 1.0.3">Release 1.0.3</a><span class="divider">/</span></li> + <li class="active ">Tutorial - Task Framework</li> + <li id="publishDate" class="pull-right">Last Published: 2022-04-23</li> + </ul> + </div> + </header> + <div class="row-fluid"> + <header id="leftColumn" class="span2"> + <nav class="well sidebar-nav"> + <ul class="nav nav-list"> + <li class="nav-header">Get Helix</li> + <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li> + <li><a href="Building.html" title="Building"><span class="none"></span>Building</a></li> + <li><a href="releasenotes/release-1.0.3.html" title="Release Notes"><span class="none"></span>Release Notes</a></li> + <li class="nav-header">Hands-On</li> + <li><a href="Quickstart.html" title="Quick Start"><span class="none"></span>Quick Start</a></li> + <li><a href="Tutorial.html" title="Tutorial"><span class="none"></span>Tutorial</a></li> + <li><a href="../javadocs/1.0.3" title="Javadocs"><span class="none"></span>Javadocs</a></li> + <li class="nav-header">Recipes</li> + <li><a href="recipes/lock_manager.html" title="Distributed lock manager"><span class="none"></span>Distributed lock manager</a></li> + <li><a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group"><span class="none"></span>Rabbit MQ consumer group</a></li> + <li><a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store"><span class="none"></span>Rsync replicated file store</a></li> + <li><a href="recipes/service_discovery.html" title="Service discovery"><span class="none"></span>Service discovery</a></li> + <li><a href="recipes/task_dag_execution.html" title="Distributed task DAG execution"><span class="none"></span>Distributed task DAG execution</a></li> + </ul> + </nav> + <div class="well sidebar-nav"> +<form id="search-form" action="https://www.google.com/search"; method="get" > + <input value="helix.apache.org/1.0.3-docs" name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script>asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div id="twitter" style="border:none; margin-top: 10px"> + <a href="https://twitter.com/ApacheHelix"; class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ApacheHelix</a> + <script>!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> + </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> + </header> + <main id="bodyColumn" class="span10" > +<!--- +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. +--> + +<section> +<h2><a name="Helix_Tutorial:_Task_Framework"></a><a href="./Tutorial.html">Helix Tutorial</a>: Task Framework</h2> +<p>Task framework, in Helix, provides executable task scheduling and workflow management. In Helix, three layers of task abstraction have been offered to user for defining their logics of dependencies. The graph shows the relationships between three layers. Workflow can contain multiple jobs. One job can depend on other one. Multiple tasks, including same task different partition and different task different partition, can be added in one job. +Task framework not only can abstract three layers task logics but also helps doing task assignment and rebalancing. User can create a workflow (or a job queue) at first beginning. Then jobs can be added into workflow. Those jobs contain the executable tasks implemented by user. Once workflow is completed, Helix will schedule the works based on the condition user provided.</p> +<p><img src="./images/TaskFrameworkLayers.png" alt="Task Framework flow chart" /></p><section> +<h3><a name="Key_Concepts"></a>Key Concepts</h3> +<ul> + +<li>Task is the smallest unit of work in Helix Task Framework. It represents a single runnable logics that user prefer to execute for each partition (distributed units).</li> +<li>Job defines one time operation across all the partitions. It contains multiple Tasks and configuration of tasks, such as how many tasks, timeout per task and so on.</li> +<li>Workflow is a directed acyclic graph that represents the relationships and running orders of Jobs. In addition, a workflow can also provide customized configuration, for example, Job dependencies.</li> +<li>JobQueue is another type of Workflow. Different from normal one, JobQueue is not terminated until user kill it. Also JobQueue can keep accepting newly coming jobs.</li> +</ul></section><section> +<h3><a name="Implement_Your_Task"></a>Implement Your Task</h3><section> +<h4><a name="Task_Interface"></a><a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/Task.java";>Task Interface</a></h4> +<p>The task interface contains two methods: run and cancel. User can implement his or her own logic in run function and cancel / roll back logic in cancel function.</p> + +<div class="source"><pre class="prettyprint"><code>public class MyTask implements Task { + @Override + TaskResult run() { + // Task logic + } + + @Override + void cancel() { + // Cancel logic + } +} +</code></pre></div></section><section> +<h4><a name="TaskConfig"></a><a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/TaskConfig.java";>TaskConfig</a></h4> +<p>In helix, usually an object config represents the abstraction of that object, such as TaskConfig, JobConfig and WorkflowConfig. TaskConfig contains configurable task conditions. TaskConfig does not require to have any input to create a new object:</p> + +<div class="source"><pre class="prettyprint"><code>TaskConfig taskConfig = new TaskConfig(null, null, null, null); +</code></pre></div> +<p>For these four fields:</p> +<ul> + +<li>Command: The task command, will use Job command if this is null</li> +<li>ID: Task unique id, will generate a new ID for this task if input is null</li> +<li>TaskTargetPartition: Target partition of a target. Could be null</li> +<li>ConfigMap: Task property key-value map containing all other property stated above, such as command, ID.</li> +</ul></section><section> +<h4><a name="Share_Content_Across_Tasks_and_Jobs"></a>Share Content Across Tasks and Jobs</h4> +<p>Task framework also provides a feature that user can store the key-value data per task, job and workflow. The content stored at workflow layer can shared by different jobs belong to this workflow. Similarly, content persisted at job layer can shared by different tasks nested in this job. Currently, user can extend the abstract class <a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/UserContentStore.java";>UserContentStore</a> and use two methods putUserContent and getUserContent. It's similar to HashMap put and get method except for the additional param Scope. The Scope defines which layer this key-value pair to be persisted.</p> + +<div class="source"><pre class="prettyprint"><code>public class MyTask extends UserContentStore implements Task { + @Override + TaskResult run() { + putUserContent("KEY", "WORKFLOWVALUE", SCOPE.WORKFLOW); + putUserContent("KEY", "JOBVALUE", SCOPE.JOB); + putUserContent("KEY", "TASKVALUE", SCOPE.TASK); + String taskValue = getUserContent("KEY", SCOPE.TASK); + } + ... +} +</code></pre></div></section><section> +<h4><a name="Return_Task_Results"></a>Return <a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/TaskResult.java";>Task Results</a></h4> +<p>User can define the TaskResult for a task once it is at final stage (complete or failed). The TaskResult contains two fields: status and info. Status is current Task Status including COMPLETED, CANCELLED, FAILED and FATAL_FAILED. The difference between FAILED and FATAL_FAILED is that once the task defined as FATAL_FAILED, helix will not do the retry for this task and abort it. The other field is information, which is a String type. User can pass any information including error message, description and so on.</p> + +<div class="source"><pre class="prettyprint"><code>TaskResult run() { + .... + return new TaskResult(TaskResult.Status.FAILED, "ERROR MESSAGE OR OTHER INFORMATION"); +} +</code></pre></div></section><section> +<h4><a name="Task_Retry_and_Abort"></a>Task Retry and Abort</h4> +<p>Helix provides retry logics to users. User can specify the number of task failures to allow under a job. It is a method will be introduced in Following Job Section. Another choice offered to user that if user thinks a task is very critical and do not want to do the retry once it is failed, user can return a TaskResult stated above with FATAL_FAILED status. Then Helix will not do the retry for that task.</p> + +<div class="source"><pre class="prettyprint"><code>return new TaskResult(TaskResult.Status.FATAL_FAILED, "DO NOT WANT TO RETRY, ERROR MESSAGE"); +</code></pre></div></section><section> +<h4><a name="TaskDriver"></a><a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/TaskDriver.java";>TaskDriver</a></h4> +<p>All the control operation related to workflow and job are based on TaskDriver object. TaskDriver offers several APIs to controller, modify and track the tasks. Those APIs will be introduced in each section when they are necessary. TaskDriver object can be created either by <a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/HelixManager.java";>HelixManager</a> or <a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/manager/zk/ZkClient.java";>ZkClient</a> with cluster name:</p> + +<div class="source"><pre class="prettyprint"><code>HelixManager manager = new ZKHelixManager(CLUSTER_NAME, INSTANCE_NAME, InstanceType.PARTICIPANT, ZK_ADDRESS); +TaskDriver taskDriver1 = new TaskDriver(manager); + +TaskDriver taskDriver2 = new TaskDriver(zkclient, CLUSTER_NAME); +</code></pre></div></section><section> +<h4><a name="Propagate_Task_Error_Message_to_Helix"></a>Propagate Task Error Message to Helix</h4> +<p>When task encounter an error, it could be returned by TaskResult. Unfortunately, user can not get this TaskResult object directly. But Helix provides error messages persistent. Thus user can fetch the error messages from Helix via TaskDriver, which introduced above. The error messages will be stored in Info field per Job. Thus user have to get JobContext, which is the job status and result object.</p> + +<div class="source"><pre class="prettyprint"><code>taskDriver.getJobContext("JOBNAME").getInfo(); +</code></pre></div></section></section><section> +<h3><a name="Creating_a_Workflow"></a>Creating a Workflow</h3><section> +<h4><a name="One-time_Workflow"></a>One-time Workflow</h4> +<p>As common use, one-time workflow will be the default workflow as user created. The first step is to create a WorkflowConfig.Builder object with workflow name. Then all configs can be set in WorkflowConfig.Builder. Once the configuration is done, <a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/WorkflowConfig.java";>WorkflowConfig</a> object can be got from WorkflowConfig.Builder object. +We have two rules to validate the Workflow configuration:</p> +<ul> + +<li>Expiry time should not be less than 0</li> +<li>Schedule config should be valid either one-time or a positive interval magnitude (Recurrent workflow)</li> +</ul> +<p>Example:</p> + +<div class="source"><pre class="prettyprint"><code>Workflow.Builder myWorkflowBuilder = new Workflow.Builder("MyWorkflow"); +myWorkflowBuilder.setExpiry(5000L); +Workflow myWorkflow = myWorkflowBuilder.build(); +</code></pre></div></section><section> +<h4><a name="Recurrent_Workflow"></a>Recurrent Workflow</h4> +<p>Recurrent workflow is the workflow scheduled periodically. The only config different from One-time workflow is to set a recurrent <a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/ScheduleConfig.java";>ScheduleConfig</a>. There two methods in ScheduleConfig can help you to create a ScheduleConfig object: recurringFromNow and recurringFromDate. Both of them needs recurUnit (time unit for recurrent) and recurInteval (magnitude of recurrent interval). Here's the example:</p> + +<div class="source"><pre class="prettyprint"><code>ScheduleConfig myConfig1 = ScheduleConfig.recurringFFromNow(TimeUnit.MINUTES, 5L); +ScheduleConfig myConfig2 = ScheduleConfig.recurringFFromDate(Calendar.getInstance.getTime, TimeUnit.HOURS, 10L); +</code></pre></div> +<p>Once this schedule config is created. It could be set in the workflow config:</p> + +<div class="source"><pre class="prettyprint"><code>Workflow.Builder myWorkflowBuilder = new Workflow.Builder("MyWorkflow"); +myWorkflowBuilder.setExpiry(2000L) + .setScheduleConfig(ScheduleConfig.recurringFromNow(TimeUnit.DAYS, 5)); +Workflow myWorkflow = myWorkflowBuilder.build(); +</code></pre></div></section><section> +<h4><a name="Start_a_Workflow"></a>Start a Workflow</h4> +<p>Start a workflow is just using taskdrive to start it. Since this is an async call, after start the workflow, user can keep doing actions.</p> + +<div class="source"><pre class="prettyprint"><code>taskDriver.start(myWorkflow); +</code></pre></div></section><section> +<h4><a name="Stop_a_Workflow"></a>Stop a Workflow</h4> +<p>Stop workflow can be executed via TaskDriver:</p> + +<div class="source"><pre class="prettyprint"><code>taskDriver.stop(myWorkflow); +</code></pre></div></section><section> +<h4><a name="Resume_a_Workflow"></a>Resume a Workflow</h4> +<p>Once the workflow is stopped, it does not mean the workflow is gone. Thus user can resume the workflow that has been stopped. Using TaskDriver resume the workflow:</p> + +<div class="source"><pre class="prettyprint"><code>taskDriver.resume(myWorkflow); +</code></pre></div></section><section> +<h4><a name="Delete_a_Workflow"></a>Delete a Workflow</h4> +<p>Similar to start, stop and resume, delete operation is supported by TaskDriver.</p> + +<div class="source"><pre class="prettyprint"><code>taskDriver.delete(myWorkflow); +</code></pre></div></section><section> +<h4><a name="Add_a_Job"></a>Add a Job</h4> +<p>WARNING: Job can only be added to WorkflowConfig.Builder. Once WorkflowConfig is built, no job can be added! For creating a Job, please refer to the following section (Create a Job)</p> + +<div class="source"><pre class="prettyprint"><code>myWorkflowBuilder.addJob("JobName", jobConfigBuilder); +</code></pre></div></section><section> +<h4><a name="Add_a_Job_dependency"></a>Add a Job dependency</h4> +<p>Jobs can have dependencies. If one job2 depends on job1, job2 will not be scheduled until job1 finished.</p> + +<div class="source"><pre class="prettyprint"><code>myWorkflowBuilder.addParentChildDependency(ParentJobName, ChildJobName); +</code></pre></div></section><section> +<h4><a name="Schedule_a_workflow_for_executing_in_a_future_time"></a>Schedule a workflow for executing in a future time</h4> +<p>Application can create a workflow with a ScheduleConfig so as to schedule it to be executed in a future time.</p> + +<div class="source"><pre class="prettyprint"><code>myWorkflowBuilder.setScheduleConfig(ScheduleConfig.oneTimeDelayedStart(new Date(inFiveSeconds))); +</code></pre></div></section><section> +<h4><a name="Additional_Workflow_Options"></a>Additional Workflow Options</h4> +<table border="0" class="table table-striped"> +<thead> + +<tr class="a"> +<th>Additional Config Options</th> +<th>Detail</th></tr> +</thead><tbody> + +<tr class="b"> +<td align="left"><i>setJobDag(JobDag v)</i></td> +<td>If user already defined the job DAG, it could be set with this method.</td></tr> +<tr class="a"> +<td align="left"><i>setExpiry(long v, TimeUnit unit)</i></td> +<td>Set the expiration time for this workflow.</td></tr> +<tr class="b"> +<td align="left"><i>setFailureThreshold(int failureThreshold)</i></td> +<td>Set the failure threshold for this workflow, once job failures reach this number, the workflow will be failed.</td></tr> +<tr class="a"> +<td align="left"><i>setWorkflowType(String workflowType)</i></td> +<td>Set the user defined workflowType for this workflow.</td></tr> +<tr class="b"> +<td align="left"><i>setTerminable(boolean isTerminable)</i></td> +<td>Specify whether this workflow is terminable or not.</td></tr> +<tr class="a"> +<td align="left"><i>setCapacity(int capacity)</i></td> +<td>Set the number of jobs that workflow can hold before reject further jobs. Only used when workflow is not terminable.</td></tr> +<tr class="b"> +<td align="left"><i>setTargetState(TargetState v)</i></td> +<td>Set the final state of this workflow.</td></tr> +</tbody> +</table></section></section><section> +<h3><a name="Creating_a_Queue"></a>Creating a Queue</h3> +<p><a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/JobQueue.java";>Job queue</a> is another shape of workflow. Here listed different between a job queue and workflow:</p> +<table border="0" class="table table-striped"> +<thead> + +<tr class="a"> +<th>Property</th> +<th>Workflow</th> +<th>Job Queue</th></tr> +</thead><tbody> + +<tr class="b"> +<td align="left">Existing time</td> +<td>Workflow will be deleted after it is done.</td> +<td>Job queue will be there until user delete it.</td></tr> +<tr class="a"> +<td align="left">Add jobs</td> +<td>Once workflow is build, no job can be added.</td> +<td>Job queue can keep accepting jobs.</td></tr> +<tr class="b"> +<td align="left">Parallel run</td> +<td>Allows parallel run for jobs without dependencies</td> +<td>No parallel run allowed except setting <i>ParallelJobs</i></td></tr> +</tbody> +</table> +<p>For creating a job queue, user have to provide queue name and workflow config (please refer above Create a Workflow). Similar to other task object, create a JobQueue.Builder first. Then JobQueue can be validated and generated via build function.</p> + +<div class="source"><pre class="prettyprint"><code>WorkflowConfig.Builder myWorkflowCfgBuilder = new WorkflowConfig.Builder().setWorkFlowType("MyType"); +JobQueue jobQueue = new JobQueue.Builder("MyQueueName").setWorkflowConfig(myWorkflowCfgBuilder.build()).build(); +</code></pre></div> +<p>####Append Job to Queue</p> +<p>WARNING:Different from normal workflow, job for JobQueue can be append even in anytime. Similar to workflow add a job, job can be appended via enqueueJob function via TaskDriver.</p> + +<div class="source"><pre class="prettyprint"><code>jobQueueBuilder.enqueueJob("JobName", jobConfigBuilder); +</code></pre></div> +<p>####Delete Job from Queue</p> +<p>Helix allowed user to delete a job from existing queue. We offer delete API in TaskDriver to do this. The queue has to be stopped in order for a job to be deleted. User can resume the queue once deletion succeeds.</p> + +<div class="source"><pre class="prettyprint"><code>taskDriver.stop("QueueName"); +taskDriver.deleteJob("QueueName", "JobName"); +taskDriver.resume("QueueName"); +</code></pre></div> +<p>####Additional Option for JobQueue</p> +<p><i>setParallelJobs(int parallelJobs)</i> : Set the how many jobs can parallel running, except there is any dependencies.</p> +<p>###Create a Job</p> +<p>Before generate a <a class="externalLink" href="https://github.com/apache/helix/blob/helix-0.6.x/helix-core/src/main/java/org/apache/helix/task/JobConfig.java";>JobConfig</a> object, user still have to use JobConfig.Builder to build JobConfig.</p> + +<div class="source"><pre class="prettyprint"><code>JobConfig.Builder myJobCfgBuilder = new JobConfig.Builder(); +JobConfig myJobCfg = myJobCfgBuilder.build(); +</code></pre></div> +<p>Helix has couple rules to validate a job:</p> +<ul> + +<li>Each job must at least have one task to execute. For adding tasks and task rules please refer following section Add Tasks.</li> +<li>Task timeout should not less than zero.</li> +<li>Number of concurrent tasks per instances should not less than one.</li> +<li>Maximum attempts per task should not less than one</li> +<li>There must be a workflow name</li> +</ul><section> +<h4><a name="Add_Tasks"></a>Add Tasks</h4> +<p>There are two ways of adding tasks:</p> +<ul> + +<li>Add by TaskConfig. Tasks can be added via adding TaskConfigs. User can create a List of TaskConfigs or add TaskConfigMap, which is a task id to TaskConfig mapping.</li> +</ul> + +<div class="source"><pre class="prettyprint"><code>TaskConfig taskCfg = new TaskConfig(null, null, null, null); +List<TaskConfig> taskCfgs = new ArrayList<TaskConfig>(); +myJobCfg.addTaskConfigs(taskCfgs); + +Map<String, TaskConfig> taskCfgMap = new HashMap<String, TaskConfig>(); +taskCfgMap.put(taskCfg.getId(), taskCfg); +myJobCfg.addTaskConfigMap(taskCfgMap); +</code></pre></div> +<ul> + +<li>Add by Job command. If user does not want to specify each TaskConfig, we can create identical tasks based on Job command with number of tasks.</li> +</ul> + +<div class="source"><pre class="prettyprint"><code>myJobCfg.setCommand("JobCommand").setNumberOfTasks(10); +</code></pre></div> +<p>WARNING: Either user provides TaskConfigs / TaskConfigMap or both of Job command and number tasks (except Targeted Job, refer following section) . Otherwise, validation will be failed.</p></section><section> +<h4><a name="Generic_Job"></a>Generic Job</h4> +<p>Generic Job is the default job created. It does not have targeted resource. Thus this generic job could be assigned to one of eligble instances.</p></section><section> +<h4><a name="Targeted_Job"></a>Targeted Job</h4> +<p>Targeted Job has set up the target resource. For this kind of job, Job command is necessary, but number of tasks is not. The tasks will depends on the partion number of targeted resource. To set target resource, just put target resource name to JobConfig.Builder.</p> + +<div class="source"><pre class="prettyprint"><code>myJobCfgBuilder.setTargetResource("TargetResourceName"); +</code></pre></div> +<p>In addition, user can specify the instance target state. For example, if user want to run the Task on “Master” state instance, setTargetPartitionState method can help to set the partition to assign to specific instance.</p> + +<div class="source"><pre class="prettyprint"><code>myJobCfgBuilder.setTargetPartitionState(Arrays.asList(new String[]{"Master", "Slave"})); +</code></pre></div></section><section> +<h4><a name="Instance_Group"></a>Instance Group</h4> +<p>Grouping jobs with targeted group of instances feature has been supported. User firstly have to define the instance group tag for instances, which means label some instances with specific tag. Then user can put those tags to a job that only would like to assigned to those instances. For example, customer data only available on instance 1, 2, 3. These three instances can be tagged as “CUSTOMER” and customer data related jobs can set the instance group tag “CUSTOMER”. Thus customer data related jobs will only assign to instance 1, 2, 3. +To add instance group tag, just set it in JobConfig.Builder:</p> + +<div class="source"><pre class="prettyprint"><code>jobCfg.setInstanceGroupTag("INSTANCEGROUPTAG"); +</code></pre></div></section><section> +<h4><a name="Delayed_scheduling_job"></a>Delayed scheduling job</h4> +<p>Set up a schedule plan for the job. +If both items are set, Helix will calculate and use the later one.</p> + +<div class="source"><pre class="prettyprint"><code>myJobCfgBuilder.setExecutionDelay(delayMs); +myJobCfgBuilder.setExecutionStart(startTimeMs); +</code></pre></div> +<p>Note that the scheduled job needs to be runnable first. Then Helix will start checking it's configuration for scheduling. +If any parent jobs are not finished, the job won't be scheduled even the scheduled timestamp has already passed.</p></section><section> +<h4><a name="Additional_Job_Options"></a>Additional Job Options</h4> +<table border="0" class="table table-striped"> +<thead> + +<tr class="a"> +<th>Operation</th> +<th>Detail</th></tr> +</thead><tbody> + +<tr class="b"> +<td align="left"><i>setWorkflow(String workflowName)</i></td> +<td>Set the workflow that this job belongs to</td></tr> +<tr class="a"> +<td align="left"><i>setTargetPartions(List<String> targetPartionNames)</i></td> +<td>Set list of partition names</td></tr> +<tr class="b"> +<td align="left"><i>setTargetPartionStates(Set<String>)</i></td> +<td>Set the partition states</td></tr> +<tr class="a"> +<td align="left"><i>setCommand(String command)</i></td> +<td>Set the job command</td></tr> +<tr class="b"> +<td align="left"><i>setJobCommandConfigMap(Map<String, String> v)</i></td> +<td>Set the job command config maps</td></tr> +<tr class="a"> +<td align="left"><i>setTimeoutPerTask(long v)</i></td> +<td>Set the timeout for each task</td></tr> +<tr class="b"> +<td align="left"><i>setNumConcurrentTasksPerInstance(int v)</i></td> +<td>Set number of tasks can concurrent run on same instance</td></tr> +<tr class="a"> +<td align="left"><i>setMaxAttemptsPerTask(int v)</i></td> +<td>Set times of retry for a task</td></tr> +<tr class="b"> +<td align="left"><i>setFailureThreshold(int v)</i></td> +<td>Set failure tolerance of tasks for this job</td></tr> +<tr class="a"> +<td align="left"><i>setTaskRetryDelay(long v)</i></td> +<td>Set the delay time before a task retry</td></tr> +<tr class="b"> +<td align="left"><i>setIgnoreDependentJobFailure(boolean ignoreDependentJobFailure)</i></td> +<td>Set whether ignore the job failure of parent job of this job</td></tr> +<tr class="a"> +<td align="left"><i>setJobType(String jobType)</i></td> +<td>Set the job type of this job</td></tr> +<tr class="b"> +<td align="left"><i>setExecutionDelay(String delay)</i></td> +<td>Set the delay time to schedule job execution</td></tr> +<tr class="a"> +<td align="left"><i>setExecutionStart(String start)</i></td> +<td>Set the start time to schedule job execution</td></tr> +</tbody> +</table></section></section><section> +<h3><a name="Monitor_the_status_of_your_job"></a>Monitor the status of your job</h3> +<p>As we introduced the excellent util TaskDriver in Workflow Section, we have extra more functionality that provided to user. The user can synchronized wait Job or Workflow until it reaches certain STATES. The function Helix have API pollForJobState and pollForWorkflowState. For pollForJobState, it accepts arguments:</p> +<ul> + +<li>Workflow name, required</li> +<li>Job name, required</li> +<li>Timeout, not required, will be three minutes if user choose function without timeout argument. Time unit is milisecond.</li> +<li>TaskStates, at least one state. This function can accept multiple TaskState, will end function until one of those TaskState reaches.</li> +</ul> +<p>For example:</p> + +<div class="source"><pre class="prettyprint"><code>taskDriver.pollForJobState("MyWorkflowName", "MyJobName", 180000L, TaskState.FAILED, TaskState.FATAL_FAILED); +taskDriver.pollForJobState("MyWorkflowName", "MyJobName", TaskState.COMPLETED); +</code></pre></div> +<p>For pollForWorkflowState, it accepts similar arguments except Job name. For example:</p> + +<div class="source"><pre class="prettyprint"><code>taskDriver.pollForWorkflowState("MyWorkflowName", 180000L, TaskState.FAILED, TaskState.FATAL_FAILED); +taskDriver.pollForWorkflowState("MyWorkflowName", TaskState.COMPLETED); +</code></pre></div><section> +<h4><a name="Task_framework_monitoring_metrics"></a>Task framework monitoring metrics</h4> +<p>Please refer to following links.</p> +<ul> + +<li><a href="./Metrics.html#MBean_JobMonitor">Job Monitor</a></li> +<li><a href="./Metrics.html#MBean_WorkflowMonitor">Workflow Monitor</a></li> +</ul></section></section></section> + </main> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> +<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="https://helix.apache.org/1.0.3-docs/privacy-policy.html";>Privacy Policy</a> + </div> + </div> + </div> + </footer> +<script> + if(anchors) { + anchors.add(); + } +</script> + </body> +</html> \ No newline at end of file
Added: helix/site-content/1.0.3-docs/tutorial_task_throttling.html URL: http://svn.apache.org/viewvc/helix/site-content/1.0.3-docs/tutorial_task_throttling.html?rev=1900184&view=auto ============================================================================== --- helix/site-content/1.0.3-docs/tutorial_task_throttling.html (added) +++ helix/site-content/1.0.3-docs/tutorial_task_throttling.html Sat Apr 23 04:22:15 2022 @@ -0,0 +1,192 @@ +<!DOCTYPE html> + + +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/markdown/tutorial_task_throttling.md at 2022-04-23 + | Rendered using Apache Maven Fluido Skin 1.11.0-SNAPSHOT +--> +<html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> + <title>Apache Helix – Tutorial - Task Throttling</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.0-SNAPSHOT.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + <script src="./js/apache-maven-fluido-1.11.0-SNAPSHOT.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"> + <header 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">Get Helix <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="download.html" title="Download">Download</a></li> + <li><a href="Building.html" title="Building">Building</a></li> + <li><a href="releasenotes/release-1.0.3.html" title="Release Notes">Release Notes</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Hands-On <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="Quickstart.html" title="Quick Start">Quick Start</a></li> + <li><a href="Tutorial.html" title="Tutorial">Tutorial</a></li> + <li><a href="../javadocs/1.0.3" title="Javadocs">Javadocs</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Recipes <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager</a></li> + <li><a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group</a></li> + <li><a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store</a></li> + <li><a href="recipes/service_discovery.html" title="Service discovery">Service discovery</a></li> + <li><a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution</a></li> + </ul> + </li> + </ul> + <ul class="nav pull-right"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">External Links <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="index.html" title="Helix 1.0.3">Helix 1.0.3</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div class="container-fluid"> + <header> + <div id="banner"> + <div class="pull-left"><a href="http://helix.apache.org/"; id="bannerLeft"><img src="../images/helix-logo.jpg" alt=""/></a></div> + <div class="pull-right"><a href="http://www.apache.org/"; id="bannerRight"><img src="../images/feather_small.gif" alt=""/></a></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="http://helix.apache.org/"; class="externalLink" title="Apache Helix">Apache Helix</a><span class="divider">/</span></li> + <li class=""><a href="../" title="Apache Helix">Apache Helix</a><span class="divider">/</span></li> + <li class=""><a href="./" title="Release 1.0.3">Release 1.0.3</a><span class="divider">/</span></li> + <li class="active ">Tutorial - Task Throttling</li> + <li id="publishDate" class="pull-right">Last Published: 2022-04-23</li> + </ul> + </div> + </header> + <div class="row-fluid"> + <header id="leftColumn" class="span2"> + <nav class="well sidebar-nav"> + <ul class="nav nav-list"> + <li class="nav-header">Get Helix</li> + <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li> + <li><a href="Building.html" title="Building"><span class="none"></span>Building</a></li> + <li><a href="releasenotes/release-1.0.3.html" title="Release Notes"><span class="none"></span>Release Notes</a></li> + <li class="nav-header">Hands-On</li> + <li><a href="Quickstart.html" title="Quick Start"><span class="none"></span>Quick Start</a></li> + <li><a href="Tutorial.html" title="Tutorial"><span class="none"></span>Tutorial</a></li> + <li><a href="../javadocs/1.0.3" title="Javadocs"><span class="none"></span>Javadocs</a></li> + <li class="nav-header">Recipes</li> + <li><a href="recipes/lock_manager.html" title="Distributed lock manager"><span class="none"></span>Distributed lock manager</a></li> + <li><a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group"><span class="none"></span>Rabbit MQ consumer group</a></li> + <li><a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store"><span class="none"></span>Rsync replicated file store</a></li> + <li><a href="recipes/service_discovery.html" title="Service discovery"><span class="none"></span>Service discovery</a></li> + <li><a href="recipes/task_dag_execution.html" title="Distributed task DAG execution"><span class="none"></span>Distributed task DAG execution</a></li> + </ul> + </nav> + <div class="well sidebar-nav"> +<form id="search-form" action="https://www.google.com/search"; method="get" > + <input value="helix.apache.org/1.0.3-docs" name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script>asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div id="twitter" style="border:none; margin-top: 10px"> + <a href="https://twitter.com/ApacheHelix"; class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ApacheHelix</a> + <script>!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> + </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> + </header> + <main id="bodyColumn" class="span10" > +<!--- +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. +--> + +<section> +<h2><a name="Helix_Tutorial:_Task_Throttling"></a><a href="./Tutorial.html">Helix Tutorial</a>: Task Throttling</h2> +<p>In this chapter, we'll learn how to control the parallel execution of tasks in the task framework.</p><section> +<h3><a name="Task_Throttling_Configuration"></a>Task Throttling Configuration</h3> +<p>Helix can control the number of tasks that are executed in parallel according to multiple thresholds. +Applications can set these thresholds in the following configuration items:</p> +<ul> + +<li>JobConfig.ConcurrentTasksPerInstance The number of concurrent tasks in this job that are allowed to run on an instance.</li> +<li>InstanceConfig.MAX_CONCURRENT_TASK The number of total concurrent tasks that are allowed to run on an instance.</li> +</ul> +<p>Also see <a href="./tutorial_task_framework.html">WorkflowConfig.ParallelJobs</a>.</p></section><section> +<h3><a name="Job_Priority_for_Task_Throttling"></a>Job Priority for Task Throttling</h3> +<p>Whenever there are too many tasks to be scheduled according to the threshold, Helix will prioritize the older jobs. +The age of a job is calculated based on the job start time.</p></section></section> + </main> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> +<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="https://helix.apache.org/1.0.3-docs/privacy-policy.html";>Privacy Policy</a> + </div> + </div> + </div> + </footer> +<script> + if(anchors) { + anchors.add(); + } +</script> + </body> +</html> \ No newline at end of file Added: helix/site-content/1.0.3-docs/tutorial_throttling.html URL: http://svn.apache.org/viewvc/helix/site-content/1.0.3-docs/tutorial_throttling.html?rev=1900184&view=auto ============================================================================== --- helix/site-content/1.0.3-docs/tutorial_throttling.html (added) +++ helix/site-content/1.0.3-docs/tutorial_throttling.html Sat Apr 23 04:22:15 2022 @@ -0,0 +1,190 @@ +<!DOCTYPE html> + + +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/markdown/tutorial_throttling.md at 2022-04-23 + | Rendered using Apache Maven Fluido Skin 1.11.0-SNAPSHOT +--> +<html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> + <title>Apache Helix – Tutorial - Throttling</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.0-SNAPSHOT.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + <script src="./js/apache-maven-fluido-1.11.0-SNAPSHOT.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"> + <header 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">Get Helix <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="download.html" title="Download">Download</a></li> + <li><a href="Building.html" title="Building">Building</a></li> + <li><a href="releasenotes/release-1.0.3.html" title="Release Notes">Release Notes</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Hands-On <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="Quickstart.html" title="Quick Start">Quick Start</a></li> + <li><a href="Tutorial.html" title="Tutorial">Tutorial</a></li> + <li><a href="../javadocs/1.0.3" title="Javadocs">Javadocs</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Recipes <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager</a></li> + <li><a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group</a></li> + <li><a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store</a></li> + <li><a href="recipes/service_discovery.html" title="Service discovery">Service discovery</a></li> + <li><a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution</a></li> + </ul> + </li> + </ul> + <ul class="nav pull-right"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">External Links <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="index.html" title="Helix 1.0.3">Helix 1.0.3</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div class="container-fluid"> + <header> + <div id="banner"> + <div class="pull-left"><a href="http://helix.apache.org/"; id="bannerLeft"><img src="../images/helix-logo.jpg" alt=""/></a></div> + <div class="pull-right"><a href="http://www.apache.org/"; id="bannerRight"><img src="../images/feather_small.gif" alt=""/></a></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="http://helix.apache.org/"; class="externalLink" title="Apache Helix">Apache Helix</a><span class="divider">/</span></li> + <li class=""><a href="../" title="Apache Helix">Apache Helix</a><span class="divider">/</span></li> + <li class=""><a href="./" title="Release 1.0.3">Release 1.0.3</a><span class="divider">/</span></li> + <li class="active ">Tutorial - Throttling</li> + <li id="publishDate" class="pull-right">Last Published: 2022-04-23</li> + </ul> + </div> + </header> + <div class="row-fluid"> + <header id="leftColumn" class="span2"> + <nav class="well sidebar-nav"> + <ul class="nav nav-list"> + <li class="nav-header">Get Helix</li> + <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li> + <li><a href="Building.html" title="Building"><span class="none"></span>Building</a></li> + <li><a href="releasenotes/release-1.0.3.html" title="Release Notes"><span class="none"></span>Release Notes</a></li> + <li class="nav-header">Hands-On</li> + <li><a href="Quickstart.html" title="Quick Start"><span class="none"></span>Quick Start</a></li> + <li><a href="Tutorial.html" title="Tutorial"><span class="none"></span>Tutorial</a></li> + <li><a href="../javadocs/1.0.3" title="Javadocs"><span class="none"></span>Javadocs</a></li> + <li class="nav-header">Recipes</li> + <li><a href="recipes/lock_manager.html" title="Distributed lock manager"><span class="none"></span>Distributed lock manager</a></li> + <li><a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group"><span class="none"></span>Rabbit MQ consumer group</a></li> + <li><a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store"><span class="none"></span>Rsync replicated file store</a></li> + <li><a href="recipes/service_discovery.html" title="Service discovery"><span class="none"></span>Service discovery</a></li> + <li><a href="recipes/task_dag_execution.html" title="Distributed task DAG execution"><span class="none"></span>Distributed task DAG execution</a></li> + </ul> + </nav> + <div class="well sidebar-nav"> +<form id="search-form" action="https://www.google.com/search"; method="get" > + <input value="helix.apache.org/1.0.3-docs" name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script>asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div id="twitter" style="border:none; margin-top: 10px"> + <a href="https://twitter.com/ApacheHelix"; class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ApacheHelix</a> + <script>!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> + </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> + </header> + <main id="bodyColumn" class="span10" > +<!--- +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. +--> + +<section> +<h2><a name="Helix_Tutorial:_Throttling"></a><a href="./Tutorial.html">Helix Tutorial</a>: Throttling</h2> +<p>In this chapter, we'll learn how to control the parallel execution of cluster tasks. Only a centralized cluster manager with global knowledge (i.e. Helix) is capable of coordinating this decision.</p><section> +<h3><a name="Throttling"></a>Throttling</h3> +<p>Since all state changes in the system are triggered through transitions, Helix can control the number of transitions that can happen in parallel. Some of the transitions may be lightweight, but some might involve moving data, which is quite expensive from a network and IOPS perspective.</p> +<p>Helix allows applications to set a threshold on transitions. The threshold can be set at multiple scopes:</p> +<ul> + +<li>MessageType e.g STATE_TRANSITION</li> +<li>TransitionType e.g SLAVE-MASTER</li> +<li>Resource e.g database</li> +<li>Node i.e per-node maximum transitions in parallel</li> +</ul></section></section> + </main> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> +<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="https://helix.apache.org/1.0.3-docs/privacy-policy.html";>Privacy Policy</a> + </div> + </div> + </div> + </footer> +<script> + if(anchors) { + anchors.add(); + } +</script> + </body> +</html> \ No newline at end of file Added: helix/site-content/1.0.3-docs/tutorial_ui.html URL: http://svn.apache.org/viewvc/helix/site-content/1.0.3-docs/tutorial_ui.html?rev=1900184&view=auto ============================================================================== --- helix/site-content/1.0.3-docs/tutorial_ui.html (added) +++ helix/site-content/1.0.3-docs/tutorial_ui.html Sat Apr 23 04:22:15 2022 @@ -0,0 +1,254 @@ +<!DOCTYPE html> + + +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/markdown/tutorial_ui.md at 2022-04-23 + | Rendered using Apache Maven Fluido Skin 1.11.0-SNAPSHOT +--> +<html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> + <title>Apache Helix – Tutorial - Helix UI Setup</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.0-SNAPSHOT.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + <script src="./js/apache-maven-fluido-1.11.0-SNAPSHOT.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"> + <header 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">Get Helix <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="download.html" title="Download">Download</a></li> + <li><a href="Building.html" title="Building">Building</a></li> + <li><a href="releasenotes/release-1.0.3.html" title="Release Notes">Release Notes</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Hands-On <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="Quickstart.html" title="Quick Start">Quick Start</a></li> + <li><a href="Tutorial.html" title="Tutorial">Tutorial</a></li> + <li><a href="../javadocs/1.0.3" title="Javadocs">Javadocs</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Recipes <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager</a></li> + <li><a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group</a></li> + <li><a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store</a></li> + <li><a href="recipes/service_discovery.html" title="Service discovery">Service discovery</a></li> + <li><a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution</a></li> + </ul> + </li> + </ul> + <ul class="nav pull-right"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">External Links <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="index.html" title="Helix 1.0.3">Helix 1.0.3</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div class="container-fluid"> + <header> + <div id="banner"> + <div class="pull-left"><a href="http://helix.apache.org/"; id="bannerLeft"><img src="../images/helix-logo.jpg" alt=""/></a></div> + <div class="pull-right"><a href="http://www.apache.org/"; id="bannerRight"><img src="../images/feather_small.gif" alt=""/></a></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="http://helix.apache.org/"; class="externalLink" title="Apache Helix">Apache Helix</a><span class="divider">/</span></li> + <li class=""><a href="../" title="Apache Helix">Apache Helix</a><span class="divider">/</span></li> + <li class=""><a href="./" title="Release 1.0.3">Release 1.0.3</a><span class="divider">/</span></li> + <li class="active ">Tutorial - Helix UI Setup</li> + <li id="publishDate" class="pull-right">Last Published: 2022-04-23</li> + </ul> + </div> + </header> + <div class="row-fluid"> + <header id="leftColumn" class="span2"> + <nav class="well sidebar-nav"> + <ul class="nav nav-list"> + <li class="nav-header">Get Helix</li> + <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li> + <li><a href="Building.html" title="Building"><span class="none"></span>Building</a></li> + <li><a href="releasenotes/release-1.0.3.html" title="Release Notes"><span class="none"></span>Release Notes</a></li> + <li class="nav-header">Hands-On</li> + <li><a href="Quickstart.html" title="Quick Start"><span class="none"></span>Quick Start</a></li> + <li><a href="Tutorial.html" title="Tutorial"><span class="none"></span>Tutorial</a></li> + <li><a href="../javadocs/1.0.3" title="Javadocs"><span class="none"></span>Javadocs</a></li> + <li class="nav-header">Recipes</li> + <li><a href="recipes/lock_manager.html" title="Distributed lock manager"><span class="none"></span>Distributed lock manager</a></li> + <li><a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group"><span class="none"></span>Rabbit MQ consumer group</a></li> + <li><a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store"><span class="none"></span>Rsync replicated file store</a></li> + <li><a href="recipes/service_discovery.html" title="Service discovery"><span class="none"></span>Service discovery</a></li> + <li><a href="recipes/task_dag_execution.html" title="Distributed task DAG execution"><span class="none"></span>Distributed task DAG execution</a></li> + </ul> + </nav> + <div class="well sidebar-nav"> +<form id="search-form" action="https://www.google.com/search"; method="get" > + <input value="helix.apache.org/1.0.3-docs" name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script>asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div id="twitter" style="border:none; margin-top: 10px"> + <a href="https://twitter.com/ApacheHelix"; class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ApacheHelix</a> + <script>!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> + </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> + </header> + <main id="bodyColumn" class="span10" > +<!--- +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. +--> + +<section> +<h2><a name="Helix_Tutorial:_Helix_UI_Setup"></a><a href="./Tutorial.html">Helix Tutorial</a>: Helix UI Setup</h2> +<p>Helix now provides a modern web user interface for users to manage Helix clusters in a more convenient way (aka Helix UI). Currently the following features are supported via Helix UI:</p> +<ul> + +<li>View all Helix clusters exposed by Helix REST service</li> +<li>View detailed cluster information</li> +<li>View resources / instances in a Helix cluster</li> +<li>View partition placement and health status in a resource</li> +<li>Create new Helix clusters</li> +<li>Enable / Disable a cluster / resource / instance</li> +<li>Add an instance into a Helix cluster</li> +</ul><section> +<h3><a name="Prerequisites"></a>Prerequisites</h3> +<p>Since Helix UI is talking with Helix REST service to manage Helix clusters, a well deployed Helix REST service is required and necessary. Please refer to this tutorial to setup a functional Helix REST service: <a href="./tutorial_rest_service.html">Helix REST Service 2.0</a>.</p></section><section> +<h3><a name="Installation"></a>Installation</h3> +<p>To get and run Helix UI locally, simply use the following command lines:</p> + +<div class="source"><pre class="prettyprint"><code>git clone https://git-wip-us.apache.org/repos/asf/helix.git +cd helix/helix-front +git checkout tags/helix-1.0.3 +../build +cd target/helix-front-pkg/bin +chmod +x *.sh +</code></pre></div></section><section> +<h3><a name="Configuration"></a>Configuration</h3> +<p>Helix UI does not need any configuration if you have started Helix REST service without specifying a port ( Helix REST service will be serving through <a class="externalLink" href="http://localhost:8100/admin/v2";>http://localhost:8100/admin/v2</a> ). If you have specified a customized port or you need to wire in additional REST services, please navigate to <code>../dist/server/config.js</code> and edit the following section accordingly:</p> + +<div class="source"><pre class="prettyprint"><code>... +exports.HELIX_ENDPOINTS = { + <service nickname>: [ + { + <nickname of REST endpoint>: '<REST endpoint url>' + } + ] +}; +... +</code></pre></div> +<p>For example, if you have multiple Helix REST services deployed (all listening on port 12345), and you want to divide them into two services, and each service will contain two groups (e.g. staging and production), and each group will contain two fabrics as well, you may configure the above section like this:</p> + +<div class="source"><pre class="prettyprint"><code>... +exports.HELIX_ENDPOINTS = { + service1: [ + { + staging1: 'http://staging1.service1.com:12345/admin/v2', + staging2: 'http://staging2.service1.com:12345/admin/v2' + }, + { + production1: 'http://production1.service1.com:12345/admin/v2', + production2: 'http://production2.service1.com:12345/admin/v2' + } + ], + service2: [ + { + staging1: 'http://staging1.service2.com:12345/admin/v2', + staging2: 'http://staging2.service2.com:12345/admin/v2' + }, + { + production1: 'http://production1.service2.com:12345/admin/v2', + production2: 'http://production2.service2.com:12345/admin/v2' + } + ] +}; +... + +</code></pre></div></section><section> +<h3><a name="Launch_Helix_UI"></a>Launch Helix UI</h3> + +<div class="source"><pre class="prettyprint"><code>./start-helix-ui.sh +</code></pre></div> +<p>Helix UI will be listening on your port <code>3000</code> by default. Just use any browser to navigate to <a class="externalLink" href="http://localhost:3000";>http://localhost:3000</a> to get started.</p></section><section> +<h3><a name="Introduction"></a>Introduction</h3> +<p>The primary UI will look like this:</p> +<p><img src="./images/UIScreenshot.png" alt="UI Screenshot" /></p> +<p>The left side is the cluster list, and the right side is the detailed cluster view if you click one on the left. You will find resource list, workflow list and instance list of the cluster as well as the cluster configurations.</p> +<p>When navigating into a single resource, Helix UI will show the partition placement with comparison of idealStates and externalViews like this:</p> +<p><img src="./images/UIScreenshot2.png" alt="UI Screenshot" /></p></section></section> + </main> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> +<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="https://helix.apache.org/1.0.3-docs/privacy-policy.html";>Privacy Policy</a> + </div> + </div> + </div> + </footer> +<script> + if(anchors) { + anchors.add(); + } +</script> + </body> +</html> \ No newline at end of file Added: helix/site-content/1.0.3-docs/tutorial_user_content_store.html URL: http://svn.apache.org/viewvc/helix/site-content/1.0.3-docs/tutorial_user_content_store.html?rev=1900184&view=auto ============================================================================== --- helix/site-content/1.0.3-docs/tutorial_user_content_store.html (added) +++ helix/site-content/1.0.3-docs/tutorial_user_content_store.html Sat Apr 23 04:22:15 2022 @@ -0,0 +1,221 @@ +<!DOCTYPE html> + + +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/markdown/tutorial_user_content_store.md at 2022-04-23 + | Rendered using Apache Maven Fluido Skin 1.11.0-SNAPSHOT +--> +<html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> + <title>Apache Helix – Tutorial - User Defined Content Store for Tasks</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.0-SNAPSHOT.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + <script src="./js/apache-maven-fluido-1.11.0-SNAPSHOT.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"> + <header 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">Get Helix <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="download.html" title="Download">Download</a></li> + <li><a href="Building.html" title="Building">Building</a></li> + <li><a href="releasenotes/release-1.0.3.html" title="Release Notes">Release Notes</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Hands-On <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="Quickstart.html" title="Quick Start">Quick Start</a></li> + <li><a href="Tutorial.html" title="Tutorial">Tutorial</a></li> + <li><a href="../javadocs/1.0.3" title="Javadocs">Javadocs</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Recipes <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="recipes/lock_manager.html" title="Distributed lock manager">Distributed lock manager</a></li> + <li><a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group">Rabbit MQ consumer group</a></li> + <li><a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store">Rsync replicated file store</a></li> + <li><a href="recipes/service_discovery.html" title="Service discovery">Service discovery</a></li> + <li><a href="recipes/task_dag_execution.html" title="Distributed task DAG execution">Distributed task DAG execution</a></li> + </ul> + </li> + </ul> + <ul class="nav pull-right"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">External Links <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="index.html" title="Helix 1.0.3">Helix 1.0.3</a></li> + </ul> + </li> + </ul> + </div> + </div> + </header> + <div class="container-fluid"> + <header> + <div id="banner"> + <div class="pull-left"><a href="http://helix.apache.org/"; id="bannerLeft"><img src="../images/helix-logo.jpg" alt=""/></a></div> + <div class="pull-right"><a href="http://www.apache.org/"; id="bannerRight"><img src="../images/feather_small.gif" alt=""/></a></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="http://helix.apache.org/"; class="externalLink" title="Apache Helix">Apache Helix</a><span class="divider">/</span></li> + <li class=""><a href="../" title="Apache Helix">Apache Helix</a><span class="divider">/</span></li> + <li class=""><a href="./" title="Release 1.0.3">Release 1.0.3</a><span class="divider">/</span></li> + <li class="active ">Tutorial - User Defined Content Store for Tasks</li> + <li id="publishDate" class="pull-right">Last Published: 2022-04-23</li> + </ul> + </div> + </header> + <div class="row-fluid"> + <header id="leftColumn" class="span2"> + <nav class="well sidebar-nav"> + <ul class="nav nav-list"> + <li class="nav-header">Get Helix</li> + <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li> + <li><a href="Building.html" title="Building"><span class="none"></span>Building</a></li> + <li><a href="releasenotes/release-1.0.3.html" title="Release Notes"><span class="none"></span>Release Notes</a></li> + <li class="nav-header">Hands-On</li> + <li><a href="Quickstart.html" title="Quick Start"><span class="none"></span>Quick Start</a></li> + <li><a href="Tutorial.html" title="Tutorial"><span class="none"></span>Tutorial</a></li> + <li><a href="../javadocs/1.0.3" title="Javadocs"><span class="none"></span>Javadocs</a></li> + <li class="nav-header">Recipes</li> + <li><a href="recipes/lock_manager.html" title="Distributed lock manager"><span class="none"></span>Distributed lock manager</a></li> + <li><a href="recipes/rabbitmq_consumer_group.html" title="Rabbit MQ consumer group"><span class="none"></span>Rabbit MQ consumer group</a></li> + <li><a href="recipes/rsync_replicated_file_store.html" title="Rsync replicated file store"><span class="none"></span>Rsync replicated file store</a></li> + <li><a href="recipes/service_discovery.html" title="Service discovery"><span class="none"></span>Service discovery</a></li> + <li><a href="recipes/task_dag_execution.html" title="Distributed task DAG execution"><span class="none"></span>Distributed task DAG execution</a></li> + </ul> + </nav> + <div class="well sidebar-nav"> +<form id="search-form" action="https://www.google.com/search"; method="get" > + <input value="helix.apache.org/1.0.3-docs" name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script>asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div id="twitter" style="border:none; margin-top: 10px"> + <a href="https://twitter.com/ApacheHelix"; class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ApacheHelix</a> + <script>!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> + </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> + </header> + <main id="bodyColumn" class="span10" > +<!--- +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. +--> + +<section> +<h2><a name="Helix_Tutorial:_User_Defined_Content_Store_for_Tasks"></a><a href="./Tutorial.html">Helix Tutorial</a>: User Defined Content Store for Tasks</h2> +<p>The purpose of user defined content store is to provide an easy use feature for some task dedicated meta temporary store. +In this chapter, we'll learn how to implement and use content store in the user defined tasks.</p><section> +<h3><a name="Content_Store_Implementation"></a>Content Store Implementation</h3> +<p>Extends abstract class UserContentStore.</p> + +<div class="source"><pre class="prettyprint"><code>private static class ContentStoreTask extends UserContentStore implements Task { + @Override public TaskResult run() { + ... + } + @Override public void cancel() { + ... + } +} +</code></pre></div> +<p>The default methods support 3 types of scopes:</p> +<ol style="list-style-type: decimal"> + +<li>WORKFLOW: Define the content store in workflow level</li> +<li>JOB: Define the content store in job level</li> +<li>TASK: Define the content store in task level</li> +</ol></section><section> +<h3><a name="Content_Store_Usage"></a>Content Store Usage</h3> +<p>Access content store in Task.run() method.</p> + +<div class="source"><pre class="prettyprint"><code> private static class ContentStoreTask extends UserContentStore implements Task { + @Override public TaskResult run() { + // put values into the store + putUserContent("ContentTest", "Value1", Scope.JOB); + putUserContent("ContentTest", "Value2", Scope.WORKFLOW); + putUserContent("ContentTest", "Value3", Scope.TASK); + + // get the values with the same key in the different scopes + if (!getUserContent("ContentTest", Scope.JOB).equals("Value1") || + !getUserContent("ContentTest", Scope.WORKFLOW).equals("Value2") || + !getUserContent("ContentTest", Scope.TASK).equals("Value3")) { + return new TaskResult(TaskResult.Status.FAILED, null); + } + + return new TaskResult(TaskResult.Status.COMPLETED, null); + } + } +</code></pre></div></section></section> + </main> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> +<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="https://helix.apache.org/1.0.3-docs/privacy-policy.html";>Privacy Policy</a> + </div> + </div> + </div> + </footer> +<script> + if(anchors) { + anchors.add(); + } +</script> + </body> +</html> \ No newline at end of file
