incubator-hama-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From edwardy...@apache.org
Subject svn commit: r1078408 - in /incubator/hama/trunk/src: docs/src/documentation/content/xdocs/ docs/src/documentation/content/xdocs/docs/ docs/src/documentation/content/xdocs/docs/r0.2.0/ java/
Date Sun, 06 Mar 2011 07:15:05 GMT
Author: edwardyoon
Date: Sun Mar  6 07:15:05 2011
New Revision: 1078408

URL: http://svn.apache.org/viewvc?rev=1078408&view=rev
Log:
Add document for release 0.2.0

Added:
    incubator/hama/trunk/src/docs/src/documentation/content/xdocs/docs/
    incubator/hama/trunk/src/docs/src/documentation/content/xdocs/docs/r0.2.0/
    incubator/hama/trunk/src/docs/src/documentation/content/xdocs/docs/r0.2.0/ApacheHama-0.2_UserGuide.pdf
  (with props)
    incubator/hama/trunk/src/docs/src/documentation/content/xdocs/docs/r0.2.0/index.xml
Modified:
    incubator/hama/trunk/src/docs/src/documentation/content/xdocs/site.xml
    incubator/hama/trunk/src/java/overview.html

Added: incubator/hama/trunk/src/docs/src/documentation/content/xdocs/docs/r0.2.0/ApacheHama-0.2_UserGuide.pdf
URL: http://svn.apache.org/viewvc/incubator/hama/trunk/src/docs/src/documentation/content/xdocs/docs/r0.2.0/ApacheHama-0.2_UserGuide.pdf?rev=1078408&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/hama/trunk/src/docs/src/documentation/content/xdocs/docs/r0.2.0/ApacheHama-0.2_UserGuide.pdf
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: incubator/hama/trunk/src/docs/src/documentation/content/xdocs/docs/r0.2.0/index.xml
URL: http://svn.apache.org/viewvc/incubator/hama/trunk/src/docs/src/documentation/content/xdocs/docs/r0.2.0/index.xml?rev=1078408&view=auto
==============================================================================
--- incubator/hama/trunk/src/docs/src/documentation/content/xdocs/docs/r0.2.0/index.xml (added)
+++ incubator/hama/trunk/src/docs/src/documentation/content/xdocs/docs/r0.2.0/index.xml Sun
Mar  6 07:15:05 2011
@@ -0,0 +1,185 @@
+<?xml version="1.0"?>
+<!--
+  Copyright 2002-2004 The Apache Software Foundation
+
+  Licensed 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 document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" 
+"http://forrest.apache.org/dtd/document-v20.dtd">
+
+<document>
+  
+  <header>
+    <title>Welcome to Hama project</title>
+  </header>
+  <body>
+<script src="http://widgets.twimg.com/j/2/widget.js"></script>
+<script>
+new TWTR.Widget({
+  version: 2,
+  type: 'search',
+  id: 'credit2',
+  search: '\"apache hama\" OR apachehama OR #ApacheHama',
+  interval: 6000,
+  title: 'Recent Tweets About Apache Hama',
+  subject: '#ApacheHama on Twitter',
+  width: 206,
+  height: 280,
+  theme: {
+    shell: {
+      background: '#4a6d8c',
+      color: '#ffffff'
+    },
+    tweets: {
+      background: '#ffffff',
+      color: '#444444',
+      links: '#1985b5'
+    }
+  },
+  features: {
+    scrollbar: false,
+    loop: true,
+    live: true,
+    hashtags: true,
+    timestamp: true,
+    avatars: true,
+    toptweets: true,
+    behavior: 'default'
+  }
+}).render().start();
+</script>
+    
+    <section>
+    <title>Downloadable User Guide</title>
+    <ul>
+    	<li>Apache Hama (v0.2) : User Guide [<a href="/docs/r0.2.0/ApacheHama-0.2_UserGuide.pdf">pdf</a>]</li>
+    </ul>
+    </section>
+    
+     <section>
+      <title> Getting Started </title>
+
+Hama is a distributed computing framework based on BSP (Bulk Synchronous Parallel) computing
techniques for massive scientific computations.
+
+<h3 id="Requirements">Requirements</h3>
+<ul>
+<li>hadoop-0.20.x for HDFS</li>
+<li>Sun Java JDK 1.6.x or higher version</li>
+</ul>
+
+<h3 id="Startup_script">Startup script</h3>
+The <i>$HAMA_HOME/bin</i> directory contains some script used to start up the
Hama daemons.
+<ul>
+<li>
+<i>start-bspd.sh</i> - Starts all Hama daemons, the BSPMaster, GroomServers and
Zookeeper.
+</li>
+</ul>
+
+<h3 id="Configuration_files">Configuration files</h3>
+
+The <i>$HAMA_HOME/conf</i> directory contains some configuration files for Hama.
These are:
+<ul>
+<li>
+<i>hama-env.sh</i> - This file contains some environment variable settings used
by Hama. You can use these to affect some aspects of Hama daemon behavior, 
+such as where log files are stored, the maximum amount of heap used etc. The only variable
you should need to change in this file is JAVA_HOME, 
+which specifies the path to the Java 1.5.x installation used by Hama.
+</li>
+<li>
+<i>groomservers</i> - This file lists the hosts, one per line, where the GroomServer
daemons will run. By default this contains the single entry localhost.</li>
+<li>
+<i>hama-default.xml</i> - This file contains generic default settings for Hama
daemons.&nbsp;<strong>Do not modify this file</strong>.
+</li>
+<li>
+<i>hama-site.xml</i> - This file contains site specific settings for all Hama
daemons and BSP jobs. 
+This file is empty by default. Settings in this file override those in hama-default.xml.

