Repository: helix Updated Branches: refs/heads/master 2caac77f9 -> 7ee83899c
http://git-wip-us.apache.org/repos/asf/helix/blob/7ee83899/website/0.6.5/src/site/markdown/tutorial_state.md ---------------------------------------------------------------------- diff --git a/website/0.6.5/src/site/markdown/tutorial_state.md b/website/0.6.5/src/site/markdown/tutorial_state.md new file mode 100644 index 0000000..856b8b3 --- /dev/null +++ b/website/0.6.5/src/site/markdown/tutorial_state.md @@ -0,0 +1,131 @@ +<!--- +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/helix/blob/7ee83899/website/0.6.5/src/site/markdown/tutorial_throttling.md ---------------------------------------------------------------------- diff --git a/website/0.6.5/src/site/markdown/tutorial_throttling.md b/website/0.6.5/src/site/markdown/tutorial_throttling.md new file mode 100644 index 0000000..16a6f81 --- /dev/null +++ b/website/0.6.5/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/helix/blob/7ee83899/website/0.6.5/src/site/markdown/tutorial_user_def_rebalancer.md ---------------------------------------------------------------------- diff --git a/website/0.6.5/src/site/markdown/tutorial_user_def_rebalancer.md b/website/0.6.5/src/site/markdown/tutorial_user_def_rebalancer.md new file mode 100644 index 0000000..2149739 --- /dev/null +++ b/website/0.6.5/src/site/markdown/tutorial_user_def_rebalancer.md @@ -0,0 +1,172 @@ +<!--- +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 Rebalancer interface is as follows: + +``` +void init(HelixManager manager); + +IdealState computeNewIdealState(String resourceName, IdealState currentIdealState, + final CurrentStateOutput currentStateOutput, final ClusterDataCache clusterData); +``` +The first parameter is the resource to rebalance, the second is pre-existing ideal mappings, the third is a snapshot of the actual placements and state assignments, and the fourth is a full cache of all of the cluster data available to Helix. 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. + +An IdealState is a full representation of the location 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. + +### Specifying a Rebalancer +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. Without specification of the USER_DEFINED mode, the user-defined rebalancer class will not be used even if specified. Furthermore, Helix will not attempt to rebalance the resources through its standard routines if its mode is USER_DEFINED, regardless of whether or not a rebalancer class is registered. + +### Example + +In the next release (0.7.0), we will provide a full recipe of a user-defined rebalancer in action. + +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 +IdealState computeNewIdealState(String resourceName, IdealState currentIdealState, + final CurrentStateOutput currentStateOutput, final ClusterDataCache clusterData) { + // Get the list of live participants in the cluster + List<String> liveParticipants = new ArrayList<String>(clusterData.getLiveInstances().keySet()); + + // Count the number of participants allowed to lock each lock (in this example, this is 1) + int lockHolders = Integer.parseInt(currentIdealState.getReplicas()); + + // 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. + int i = 0; + for (String partition : currentIdealState.getPartitionSet()) { + List<String> preferenceList = new ArrayList<String>(); + for (int j = i; j < i + lockHolders; j++) { + int participantIndex = j % liveParticipants.size(); + String participant = liveParticipants.get(participantIndex); + // enforce that a participant can only have one instance of a given lock + if (!preferenceList.contains(participant)) { + preferenceList.add(participant); + } + } + currentIdealState.setPreferenceList(partition, preferenceList); + i++; + } + return assignment; +} +``` + +Here are the IdealState preference lists 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"], + "lock_1": ["Participant_A"], + "lock_2": ["Participant_A"], + "lock_3": ["Participant_A"], + "lock_4": ["Participant_A"], + "lock_5": ["Participant_A"], +} +``` + +A preference list is a mapping for each resource of partition to the participants serving 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"], + "lock_1": ["Participant_B"], + "lock_2": ["Participant_A"], + "lock_3": ["Participant_B"], + "lock_4": ["Participant_A"], + "lock_5": ["Participant_B"], +} +``` + +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"], + "lock_1": ["Participant_B"], + "lock_2": ["Participant_C"], + "lock_3": ["Participant_A"], + "lock_4": ["Participant_B"], + "lock_5": ["Participant_C"], +} +``` + +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"], + "lock_1": ["Participant_C"], + "lock_2": ["Participant_A"], + "lock_3": ["Participant_C"], + "lock_4": ["Participant_A"], + "lock_5": ["Participant_C"], +} +``` + +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"], + "lock_1": ["Participant_B"], + "lock_2": ["Participant_C"], + "lock_3": ["Participant_A"], + "lock_4": ["Participant_B"], + "lock_5": ["Participant_C"], +} +``` + +The rebalancer was invoked once again and the resulting IdealState preference lists reflect the steady state. + +### Caveats +- The rebalancer class must be available at runtime, or else Helix will not attempt to rebalance at all +- The Helix controller will only take into account the preference lists in the new IdealState for this release. In 0.7.0, Helix rebalancers will be able to compute the full resource assignment, including the states. +- Helix does not currently persist the new IdealState computed by the user-defined rebalancer. However, the Helix property store is available for saving any computed state. In 0.7.0, Helix will persist the result of running the rebalancer. http://git-wip-us.apache.org/repos/asf/helix/blob/7ee83899/website/0.6.5/src/site/markdown/tutorial_yaml.md ---------------------------------------------------------------------- diff --git a/website/0.6.5/src/site/markdown/tutorial_yaml.md b/website/0.6.5/src/site/markdown/tutorial_yaml.md new file mode 100644 index 0000000..1e4772e --- /dev/null +++ b/website/0.6.5/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: + +``` +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/helix/blob/7ee83899/website/0.6.5/src/site/resources/.htaccess ---------------------------------------------------------------------- diff --git a/website/0.6.5/src/site/resources/.htaccess b/website/0.6.5/src/site/resources/.htaccess new file mode 100644 index 0000000..d5c7bf3 --- /dev/null +++ b/website/0.6.5/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/helix/blob/7ee83899/website/0.6.5/src/site/resources/download.cgi ---------------------------------------------------------------------- diff --git a/website/0.6.5/src/site/resources/download.cgi b/website/0.6.5/src/site/resources/download.cgi new file mode 100644 index 0000000..f9a0e30 --- /dev/null +++ b/website/0.6.5/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/helix/blob/7ee83899/website/0.6.5/src/site/resources/images/PFS-Generic.png ---------------------------------------------------------------------- diff --git a/website/0.6.5/src/site/resources/images/PFS-Generic.png b/website/0.6.5/src/site/resources/images/PFS-Generic.png new file mode 100644 index 0000000..7eea3a0 Binary files /dev/null and b/website/0.6.5/src/site/resources/images/PFS-Generic.png differ http://git-wip-us.apache.org/repos/asf/helix/blob/7ee83899/website/0.6.5/src/site/resources/images/RSYNC_BASED_PFS.png ---------------------------------------------------------------------- diff --git a/website/0.6.5/src/site/resources/images/RSYNC_BASED_PFS.png b/website/0.6.5/src/site/resources/images/RSYNC_BASED_PFS.png new file mode 100644 index 0000000..0cc55ae Binary files /dev/null and b/website/0.6.5/src/site/resources/images/RSYNC_BASED_PFS.png differ http://git-wip-us.apache.org/repos/asf/helix/blob/7ee83899/website/0.6.5/src/site/site.xml ---------------------------------------------------------------------- diff --git a/website/0.6.5/src/site/site.xml b/website/0.6.5/src/site/site.xml new file mode 100644 index 0000000..9bfa91c --- /dev/null +++ b/website/0.6.5/src/site/site.xml @@ -0,0 +1,140 @@ +<?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.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.apache.org/"/> + <item name="Release 0.6.4" href="http://helix.apache.org/0.6.4-docs/"/> + </breadcrumbs> + + <links> + <item name="Helix 0.6.4" href="./index.html"/> + </links> + + <menu name="Get Helix"> + <item name="Download" href="./download.html"/> + <item name="Building" href="./Building.html"/> + <item name="Release Notes" href="./releasenotes/release-0.6.4.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.apache.org/javadocs/0.6.4"/> + </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"/> + </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.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/helix/blob/7ee83899/website/0.6.5/src/site/xdoc/download.xml.vm ---------------------------------------------------------------------- diff --git a/website/0.6.5/src/site/xdoc/download.xml.vm b/website/0.6.5/src/site/xdoc/download.xml.vm new file mode 100644 index 0000000..931387e --- /dev/null +++ b/website/0.6.5/src/site/xdoc/download.xml.vm @@ -0,0 +1,214 @@ +<?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.6.4" ) +#set( $releaseDate = "09/03/2014" ) +<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="[email protected]">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> + <th>Hashes</th> + </tr> + </thead> + <tbody> + <tr> + <td> + <a href="[preferred]helix/${releaseName}/src/helix-${releaseName}-src.zip">helix-${releaseName}-src.zip</a> + </td> + <td> + <a href="http://www.apache.org/dist/helix/${releaseName}/src/helix-${releaseName}-src.zip.asc";>asc</a> + </td> + <td> + <a href="http://www.apache.org/dist/helix/${releaseName}/src/helix-${releaseName}-src.zip.md5";>md5</a> + <a href="http://www.apache.org/dist/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> + <th>Hashes</th> + </tr> + </thead> + <tbody> + <tr> + <td> + <a href="[preferred]helix/${releaseName}/binaries/helix-core-${releaseName}-pkg.tar">helix-core-${releaseName}-pkg.tar</a> + </td> + <td> + <a href="http://www.apache.org/dist/helix/${releaseName}/binaries/helix-core-${releaseName}-pkg.tar.asc";>asc</a> + </td> + <td> + <a href="http://www.apache.org/dist/helix/${releaseName}/binaries/helix-core-${releaseName}-pkg.tar.md5";>md5</a> + <a href="http://www.apache.org/dist/helix/${releaseName}/binaries/helix-core-${releaseName}-pkg.tar.sha1";>sha1</a> + </td> + </tr> + <tr> + <td> + <a href="[preferred]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/helix/${releaseName}/binaries/helix-admin-webapp-${releaseName}-pkg.tar.asc";>asc</a> + </td> + <td> + <a href="http://www.apache.org/dist/helix/${releaseName}/binaries/helix-admin-webapp-${releaseName}-pkg.tar.md5";>md5</a> + <a href="http://www.apache.org/dist/helix/${releaseName}/binaries/helix-admin-webapp-${releaseName}-pkg.tar.sha1";>sha1</a> + </td> + </tr> + <tr> + <td> + <a href="[preferred]helix/${releaseName}/binaries/helix-agent-${releaseName}-pkg.tar">helix-agent-${releaseName}-pkg.tar</a> + </td> + <td> + <a href="http://www.apache.org/dist/helix/${releaseName}/binaries/helix-agent-${releaseName}-pkg.tar.asc";>asc</a> + </td> + <td> + <a href="http://www.apache.org/dist/helix/${releaseName}/binaries/helix-agent-${releaseName}-pkg.tar.md5";>md5</a> + <a href="http://www.apache.org/dist/helix/${releaseName}/binaries/helix-agent-${releaseName}-pkg.tar.sha1";>sha1</a> + </td> + </tr> + </tbody> + </table> + </subsection> + </section> + +<!-- <section name="Older Releases"> + </section>--> + + <section name="Verifying Releases"> + <p>It is essential that you verify the integrity of the downloaded file using the PGP signature (<tt>.asc</tt> file) or a hash (<tt>.md5</tt> or <tt>.sha1</tt> file). Please read <a href="http://www.apache.org/info/verification.html";>Verifying Apache Software Foundation Releases</a> for more information on why you should verify our releases.</p> + <p>The PGP signature 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 files for the relevant distribution. Make sure you get these files from the main distribution site, rather than from a mirror. Then verify the signatures using one of the following sets of commands: + + <source>% pgpk -a KEYS +% pgpv downloaded_file.asc</source> + + or<br/> + + <source>% pgp -ka KEYS +% pgp downloaded_file.asc</source> + + or<br/> + + <source>% gpg --import KEYS +% gpg --verify downloaded_file.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/helix/blob/7ee83899/website/0.6.5/src/test/conf/testng.xml ---------------------------------------------------------------------- diff --git a/website/0.6.5/src/test/conf/testng.xml b/website/0.6.5/src/test/conf/testng.xml new file mode 100644 index 0000000..58f0803 --- /dev/null +++ b/website/0.6.5/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> http://git-wip-us.apache.org/repos/asf/helix/blob/7ee83899/website/pom.xml ---------------------------------------------------------------------- diff --git a/website/pom.xml b/website/pom.xml index 00cb524..f696b3b 100644 --- a/website/pom.xml +++ b/website/pom.xml @@ -63,7 +63,7 @@ under the License. <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-site-plugin</artifactId> - <version>3.3</version> + <version>3.2</version> <dependencies> <dependency> <groupId>lt.velykis.maven.skins</groupId> http://git-wip-us.apache.org/repos/asf/helix/blob/7ee83899/website/src/site/apt/releasenotes/release-0.6.5.apt ---------------------------------------------------------------------- diff --git a/website/src/site/apt/releasenotes/release-0.6.5.apt b/website/src/site/apt/releasenotes/release-0.6.5.apt new file mode 100644 index 0000000..8ac6669 --- /dev/null +++ b/website/src/site/apt/releasenotes/release-0.6.5.apt @@ -0,0 +1,117 @@ + ----- + Release Notes for Apache Helix 0.6.5 + ----- + +~~ 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. + +~~ NOTE: For help with the syntax of this file, see: +~~ http://maven.apache.org/guides/mini/guide-apt-format.html + +Release Notes for Apache Helix 0.6.5 + + The Apache Helix team would like to announce the release of Apache Helix 0.6.5. + + This is the sixth release under the Apache umbrella, and the second as a top-level project. + + Helix is a generic cluster management framework used for the automatic management of partitioned, replicated and distributed resources hosted on a cluster of nodes. Helix provides the following features: + + * Automatic assignment of resource/partition to nodes + + * Node failure detection and recovery + + * Dynamic addition of Resources + + * Dynamic addition of nodes to the cluster + + * Pluggable distributed state machine to manage the state of a resource via state transitions + + * Automatic load balancing and throttling of transitions + + [] + +* Changes + +** Bug + + * [HELIX-512] - add back HelixManager#getHealthReportCollector() interface to 0.6.x + + * [HELIX-514] - ZkBaseDataAccessor#set() should throw BadVersionException instead of return false in case of version mismatch + + * [HELIX-518] - Add integration tests to ensure helix tasks work as expected during master failover + + * [HELIX-519] - Add integration tests to ensure that "kill-switch" for Helix tasks work as expected + + * [HELIX-521] - Should not start GenericHelixController#ClusterEventProcessor in types other than CONTROLLER and CONTROLLER_PARTICIPANT + + * [HELIX-537] - org.apache.helix.task.TaskStateModel should have a shutdown method. + + * [HELIX-541] - Possible "livelock" in Helix controller + + * [HELIX-547] - AutoRebalancer may not converge in some rare situation + + * [HELIX-549] - Discarding Throwable exceptions makes threads unkillable. + + * [HELIX-550] - ZKHelixManager does not shutdown GenericHelixController threads. + + * [HELIX-552] - StateModelFactory#_stateModelMap should use both resourceName and partitionKey to map a state model + + * [HELIX-555] - ClusterStateVerifier leaks ZkClients. + + * [HELIX-559] - Helix web admin performance issues + + * [HELIX-562] - TaskRebalancer doesn't honor MaxAttemptsPerTask when FailureThreshold is larger than 0 + + * [HELIX-563] - Throw more meaningful exceptions when AutoRebalanceStrategy#computePartitionAssignment inputs are invalid + + * [HELIX-572] - External view is recreated every time for bucketized resource + + * [HELIX-574] - fix bucketize resource bug in current state carryover + + * [HELIX-575] - Should not send FINALIZED callback when a bucketized resource is removed + + * [HELIX-579] - fix ivy files issue + +** Improvement + + * [HELIX-524] - add getProgress() to Task interface + + * [HELIX-570] - Add default state model definitions if not already exists when controller starts + + * [HELIX-573] - Add support to compress/uncompress data on ZK + + * [HELIX-576] - Make StateModelFactory change backward compatible + +** New Feature + + * [HELIX-546] - REST Admin APIs needed for helix job queue management + + * [HELIX-581] - Support deleting job from a job queue + +** Task + + * [HELIX-539] - Add ivy file for helix-agent + +** Test + + * [HELIX-580] - Fix test: TestBatchMessage#testSubMsgExecutionFail + +[] + +Cheers, +-- +The Apache Helix Team http://git-wip-us.apache.org/repos/asf/helix/blob/7ee83899/website/src/site/site.xml ---------------------------------------------------------------------- diff --git a/website/src/site/site.xml b/website/src/site/site.xml index 2de3a8d..60715d1 100644 --- a/website/src/site/site.xml +++ b/website/src/site/site.xml @@ -66,6 +66,7 @@ <menu name="Documentation"> <item name="0.6.4 (stable)" href="./0.6.4-docs/index.html"/> + <item name="0.6.5 (stable)" href="./0.6.5-docs/index.html"/> <item name="0.7.1 (beta)" href="./0.7.1-docs/index.html"/> <item name="0.6.3" href="./0.6.3-docs/index.html"/> <item name="0.7.0-incubating (alpha)" href="./0.7.0-incubating-docs/index.html"/> @@ -74,11 +75,11 @@ <item name="trunk" href="./trunk-docs/index.html"/> </menu> - <menu name="Helix 0.6.4"> - <item name="Documentation" href="./0.6.4-docs/index.html"/> - <item name="Quick Start" href="./0.6.4-docs/Quickstart.html"/> - <item name="Tutorial" href="./0.6.4-docs/Tutorial.html"/> - <item name="Download" href="./0.6.4-docs/download.html"/> + <menu name="Helix 0.6.5"> + <item name="Documentation" href="./0.6.5-docs/index.html"/> + <item name="Quick Start" href="./0.6.5-docs/Quickstart.html"/> + <item name="Tutorial" href="./0.6.5-docs/Tutorial.html"/> + <item name="Download" href="./0.6.5-docs/download.html"/> </menu> <menu name="Helix 0.7.1 (beta)"> @@ -142,7 +143,7 @@ <slogan>A cluster management framework for partitioned and replicated distributed resources</slogan> <bottomNav> <column>Learn</column> - <column>Documentation|Helix 0.6.4|Helix 0.7.1 (beta)</column> + <column>Documentation|Helix 0.6.5|Helix 0.7.1 (beta)</column> <column>Get Involved</column> <column>ASF</column> </bottomNav>
