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/12/12 21:11:45 UTC
git commit: Minor documentation changes
Updated Branches:
refs/heads/master 2cba19a26 -> 3f44a106e
Minor documentation changes
Project: http://git-wip-us.apache.org/repos/asf/incubator-helix/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-helix/commit/3f44a106
Tree: http://git-wip-us.apache.org/repos/asf/incubator-helix/tree/3f44a106
Diff: http://git-wip-us.apache.org/repos/asf/incubator-helix/diff/3f44a106
Branch: refs/heads/master
Commit: 3f44a106e7ab88fb0fb2f4abd69a63d8d6f9325e
Parents: 2cba19a
Author: Kishore Gopalakrishna <g....@gmail.com>
Authored: Wed Dec 12 12:11:27 2012 -0800
Committer: Kishore Gopalakrishna <g....@gmail.com>
Committed: Wed Dec 12 12:11:27 2012 -0800
----------------------------------------------------------------------
src/site/markdown/Architecture.md | 2 +
src/site/markdown/Quickstart.md | 68 +++++++++---------
src/site/resources/images/HELIX-components.png | Bin 0 -> 82112 bytes
3 files changed, 36 insertions(+), 34 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/3f44a106/src/site/markdown/Architecture.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/Architecture.md b/src/site/markdown/Architecture.md
index bef20d9..f8fa8fc 100644
--- a/src/site/markdown/Architecture.md
+++ b/src/site/markdown/Architecture.md
@@ -46,6 +46,8 @@ In general any distributed system cluster will have the following
Roles
-----
+
+
Not all nodes in a distributed system will perform similar functionality. For e.g, a few nodes might be serving requests, few nodes might be sending the request and some nodes might be controlling the nodes in the cluster. Based on functionality we have grouped them into
We have divided Helix in 3 logical components based on their responsibility
http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/3f44a106/src/site/markdown/Quickstart.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/Quickstart.md b/src/site/markdown/Quickstart.md
index 788602e..4d92fe8 100644
--- a/src/site/markdown/Quickstart.md
+++ b/src/site/markdown/Quickstart.md
@@ -18,10 +18,10 @@ under the License.
-->
Build/Download Helix
-===================
+--------------------
+
+### Build
-Build
------
Jump to download section to skip building code
@@ -31,12 +31,12 @@ Jump to download section to skip building code
cd helix-core/target/helix-core-pkg/bin //This folder contains all the scripts used in following sections
chmod \+x *
-Download Helix
---------------
+### 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 *
@@ -57,12 +57,12 @@ The quick start does the following
* Shows cluster state after node is stopped.
Long Version
-===========
+------------
+
+Helix 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.
-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
-Install/Start zookeeper
------------------------
Zookeeper can be started in standalone mode or replicated mode.
@@ -71,8 +71,8 @@ and http://zookeeper.apache.org/doc/trunk/zookeeperAdmin.html#sc_zkMulitServerSe
In this example, we will start zookeeper in local mode.
-Cluster setup
--------------
+### Cluster setup
+
cluster-admin tool is used for cluster administration tasks. Apart from a 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.
@@ -86,40 +86,40 @@ In the following section we will see how one can set up a mock mycluster cluster
Note that this mock cluster does not have any functionality apart from handling Helix callbacks.
-Steps
------
+### Steps
+
If you build the code
cd helix/helix-core/target/helix-core-pkg
If you download the release package, extract it.
cd helix-core-pkg
-#### start zookeeper locally at port 2199
+##### start zookeeper locally at port 2199
./start-standalone-zookeeper 2199 &
-#### create the cluster mycluster
+##### create the cluster mycluster
## helix-admin --zkSvr localhost:2199 --addCluster <clustername>
./helix-admin --zkSvr localhost:2199 --addCluster mycluster
-#### Create a database with 6 partitions using MasterSlave state model. This ensures there will be one master for each partition
+##### Create a database with 6 partitions using MasterSlave state model. This ensures there will be one master for each partition
### helix-admin --zkSvr localhost:2199 --addResource <clustername> <resourceName> <numPartitions> <StateModelName>
./helix-admin --zkSvr localhost:2199 --addResource mycluster myDB 6 MasterSlave
-#### Add nodes to the cluster, in this case we add three nodes, hostname:port is host and port on which the service will start
+##### Add nodes to the cluster, in this case we add three nodes, hostname:port is host and port on which the service will start
## helix-admin --zkSvr <zk_address> --addNode <clustername> <host:port>
./helix-admin --zkSvr localhost:2199 --addNode mycluster localhost:12913
./helix-admin --zkSvr localhost:2199 --addNode mycluster localhost:12914
./helix-admin --zkSvr localhost:2199 --addNode mycluster localhost:12915
-#### After adding nodes assign partitions to nodes. This command will distribute the partitions amongst all the nodes in the cluster. Each partition will have 3 replicas
+##### After adding nodes assign partitions to nodes. This command will distribute the partitions amongst all the nodes in the cluster. Each partition will have 3 replicas
helix-admin --rebalance <clustername> <resourceName> <replication factor>
./helix-admin --zkSvr localhost:2199 --rebalance mycluster myDB 3
-#### Start Helix Controller
+##### Start Helix Controller
#This will start the cluster manager which will manage <mycluster>
./run-helix-controller --zkSvr localhost:2199 --cluster mycluster 2>&1 > /tmp/controller.log &
-#### Start Example Participant, This is a dummy participant where the transitions are no-ops.
+##### Start Example Participant, This is a dummy participant where the transitions are no-ops.
./start-helix-participant --help
# start process 1 process corresponding to every host port added during cluster setup
./start-helix-participant --zkSvr localhost:2199 --cluster mycluster --host localhost --port 12913 --stateModelType MasterSlave 2>&1 > /tmp/participant_12913.log
@@ -127,51 +127,51 @@ cd helix-core-pkg
./start-helix-participant --zkSvr localhost:2199 --cluster mycluster --host localhost --port 12915 --stateModelType MasterSlave 2>&1 > /tmp/participant_12915.log
-Inspect Cluster Data
---------------------
+### Inspect Cluster Data
+
-We can see the cluster state on zookeeper and know the partition assignment and current state of each partition.
+At any time, we can get the cluster status on zookeeper and view the partition assignment and current state of each partition.
Command line tool
-#### List existing clusters
+##### List existing clusters
./helix-admin --zkSvr localhost:2199 --listClusters
-#### Query info of a cluster
+##### Query info of a cluster
#helix-admin --zkSvr localhost:2199 --listClusterInfo <clusterName>
./helix-admin --zkSvr localhost:2199 --listClusterInfo mycluster
-#### List Instances in a cluster
+##### List Instances in a cluster
## helix-admin --zkSvr localhost:2199 --listInstances <clusterName>
./helix-admin --zkSvr localhost:2199 --listInstances mycluster
-#### Query info of a Instance in a cluster
+##### Query info of a Instance in a cluster
#./helix-admin --zkSvr localhost:2199 --listInstanceInfo <clusterName InstanceName>
./helix-admin --zkSvr localhost:2199 --listInstanceInfo mycluster localhost_12913
./helix-admin --zkSvr localhost:2199 --listInstanceInfo mycluster localhost_12914
./helix-admin --zkSvr localhost:2199 --listInstanceInfo mycluster localhost_12915
-#### List resourceGroups hosted in a cluster
+##### List resourceGroups hosted in a cluster
## helix-admin --zkSvr localhost:2199 --listResources <clusterName>
./helix-admin --zkSvr localhost:2199 --listResources mycluster
-#### Query info of a resource
+##### Query info of a resource
## helix-admin --zkSvr localhost:2199 --listResourceInfo <clusterName resourceName>
./helix-admin --zkSvr localhost:2199 --listResourceInfo mycluster myDB
-#### Query info about a partition
+##### Query info about a partition
## helix-admin --zkSvr localhost:2199 --listResourceInfo <clusterName partition>
./helix-admin --zkSvr localhost:2199 --listResourceInfo mycluster myDB_0
-#### List all state models in the cluster
+##### List all state models in the cluster
# helix-admin --zkSvr localhost:2199 --listStateModels <clusterName>
./helix-admin --zkSvr localhost:2199 --listStateModels mycluster
-#### Query info about a state model in a cluster
+##### Query info about a state model in a cluster
## helix-admin --zkSvr localhost:2199 --listStateModel <clusterName stateModelName>
./helix-admin --zkSvr localhost:2199 --listStateModel mycluster MasterSlave
-#### ZOOINSPECTOR
+##### ZOOINSPECTOR
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
http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/3f44a106/src/site/resources/images/HELIX-components.png
----------------------------------------------------------------------
diff --git a/src/site/resources/images/HELIX-components.png b/src/site/resources/images/HELIX-components.png
new file mode 100644
index 0000000..c0c35ae
Binary files /dev/null and b/src/site/resources/images/HELIX-components.png differ