+This file should contain settings that must be respected by all servers and clients in a
Hama installation.
+</li>
+</ul>
+<div class="line867">
+</div>
+<h2 id="Setting_up_Hama">Setting up Hama</h2>
+This section describes how to get started by setting up a Hama cluster.
+<ul>
+<li>
+<strong>BSPMaster and Zookeeper settings</strong> - Figure out where to run your
HDFS namenode and BSPMaster. 
+Set the variable <i>bsp.master.address</i> to the BSPMaster's intended host:port.

+Set the variable <i>fs.default.name</i> to the HDFS Namenode's intended host:port.
+</li>
+</ul>
+
+An example of a hama-site.xml file:
+<pre style="background-color: #f3f5f7; border-bottom-color: rgb(174, 189, 204); border-bottom-style:
solid; border-bottom-width: 1pt; border-left-color: rgb(174, 189, 204); border-left-style:
solid; border-left-width: 1pt; border-right-color: rgb(174, 189, 204); border-right-style:
solid; border-right-width: 1pt; border-top-color: rgb(174, 189, 204); border-top-style: solid;
border-top-width: 1pt; font-family: courier, monospace; padding-bottom: 5pt; padding-left:
5pt; padding-right: 5pt; padding-top: 5pt; white-space: pre-wrap; word-wrap: break-word;">
+&lt;!--?xml version="1.0"?--&gt;
+&lt;!--?xml-stylesheet type="text/xsl" href="configuration.xsl"?--&gt;
+&lt;configuration&gt;
+  &lt;property&gt;
+    &lt;name&gt;bsp.master.address&lt;/name&gt;
+    &lt;value&gt;mydomain.com:40000&lt;/value&gt;
+    &lt;description&gt;The address of the bsp master server. Either the
+    literal string "local" or a host:port for distributed mode
+    &lt;/description&gt;
+  &lt;/property&gt;
+  
+  &lt;property&gt;
+    &lt;name&gt;fs.default.name&lt;/name&gt;
+    &lt;value&gt;hdfs://mydomain.com:9000/&lt;/value&gt;
+    &lt;description&gt;
+      The name of the default file system. Either the literal string
+      "local" or a host:port for HDFS.
+    &lt;/description&gt;
+  &lt;/property&gt;
+  
+  &lt;property&gt;
+    &lt;name&gt;hama.zookeeper.quorum&lt;/name&gt;
+    &lt;value&gt;mydomain.com&lt;/value&gt;
+    &lt;description&gt;Comma separated list of servers in the ZooKeeper Quorum.
+    For example, "host1.mydomain.com,host2.mydomain.com,host3.mydomain.com".
+    By default this is set to localhost for local and pseudo-distributed modes
+    of operation. For a fully-distributed setup, this should be set to a full
+    list of ZooKeeper quorum servers. If HAMA_MANAGES_ZK is set in hama-env.sh
+    this is the list of servers which we will start/stop zookeeper on.
+    &lt;/description&gt;
+  &lt;/property&gt;
+&lt;/configuration&gt;
+</pre>
+
+<h4 id="Starting_a_Hama_cluster">Starting a Hama cluster</h4>
+
+Run the command:
+<pre style="background-color: #f3f5f7; border-bottom-color: rgb(174, 189, 204); border-bottom-style:
solid; border-bottom-width: 1pt; border-left-color: rgb(174, 189, 204); border-left-style:
solid; border-left-width: 1pt; border-right-color: rgb(174, 189, 204); border-right-style:
solid; border-right-width: 1pt; border-top-color: rgb(174, 189, 204); border-top-style: solid;
border-top-width: 1pt; font-family: courier, monospace; padding-bottom: 5pt; padding-left:
5pt; padding-right: 5pt; padding-top: 5pt; white-space: pre-wrap; word-wrap: break-word;">
+  # $HAMA_HOME/bin/start-bspd.sh
+</pre>
+
+This will startup a BSPMaster, GroomServers and Zookeeper on your machine.
+
+<h4 id="Stopping_a_Hama_cluster">Stopping a Hama cluster</h4>
+
+Run the command:
+<pre style="background-color: #f3f5f7; border-bottom-color: rgb(174, 189, 204); border-bottom-style:
solid; border-bottom-width: 1pt; border-left-color: rgb(174, 189, 204); border-left-style:
solid; border-left-width: 1pt; border-right-color: rgb(174, 189, 204); border-right-style:
solid; border-right-width: 1pt; border-top-color: rgb(174, 189, 204); border-top-style: solid;
border-top-width: 1pt; font-family: courier, monospace; padding-bottom: 5pt; padding-left:
5pt; padding-right: 5pt; padding-top: 5pt; white-space: pre-wrap; word-wrap: break-word;">
+  # $HAMA_HOME/bin/stop-bspd.sh
+</pre>
+
+to stop all the daemons running on your cluster.
+
+
+<h3 id="Run_the_BSP_Examples">Run the BSP Examples</h3>
+Run the command:
+<pre style="background-color: #f3f5f7; border-bottom-color: rgb(174, 189, 204); border-bottom-style:
solid; border-bottom-width: 1pt; border-left-color: rgb(174, 189, 204); border-left-style:
solid; border-left-width: 1pt; border-right-color: rgb(174, 189, 204); border-right-style:
solid; border-right-width: 1pt; border-top-color: rgb(174, 189, 204); border-top-style: solid;
border-top-width: 1pt; font-family: courier, monospace; padding-bottom: 5pt; padding-left:
5pt; padding-right: 5pt; padding-top: 5pt; white-space: pre-wrap; word-wrap: break-word;">
+  # $HAMA_HOME/bin/hama jar hama-0.2.0-examples.jar pi or test
+</pre>
+
+    </section>
+    
+  </body>
+</document>
\ No newline at end of file

