helix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ka...@apache.org
Subject [01/24] [HELIX-348] Simplify website layout
Date Thu, 02 Jan 2014 21:52:46 GMT
Updated Branches:
  refs/heads/master 2d78ba86a -> 439125ae3


http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/439125ae/website/trunk/src/site/markdown/tutorial_state.md
----------------------------------------------------------------------
diff --git a/website/trunk/src/site/markdown/tutorial_state.md b/website/trunk/src/site/markdown/tutorial_state.md
new file mode 100644
index 0000000..9fd0f9f
--- /dev/null
+++ b/website/trunk/src/site/markdown/tutorial_state.md
@@ -0,0 +1,133 @@
+<!---
+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.
+-->
+
+<head>
+  <title>Tutorial - State Machine Configuration</title>
+</head>
+
+## [Helix Tutorial](./Tutorial.html): State Machine Configuration
+
+In this chapter, we\'ll learn about the state models provided by Helix, and how to create
your own custom state model.
+
+### State Models
+
+Helix comes with 3 default state models that are commonly used.  It is possible to have multiple
state models in a cluster.
+Every resource that is added should be configured to use a state model that govern its _ideal
state_.
+
+#### MASTER-SLAVE
+
+* 3 states: OFFLINE, SLAVE, MASTER
+* Maximum number of masters: 1
+* Slaves are based on the replication factor. The replication factor can be specified while
adding the resource.
+
+
+#### ONLINE-OFFLINE
+
+* Has 2 states: OFFLINE and ONLINE.  This simple state model is a good starting point for
most applications.
+
+#### LEADER-STANDBY
+
+* 1 Leader and multiple stand-bys.  The idea is that exactly one leader accomplishes a designated
task, the stand-bys are ready to take over if the leader fails.
+
+### Constraints
+
+In addition to the state machine configuration, one can specify the constraints of states
and transitions.
+
+For example, one can say:
+
+* MASTER:1
+<br/>Maximum number of replicas in MASTER state at any time is 1
+
+* OFFLINE-SLAVE:5
+<br/>Maximum number of OFFLINE-SLAVE transitions that can happen concurrently in the
system is 5 in this example.
+
+#### Dynamic State Constraints
+
+We also support two dynamic upper bounds for the number of replicas in each state:
+
+* N: The number of replicas in the state is at most the number of live participants in the
cluster
+* R: The number of replicas in the state is at most the specified replica count for the partition
+
+#### State Priority
+
+Helix uses a greedy approach to satisfy the state constraints. For example, if the state
machine configuration says it needs 1 MASTER and 2 SLAVES, but only 1 node is active, Helix
must promote it to MASTER. This behavior is achieved by providing the state priority list
as \[MASTER, SLAVE\].
+
+#### State Transition Priority
+
+Helix tries to fire as many transitions as possible in parallel to reach the stable state
without violating constraints. By default, Helix simply sorts the transitions alphabetically
and fires as many as it can without violating the constraints. You can control this by overriding
the priority order.
+
+### Special States
+
+There are a few Helix-defined states that are important to be aware of.
+
+#### DROPPED
+
+The DROPPED state is used to signify a replica that was served by a given participant, but
is no longer served. This allows Helix and its participants to effectively clean up. There
are two requirements that every new state model should follow with respect to the DROPPED
state:
+
+* The DROPPED state must be defined
+* There must be a path to DROPPED for every state in the model
+
+#### ERROR
+
+The ERROR state is used whenever the participant serving a partition encountered an error
and cannot continue to serve the partition. HelixAdmin has \"reset\" functionality to allow
for participants to recover from the ERROR state.
+
+### Annotated Example
+
+Below is a complete definition of a Master-Slave state model. Notice the fields marked REQUIRED;
these are essential for any state model definition.
+
+```
+StateModelDefinition stateModel = new StateModelDefinition.Builder("MasterSlave")
+  // OFFLINE is the state that the system starts in (initial state is REQUIRED)
+  .initialState("OFFLINE")
+
+  // Lowest number here indicates highest priority, no value indicates lowest priority
+  .addState("MASTER", 1)
+  .addState("SLAVE", 2)
+  .addState("OFFLINE")
+
+  // Note the special inclusion of the DROPPED state (REQUIRED)
+  .addState(HelixDefinedState.DROPPED.toString())
+
+  // No more than one master allowed
+  .upperBound("MASTER", 1)
+
+  // R indicates an upper bound of number of replicas for each partition
+  .dynamicUpperBound("SLAVE", "R")
+
+  // Add some high-priority transitions
+  .addTransition("SLAVE", "MASTER", 1)
+  .addTransition("OFFLINE", "SLAVE", 2)
+
+  // Using the same priority value indicates that these transitions can fire in any order
+  .addTransition("MASTER", "SLAVE", 3)
+  .addTransition("SLAVE", "OFFLINE", 3)
+
+  // Not specifying a value defaults to lowest priority
+  // Notice the inclusion of the OFFLINE to DROPPED transition
+  // Since every state has a path to OFFLINE, they each now have a path to DROPPED (REQUIRED)
+  .addTransition("OFFLINE", HelixDefinedState.DROPPED.toString())
+
+  // Create the StateModelDefinition instance
+  .build();
+
+  // Use the isValid() function to make sure the StateModelDefinition will work without issues
+  Assert.assertTrue(stateModel.isValid());
+```
+
+

