You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@helix.apache.org by ka...@apache.org on 2013/11/16 03:32:00 UTC
[03/16] [HELIX-270] Include documentation for previous version on the
website
http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/150ce693/site-releases/trunk/src/site/xdoc/download.xml.vm
----------------------------------------------------------------------
diff --git a/site-releases/trunk/src/site/xdoc/download.xml.vm b/site-releases/trunk/src/site/xdoc/download.xml.vm
new file mode 100644
index 0000000..41355db
--- /dev/null
+++ b/site-releases/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.0-incubating" )
+#set( $releaseDate = "10/31/2013" )
+<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 Incubator 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/150ce693/site-releases/trunk/src/test/conf/testng.xml
----------------------------------------------------------------------
diff --git a/site-releases/trunk/src/test/conf/testng.xml b/site-releases/trunk/src/test/conf/testng.xml
new file mode 100644
index 0000000..58f0803
--- /dev/null
+++ b/site-releases/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>
http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/150ce693/src/site/apt/releasenotes/release-0.6.2-incubating.apt
----------------------------------------------------------------------
diff --git a/src/site/apt/releasenotes/release-0.6.2-incubating.apt b/src/site/apt/releasenotes/release-0.6.2-incubating.apt
new file mode 100644
index 0000000..51afc62
--- /dev/null
+++ b/src/site/apt/releasenotes/release-0.6.2-incubating.apt
@@ -0,0 +1,181 @@
+ -----
+ Release Notes for Apache Helix 0.6.2-incubating
+ -----
+
+~~ 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.2-incubating
+
+ The Apache Helix team would like to announce the release of Apache Helix 0.6.2-incubating
+
+ This is the third release under the Apache umbrella.
+
+ 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
+
+** Sub-task
+
+ * [HELIX-28] - ZkHelixManager.handleNewSession() can happen when a liveinstance already exists
+
+ * [HELIX-85] - Remove mock service module
+
+ * [HELIX-106] - Remove all string constants in the code
+
+ * [HELIX-107] - Add support to set custom objects into ZNRecord
+
+ * [HELIX-124] - race condition in ZkHelixManager.handleNewSession()
+
+ * [HELIX-165] - Add dependency for Guava libraries
+
+ * [HELIX-169] - Take care of consecutive handleNewSession() and session expiry during handleNewSession()
+
+ * [HELIX-170] - HelixManager#isLeader() should compare both instanceName and sessionId
+
+ * [HELIX-195] - Race condition between FINALIZE callbacks and Zk Callbacks
+
+ * [HELIX-207] - Add javadocs to classes and public methods in the top-level package
+
+ * [HELIX-208] - Add javadocs to classes and public methods in the model package
+
+ * [HELIX-277] - FULL_AUTO rebalancer should not prefer nodes that are just coming up
+
+** Bug
+
+ * [HELIX-7] - Tune test parameters to fix random test failures
+
+ * [HELIX-87] - Bad repository links in website
+
+ * [HELIX-117] - backward incompatibility problem in accessing zkPath vis HelixWebAdmin
+
+ * [HELIX-118] - PropertyStore -> HelixPropertyStore backwards incompatible location
+
+ * [HELIX-119] - HelixManager serializer no longer needs ByteArraySerializer for /PROPERTYSTORE
+
+ * [HELIX-129] - ZKDumper should use byte[] instead of String to read/write file/zk
+
+ * [HELIX-131] - Connection timeout not set while connecting to zookeeper via zkHelixAdmin
+
+ * [HELIX-133] - Cluster-admin command parsing does not work with removeConfig
+
+ * [HELIX-140] - In ClusterSetup.java, the removeConfig is wrong wired to getConfig
+
+ * [HELIX-141] - Autorebalance does not work reliably and fails when replica>1
+
+ * [HELIX-144] - Need to validate StateModelDefinition when adding new StateModelDefinition to Cluster
+
+ * [HELIX-147] - Fix typo in Idealstate property max_partitions_per_instance
+
+ * [HELIX-148] - Current preferred placement for auto rebalace is suboptimal for n > p
+
+ * [HELIX-150] - Auto rebalance might not evenly distribute states across nodes
+
+ * [HELIX-151] - Auto rebalance doesn't assign some replicas when other nodes could make room
+
+ * [HELIX-153] - Auto rebalance tester uses the returned map fields, but production uses only list fields
+
+ * [HELIX-155] - PropertyKey.instances() is wrongly wired to CONFIG type instead of INSTANCES type
+
+ * [HELIX-197] - state model leak
+
+ * [HELIX-199] - ZNRecord should not publish rawPayload unless it exists
+
+ * [HELIX-216] - Allow HelixAdmin addResource to accept the old rebalancing types
+
+ * [HELIX-221] - Can't find default error->dropped transition method using name convention
+
+ * [HELIX-257] - Upgrade Restlet to 2.1.4 - due security flaw
+
+ * [HELIX-258] - Upgrade Apache Camel due to CVE-2013-4330
+
+ * [HELIX-264] - fix zkclient#close() bug
+
+ * [HELIX-279] - Apply gc handling fixes to main ZKHelixManager class
+
+ * [HELIX-280] - Full auto rebalancer should check for resource tag first
+
+ * [HELIX-288] - helix-core uses an old version of guava
+
+ * [HELIX-299] - Some files in 0.6.2 are missing license headers
+
+** Improvement
+
+ * [HELIX-20] - AUTO-REBALANCE helix controller should re-assign disabled partitions on a node to other available nodes
+
+ * [HELIX-70] - Make Helix OSGi ready
+
+ * [HELIX-149] - Allow clients to pass in preferred placement strategies
+
+ * [HELIX-198] - Unify helix code style
+
+ * [HELIX-218] - Add a reviewboard submission script
+
+ * [HELIX-284] - Support participant auto join in YAML cluster setup
+
+** New Feature
+
+ * [HELIX-215] - Allow setting up the cluster with a YAML file
+
+** Task
+
+ * [HELIX-95] - Tracker for 0.6.2 release
+
+ * [HELIX-154] - Auto rebalance algorithm should not depend on state
+
+ * [HELIX-166] - Rename modes to auto, semi-auto, and custom
+
+ * [HELIX-173] - Move rebalancing strategies to separate classes that implement the Rebalancer interface
+
+ * [HELIX-188] - Add admin command line / REST API documentations
+
+ * [HELIX-194] - ZNRecord has too many constructors
+
+ * [HELIX-205] - Have user-defined rebalancers use RebalanceMode.USER_DEFINED
+
+ * [HELIX-210] - Add support to set data with expect version in BaseDataAccessor
+
+ * [HELIX-217] - Remove mock service module
+
+ * [HELIX-273] - Rebalancer interface should remain unchanged in 0.6.2
+
+ * [HELIX-274] - Verify FULL_AUTO tagged node behavior
+
+ * [HELIX-285] - add integration test util's
+
+ []
+
+ Cheers,
+ --
+ The Apache Helix Team
http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/150ce693/src/site/apt/releasenotes/release-0.7.0-incubating.apt
----------------------------------------------------------------------
diff --git a/src/site/apt/releasenotes/release-0.7.0-incubating.apt b/src/site/apt/releasenotes/release-0.7.0-incubating.apt
new file mode 100644
index 0000000..7661df0
--- /dev/null
+++ b/src/site/apt/releasenotes/release-0.7.0-incubating.apt
@@ -0,0 +1,174 @@
+ -----
+ Release Notes for Apache Helix 0.7.0-incubating
+ -----
+
+~~ 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.7.0-incubating
+
+ The Apache Helix team would like to announce the release of Apache Helix 0.7.0-incubating
+
+ This is the fourth release and second major release under the Apache umbrella.
+
+ 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
+
+ * Configurable, pluggable rebalancing
+
+ []
+
+* Changes
+
+** Sub-task
+
+ * [HELIX-18] - Unify cluster setup and helixadmin
+
+ * [HELIX-79] - consecutive GC may mess up helix session ids
+
+ * [HELIX-83] - Add typed classes to denote helix ids
+
+ * [HELIX-90] - Clean up Api's
+
+ * [HELIX-98] - clean up setting constraint api
+
+ * [HELIX-100] - Improve the helix config api
+
+ * [HELIX-102] - Add new wrapper classes for Participant, Controller, Spectator, Administrator
+
+ * [HELIX-104] - Add support to reuse zkclient
+
+ * [HELIX-123] - ZkHelixManager.isLeader() should check session id in addition to instance name
+
+ * [HELIX-139] - Need to double check the logic to prevent 2 controllers to control the same cluster
+
+ * [HELIX-168] - separate HelixManager implementation for participant, controller, and distributed controller
+
+ * [HELIX-176] - Need a list of tests that must pass to certify a release
+
+ * [HELIX-224] - Move helix examples to separate module
+
+ * [HELIX-233] - Ensure that website and wiki fully capture the updated changes in 0.7.0
+
+ * [HELIX-234] - Create concrete id classes for constructs, replacing strings
+
+ * [HELIX-235] - Create a hierarchical logical model for the cluster
+
+ * [HELIX-236] - Create a hierarchical cluster snapshot to replace ClusterDataCache
+
+ * [HELIX-237] - Create helix-internal config classes for the hierarchical model
+
+ * [HELIX-238] - Create accessors for the logical model
+
+ * [HELIX-239] - List use cases for the logical model
+
+ * [HELIX-240] - Write an example of the key use cases for the logical model
+
+ * [HELIX-241] - Write the controller pipeline with the logical model
+
+ * [HELIX-242] - Re-integrate the scheduler rebalancing into the new controller pipeline
+
+ * [HELIX-243] - Fix failing tests related to helix model overhaul
+
+ * [HELIX-244] - Redesign rebalancers using rebalancer-specific configs
+
+ * [HELIX-246] - Refactor scheduler task config to comply with new rebalancer config and fix related scheduler task tests
+
+ * [HELIX-248] - Resource logical model should be general enough to handle various resource types
+
+ * [HELIX-268] - Atomic API
+
+ * [HELIX-297] - Make 0.7.0 backward compatible for user-defined rebalancing
+
+
+** Bug
+
+ * [HELIX-40] - fix zkclient subscribe path leaking and zk callback-handler leaking in case of session expiry
+
+ * [HELIX-46] - Add REST/cli admin command for message selection constraints
+
+ * [HELIX-47] - when drop resource, remove resource-level config also
+
+ * [HELIX-48] - use resource instead of db in output messages
+
+ * [HELIX-50] - Ensure num replicas and preference list size in idealstate matches
+
+ * [HELIX-59] - controller not cleaning dead external view generated from old sessions
+
+ * [HELIX-136] - Write IdealState back to ZK when computed by custom Rebalancer
+
+ * [HELIX-200] - helix controller send ERROR->DROPPED transition infinitely
+
+ * [HELIX-214] - User-defined rebalancer should never use SEMI_AUTO code paths
+
+ * [HELIX-225] - fix helix-example package build error
+
+ * [HELIX-271] - ZkHelixAdmin#addResource() backward compatible problem
+
+ * [HELIX-292] - ZNRecordStreamingSerializer should not assume id comes first
+
+ * [HELIX-296] - HelixConnection in 0.7.0 does not remove LiveInstance znode
+
+ * [HELIX-300] - Some files in 0.7.0 are missing license headers
+
+ * [HELIX-302] - fix helix version compare bug
+
+** Improvement
+
+ * [HELIX-37] - Cleanup CallbackHandler
+
+ * [HELIX-202] - Ideal state should be a full mapping, not just a set of instance preferences
+
+** Task
+
+ * [HELIX-109] - Review Helix model package
+
+ * [HELIX-174] - Clean up ideal state calculators, move them to the controller rebalancer package
+
+ * [HELIX-212] - Rebalancer interface should have 1 function to compute the entire ideal state
+
+ * [HELIX-232] - Validation of 0.7.0
+
+ * [HELIX-290] - Ensure 0.7.0 can respond correctly to ideal state changes
+
+ * [HELIX-295] - Upgrade or remove xstream dependency
+
+ * [HELIX-301] - Update integration test utils for 0.7.0
+
+** Test
+
+ * [HELIX-286] - add a test for redefine state model definition
+
+ []
+
+ Cheers,
+ --
+ The Apache Helix Team
http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/150ce693/src/site/apt/releasing.apt
----------------------------------------------------------------------
diff --git a/src/site/apt/releasing.apt b/src/site/apt/releasing.apt
index 11d0cd9..9771ba6 100644
--- a/src/site/apt/releasing.apt
+++ b/src/site/apt/releasing.apt
@@ -52,12 +52,6 @@ Helix release process
You should have a GPG agent running in the session you will run the maven release commands(preferred), and confirm it works by running "gpg -ab" (type some text and press Ctrl-D).
If you do not have a GPG agent running, make sure that you have the "apache-release" profile set in your settings.xml as shown below.
- Run the release
-
-+-------------
-mvn release:prepare release:perform -B
-+-------------
-
GPG configuration in maven settings xml:
+-------------
@@ -69,17 +63,28 @@ mvn release:prepare release:perform -B
</profile>
+-------------
- [[4]] go to https://repository.apache.org and close your staged repository. Note the repository url (format https://repository.apache.org/content/repositories/orgapachehelix-019/org/apache/helix/helix/0.6-incubating/)
+ Run the release
+
++-------------
+mvn release:prepare
+mvn release:perform
++-------------
+
+ [[4]] go to https://repository.apache.org and close your staged repository. Log in, click on Staging Repositories, check your repository, and click Close. Note the repository url (format https://repository.apache.org/content/repositories/orgapachehelix-019/org/apache/helix/helix/0.6-incubating/)
+
+ [[5]] Stage the release (stagingRepoUrl format https://repository.apache.org/content/repositories/orgapachehelix-019/org/apache/helix/helix/0.6-incubating/)
+-------------
svn co https://dist.apache.org/repos/dist/dev/incubator/helix helix-dev-release
cd helix-dev-release
sh ./release-script-svn.sh version stagingRepoUrl
-then svn add <new directory created with new version as name>
-then svn ci
+svn add <new directory created with new version as name>
+gpg -k email@domain.com >> KEYS
+gpg --armor --export email@domain.com >> KEYS
+svn ci
+-------------
- [[5]] Validating the release
+ [[6]] Validating the release
+-------------
* Download sources, extract, build and run tests - mvn clean package
@@ -90,18 +95,38 @@ then svn ci
* Check signatures of all the binaries using gpg <binary>
+-------------
- [[6]] Call for a vote in the dev list and wait for 72 hrs. for the vote results. 3 binding votes are necessary for the release to be finalized. example
+ [[7]] Call for a vote in the dev list and wait for 72 hrs. for the vote results. 3 binding votes are necessary for the release to be finalized. example
After the vote has passed, move the files from dist dev to dist release: svn mv https://dist.apache.org/repos/dist/dev/incubator/helix/version to https://dist.apache.org/repos/dist/release/incubator/helix/
- [[7]] Prepare release note. Add a page in src/site/apt/releasenotes/ and change value of \<currentRelease> in parent pom.
++-------------
+Hi, I'd like to release Apache Helix [VERSION]-incubating.
+
+Release notes: http://helix.incubator.apache.org/releasenotes/release-[VERSION]-incubating.html
+
+Maven staged release repository: https://repository.apache.org/content/repositories/orgapachehelix-[NNN]/
+
+Distribution:
+* binaries: https://dist.apache.org/repos/dist/dev/incubator/helix/[VERSION]-incubating/binaries/
+* sources: https://dist.apache.org/repos/dist/dev/incubator/helix/[VERSION]-incubating/src/
+
+KEYS file available here: https://dist.apache.org/repos/dist/release/incubator/helix/KEYS
+
+Vote open for 72H
+
+[+1]
+[0]
+[-1]
++-------------
+
+ [[8]] Prepare release note. Add a page in src/site/apt/releasenotes/ and change value of \<currentRelease> in parent pom.
- [[8]] Send out an announcement of the release to:
+ [[9]] Send out an announcement of the release to:
- * users@helix.incubator.apache.org
+ * user@helix.incubator.apache.org
* dev@helix.incubator.apache.org
- [[9]] Celebrate !
+ [[10]] Celebrate!
http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/150ce693/src/site/markdown/Concepts.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/Concepts.md b/src/site/markdown/Concepts.md
index fa5d0ba..5bf42ac 100644
--- a/src/site/markdown/Concepts.md
+++ b/src/site/markdown/Concepts.md
@@ -260,7 +260,7 @@ The above steps happen for every change in the system. Once the current state ma
One of the things that makes Helix powerful is that IdealState can be changed dynamically. This means one can listen to cluster events like node failures and dynamically change the ideal state. Helix will then take care of triggering the respective transitions in the system.
-Helix comes with a few algorithms to automatically compute the IdealState based on the constraints. For example, if you have a resource of 3 partitions and 2 replicas, Helix can automatically compute the IdealState based on the nodes that are currently active. See the [tutorial](./tutorial_rebalance.html) to find out more about various execution modes of Helix like FULL_AUTO, SEMI_AUTO and CUSTOMIZED.
+Helix comes with a few algorithms to automatically compute the IdealState based on the constraints. For example, if you have a resource of 3 partitions and 2 replicas, Helix can automatically compute the IdealState based on the nodes that are currently active. See the [tutorial](./site-releases/0.7.0-incubating-site/tutorial_rebalance.html) to find out more about various execution modes of Helix like FULL_AUTO, SEMI_AUTO and CUSTOMIZED.
http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/150ce693/src/site/markdown/Features.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/Features.md b/src/site/markdown/Features.md
deleted file mode 100644
index ba9d0e7..0000000
--- a/src/site/markdown/Features.md
+++ /dev/null
@@ -1,313 +0,0 @@
-<!---
-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>Features</title>
-</head>
-
-Features
-----------------------------
-
-
-### CONFIGURING IDEALSTATE
-
-
-Read concepts page for definition of Idealstate.
-
-The placement of partitions in a DDS is very critical for reliability and scalability of the system.
-For example, when a node fails, it is important that the partitions hosted on that node are reallocated evenly among the remaining nodes. Consistent hashing is one such algorithm that can guarantee this.
-Helix by default comes with a variant of consistent hashing based of the RUSH algorithm.
-
-This means given a number of partitions, replicas and number of nodes Helix does the automatic assignment of partition to nodes such that
-
-* Each node has the same number of partitions and replicas of the same partition do not stay on the same node.
-* When a node fails, the partitions will be equally distributed among the remaining nodes
-* When new nodes are added, the number of partitions moved will be minimized along with satisfying the above two criteria.
-
-
-Helix provides multiple ways to control the placement and state of a replica.
-
-```
-
- |AUTO REBALANCE| AUTO | CUSTOM |
- -----------------------------------------
- LOCATION | HELIX | APP | APP |
- -----------------------------------------
- STATE | HELIX | HELIX | APP |
- -----------------------------------------
-```
-
-#### HELIX EXECUTION MODE
-
-
-Idealstate is defined as the state of the DDS when all nodes are up and running and healthy.
-Helix uses this as the target state of the system and computes the appropriate transitions needed in the system to bring it to a stable state.
-
-Helix supports 3 different execution modes which allows application to explicitly control the placement and state of the replica.
-
-##### AUTO_REBALANCE
-
-When the idealstate mode is set to AUTO_REBALANCE, Helix controls both the location of the replica along with the state. This option is useful for applications where creation of a replica is not expensive. Example
-
-```
-{
- "id" : "MyResource",
- "simpleFields" : {
- "IDEAL_STATE_MODE" : "AUTO_REBALANCE",
- "NUM_PARTITIONS" : "3",
- "REPLICAS" : "2",
- "STATE_MODEL_DEF_REF" : "MasterSlave",
- }
- "listFields" : {
- "MyResource_0" : [],
- "MyResource_1" : [],
- "MyResource_2" : []
- },
- "mapFields" : {
- }
-}
-```
-
-If there are 3 nodes in the cluster, then Helix will internally compute the ideal state as
-
-```
-{
- "id" : "MyResource",
- "simpleFields" : {
- "NUM_PARTITIONS" : "3",
- "REPLICAS" : "2",
- "STATE_MODEL_DEF_REF" : "MasterSlave",
- },
- "mapFields" : {
- "MyResource_0" : {
- "N1" : "MASTER",
- "N2" : "SLAVE",
- },
- "MyResource_1" : {
- "N2" : "MASTER",
- "N3" : "SLAVE",
- },
- "MyResource_2" : {
- "N3" : "MASTER",
- "N1" : "SLAVE",
- }
- }
-}
-```
-
-Another typical example is evenly distributing a group of tasks among the currently alive processes. For example, if there are 60 tasks and 4 nodes, Helix assigns 15 tasks to each node.
-When one node fails Helix redistributes its 15 tasks to the remaining 3 nodes. Similarly, if a node is added, Helix re-allocates 3 tasks from each of the 4 nodes to the 5th node.
-
-#### AUTO
-
-When the idealstate mode is set to AUTO, Helix only controls STATE of the replicas where as the location of the partition is controlled by application. Example: The below idealstate indicates thats 'MyResource_0' must be only on node1 and node2. But gives the control of assigning the STATE to Helix.
-
-```
-{
- "id" : "MyResource",
- "simpleFields" : {
- "IDEAL_STATE_MODE" : "AUTO",
- "NUM_PARTITIONS" : "3",
- "REPLICAS" : "2",
- "STATE_MODEL_DEF_REF" : "MasterSlave",
- }
- "listFields" : {
- "MyResource_0" : [node1, node2],
- "MyResource_1" : [node2, node3],
- "MyResource_2" : [node3, node1]
- },
- "mapFields" : {
- }
-}
-```
-In this mode when node1 fails, unlike in AUTO-REBALANCE mode the partition is not moved from node1 to others nodes in the cluster. Instead, Helix will decide to change the state of MyResource_0 in N2 based on the system constraints. For example, if a system constraint specified that there should be 1 Master and if the Master failed, then node2 will be made the new master.
-
-#### CUSTOM
-
-Helix offers a third mode called CUSTOM, in which application can completely control the placement and state of each replica. Applications will have to implement an interface that Helix will invoke when the cluster state changes.
-Within this callback, the application can recompute the idealstate. Helix will then issue appropriate transitions such that Idealstate and Currentstate converges.
-
-```
-{
- "id" : "MyResource",
- "simpleFields" : {
- "IDEAL_STATE_MODE" : "CUSTOM",
- "NUM_PARTITIONS" : "3",
- "REPLICAS" : "2",
- "STATE_MODEL_DEF_REF" : "MasterSlave",
- },
- "mapFields" : {
- "MyResource_0" : {
- "N1" : "MASTER",
- "N2" : "SLAVE",
- },
- "MyResource_1" : {
- "N2" : "MASTER",
- "N3" : "SLAVE",
- },
- "MyResource_2" : {
- "N3" : "MASTER",
- "N1" : "SLAVE",
- }
- }
-}
-```
-
-For example, the current state of the system might be 'MyResource_0' -> {N1:MASTER,N2:SLAVE} and the application changes the ideal state to 'MyResource_0' -> {N1:SLAVE,N2:MASTER}. Helix will not blindly issue MASTER-->SLAVE to N1 and SLAVE-->MASTER to N2 in parallel since it might result in a transient state where both N1 and N2 are masters.
-Helix will first issue MASTER-->SLAVE to N1 and after its completed it will issue SLAVE-->MASTER to N2.
-
-
-### State Machine Configuration
-
-Helix comes with 3 default state models that are most commonly used. Its possible to have multiple state models in a cluster.
-Every resource that is added should have a reference to the state model.
-
-* MASTER-SLAVE: Has 3 states OFFLINE,SLAVE,MASTER. Max masters is 1. Slaves will be based on the replication factor. Replication factor can be specified while adding the resource
-* ONLINE-OFFLINE: Has 2 states OFFLINE and ONLINE. Very simple state model and most applications start off with this state model.
-* LEADER-STANDBY:1 Leader and many stand bys. In general the standby's are idle.
-
-Apart from providing the state machine configuration, one can specify the constraints of states and transitions.
-
-For example one can say
-Master:1. Max number of replicas in Master state at any time is 1.
-OFFLINE-SLAVE:5 Max number of Offline-Slave transitions that can happen concurrently in the system
-
-STATE PRIORITY
-Helix uses 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.
-One can control this by overriding the priority order.
-
-### Config management
-
-Helix allows applications to store application specific properties. The configuration can have different scopes.
-
-* Cluster
-* Node specific
-* Resource specific
-* Partition specific
-
-Helix also provides notifications when any configs are changed. This allows applications to support dynamic configuration changes.
-
-See HelixManager.getConfigAccessor for more info
-
-### Intra cluster messaging api
-
-This is an interesting feature which is quite useful in practice. Often times, nodes in DDS requires a mechanism to interact with each other. One such requirement is a process of bootstrapping a replica.
-
-Consider a search system use case where the index replica starts up and it does not have an index. One of the commonly used solutions is to get the index from a common location or to copy the index from another replica.
-Helix provides a messaging api, that can be used to talk to other nodes in the system. The value added that Helix provides here is, message recipient can be specified in terms of resource,
-partition, state and Helix ensures that the message is delivered to all of the required recipients. In this particular use case, the instance can specify the recipient criteria as all replicas of P1.
-Since Helix is aware of the global state of the system, it can send the message to appropriate nodes. Once the nodes respond Helix provides the bootstrapping replica with all the responses.
-
-This is a very generic api and can also be used to schedule various periodic tasks in the cluster like data backups etc.
-System Admins can also perform adhoc tasks like on demand backup or execute a system command(like rm -rf ;-)) across all nodes.
-
-```
- ClusterMessagingService messagingService = manager.getMessagingService();
- //CONSTRUCT THE MESSAGE
- Message requestBackupUriRequest = new Message(
- MessageType.USER_DEFINE_MSG, UUID.randomUUID().toString());
- requestBackupUriRequest
- .setMsgSubType(BootstrapProcess.REQUEST_BOOTSTRAP_URL);
- requestBackupUriRequest.setMsgState(MessageState.NEW);
- //SET THE RECIPIENT CRITERIA, All nodes that satisfy the criteria will receive the message
- Criteria recipientCriteria = new Criteria();
- recipientCriteria.setInstanceName("%");
- recipientCriteria.setRecipientInstanceType(InstanceType.PARTICIPANT);
- recipientCriteria.setResource("MyDB");
- recipientCriteria.setPartition("");
- //Should be processed only the process that is active at the time of sending the message.
- //This means if the recipient is restarted after message is sent, it will not be processed.
- recipientCriteria.setSessionSpecific(true);
- // wait for 30 seconds
- int timeout = 30000;
- //The handler that will be invoked when any recipient responds to the message.
- BootstrapReplyHandler responseHandler = new BootstrapReplyHandler();
- //This will return only after all recipients respond or after timeout.
- int sentMessageCount = messagingService.sendAndWait(recipientCriteria,
- requestBackupUriRequest, responseHandler, timeout);
-```
-
-See HelixManager.getMessagingService for more info.
-
-
-### Application specific property storage
-
-There are several usecases where applications needs support for distributed data structures. Helix uses Zookeeper to store the application data and hence provides notifications when the data changes.
-One value add Helix provides is the ability to specify cache the data and also write through cache. This is more efficient than reading from ZK every time.
-
-See HelixManager.getHelixPropertyStore
-
-### 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 light weight but some might involve moving data around which is quite expensive.
-Helix allows applications to set threshold on transitions. The threshold can be set at the multiple scopes.
-
-* MessageType e.g STATE_TRANSITION
-* TransitionType e.g SLAVE-MASTER
-* Resource e.g database
-* Node i.e per node max transitions in parallel.
-
-See HelixManager.getHelixAdmin.addMessageConstraint()
-
-### Health monitoring and alerting
-
-This in currently in development mode, not yet productionized.
-
-Helix provides ability for each node in the system to report health metrics on a periodic basis.
-Helix supports multiple ways to aggregate these metrics like simple SUM, AVG, EXPONENTIAL DECAY, WINDOW. Helix will only persist the aggregated value.
-Applications can define threshold on the aggregate values according to the SLA's and when the SLA is violated Helix will fire an alert.
-Currently Helix only fires an alert but eventually we plan to use this metrics to either mark the node dead or load balance the partitions.
-This feature will be valuable in for distributed systems that support multi-tenancy and have huge variation in work load patterns. Another place this can be used is to detect skewed partitions and rebalance the cluster.
-
-This feature is not yet stable and do not recommend to be used in production.
-
-
-### Controller deployment modes
-
-Read Architecture wiki for more details on the Role of a controller. In simple words, it basically controls the participants in the cluster by issuing transitions.
-
-Helix provides multiple options to deploy the controller.
-
-#### STANDALONE
-
-Controller can be started as a separate process to manage a cluster. This is the recommended approach. How ever since one controller can be a single point of failure, multiple controller processes are required for reliability.
-Even if multiple controllers are running only one will be actively managing the cluster at any time and is decided by a leader election process. If the leader fails, another leader will resume managing the cluster.
-
-Even though we recommend this method of deployment, it has the drawback of having to manage an additional service for each cluster. See Controller As a Service option.
-
-#### EMBEDDED
-
-If setting up a separate controller process is not viable, then it is possible to embed the controller as a library in each of the participant.
-
-#### CONTROLLER AS A SERVICE
-
-One of the cool feature we added in helix was use a set of controllers to manage a large number of clusters.
-For example if you have X clusters to be managed, instead of deploying X*3(3 controllers for fault tolerance) controllers for each cluster, one can deploy only 3 controllers. Each controller can manage X/3 clusters.
-If any controller fails the remaining two will manage X/2 clusters. At LinkedIn, we always deploy controllers in this mode.
-
-
-
-
-
-
-
-
http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/150ce693/src/site/markdown/Publications.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/Publications.md b/src/site/markdown/Publications.md
new file mode 100644
index 0000000..e2f36b1
--- /dev/null
+++ b/src/site/markdown/Publications.md
@@ -0,0 +1,37 @@
+<!---
+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>Publications</title>
+</head>
+
+
+Publications
+-------------
+
+* Untangling cluster management using Helix at [SOCC Oct 2012](http://www.socc2012.org/home/program)
+ - [paper](https://915bbc94-a-62cb3a1a-s-sites.googlegroups.com/site/acm2012socc/helix_onecol.pdf)
+ - [presentation](http://www.slideshare.net/KishoreGopalakrishna/helix-socc-v10final)
+* Building distributed systems using Helix
+ - [presentation at RelateIQ](http://www.slideshare.net/KishoreGopalakrishna/helix-talk)
+ - [presentation at ApacheCon](http://www.slideshare.net/KishoreGopalakrishna/apache-con-buildingddsusinghelix)
+ - [presentation at VMWare](http://www.slideshare.net/KishoreGopalakrishna/apache-helix-presentation-at-vmware)
+* Data driven testing:
+ - [short talk at LSPE meetup](http://www.slideshare.net/KishoreGopalakrishna/data-driven-testing)
+ - [paper DBTest 2013 acm SIGMOD:will be published on Jun 24, 2013](http://dbtest2013.soe.ucsc.edu/Program.htm)
http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/150ce693/src/site/markdown/Quickstart.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/Quickstart.md b/src/site/markdown/Quickstart.md
deleted file mode 100644
index 4a5e83d..0000000
--- a/src/site/markdown/Quickstart.md
+++ /dev/null
@@ -1,626 +0,0 @@
-<!---
-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>Quickstart</title>
-</head>
-
-Get Helix
----------
-
-First, let\'s get Helix, either build it, or download.
-
-### Build
-
- git clone https://git-wip-us.apache.org/repos/asf/incubator-helix.git
- cd incubator-helix
- git checkout tags/helix-0.6.1-incubating
- ./build
- cd helix-core/target/helix-core-pkg/bin //This folder contains all the scripts used in following sections
- chmod +x *
-
-### Download
-
-Download the 0.6.1-incubating release package [here](./download.html)
-
-Overview
---------
-
-In this Quickstart, we\'ll set up a master-slave replicated, partitioned system. Then we\'ll demonstrate how to add a node, rebalance the partitions, and show how Helix manages failover.
-
-
-Let\'s Do It
-------------
-
-Helix provides command line interfaces to set up the cluster and view the cluster state. The best way to understand how Helix views a cluster is to build a cluster.
-
-#### First, get to the tools directory
-
-If you built the code
-
-```
-cd incubator-helix/helix-core/target/helix-core-pkg/bin
-```
-
-If you downloaded the release package, extract it.
-
-
-Short Version
--------------
-You can observe the components working together in this demo, which does the following:
-
-* Create a cluster
-* Add 2 nodes (participants) to the cluster
-* Set up a resource with 6 partitions and 2 replicas: 1 Master, and 1 Slave per partition
-* Show the cluster state after Helix balances the partitions
-* Add a third node
-* Show the cluster state. Note that the third node has taken mastership of 2 partitions.
-* Kill the third node (Helix takes care of failover)
-* Show the cluster state. Note that the two surviving nodes take over mastership of the partitions from the failed node
-
-##### Run the demo
-
-```
-cd incubator-helix/helix-core/target/helix-core-pkg/bin
-./quickstart.sh
-```
-
-##### 2 nodes are set up and the partitions rebalanced
-
-The cluster state is as follows:
-
-```
-CLUSTER STATE: After starting 2 nodes
- localhost_12000 localhost_12001
- MyResource_0 M S
- MyResource_1 S M
- MyResource_2 M S
- MyResource_3 M S
- MyResource_4 S M
- MyResource_5 S M
-```
-
-Note there is one master and one slave per partition.
-
-##### A third node is added and the cluster rebalanced
-
-The cluster state changes to:
-
-```
-CLUSTER STATE: After adding a third node
- localhost_12000 localhost_12001 localhost_12002
- MyResource_0 S M S
- MyResource_1 S S M
- MyResource_2 M S S
- MyResource_3 S S M
- MyResource_4 M S S
- MyResource_5 S M S
-```
-
-Note there is one master and _two_ slaves per partition. This is expected because there are three nodes.
-
-##### Finally, a node is killed to simulate a failure
-
-Helix makes sure each partition has a master. The cluster state changes to:
-
-```
-CLUSTER STATE: After the 3rd node stops/crashes
- localhost_12000 localhost_12001 localhost_12002
- MyResource_0 S M -
- MyResource_1 S M -
- MyResource_2 M S -
- MyResource_3 M S -
- MyResource_4 M S -
- MyResource_5 S M -
-```
-
-
-Long Version
-------------
-Now you can run the same steps by hand. In the detailed version, we\'ll do the following:
-
-* Define a cluster
-* Add two nodes to the cluster
-* Add a 6-partition resource with 1 master and 2 slave replicas per partition
-* Verify that the cluster is healthy and inspect the Helix view
-* Expand the cluster: add a few nodes and rebalance the partitions
-* Failover: stop a node and verify the mastership transfer
-
-### Install and Start Zookeeper
-
-Zookeeper can be started in standalone mode or replicated mode.
-
-More info is available at
-
-* http://zookeeper.apache.org/doc/r3.3.3/zookeeperStarted.html
-* http://zookeeper.apache.org/doc/trunk/zookeeperAdmin.html#sc_zkMulitServerSetup
-
-In this example, let\'s start zookeeper in local mode.
-
-##### start zookeeper locally on port 2199
-
- ./start-standalone-zookeeper.sh 2199 &
-
-### Define the Cluster
-
-The helix-admin tool is used for cluster administration tasks. In the Quickstart, we\'ll use the command line interface. Helix supports a REST interface as well.
-
-zookeeper_address is of the format host:port e.g localhost:2199 for standalone or host1:port,host2:port for multi-node.
-
-Next, we\'ll set up a cluster MYCLUSTER cluster with these attributes:
-
-* 3 instances running on localhost at ports 12913,12914,12915
-* One database named myDB with 6 partitions
-* Each partition will have 3 replicas with 1 master, 2 slaves
-* zookeeper running locally at localhost:2199
-
-##### Create the cluster MYCLUSTER
- ## helix-admin.sh --zkSvr <zk_address> --addCluster <clustername>
- ./helix-admin.sh --zkSvr localhost:2199 --addCluster MYCLUSTER
-
-##### Add nodes to the cluster
-
-In this case we\'ll add three nodes: localhost:12913, localhost:12914, localhost:12915
-
- ## helix-admin.sh --zkSvr <zk_address> --addNode <clustername> <host:port>
- ./helix-admin.sh --zkSvr localhost:2199 --addNode MYCLUSTER localhost:12913
- ./helix-admin.sh --zkSvr localhost:2199 --addNode MYCLUSTER localhost:12914
- ./helix-admin.sh --zkSvr localhost:2199 --addNode MYCLUSTER localhost:12915
-
-#### Define the resource and partitioning
-
-In this example, the resource is a database, partitioned 6 ways. (In a production system, it\'s common to over-partition for better load balancing. Helix has been used in production to manage hundreds of databases each with 10s or 100s of partitions running on 10s of physical nodes.)
-
-##### Create a database with 6 partitions using the MasterSlave state model.
-
-Helix ensures there will be exactly one master for each partition.
-
- ## helix-admin.sh --zkSvr <zk_address> --addResource <clustername> <resourceName> <numPartitions> <StateModelName>
- ./helix-admin.sh --zkSvr localhost:2199 --addResource MYCLUSTER myDB 6 MasterSlave
-
-##### Now we can let Helix assign partitions to nodes.
-
-This command will distribute the partitions amongst all the nodes in the cluster. In this example, each partition has 3 replicas.
-
- ## helix-admin.sh --zkSvr <zk_address> --rebalance <clustername> <resourceName> <replication factor>
- ./helix-admin.sh --zkSvr localhost:2199 --rebalance MYCLUSTER myDB 3
-
-Now the cluster is defined in Zookeeper. The nodes (localhost:12913, localhost:12914, localhost:12915) and resource (myDB, with 6 partitions using the MasterSlave model). And the _ideal state_ has been calculated, assuming a replication factor of 3.
-
-##### Start the Helix Controller
-
-Now that the cluster is defined in Zookeeper, the Helix controller can manage the cluster.
-
- ## Start the cluster manager, which will manage MYCLUSTER
- ./run-helix-controller.sh --zkSvr localhost:2199 --cluster MYCLUSTER 2>&1 > /tmp/controller.log &
-
-##### Start up the cluster to be managed
-
-We\'ve started up Zookeeper, defined the cluster, the resources, the partitioning, and started up the Helix controller. Next, we\'ll start up the nodes of the system to be managed. Each node is a Participant, which is an instance of the system component to be managed. Helix assigns work to Participants, keeps track of their roles and health, and takes action when a node fails.
-
- # start up each instance. These are mock implementations that are actively managed by Helix
- ./start-helix-participant.sh --zkSvr localhost:2199 --cluster MYCLUSTER --host localhost --port 12913 --stateModelType MasterSlave 2>&1 > /tmp/participant_12913.log
- ./start-helix-participant.sh --zkSvr localhost:2199 --cluster MYCLUSTER --host localhost --port 12914 --stateModelType MasterSlave 2>&1 > /tmp/participant_12914.log
- ./start-helix-participant.sh --zkSvr localhost:2199 --cluster MYCLUSTER --host localhost --port 12915 --stateModelType MasterSlave 2>&1 > /tmp/participant_12915.log
-
-
-#### Inspect the Cluster
-
-Now, let\'s see the Helix view of our cluster. We\'ll work our way down as follows:
-
-```
-Clusters -> MYCLUSTER -> instances -> instance detail
- -> resources -> resource detail
- -> partitions
-```
-
-A single Helix controller can manage multiple clusters, though so far, we\'ve only defined one cluster. Let\'s see:
-
-```
-## List existing clusters
-./helix-admin.sh --zkSvr localhost:2199 --listClusters
-
-Existing clusters:
-MYCLUSTER
-```
-
-Now, let\'s see the Helix view of MYCLUSTER
-
-```
-## helix-admin.sh --zkSvr <zk_address> --listClusterInfo <clusterName>
-./helix-admin.sh --zkSvr localhost:2199 --listClusterInfo MYCLUSTER
-
-Existing resources in cluster MYCLUSTER:
-myDB
-Instances in cluster MYCLUSTER:
-localhost_12915
-localhost_12914
-localhost_12913
-```
-
-
-Let\'s look at the details of an instance
-
-```
-## ./helix-admin.sh --zkSvr <zk_address> --listInstanceInfo <clusterName> <InstanceName>
-./helix-admin.sh --zkSvr localhost:2199 --listInstanceInfo MYCLUSTER localhost_12913
-
-InstanceConfig: {
- "id" : "localhost_12913",
- "mapFields" : {
- },
- "listFields" : {
- },
- "simpleFields" : {
- "HELIX_ENABLED" : "true",
- "HELIX_HOST" : "localhost",
- "HELIX_PORT" : "12913"
- }
-}
-```
-
-
-##### Query info of a resource
-
-```
-## helix-admin.sh --zkSvr <zk_address> --listResourceInfo <clusterName> <resourceName>
-./helix-admin.sh --zkSvr localhost:2199 --listResourceInfo MYCLUSTER myDB
-
-IdealState for myDB:
-{
- "id" : "myDB",
- "mapFields" : {
- "myDB_0" : {
- "localhost_12913" : "SLAVE",
- "localhost_12914" : "MASTER",
- "localhost_12915" : "SLAVE"
- },
- "myDB_1" : {
- "localhost_12913" : "SLAVE",
- "localhost_12914" : "SLAVE",
- "localhost_12915" : "MASTER"
- },
- "myDB_2" : {
- "localhost_12913" : "MASTER",
- "localhost_12914" : "SLAVE",
- "localhost_12915" : "SLAVE"
- },
- "myDB_3" : {
- "localhost_12913" : "SLAVE",
- "localhost_12914" : "SLAVE",
- "localhost_12915" : "MASTER"
- },
- "myDB_4" : {
- "localhost_12913" : "MASTER",
- "localhost_12914" : "SLAVE",
- "localhost_12915" : "SLAVE"
- },
- "myDB_5" : {
- "localhost_12913" : "SLAVE",
- "localhost_12914" : "MASTER",
- "localhost_12915" : "SLAVE"
- }
- },
- "listFields" : {
- "myDB_0" : [ "localhost_12914", "localhost_12913", "localhost_12915" ],
- "myDB_1" : [ "localhost_12915", "localhost_12913", "localhost_12914" ],
- "myDB_2" : [ "localhost_12913", "localhost_12915", "localhost_12914" ],
- "myDB_3" : [ "localhost_12915", "localhost_12913", "localhost_12914" ],
- "myDB_4" : [ "localhost_12913", "localhost_12914", "localhost_12915" ],
- "myDB_5" : [ "localhost_12914", "localhost_12915", "localhost_12913" ]
- },
- "simpleFields" : {
- "REBALANCE_MODE" : "SEMI_AUTO",
- "NUM_PARTITIONS" : "6",
- "REPLICAS" : "3",
- "STATE_MODEL_DEF_REF" : "MasterSlave",
- "STATE_MODEL_FACTORY_NAME" : "DEFAULT"
- }
-}
-
-ExternalView for myDB:
-{
- "id" : "myDB",
- "mapFields" : {
- "myDB_0" : {
- "localhost_12913" : "SLAVE",
- "localhost_12914" : "MASTER",
- "localhost_12915" : "SLAVE"
- },
- "myDB_1" : {
- "localhost_12913" : "SLAVE",
- "localhost_12914" : "SLAVE",
- "localhost_12915" : "MASTER"
- },
- "myDB_2" : {
- "localhost_12913" : "MASTER",
- "localhost_12914" : "SLAVE",
- "localhost_12915" : "SLAVE"
- },
- "myDB_3" : {
- "localhost_12913" : "SLAVE",
- "localhost_12914" : "SLAVE",
- "localhost_12915" : "MASTER"
- },
- "myDB_4" : {
- "localhost_12913" : "MASTER",
- "localhost_12914" : "SLAVE",
- "localhost_12915" : "SLAVE"
- },
- "myDB_5" : {
- "localhost_12913" : "SLAVE",
- "localhost_12914" : "MASTER",
- "localhost_12915" : "SLAVE"
- }
- },
- "listFields" : {
- },
- "simpleFields" : {
- "BUCKET_SIZE" : "0"
- }
-}
-```
-
-Now, let\'s look at one of the partitions:
-
- ## helix-admin.sh --zkSvr <zk_address> --listPartitionInfo <clusterName> <resource> <partition>
- ./helix-admin.sh --zkSvr localhost:2199 --listPartitionInfo MYCLUSTER myDB myDB_0
-
-#### Expand the Cluster
-
-Next, we\'ll show how Helix does the work that you\'d otherwise have to build into your system. When you add capacity to your cluster, you want the work to be evenly distributed. In this example, we started with 3 nodes, with 6 partitions. The partitions were evenly balanced, 2 masters and 4 slaves per node. Let\'s add 3 more nodes: localhost:12916, localhost:12917, localhost:12918
-
- ./helix-admin.sh --zkSvr localhost:2199 --addNode MYCLUSTER localhost:12916
- ./helix-admin.sh --zkSvr localhost:2199 --addNode MYCLUSTER localhost:12917
- ./helix-admin.sh --zkSvr localhost:2199 --addNode MYCLUSTER localhost:12918
-
-And start up these instances:
-
- # start up each instance. These are mock implementations that are actively managed by Helix
- ./start-helix-participant.sh --zkSvr localhost:2199 --cluster MYCLUSTER --host localhost --port 12916 --stateModelType MasterSlave 2>&1 > /tmp/participant_12916.log
- ./start-helix-participant.sh --zkSvr localhost:2199 --cluster MYCLUSTER --host localhost --port 12917 --stateModelType MasterSlave 2>&1 > /tmp/participant_12917.log
- ./start-helix-participant.sh --zkSvr localhost:2199 --cluster MYCLUSTER --host localhost --port 12918 --stateModelType MasterSlave 2>&1 > /tmp/participant_12918.log
-
-
-And now, let Helix do the work for you. To shift the work, simply rebalance. After the rebalance, each node will have one master and two slaves.
-
- ./helix-admin.sh --zkSvr localhost:2199 --rebalance MYCLUSTER myDB 3
-
-#### View the cluster
-
-OK, let\'s see how it looks:
-
-
-```
-./helix-admin.sh --zkSvr localhost:2199 --listResourceInfo MYCLUSTER myDB
-
-IdealState for myDB:
-{
- "id" : "myDB",
- "mapFields" : {
- "myDB_0" : {
- "localhost_12913" : "SLAVE",
- "localhost_12914" : "SLAVE",
- "localhost_12917" : "MASTER"
- },
- "myDB_1" : {
- "localhost_12916" : "SLAVE",
- "localhost_12917" : "SLAVE",
- "localhost_12918" : "MASTER"
- },
- "myDB_2" : {
- "localhost_12913" : "MASTER",
- "localhost_12917" : "SLAVE",
- "localhost_12918" : "SLAVE"
- },
- "myDB_3" : {
- "localhost_12915" : "MASTER",
- "localhost_12917" : "SLAVE",
- "localhost_12918" : "SLAVE"
- },
- "myDB_4" : {
- "localhost_12916" : "MASTER",
- "localhost_12917" : "SLAVE",
- "localhost_12918" : "SLAVE"
- },
- "myDB_5" : {
- "localhost_12913" : "SLAVE",
- "localhost_12914" : "MASTER",
- "localhost_12915" : "SLAVE"
- }
- },
- "listFields" : {
- "myDB_0" : [ "localhost_12917", "localhost_12913", "localhost_12914" ],
- "myDB_1" : [ "localhost_12918", "localhost_12917", "localhost_12916" ],
- "myDB_2" : [ "localhost_12913", "localhost_12917", "localhost_12918" ],
- "myDB_3" : [ "localhost_12915", "localhost_12917", "localhost_12918" ],
- "myDB_4" : [ "localhost_12916", "localhost_12917", "localhost_12918" ],
- "myDB_5" : [ "localhost_12914", "localhost_12915", "localhost_12913" ]
- },
- "simpleFields" : {
- "REBALANCE_MODE" : "SEMI_AUTO",
- "NUM_PARTITIONS" : "6",
- "REPLICAS" : "3",
- "STATE_MODEL_DEF_REF" : "MasterSlave",
- "STATE_MODEL_FACTORY_NAME" : "DEFAULT"
- }
-}
-
-ExternalView for myDB:
-{
- "id" : "myDB",
- "mapFields" : {
- "myDB_0" : {
- "localhost_12913" : "SLAVE",
- "localhost_12914" : "SLAVE",
- "localhost_12917" : "MASTER"
- },
- "myDB_1" : {
- "localhost_12916" : "SLAVE",
- "localhost_12917" : "SLAVE",
- "localhost_12918" : "MASTER"
- },
- "myDB_2" : {
- "localhost_12913" : "MASTER",
- "localhost_12917" : "SLAVE",
- "localhost_12918" : "SLAVE"
- },
- "myDB_3" : {
- "localhost_12915" : "MASTER",
- "localhost_12917" : "SLAVE",
- "localhost_12918" : "SLAVE"
- },
- "myDB_4" : {
- "localhost_12916" : "MASTER",
- "localhost_12917" : "SLAVE",
- "localhost_12918" : "SLAVE"
- },
- "myDB_5" : {
- "localhost_12913" : "SLAVE",
- "localhost_12914" : "MASTER",
- "localhost_12915" : "SLAVE"
- }
- },
- "listFields" : {
- },
- "simpleFields" : {
- "BUCKET_SIZE" : "0"
- }
-}
-```
-
-Mission accomplished. The partitions are nicely balanced.
-
-#### How about Failover?
-
-Building a fault tolerant system isn\'t trivial, but with Helix, it\'s easy. Helix detects a failed instance, and triggers mastership transfer automatically.
-
-First, let's fail an instance. In this example, we\'ll kill localhost:12918 to simulate a failure.
-
-We lost localhost:12918, so myDB_1 lost its MASTER. Helix can fix that, it will transfer mastership to a healthy node that is currently a SLAVE, say localhost:12197. Helix balances the load as best as it can, given there are 6 partitions on 5 nodes. Let\'s see:
-
-
-```
-./helix-admin.sh --zkSvr localhost:2199 --listResourceInfo MYCLUSTER myDB
-
-IdealState for myDB:
-{
- "id" : "myDB",
- "mapFields" : {
- "myDB_0" : {
- "localhost_12913" : "SLAVE",
- "localhost_12914" : "SLAVE",
- "localhost_12917" : "MASTER"
- },
- "myDB_1" : {
- "localhost_12916" : "SLAVE",
- "localhost_12917" : "SLAVE",
- "localhost_12918" : "MASTER"
- },
- "myDB_2" : {
- "localhost_12913" : "MASTER",
- "localhost_12917" : "SLAVE",
- "localhost_12918" : "SLAVE"
- },
- "myDB_3" : {
- "localhost_12915" : "MASTER",
- "localhost_12917" : "SLAVE",
- "localhost_12918" : "SLAVE"
- },
- "myDB_4" : {
- "localhost_12916" : "MASTER",
- "localhost_12917" : "SLAVE",
- "localhost_12918" : "SLAVE"
- },
- "myDB_5" : {
- "localhost_12913" : "SLAVE",
- "localhost_12914" : "MASTER",
- "localhost_12915" : "SLAVE"
- }
- },
- "listFields" : {
- "myDB_0" : [ "localhost_12917", "localhost_12913", "localhost_12914" ],
- "myDB_1" : [ "localhost_12918", "localhost_12917", "localhost_12916" ],
- "myDB_2" : [ "localhost_12913", "localhost_12918", "localhost_12917" ],
- "myDB_3" : [ "localhost_12915", "localhost_12918", "localhost_12917" ],
- "myDB_4" : [ "localhost_12916", "localhost_12917", "localhost_12918" ],
- "myDB_5" : [ "localhost_12914", "localhost_12915", "localhost_12913" ]
- },
- "simpleFields" : {
- "REBALANCE_MODE" : "SEMI_AUTO",
- "NUM_PARTITIONS" : "6",
- "REPLICAS" : "3",
- "STATE_MODEL_DEF_REF" : "MasterSlave",
- "STATE_MODEL_FACTORY_NAME" : "DEFAULT"
- }
-}
-
-ExternalView for myDB:
-{
- "id" : "myDB",
- "mapFields" : {
- "myDB_0" : {
- "localhost_12913" : "SLAVE",
- "localhost_12914" : "SLAVE",
- "localhost_12917" : "MASTER"
- },
- "myDB_1" : {
- "localhost_12916" : "SLAVE",
- "localhost_12917" : "MASTER"
- },
- "myDB_2" : {
- "localhost_12913" : "MASTER",
- "localhost_12917" : "SLAVE"
- },
- "myDB_3" : {
- "localhost_12915" : "MASTER",
- "localhost_12917" : "SLAVE"
- },
- "myDB_4" : {
- "localhost_12916" : "MASTER",
- "localhost_12917" : "SLAVE"
- },
- "myDB_5" : {
- "localhost_12913" : "SLAVE",
- "localhost_12914" : "MASTER",
- "localhost_12915" : "SLAVE"
- }
- },
- "listFields" : {
- },
- "simpleFields" : {
- "BUCKET_SIZE" : "0"
- }
-}
-```
-
-As we\'ve seen in this Quickstart, Helix takes care of partitioning, load balancing, elasticity, failure detection and recovery.
-
-##### ZooInspector
-
-You can view all of the underlying data by going direct to zookeeper. Use ZooInspector that comes with zookeeper to browse the data. This is a java applet (make sure you have X windows)
-
-To start zooinspector run the following command from <zk_install_directory>/contrib/ZooInspector
-
- java -cp zookeeper-3.3.3-ZooInspector.jar:lib/jtoaster-1.0.4.jar:../../lib/log4j-1.2.15.jar:../../zookeeper-3.3.3.jar org.apache.zookeeper.inspector.ZooInspector
-
-#### Next
-
-Now that you understand the idea of Helix, read the [tutorial](./tutorial.html) to learn how to choose the right state model and constraints for your system, and how to implement it. In many cases, the built-in features meet your requirements. And best of all, Helix is a customizable framework, so you can plug in your own behavior, while retaining the automation provided by Helix.
-
http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/150ce693/src/site/markdown/Tutorial.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/Tutorial.md b/src/site/markdown/Tutorial.md
deleted file mode 100644
index 61221b7..0000000
--- a/src/site/markdown/Tutorial.md
+++ /dev/null
@@ -1,205 +0,0 @@
-<!---
-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</title>
-</head>
-
-# Helix Tutorial
-
-In this tutorial, we will cover the roles of a Helix-managed cluster, and show the code you need to write to integrate with it. In many cases, there is a simple default behavior that is often appropriate, but you can also customize the behavior.
-
-Convention: we first cover the _basic_ approach, which is the easiest to implement. Then, we'll describe _advanced_ options, which give you more control over the system behavior, but require you to write more code.
-
-
-### Prerequisites
-
-1. Read [Concepts/Terminology](./Concepts.html) and [Architecture](./Architecture.html)
-2. Read the [Quickstart guide](./Quickstart.html) to learn how Helix models and manages a cluster
-3. Install Helix source. See: [Quickstart](./Quickstart.html) for the steps.
-
-### Tutorial Outline
-
-1. [Participant](./tutorial_participant.html)
-2. [Spectator](./tutorial_spectator.html)
-3. [Controller](./tutorial_controller.html)
-4. [Rebalancing Algorithms](./tutorial_rebalance.html)
-5. [User-Defined Rebalancing](./tutorial_user_def_rebalancer.html)
-6. [State Machines](./tutorial_state.html)
-7. [Messaging](./tutorial_messaging.html)
-8. [Customized health check](./tutorial_health.html)
-9. [Throttling](./tutorial_throttling.html)
-10. [Application Property Store](./tutorial_propstore.html)
-11. [Admin Interface](./tutorial_admin.html)
-12. [YAML Cluster Setup](./tutorial_yaml.html)
-
-### Preliminaries
-
-First, we need to set up the system. Let\'s walk through the steps in building a distributed system using Helix.
-
-### Start Zookeeper
-
-This starts a zookeeper in standalone mode. For production deployment, see [Apache Zookeeper](http://zookeeper.apache.org) for instructions.
-
-```
- ./start-standalone-zookeeper.sh 2199 &
-```
-
-### Create a cluster
-
-Creating a cluster will define the cluster in appropriate znodes on zookeeper.
-
-Using the java API:
-
-```
- // Create setup tool instance
- // Note: ZK_ADDRESS is the host:port of Zookeeper
- String ZK_ADDRESS = "localhost:2199";
- admin = new ZKHelixAdmin(ZK_ADDRESS);
-
- String CLUSTER_NAME = "helix-demo";
- //Create cluster namespace in zookeeper
- admin.addCluster(CLUSTER_NAME);
-```
-
-OR
-
-Using the command-line interface:
-
-```
- ./helix-admin.sh --zkSvr localhost:2199 --addCluster helix-demo
-```
-
-
-### Configure the nodes of the cluster
-
-First we\'ll add new nodes to the cluster, then configure the nodes in the cluster. Each node in the cluster must be uniquely identifiable.
-The most commonly used convention is hostname:port.
-
-```
- String CLUSTER_NAME = "helix-demo";
- int NUM_NODES = 2;
- String hosts[] = new String[]{"localhost","localhost"};
- String ports[] = new String[]{7000,7001};
- for (int i = 0; i < NUM_NODES; i++)
- {
-
- InstanceConfig instanceConfig = new InstanceConfig(hosts[i]+ "_" + ports[i]);
- instanceConfig.setHostName(hosts[i]);
- instanceConfig.setPort(ports[i]);
- instanceConfig.setInstanceEnabled(true);
-
- //Add additional system specific configuration if needed. These can be accessed during the node start up.
- instanceConfig.getRecord().setSimpleField("key", "value");
- admin.addInstance(CLUSTER_NAME, instanceConfig);
-
- }
-```
-
-### Configure the resource
-
-A _resource_ represents the actual task performed by the nodes. It can be a database, index, topic, queue or any other processing entity.
-A _resource_ can be divided into many sub-parts known as _partitions_.
-
-
-#### Define the _state model_ and _constraints_
-
-For scalability and fault tolerance, each partition can have one or more replicas.
-The _state model_ allows one to declare the system behavior by first enumerating the various STATES, and the TRANSITIONS between them.
-A simple model is ONLINE-OFFLINE where ONLINE means the task is active and OFFLINE means it\'s not active.
-You can also specify how many replicas must be in each state, these are known as _constraints_.
-For example, in a search system, one might need more than one node serving the same index to handle the load.
-
-The allowed states:
-
-* MASTER
-* SLAVE
-* OFFLINE
-
-The allowed transitions:
-
-* OFFLINE to SLAVE
-* SLAVE to OFFLINE
-* SLAVE to MASTER
-* MASTER to SLAVE
-
-The constraints:
-
-* no more than 1 MASTER per partition
-* the rest of the replicas should be slaves
-
-The following snippet shows how to declare the _state model_ and _constraints_ for the MASTER-SLAVE model.
-
-```
-
- StateModelDefinition.Builder builder = new StateModelDefinition.Builder(STATE_MODEL_NAME);
-
- // Add states and their rank to indicate priority. A lower rank corresponds to a higher priority
- builder.addState(MASTER, 1);
- builder.addState(SLAVE, 2);
- builder.addState(OFFLINE);
-
- // Set the initial state when the node starts
- builder.initialState(OFFLINE);
-
- // Add transitions between the states.
- builder.addTransition(OFFLINE, SLAVE);
- builder.addTransition(SLAVE, OFFLINE);
- builder.addTransition(SLAVE, MASTER);
- builder.addTransition(MASTER, SLAVE);
-
- // set constraints on states.
-
- // static constraint: upper bound of 1 MASTER
- builder.upperBound(MASTER, 1);
-
- // dynamic constraint: R means it should be derived based on the replication factor for the cluster
- // this allows a different replication factor for each resource without
- // having to define a new state model
- //
- builder.dynamicUpperBound(SLAVE, "R");
-
- StateModelDefinition statemodelDefinition = builder.build();
- admin.addStateModelDef(CLUSTER_NAME, STATE_MODEL_NAME, myStateModel);
-```
-
-#### Assigning partitions to nodes
-
-The final goal of Helix is to ensure that the constraints on the state model are satisfied.
-Helix does this by assigning a STATE to a partition (such as MASTER, SLAVE), and placing it on a particular node.
-
-There are 3 assignment modes Helix can operate on
-
-* FULL_AUTO: Helix decides the placement and state of a partition.
-* SEMI_AUTO: Application decides the placement but Helix decides the state of a partition.
-* CUSTOMIZED: Application controls the placement and state of a partition.
-
-For more info on the assignment modes, see [Rebalancing Algorithms](./tutorial_rebalance.html) section of the tutorial.
-
-```
- String RESOURCE_NAME = "MyDB";
- int NUM_PARTITIONS = 6;
- STATE_MODEL_NAME = "MasterSlave";
- String MODE = "SEMI_AUTO";
- int NUM_REPLICAS = 2;
-
- admin.addResource(CLUSTER_NAME, RESOURCE_NAME, NUM_PARTITIONS, STATE_MODEL_NAME, MODE);
- admin.rebalance(CLUSTER_NAME, RESOURCE_NAME, NUM_REPLICAS);
-```
-
http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/150ce693/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index fd42592..a2a8b8c 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -21,51 +21,23 @@ under the License.
<title>Home</title>
</head>
-Navigating the Documentation
-----------------------------
+News
+----
-### Conceptual Understanding
+Apache Helix has two new releases:
-[Concepts / Terminology](./Concepts.html)
+* [0.7.0-incubating](./site-releases/0.7.0-incubating-site/index.html) - A release that includes high-level APIs to logically interact with Participants, Controllers, Resources, and other Helix constructs. This release should be considered alpha, but contains many new features, is backward-compatible, and is the basis for future development of Helix. [\[Release Notes\]](./releasenotes/release-0.7.0-incubating.html)
-[Architecture](./Architecture.html)
+* [0.6.2-incubating](./site-releases/0.6.2-incubating-site/index.html) - A bug and security fix release hardening the Helix platform. [\[Release Notes\]](./releasenotes/release-0.6.2-incubating.html)
-### Hands-on Helix
-[Quickstart](./Quickstart.html)
-
-[Tutorial](./Tutorial.html)
-
-[Javadocs](./apidocs/index.html)
-
-[IRC](./IRC.html)
-
-### Recipes
-
-[Distributed lock manager](./recipes/lock_manager.html)
-
-[Rabbit MQ consumer group](./recipes/rabbitmq_consumer_group.html)
-
-[Rsync replicated file store](./recipes/rsync_replicated_file_store.html)
-
-[Service discovery](./recipes/service_discovery.html)
-
-[Distributed Task DAG Execution](./recipes/task_dag_execution.html)
-
-[User-Defined Rebalancer Example](./recipes/user_def_rebalancer.html)
-
-### Download
-
-[Current Release](./download.html)
-
-
-What Is Helix
+What Is Helix?
--------------
Helix is a generic _cluster management_ framework used for the automatic management of partitioned, replicated and distributed resources hosted on a cluster of nodes.
-What Is Cluster Management
---------------------------
+What Is Cluster Management?
+---------------------------
To understand Helix, first you need to understand _cluster management_. A distributed system typically runs on multiple nodes for the following reasons:
* scalability
@@ -82,8 +54,8 @@ Each node performs one or more of the primary function of the cluster, such as s
While it is possible to integrate these functions into the distributed system, it complicates the code. Helix has abstracted common cluster management tasks, enabling the system builder to model the desired behavior with a declarative state model, and let Helix manage the coordination. The result is less new code to write, and a robust, highly operable system.
-Key Features of Helix
----------------------
+What does Helix provide?
+------------------------
1. Automatic assignment of resources and partitions to nodes
2. Node failure detection and recovery
3. Dynamic addition of resources
@@ -93,8 +65,8 @@ Key Features of Helix
7. Optional pluggable rebalancing for user-defined assignment of resources and partitions
-Why Helix
----------
+Why Helix?
+----------
Modeling a distributed system as a state machine with constraints on states and transitions has the following benefits:
* Separates cluster management from the core functionality of the system.
@@ -102,40 +74,32 @@ Modeling a distributed system as a state machine with constraints on states and
* Increases simplicity: system components do not have to manage a global cluster. This division of labor makes it easier to build, debug, and maintain your system.
+Download
+--------
+
+[0.7.0-incubating](./site-releases/0.7.0-incubating-site/download.html)
+
+[0.6.2-incubating](./site-releases/0.6.2-incubating-site/download.html)
+
Build Instructions
------------------
Requirements: JDK 1.6+, Maven 2.0.8+
```
- git clone https://git-wip-us.apache.org/repos/asf/incubator-helix.git
- cd incubator-helix
- git checkout tags/helix-0.6.1-incubating
- mvn install package -DskipTests
+git clone https://git-wip-us.apache.org/repos/asf/incubator-helix.git
+cd incubator-helix
+git checkout tags/helix-0.7.0-incubating
+mvn install package -DskipTests
```
Maven dependency
```
- <dependency>
- <groupId>org.apache.helix</groupId>
- <artifactId>helix-core</artifactId>
- <version>0.6.1-incubating</version>
- </dependency>
+<dependency>
+ <groupId>org.apache.helix</groupId>
+ <artifactId>helix-core</artifactId>
+ <version>0.7.0-incubating</version>
+</dependency>
```
-[Download](./download.html) Helix artifacts from here.
-
-Publications
--------------
-
-* Untangling cluster management using Helix at [SOCC Oct 2012](http://www.socc2012.org/home/program)
- - [paper](https://915bbc94-a-62cb3a1a-s-sites.googlegroups.com/site/acm2012socc/helix_onecol.pdf)
- - [presentation](http://www.slideshare.net/KishoreGopalakrishna/helix-socc-v10final)
-* Building distributed systems using Helix Apache Con Feb 2013
- - [presentation at ApacheCon](http://www.slideshare.net/KishoreGopalakrishna/apache-con-buildingddsusinghelix)
- - [presentation at VMWare](http://www.slideshare.net/KishoreGopalakrishna/apache-helix-presentation-at-vmware)
-* Data driven testing:
- - [short talk at LSPE meetup](http://www.slideshare.net/KishoreGopalakrishna/data-driven-testing)
- - [paper DBTest 2013 acm SIGMOD:will be published on Jun 24, 2013](http://dbtest2013.soe.ucsc.edu/Program.htm)
-
http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/150ce693/src/site/markdown/involved/building.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/involved/building.md b/src/site/markdown/involved/building.md
index 06f0589..ea8c081 100644
--- a/src/site/markdown/involved/building.md
+++ b/src/site/markdown/involved/building.md
@@ -24,7 +24,7 @@ Building Apache Helix
First you need to install Apache Maven.
To install jars locally:
-mvn clean install (-DskipTests if you don't want to run tests).
-
-
+```
+mvn clean install (-DskipTests if you don't want to run tests)
+```