You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@helix.apache.org by ki...@apache.org on 2012/11/09 00:19:29 UTC
git commit: Shorter version of quickstart
Updated Branches:
refs/heads/master 5f12ac3fe -> 0c0198876
Shorter version of quickstart
Project: http://git-wip-us.apache.org/repos/asf/incubator-helix/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-helix/commit/0c019887
Tree: http://git-wip-us.apache.org/repos/asf/incubator-helix/tree/0c019887
Diff: http://git-wip-us.apache.org/repos/asf/incubator-helix/diff/0c019887
Branch: refs/heads/master
Commit: 0c0198876de4ae9127e53b054fe5df23509380b9
Parents: 5f12ac3
Author: Kishore Gopalakrishna <g....@gmail.com>
Authored: Thu Nov 8 15:19:14 2012 -0800
Committer: Kishore Gopalakrishna <g....@gmail.com>
Committed: Thu Nov 8 15:19:14 2012 -0800
----------------------------------------------------------------------
src/site/markdown/Quickstart.md | 59 +++++++++++++++++++++++++--------
1 files changed, 44 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/0c019887/src/site/markdown/Quickstart.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/Quickstart.md b/src/site/markdown/Quickstart.md
index 60d1c16..4dcda32 100644
--- a/src/site/markdown/Quickstart.md
+++ b/src/site/markdown/Quickstart.md
@@ -17,6 +17,49 @@ specific language governing permissions and limitations
under the License.
-->
+Build/Download Helix
+===================
+
+Build
+-----
+
+Jump to download section to skip building code
+
+ git clone http://git-wip-us.apache.org/repos/asf/incubator-helix.git
+ cd incubator-helix
+ mvn install package -DskipTests
+ cd helix-core/target/helix-core-pkg/bin //This folder contains all the scripts used in following sections
+ chmod \+x *
+
+Download Helix
+--------------
+Instead of building the package from the code, you can download the 0.5.28 release package from [here](http://linkedin.github.com/helix/download/release-0.5.28/helix-core-pkg-0.5.28.tar.gz)
+
+Short Version
+=============
+
+ cd helix-core/target/helix-core-pkg/bin
+ chmod +x *
+ ./quickstart.sh
+
+
+This gives an overview of Helix Apis and how it facilitates Automatic Partition Management, Failure Handling and Cluster Expansion.
+
+The quick start does the following
+
+* Add a cluster
+* Add two nodes
+* Add a resource with 6 partitions with 1 master and 1 slave replica.
+* Shows the cluster state after all nodes are up.
+* Add a node and see the partitions get rebalanced
+* Shows cluster state after the rebalance
+* Stop a node and see that master ship transfer occurs.
+* Shows cluster state after node is stopped.
+
+Long Version
+===========
+
+Helix also provides command line interfaces to setup the cluster and also view the cluster state. Follow the steps below to get a better understanding of the steps involved to setup a distributed system.
Install/Start zookeeper
-----------------------
@@ -28,20 +71,6 @@ and http://zookeeper.apache.org/doc/trunk/zookeeperAdmin.html#sc_zkMulitServerSe
In this example, we will start zookeeper in local mode.
-BUILD Helix
------------
-Jump to Download section to skip this test.
-
- git clone git@github.com:linkedin/helix.git
- cd helix-core
- mvn install package appassembler:assemble -Dmaven.test.skip=true
- cd target/helix-core-pkg/bin //This folder contains all the scripts used in following sections
- chmod \+x *
-
-Download Helix
---------------
-Instead of building the package from the code, you can download the 0.5.28 release package from [here](http://linkedin.github.com/helix/download/release-0.5.28/helix-core-pkg-0.5.28.tar.gz)
-
Cluster setup
-------------
cluster-admin tool is used for cluster administration tasks. Apart from a command line interface Helix supports a REST interface as well.
@@ -147,4 +176,4 @@ Command line tool
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
\ No newline at end of file
+ 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