Modified: incubator/hama/trunk/src/docs/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/incubator/hama/trunk/src/docs/src/documentation/content/xdocs/site.xml?rev=1078408&r1=1078407&r2=1078408&view=diff
==============================================================================
--- incubator/hama/trunk/src/docs/src/documentation/content/xdocs/site.xml (original)
+++ incubator/hama/trunk/src/docs/src/documentation/content/xdocs/site.xml Sun Mar  6 07:15:05
2011
@@ -44,6 +44,10 @@ See http://forrest.apache.org/docs/linki
     -->
   </docs>
 
+  <docs label="Documentation">
+    <r0.2.0 label="Release 0.2.0" href="/docs/r0.2.0/index.html"/>
+  </docs>
+  
   <docs label="Resources">
     <developers label="Developers"     href="developers.html" />
     <issues     label="Issue Tracking" href="issue_tracking.html" />

Modified: incubator/hama/trunk/src/java/overview.html
URL: http://svn.apache.org/viewvc/incubator/hama/trunk/src/java/overview.html?rev=1078408&r1=1078407&r2=1078408&view=diff
==============================================================================
--- incubator/hama/trunk/src/java/overview.html (original)
+++ incubator/hama/trunk/src/java/overview.html Sun Mar  6 07:15:05 2011
@@ -25,8 +25,8 @@ Hama is a distributed computing framewor
 
 <h2 id="Requirements">Requirements</h2>
 <ul>
-<li>hadoop-0.20.x for HDFS<span class="anchor" id="line-10"></li>
-<li>Sun Java JDK 1.5.x or higher version</li>
+<li>hadoop-0.20.x for HDFS</li>
+<li>Sun Java JDK 1.6.x or higher version</li>
 </ul>
 
 <h2 id="Startup_script">Startup script</h2>
@@ -127,7 +127,7 @@ to stop all the daemons running on your 
 <h2 id="Run_the_BSP_Examples">Run the BSP Examples</h2>
 Run the command:
 <pre style="background-color: #f3f5f7; border-bottom-color: rgb(174, 189, 204); border-bottom-style:
solid; border-bottom-width: 1pt; border-left-color: rgb(174, 189, 204); border-left-style:
solid; border-left-width: 1pt; border-right-color: rgb(174, 189, 204); border-right-style:
solid; border-right-width: 1pt; border-top-color: rgb(174, 189, 204); border-top-style: solid;
border-top-width: 1pt; font-family: courier, monospace; padding-bottom: 5pt; padding-left:
5pt; padding-right: 5pt; padding-top: 5pt; white-space: pre-wrap; word-wrap: break-word;">
-  # $HAMA_HOME/bin/hama jar build/hama-0.2.0-dev-examples.jar pi or test
+  # $HAMA_HOME/bin/hama jar hama-0.2.0-examples.jar pi or test
 </pre>
 
 </body>



Mime
View raw message