http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/439125ae/website/trunk/src/site/markdown/tutorial_throttling.md
----------------------------------------------------------------------
diff --git a/website/trunk/src/site/markdown/tutorial_throttling.md b/website/trunk/src/site/markdown/tutorial_throttling.md
new file mode 100644
index 0000000..16a6f81
--- /dev/null
+++ b/website/trunk/src/site/markdown/tutorial_throttling.md
@@ -0,0 +1,39 @@
+<!---
+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.
+-->
+
+<head>
+  <title>Tutorial - Throttling</title>
+</head>
+
+## [Helix Tutorial](./Tutorial.html): Throttling
+
+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.
+
+### Throttling
+
+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.
+
+Helix allows applications to set a threshold on transitions. The threshold can be set at
multiple scopes:
+
+* MessageType e.g STATE_TRANSITION
+* TransitionType e.g SLAVE-MASTER
+* Resource e.g database
+* Node i.e per-node maximum transitions in parallel
+
+

http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/439125ae/website/trunk/src/site/markdown/tutorial_user_def_rebalancer.md
----------------------------------------------------------------------
diff --git a/website/trunk/src/site/markdown/tutorial_user_def_rebalancer.md b/website/trunk/src/site/markdown/tutorial_user_def_rebalancer.md
new file mode 100644
index 0000000..551f2ec
--- /dev/null
+++ b/website/trunk/src/site/markdown/tutorial_user_def_rebalancer.md
@@ -0,0 +1,233 @@
+<!---
+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.
+-->
+
+<head>
+  <title>Tutorial - User-Defined Rebalancing</title>
+</head>
+
+## [Helix Tutorial](./Tutorial.html): User-Defined Rebalancing
+
+Even though Helix can compute both the location and the state of replicas internally using
a default fully-automatic rebalancer, specific applications may require rebalancing strategies
that optimize for different requirements. Thus, Helix allows applications to plug in arbitrary
rebalancer algorithms that implement a provided interface. One of the main design goals of
Helix is to provide maximum flexibility to any distributed application. Thus, it allows applications
to fully implement the rebalancer, which is the core constraint solver in the system, if the
application developer so chooses.
+
+Whenever the state of the cluster changes, as is the case when participants join or leave
the cluster, Helix automatically calls the rebalancer to compute a new mapping of all the
replicas in the resource. When using a pluggable rebalancer, the only required step is to
register it with Helix. Subsequently, no additional bootstrapping steps are necessary. Helix
uses reflection to look up and load the class dynamically at runtime. As a result, it is also
technically possible to change the rebalancing strategy used at any time.
+
+The [HelixRebalancer](http://helix.incubator.apache.org/apidocs/reference/org/apache/helix/controller/rebalancer/HelixRebalancer.html)
interface is as follows:
+
+```
+public void init(HelixManager helixManager, ControllerContextProvider contextProvider);
+
+public ResourceAssignment computeResourceMapping(RebalancerConfig rebalancerConfig, Cluster
cluster,
+    ResourceCurrentState currentState);
+```
+The `init` method is called exactly once per resource, and allows the rebalancer to save
the connection and a class that can persist and retrieve arbitrary contexts across controller
pipeline runs.
+
+The first parameter is a configuration of the resource to rebalance, the second is a full
cache of all of the cluster data available to Helix, and the third is a snapshot of the actual
current placements and state assignments. From the cluster variable, it is also possible to
access the ResourceAssignment last generated by this rebalancer. Internally, Helix implements
the same interface for its own rebalancing routines, so a user-defined rebalancer will be
cognizant of the same information about the cluster as an internal implementation. Helix strives
to provide applications the ability to implement algorithms that may require a large portion
of the entire state of the cluster to make the best placement and state assignment decisions
possible.
+
+A ResourceAssignment is a full representation of the location and the state of each replica
of each partition of a given resource. This is a simple representation of the placement that
the algorithm believes is the best possible. If the placement meets all defined constraints,
this is what will become the actual state of the distributed system.
+
+### Rebalancer Config
+
+Helix provides an interface called [RebalancerConfig](http://helix.incubator.apache.org/apidocs/reference/org/apache/helix/controller/rebalancer/config/RebalancerConfig.html).
For each of the four main [rebalancing modes](./tutorial_rebalance.html), there is a base
class called [PartitionedRebalancerConfig](http://helix.incubator.apache.org/apidocs/reference/org/apache/helix/controller/rebalancer/config/PartitionedRebalancerConfig.html),
which contains all of the basic properties required for a partitioned resource. Helix provides
three derived classes for PartitionedRebalancerConfig: FullAutoRebalancerConfig, SemiAutoRebalancerConfig,
and CustomizedRebalancerConfig. If none of these work for your application, you can create
your own class that derives PartiitonedRebalancerConfig (or even only implements RebalancerConfig).
+
+### Specifying a Rebalancer
+
+#### Using Logical Accessors
+To specify the rebalancer, one can use ```PartitionedRebalancerConfig#setRebalancerRef(RebalancerRef)```
to specify the specific implementation of the rebalancerClass. For example, here's a base
constructed PartitionedRebalancerConfig with a user-specified class:
+
+```
+RebalancerRef rebalancerRef = RebalancerRef.from(className);
+PartitionedRebalancerConfig rebalanceConfig =
+    new PartitionedRebalancerConfig.Builder(resourceId).replicaCount(1).addPartition(partition1)
+        .addPartition(partition2).stateModelDefId(stateModelDef.getStateModelDefId())
+        .rebalancerRef(rebalancerRef).build();
+```
+
+The class name is a fully-qualified class name consisting of its package and its name, and
the class should implement the Rebalancer interface. Now, the config can be added to a ResourceConfig
through ```ResourceConfig.Builder#rebalancerConfig(RebalancerConfig)``` and the config will
automatically be made available to the rebalancer for all subsequent executions.
+
+#### Using HelixAdmin
+For implementations that set up the cluster through existing code, the following HelixAdmin
calls will update the Rebalancer class:
+
+```
+IdealState idealState = helixAdmin.getResourceIdealState(clusterName, resourceName);
+idealState.setRebalanceMode(RebalanceMode.USER_DEFINED);
+idealState.setRebalancerClassName(className);
+helixAdmin.setResourceIdealState(clusterName, resourceName, idealState);
+```
+There are two key fields to set to specify that a pluggable rebalancer should be used. First,
the rebalance mode should be set to USER_DEFINED, and second the rebalancer class name should
be set to a class that implements Rebalancer and is within the scope of the project. The class
name is a fully-qualified class name consisting of its package and its name.
+
+#### Using YAML
+Alternatively, the rebalancer class name can be specified in a YAML file representing the
cluster configuration. The requirements are the same, but the representation is more compact.
Below are the first few lines of an example YAML file. To see a full YAML specification, see
the [YAML tutorial](./tutorial_yaml.html).
+
+```
+clusterName: lock-manager-custom-rebalancer # unique name for the cluster
+resources:
+  - name: lock-group # unique resource name
+    rebalancer: # we will provide our own rebalancer
+      mode: USER_DEFINED
+      class: domain.project.helix.rebalancer.UserDefinedRebalancerClass
+...
+```
+
+### Example
+We demonstrate plugging in a simple user-defined rebalancer as part of a revisit of the [distributed
lock manager](./recipes/user_def_rebalancer.html) example. It includes a functional Rebalancer
implementation, as well as the entire YAML file used to define the cluster.
+
+Consider the case where partitions are locks in a lock manager and 6 locks are to be distributed
evenly to a set of participants, and only one participant can hold each lock. We can define
a rebalancing algorithm that simply takes the modulus of the lock number and the number of
participants to evenly distribute the locks across participants. Helix allows capping the
number of partitions a participant can accept, but since locks are lightweight, we do not
need to define a restriction in this case. The following is a succinct implementation of this
algorithm.
+
+```
+@Override
+public void init(HelixManager manager, ControllerContextProvider contextProvider) {
+  // do nothing; this rebalancer is independent of the manager
+}
+
+@Override
+public ResourceAssignment computeResourceMapping(RebalancerConfig rebalancerConfig,
+    ResourceAssignment prevAssignment, Cluster cluster, ResourceCurrentState currentState)
{
+  // get a typed config
+  PartitionedRebalancerConfig config = PartitionedRebalancerConfig.from(rebalancerConfig);
+
+  // Initialize an empty mapping of locks to participants
+  ResourceAssignment assignment = new ResourceAssignment(config.getResourceId());
+
+  // Get the list of live participants in the cluster
+  List<ParticipantId> liveParticipants =
+      new ArrayList<ParticipantId>(cluster.getLiveParticipantMap().keySet());
+
+  // Get the state model (should be a simple lock/unlock model) and the highest-priority
state
+  StateModelDefId stateModelDefId = config.getStateModelDefId();
+  StateModelDefinition stateModelDef = cluster.getStateModelMap().get(stateModelDefId);
+  if (stateModelDef.getStatesPriorityList().size() < 1) {
+    LOG.error("Invalid state model definition. There should be at least one state.");
+    return assignment;
+  }
+  State lockState = stateModelDef.getTypedStatesPriorityList().get(0);
+
+  // Count the number of participants allowed to lock each lock
+  String stateCount = stateModelDef.getNumParticipantsPerState(lockState);
+  int lockHolders = 0;
+  try {
+    // a numeric value is a custom-specified number of participants allowed to lock the lock
+    lockHolders = Integer.parseInt(stateCount);
+  } catch (NumberFormatException e) {
+    LOG.error("Invalid state model definition. The lock state does not have a valid count");
+    return assignment;
+  }
+
+  // Fairly assign the lock state to the participants using a simple mod-based sequential
+  // assignment. For instance, if each lock can be held by 3 participants, lock 0 would be
held
+  // by participants (0, 1, 2), lock 1 would be held by (1, 2, 3), and so on, wrapping around
the
+  // number of participants as necessary.
+  // This assumes a simple lock-unlock model where the only state of interest is which nodes
have
+  // acquired each lock.
+  int i = 0;
+  for (PartitionId partition : config.getPartitionSet()) {
+    Map<ParticipantId, State> replicaMap = new HashMap<ParticipantId, State>();
+    for (int j = i; j < i + lockHolders; j++) {
+      int participantIndex = j % liveParticipants.size();
+      ParticipantId participant = liveParticipants.get(participantIndex);
+      // enforce that a participant can only have one instance of a given lock
+      if (!replicaMap.containsKey(participant)) {
+        replicaMap.put(participant, lockState);
+      }
+    }
+    assignment.addReplicaMap(partition, replicaMap);
+    i++;
+  }
+  return assignment;
+}
+```
+
+Here is the ResourceAssignment emitted by the user-defined rebalancer for a 3-participant
system whenever there is a change to the set of participants.
+
+* Participant_A joins
+
+```
+{
+  "lock_0": { "Participant_A": "LOCKED"},
+  "lock_1": { "Participant_A": "LOCKED"},
+  "lock_2": { "Participant_A": "LOCKED"},
+  "lock_3": { "Participant_A": "LOCKED"},
+  "lock_4": { "Participant_A": "LOCKED"},
+  "lock_5": { "Participant_A": "LOCKED"},
+}
+```
+
+A ResourceAssignment is a mapping for each resource of partition to the participant serving
each replica and the state of each replica. The state model is a simple LOCKED/RELEASED model,
so participant A holds all lock partitions in the LOCKED state.
+
+* Participant_B joins
+
+```
+{
+  "lock_0": { "Participant_A": "LOCKED"},
+  "lock_1": { "Participant_B": "LOCKED"},
+  "lock_2": { "Participant_A": "LOCKED"},
+  "lock_3": { "Participant_B": "LOCKED"},
+  "lock_4": { "Participant_A": "LOCKED"},
+  "lock_5": { "Participant_B": "LOCKED"},
+}
+```
+
+Now that there are two participants, the simple mod-based function assigns every other lock
to the second participant. On any system change, the rebalancer is invoked so that the application
can define how to redistribute its resources.
+
+* Participant_C joins (steady state)
+
+```
+{
+  "lock_0": { "Participant_A": "LOCKED"},
+  "lock_1": { "Participant_B": "LOCKED"},
+  "lock_2": { "Participant_C": "LOCKED"},
+  "lock_3": { "Participant_A": "LOCKED"},
+  "lock_4": { "Participant_B": "LOCKED"},
+  "lock_5": { "Participant_C": "LOCKED"},
+}
+```
+
+This is the steady state of the system. Notice that four of the six locks now have a different
owner. That is because of the naïve modulus-based assignmemt approach used by the user-defined
rebalancer. However, the interface is flexible enough to allow you to employ consistent hashing
or any other scheme if minimal movement is a system requirement.
+
+* Participant_B fails
+
+```
+{
+  "lock_0": { "Participant_A": "LOCKED"},
+  "lock_1": { "Participant_C": "LOCKED"},
+  "lock_2": { "Participant_A": "LOCKED"},
+  "lock_3": { "Participant_C": "LOCKED"},
+  "lock_4": { "Participant_A": "LOCKED"},
+  "lock_5": { "Participant_C": "LOCKED"},
+}
+```
+
+On any node failure, as in the case of node addition, the rebalancer is invoked automatically
so that it can generate a new mapping as a response to the change. Helix ensures that the
Rebalancer has the opportunity to reassign locks as required by the application.
+
+* Participant_B (or the replacement for the original Participant_B) rejoins
+
+```
+{
+  "lock_0": { "Participant_A": "LOCKED"},
+  "lock_1": { "Participant_B": "LOCKED"},
+  "lock_2": { "Participant_C": "LOCKED"},
+  "lock_3": { "Participant_A": "LOCKED"},
+  "lock_4": { "Participant_B": "LOCKED"},
+  "lock_5": { "Participant_C": "LOCKED"},
+}
+```
+
+The rebalancer was invoked once again and the resulting ResourceAssignment reflects the steady
state.
+
+### Caveats
+- The rebalancer class must be available at runtime, or else Helix will not attempt to rebalance
at all

http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/439125ae/website/trunk/src/site/markdown/tutorial_yaml.md
----------------------------------------------------------------------
diff --git a/website/trunk/src/site/markdown/tutorial_yaml.md b/website/trunk/src/site/markdown/tutorial_yaml.md
new file mode 100644
index 0000000..4660afa
--- /dev/null
+++ b/website/trunk/src/site/markdown/tutorial_yaml.md
@@ -0,0 +1,102 @@
+<!---
+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.
+-->
+
+<head>
+  <title>Tutorial - YAML Cluster Setup</title>
+</head>
+
+## [Helix Tutorial](./Tutorial.html): YAML Cluster Setup
+
+As an alternative to using Helix Admin to set up the cluster, its resources, constraints,
and the state model, Helix supports bootstrapping a cluster configuration based on a YAML
file. Below is an annotated example of such a file for a simple distributed lock manager where
a lock can only be LOCKED or RELEASED, and each lock only allows a single participant to hold
it in the LOCKED state.
+
+```
+clusterName: lock-manager-custom-rebalancer # unique name for the cluster (required)
+resources:
+  - name: lock-group # unique resource name (required)
+    rebalancer: # required
+      mode: USER_DEFINED # required - USER_DEFINED means we will provide our own rebalancer
+      class: org.apache.helix.userdefinedrebalancer.LockManagerRebalancer # required for
USER_DEFINED
+    partitions:
+      count: 12 # number of partitions for the resource (default is 1)
+      replicas: 1 # number of replicas per partition (default is 1)
+    stateModel:
+      name: lock-unlock # model name (required)
+      states: [LOCKED, RELEASED, DROPPED] # the list of possible states (required if model
not built-in)
+      transitions: # the list of possible transitions (required if model not built-in)
+        - name: Unlock
+          from: LOCKED
+          to: RELEASED
+        - name: Lock
+          from: RELEASED
+          to: LOCKED
+        - name: DropLock
+          from: LOCKED
+          to: DROPPED
+        - name: DropUnlock
+          from: RELEASED
+          to: DROPPED
+        - name: Undrop
+          from: DROPPED
+          to: RELEASED
+      initialState: RELEASED # (required if model not built-in)
+    constraints:
+      state:
+        counts: # maximum number of replicas of a partition that can be in each state (required
if model not built-in)
+          - name: LOCKED
+            count: "1"
+          - name: RELEASED
+            count: "-1"
+          - name: DROPPED
+            count: "-1"
+        priorityList: [LOCKED, RELEASED, DROPPED] # states in order of priority (all priorities
equal if not specified)
+      transition: # transitions priority to enforce order that transitions occur
+        priorityList: [Unlock, Lock, Undrop, DropUnlock, DropLock] # all priorities equal
if not specified
+participants: # list of nodes that can serve replicas (optional if dynamic joining is active,
required otherwise)
+  - name: localhost_12001
+    host: localhost
+    port: 12001
+  - name: localhost_12002
+    host: localhost
+    port: 12002
+  - name: localhost_12003
+    host: localhost
+    port: 12003
+```
+
+Using a file like the one above, the cluster can be set up either with the command line:
+
+```
+incubator-helix/helix-core/target/helix-core/pkg/bin/YAMLClusterSetup.sh localhost:2199 lock-manager-config.yaml
+```
+
+or with code:
+
+```
+YAMLClusterSetup setup = new YAMLClusterSetup(zkAddress);
+InputStream input =
+    Thread.currentThread().getContextClassLoader()
+        .getResourceAsStream("lock-manager-config.yaml");
+YAMLClusterSetup.YAMLClusterConfig config = setup.setupCluster(input);
+```
+
+Some notes:
+
+- A rebalancer class is only required for the USER_DEFINED mode. It is ignored otherwise.
+
+- Built-in state models, like OnlineOffline, LeaderStandby, and MasterSlave, or state models
that have already been added only require a name for stateModel. If partition and/or replica
counts are not provided, a value of 1 is assumed.

http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/439125ae/website/trunk/src/site/resources/.htaccess
----------------------------------------------------------------------
diff --git a/website/trunk/src/site/resources/.htaccess b/website/trunk/src/site/resources/.htaccess
new file mode 100644
index 0000000..d5c7bf3
--- /dev/null
+++ b/website/trunk/src/site/resources/.htaccess
@@ -0,0 +1,20 @@
+#
+# 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.
+#
+
+Redirect /download.html /download.cgi

http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/439125ae/website/trunk/src/site/resources/download.cgi
----------------------------------------------------------------------
diff --git a/website/trunk/src/site/resources/download.cgi b/website/trunk/src/site/resources/download.cgi
new file mode 100644
index 0000000..f9a0e30
--- /dev/null
+++ b/website/trunk/src/site/resources/download.cgi
@@ -0,0 +1,22 @@
+#!/bin/sh
+# Just call the standard mirrors.cgi script. It will use download.html
+# as the input template.
+#
+# 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.
+#
+exec /www/www.apache.org/dyn/mirrors/mirrors.cgi $*

http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/439125ae/website/trunk/src/site/resources/images/PFS-Generic.png
----------------------------------------------------------------------
diff --git a/website/trunk/src/site/resources/images/PFS-Generic.png b/website/trunk/src/site/resources/images/PFS-Generic.png
new file mode 100644
index 0000000..7eea3a0
Binary files /dev/null and b/website/trunk/src/site/resources/images/PFS-Generic.png differ

http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/439125ae/website/trunk/src/site/resources/images/RSYNC_BASED_PFS.png
----------------------------------------------------------------------
diff --git a/website/trunk/src/site/resources/images/RSYNC_BASED_PFS.png b/website/trunk/src/site/resources/images/RSYNC_BASED_PFS.png
new file mode 100644
index 0000000..0cc55ae
Binary files /dev/null and b/website/trunk/src/site/resources/images/RSYNC_BASED_PFS.png differ

http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/439125ae/website/trunk/src/site/site.xml
----------------------------------------------------------------------
diff --git a/website/trunk/src/site/site.xml b/website/trunk/src/site/site.xml
new file mode 100644
index 0000000..c6e1743
--- /dev/null
+++ b/website/trunk/src/site/site.xml
@@ -0,0 +1,139 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+  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.
+-->
+<project name="Apache Helix">
+  <bannerLeft>
+    <src>../images/helix-logo.jpg</src>
+    <href>http://helix.incubator.apache.org/</href>
+  </bannerLeft>
+  <bannerRight>
+    <src>../images/feather_small.gif</src>
+    <href>http://www.apache.org/</href>
+  </bannerRight>
+  <version position="none"/>
+
+  <publishDate position="right"/>
+
+  <skin>
+    <groupId>lt.velykis.maven.skins</groupId>
+    <artifactId>reflow-maven-skin</artifactId>
+    <version>1.0.0</version>
+  </skin>
+
+  <body>
+
+    <head>
+      <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>
+
+    <breadcrumbs position="left">
+      <item name="Apache Helix" href="http://helix.incubator.apache.org/"/>
+      <item name="trunk" href="http://helix.incubator.apache.org/trunk-docs/"/>
+    </breadcrumbs>
+
+    <links>
+      <item name="Helix trunk" href="./index.html"/>
+    </links>
+
+    <menu name="Get Helix">
+      <item name="Building" href="./Building.html"/>
+    </menu>
+
+    <menu name="Hands-On">
+      <item name="Quick Start" href="./Quickstart.html"/>
+      <item name="Tutorial" href="./Tutorial.html"/>
+      <item name="Javadocs" href="http://helix.incubator.apache.org/apidocs"/>
+    </menu>
+
+    <menu name="Recipes">
+      <item name="Distributed lock manager" href="./recipes/lock_manager.html"/>
+      <item name="Rabbit MQ consumer group" href="./recipes/rabbitmq_consumer_group.html"/>
+      <item name="Rsync replicated file store" href="./recipes/rsync_replicated_file_store.html"/>
+      <item name="Service Discovery" href="./recipes/service_discovery.html"/>
+      <item name="Distributed task DAG Execution" href="./recipes/task_dag_execution.html"/>
+      <item name="User-defined rebalancer" href="./recipes/user_def_rebalancer.html"/>
+    </menu>
+<!--
+    <menu ref="reports" inherit="bottom"/>
+    <menu ref="modules" inherit="bottom"/>
+
+
+    <menu name="ASF">
+      <item name="How Apache Works" href="http://www.apache.org/foundation/how-it-works.html"/>
+      <item name="Foundation" href="http://www.apache.org/foundation/"/>
+      <item name="Sponsoring Apache" href="http://www.apache.org/foundation/sponsorship.html"/>
+      <item name="Thanks" href="http://www.apache.org/foundation/thanks.html"/>
+    </menu>
+-->
+    <footer>
+      <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="${project.url}/privacy-policy.html">Privacy Policy</a>
+      </div>
+    </footer>
+
+
+  </body>
+
+  <custom>
+    <reflowSkin>
+      <theme>default</theme>
+      <highlightJs>false</highlightJs>
+      <brand>
+        <name>Apache Helix</name>
+        <href>http://helix.incubator.apache.org</href>
+      </brand>
+      <slogan>A cluster management framework for partitioned and replicated distributed
resources</slogan>
+      <bottomNav>
+        <column>Get Helix</column>
+        <column>Hands-On</column>
+        <column>Recipes</column>
+      </bottomNav>
+      <pages>
+        <index>
+          <sections>
+            <columns>3</columns>
+          </sections>
+        </index>
+      </pages>
+    </reflowSkin>
+    <!--fluidoSkin>
+      <topBarEnabled>true</topBarEnabled>
+      <sideBarEnabled>true</sideBarEnabled>
+      <googleSearch></googleSearch>
+      <twitter>
+        <user>ApacheHelix</user>
+        <showUser>true</showUser>
+        <showFollowers>false</showFollowers>
+      </twitter>
+    </fluidoSkin-->
+  </custom>
+
+</project>

http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/439125ae/website/trunk/src/site/xdoc/download.xml.vm
----------------------------------------------------------------------
diff --git a/website/trunk/src/site/xdoc/download.xml.vm b/website/trunk/src/site/xdoc/download.xml.vm
new file mode 100644
index 0000000..2a4d76e
--- /dev/null
+++ b/website/trunk/src/site/xdoc/download.xml.vm
@@ -0,0 +1,193 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+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.
+
+-->
+#set( $releaseName = "0.7.1" )
+#set( $releaseDate = "TBA" )
+<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+
+  <properties>
+    <title>Apache Helix Downloads</title>
+    <author email="dev@helix.incubator.apache.org">Apache Helix Documentation Team</author>
+  </properties>
+
+  <body>
+    <div class="toc_container">
+      <macro name="toc">
+        <param name="class" value="toc"/>
+      </macro>
+    </div>
+
+    <section name="Introduction">
+      <p>Apache Helix artifacts are distributed in source and binary form under the
terms of the
+        <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version
2.0</a>.
+        See the included <tt>LICENSE</tt> and <tt>NOTICE</tt> files
included in each artifact for additional license
+        information.
+      </p>
+      <p>Use the links below to download a source distribution of Apache Helix.
+      It is good practice to <a href="#Verifying_Releases">verify the integrity</a>
of the distribution files.</p>
+    </section>
+
+    <section name="Release">
+      <p>Release date: ${releaseDate} </p>
+      <p><a href="releasenotes/release-${releaseName}.html">${releaseName} Release
notes</a></p>
+      <a name="mirror"/>
+      <subsection name="Mirror">
+
+        <p>
+          [if-any logo]
+          <a href="[link]">
+            <img align="right" src="[logo]" border="0"
+                 alt="logo"/>
+          </a>
+          [end]
+          The currently selected mirror is
+          <b>[preferred]</b>.
+          If you encounter a problem with this mirror,
+          please select another mirror.
+          If all mirrors are failing, there are
+          <i>backup</i>
+          mirrors
+          (at the end of the mirrors list) that should be available.
+        </p>
+
+        <form action="[location]" method="get" id="SelectMirror" class="form-inline">
+          Other mirrors:
+          <select name="Preferred" class="input-xlarge">
+            [if-any http]
+            [for http]
+            <option value="[http]">[http]</option>
+            [end]
+            [end]
+            [if-any ftp]
+            [for ftp]
+            <option value="[ftp]">[ftp]</option>
+            [end]
+            [end]
+            [if-any backup]
+            [for backup]
+            <option value="[backup]">[backup] (backup)</option>
+            [end]
+            [end]
+          </select>
+          <input type="submit" value="Change" class="btn"/>
+        </form>
+
+        <p>
+          You may also consult the
+          <a href="http://www.apache.org/mirrors/">complete list of mirrors.</a>
+        </p>
+
+      </subsection>
+      <subsection name="${releaseName} Sources">
+        <table>
+          <thead>
+            <tr>
+              <th>Artifact</th>
+              <th>Signatures</th>
+            </tr>
+          </thead>
+          <tbody>
+            <tr>
+              <td>
+                <a href="[preferred]incubator/helix/${releaseName}/src/helix-${releaseName}-src.zip">helix-${releaseName}-src.zip</a>
+              </td>
+              <td>
+                <a href="http://www.apache.org/dist/incubator/helix/${releaseName}/src/helix-${releaseName}-src.zip.asc">asc</a>
+                <a href="http://www.apache.org/dist/incubator/helix/${releaseName}/src/helix-${releaseName}-src.zip.md5">md5</a>
+                <a href="http://www.apache.org/dist/incubator/helix/${releaseName}/src/helix-${releaseName}-src.zip.sha1">sha1</a>
+              </td>
+            </tr>
+          </tbody>
+        </table>
+      </subsection>
+      <subsection name="${releaseName} Binaries">
+        <table>
+          <thead>
+            <tr>
+              <th>Artifact</th>
+              <th>Signatures</th>
+            </tr>
+          </thead>
+          <tbody>
+            <tr>
+              <td>
+                <a href="[preferred]incubator/helix/${releaseName}/binaries/helix-core-${releaseName}-pkg.tar">helix-core-${releaseName}-pkg.tar</a>
+              </td>
+              <td>
+                <a href="http://www.apache.org/dist/incubator/helix/${releaseName}/binaries/helix-core-${releaseName}-pkg.tar.asc">asc</a>
+                <a href="http://www.apache.org/dist/incubator/helix/${releaseName}/binaries/helix-core-${releaseName}-pkg.tar.md5">md5</a>
+                <a href="http://www.apache.org/dist/incubator/helix/${releaseName}/binaries/helix-core-${releaseName}-pkg.tar.sha1">sha1</a>
+              </td>
+            </tr>
+            <tr>
+              <td>
+                <a href="[preferred]incubator/helix/${releaseName}/binaries/helix-admin-webapp-${releaseName}-pkg.tar">helix-admin-webapp-${releaseName}-pkg.tar</a>
+              </td>
+              <td>
+                <a href="http://www.apache.org/dist/incubator/helix/${releaseName}/binaries/helix-admin-webapp-${releaseName}-pkg.tar.asc">asc</a>
+                <a href="http://www.apache.org/dist/incubator/helix/${releaseName}/binaries/helix-admin-webapp-${releaseName}-pkg.tar.md5">md5</a>
+                <a href="http://www.apache.org/dist/incubator/helix/${releaseName}/binaries/helix-admin-webapp-${releaseName}-pkg.tar.sha1">sha1</a>
+              </td>
+            </tr>
+          </tbody>
+        </table>
+      </subsection>
+    </section>
+
+<!--    <section name="Older Releases">
+    </section>-->
+
+    <section name="Verifying Releases">
+      <p>We strongly recommend you verify the integrity of the downloaded files with
both PGP and MD5.</p>
+
+      <p>The PGP signatures can be verified using <a href="http://www.pgpi.org/">PGP</a>
or
+      <a href="http://www.gnupg.org/">GPG</a>.
+      First download the <a href="http://www.apache.org/dist/incubator/helix/KEYS">KEYS</a>
as well as the
+      <tt>*.asc</tt> signature file for the particular distribution. Make sure
you get these files from the main
+      distribution directory, rather than from a mirror. Then verify the signatures using
one of the following sets of
+      commands:
+
+        <source>$ pgp -ka KEYS
+$ pgp helix-*.zip.asc</source>
+
+        <source>$ gpg --import KEYS
+$ gpg --verify helix-*.zip.asc</source>
+       </p>
+    <p>Alternatively, you can verify the MD5 signature on the files. A Unix/Linux program
called
+      <code>md5</code> or
+      <code>md5sum</code> is included in most distributions.  It is also available
as part of
+      <a href="http://www.gnu.org/software/textutils/textutils.html">GNU Textutils</a>.
+      Windows users can get binary md5 programs from these (and likely other) places:
+      <ul>
+        <li>
+          <a href="http://www.md5summer.org/">http://www.md5summer.org/</a>
+        </li>
+        <li>
+          <a href="http://www.fourmilab.ch/md5/">http://www.fourmilab.ch/md5/</a>
+        </li>
+        <li>
+          <a href="http://www.pc-tools.net/win32/md5sums/">http://www.pc-tools.net/win32/md5sums/</a>
+        </li>
+      </ul>
+    </p>
+    </section>
+  </body>
+</document>

http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/439125ae/website/trunk/src/test/conf/testng.xml
----------------------------------------------------------------------
diff --git a/website/trunk/src/test/conf/testng.xml b/website/trunk/src/test/conf/testng.xml
new file mode 100644
index 0000000..58f0803
--- /dev/null
+++ b/website/trunk/src/test/conf/testng.xml
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+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.
+-->
+<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
+<suite name="Suite" parallel="none">
+  <test name="Test" preserve-order="false">
+    <packages>
+      <package name="org.apache.helix"/>
+    </packages>
+  </test>
+</suite>


Mime
View raw message