You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@falcon.apache.org by ve...@apache.org on 2013/07/10 23:37:31 UTC
svn commit: r1502017 - in /incubator/falcon:
site/docs/InstallationSteps.html trunk/CHANGES.txt
trunk/src/site/twiki/docs/InstallationSteps.twiki
Author: venkatesh
Date: Wed Jul 10 21:37:31 2013
New Revision: 1502017
URL: http://svn.apache.org/r1502017
Log:
FALCON-1 Create packaging and scripts to install and try Apache Falcon. Contributed by Srikanth Sundarrajan
Modified:
incubator/falcon/site/docs/InstallationSteps.html
incubator/falcon/trunk/CHANGES.txt
incubator/falcon/trunk/src/site/twiki/docs/InstallationSteps.twiki
Modified: incubator/falcon/site/docs/InstallationSteps.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/InstallationSteps.html?rev=1502017&r1=1502016&r2=1502017&view=diff
==============================================================================
--- incubator/falcon/site/docs/InstallationSteps.html (original)
+++ incubator/falcon/site/docs/InstallationSteps.html Wed Jul 10 21:37:31 2013
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20130710" />
<meta http-equiv="Content-Language" content="en" />
- <title>Falcon - Building & Packaging Falcon</title>
+ <title>Falcon - Building & Installing Falcon</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
<link rel="stylesheet" href="../css/site.css" />
<link rel="stylesheet" href="../css/print.css" media="print" />
@@ -214,7 +214,7 @@
Falcon</a>
</li>
<li class="divider ">/</li>
- <li class="">Building & Packaging Falcon</li>
+ <li class="">Building & Installing Falcon</li>
@@ -227,7 +227,74 @@
<div id="bodyColumn" >
- <div class="section"><h3>Building & Packaging Falcon<a name="Building__Packaging_Falcon"></a></h3></div><div class="section"><h4>Installing Falcon<a name="Installing_Falcon"></a></h4><p><b>Pre-requisites:</b></p><ul><li>hadoop-0.20.2 +</li><li>oozie-3.1.5 +</li></ul><p><b>Falcon Server</b></p><p></p><ul><li>Download the source from <a class="externalLink" href="https://git-wip-us.apache.org/repos/asf/incubator-falcon.git">https://git-wip-us.apache.org/repos/asf/incubator-falcon.git</a></li><li>Navigate to base project folder,named 'Falcon'</li><li>Build as "mvn clean package" at the base location. Please note that both maven 2/3 are supported.</li><li>By default only embedded/standalone mode is build.</li><li>To build Falcon with documentation build with MVN profile "all".</li><li>To build the Falcon for distributed mode, i.e. multiple server and prism mode, build with MVN profile "distributed".</li><li>Once the build operation is over,n
avigate to '<base-folder>/Falcon/webapps/target' and deploy the .war file generated</li></ul>there in a web container (Eg: tomcat6).</div><div class="section"><h4>User Guide<a name="User_Guide"></a></h4><p><b>Falcon Client</b></p><p></p><ul><li>Follow the steps 1 to 3 from server instructions.</li><li>Once the build operation is over, navigate to '<base-folder>/Falcon/client/target'. There is a client.jar that has</li></ul>been generated along with multiple other jars. Fetch this jar and others to use the Falcon client application. Please ensure that the other jars in the folder are always specified in the classpath of the client.jar.<ul><li>Please refer Falcon-CLI guide for various options on how to use the falcon client.</li></ul></div><div class="section"><h4>Administration Guide<a name="Administration_Guide"></a></h4><p><b>Setting up Falcon server properties:</b> Inside your web container, where the falcon war has exploded, you should be able to find 2 files, s
tartup.properties and runtime.properties. The path would be: <container-base>/<war-location>/falcon-webapp-0.2-SNAPSHOT/WEB-INF/classes</p><p><b>startup.properties:</b> Specifies values/paths used by Falcon on startup. Common entries usually include config store location ,broker url (for messaging), and other settings.Any changes to this requires Falcon to be restarted to take effect.</p><p><b>runtime.properties:</b> Specifies various properties that can be picked at runtime. Falcon server keeps polling this file after a certain interval; and incorporates changes, if any.</p><p><b>Domain based settings (only applicable for Falcon 0.2):</b></p><p>Falcon 0.2 and subsequent releases support domain based properties. The user can specify properties either for all domains (with prefixing the property with a '*' ) or for a particular domain (with prefixing the domain name to the property). Once the domain is set, the user can set an env variable,FALCON_DOMAIN as the domain tha
t the Falcon is supposed to use.</p><p>Please refer the example below:</p><p>Example: Trying to set the config store property for all domains:</p><p>*.config.store.uri=file:///var/lib/tomcat6/target/store</p><p>Trying to set config store property for a 'specific' domain:</p><p>qa.config.store.uri=file:///var/lib/tomcat6/target/store</p><p>To ensure that Falcon installation on your system uses the qa domain settings, just set the FALCON_DOMAIN value to 'qa' in your environment.</p></div><div class="section"><h5>Security<a name="Security"></a></h5><p><b>TO-DO</b></p></div>
+ <div class="section"><h3>Building & Installing Falcon<a name="Building__Installing_Falcon"></a></h3></div><div class="section"><h4>Building Falcon<a name="Building_Falcon"></a></h4><div class="source"><pre class="prettyprint">
+git clone https://git-wip-us.apache.org/repos/asf/incubator-falcon.git falcon
+
+cd falcon
+
+export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=256m" && mvn clean install
+
+[optionally -Dhadoop.version=<<hadoop.version>> can be appended to build for a specific version of hadoop]
+[Falcon has currently not been tested with secure Hadoop / Hadoop 2.0]
+
+
+</pre></div><p>Once the build successfully completes, artifacts can be packaged for deployment. By default the falcon is built for embedded mode.</p><div class="source"><pre class="prettyprint">
+
+mvn clean assembly:assembly -DskipTests
+
+
+</pre></div><p>Tar can be found in {project dir}/target/falcon-${project.version}.tar.gz</p><p>Tar is structured as follows</p><div class="source"><pre class="prettyprint">
+
+|- bin
+ |- falcon
+ |- falcon-start
+ |- falcon-stop
+|- conf
+ |- startup.properties
+ |- runtime.properties
+ |- client.properties
+ |- log4j.xml
+|- src
+|- docs
+|- client
+ |- lib (client support libs)
+|- server
+ |- webapp
+ |- classes (serer support classes)
+ |- lib (server support libs)
+ |- falcon.war
+|- logs (application log files & temp data files)
+ |- falcon.pid
+
+
+</pre></div></div><div class="section"><h4>Installing & running Falcon<a name="Installing__running_Falcon"></a></h4><p><b>Installing falcon</b></p><div class="source"><pre class="prettyprint">
+tar -xzvf falcon-${project.version}.tar.gz
+cd falcon-main-${project.version}
+
+</pre></div><p><b>Starting Falcon Server</b></p><div class="source"><pre class="prettyprint">
+bin/falcon-start
+
+</pre></div><p><b>Using Falcon</b></p><div class="source"><pre class="prettyprint">
+bin/falcon admin -version
+Falcon server build version: {Version:"0.3-SNAPSHOT-rd7e2be9afa2a5dc96acd1ec9e325f39c6b2f17f7",Mode:"embedded"}
+
+----
+
+bin/falcon help
+(for more details about falcon cli usage)
+
+</pre></div><p><b>Stopping Falcon Server</b></p><div class="source"><pre class="prettyprint">
+bin/falcon-stop
+
+</pre></div></div><div class="section"><h4>Preparing oozie bundle for use with Falcon<a name="Preparing_oozie_bundle_for_use_with_Falcon"></a></h4><div class="source"><pre class="prettyprint">
+cd <<project home>>
+mkdir target/package
+src/bin/pacakge.sh <<hadoop-version>>
+
+>> ex. src/bin/pacakge.sh 1.1.2 or src/bin/pacakge.sh 0.20.2-cdh3u5
+>> oozie bundle available in target/package/oozie-3.2.0-incubating/distro/target/oozie-3.2.2-distro.tar.gz
+
+</pre></div></div>
</div>
</div>
Modified: incubator/falcon/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/CHANGES.txt?rev=1502017&r1=1502016&r2=1502017&view=diff
==============================================================================
--- incubator/falcon/trunk/CHANGES.txt (original)
+++ incubator/falcon/trunk/CHANGES.txt Wed Jul 10 21:37:31 2013
@@ -8,6 +8,8 @@ Trunk (Unreleased)
IMPROVEMENTS
+ FALCON-1 Update installation steps to reflect packaging changes (Srikanth Sundarrajan via Venkatesh Seetharam)
+
FALCON-43 Update Ivory references in images to Falcon on Architecture page (Srikanth Sundarrajan)
FALCON-45 Architecture diagram in Site / Docs still refer to Ivory (Srikanth Sundarrajan)
Modified: incubator/falcon/trunk/src/site/twiki/docs/InstallationSteps.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/src/site/twiki/docs/InstallationSteps.twiki?rev=1502017&r1=1502016&r2=1502017&view=diff
==============================================================================
--- incubator/falcon/trunk/src/site/twiki/docs/InstallationSteps.twiki (original)
+++ incubator/falcon/trunk/src/site/twiki/docs/InstallationSteps.twiki Wed Jul 10 21:37:31 2013
@@ -1,65 +1,92 @@
----++ Building & Packaging Falcon
+---++ Building & Installing Falcon
----+++ Installing Falcon
+---+++ Building Falcon
-*Pre-requisites:*
- * hadoop-0.20.2 +
- * oozie-3.1.5 +
+<verbatim>
+git clone https://git-wip-us.apache.org/repos/asf/incubator-falcon.git falcon
-*Falcon Server*
+cd falcon
- * Download the source from https://git-wip-us.apache.org/repos/asf/incubator-falcon.git
- * Navigate to base project folder,named 'Falcon'
- * Build as "mvn clean package" at the base location. Please note that both maven 2/3 are supported.
- * By default only embedded/standalone mode is build.
- * To build Falcon with documentation build with MVN profile "all".
- * To build the Falcon for distributed mode, i.e. multiple server and prism mode, build with MVN profile "distributed".
- * Once the build operation is over,navigate to '<base-folder>/Falcon/webapps/target' and deploy the .war file generated
- there in a web container (Eg: tomcat6).
+export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=256m" && mvn clean install
----+++ User Guide
+[optionally -Dhadoop.version=<<hadoop.version>> can be appended to build for a specific version of hadoop]
+[Falcon has currently not been tested with secure Hadoop / Hadoop 2.0]
-*Falcon Client*
+</verbatim>
- * Follow the steps 1 to 3 from server instructions.
- * Once the build operation is over, navigate to '<base-folder>/Falcon/client/target'. There is a client.jar that has
- been generated along with multiple other jars. Fetch this jar and others to use the Falcon client application.
- Please ensure that the other jars in the folder are always specified in the classpath of the client.jar.
- * Please refer Falcon-CLI guide for various options on how to use the falcon client.
+Once the build successfully completes, artifacts can be packaged for deployment. By default the falcon is built for embedded mode.
----+++ Administration Guide
+<verbatim>
-*Setting up Falcon server properties:*
-Inside your web container, where the falcon war has exploded, you should be able to find 2 files, startup.properties and runtime.properties.
-The path would be:
-<container-base>/<war-location>/falcon-webapp-0.2-SNAPSHOT/WEB-INF/classes
+mvn clean assembly:assembly -DskipTests
-*startup.properties:* Specifies values/paths used by Falcon on startup. Common entries usually include config store location
-,broker url (for messaging), and other settings.Any changes to this requires Falcon to be restarted to take effect.
+</verbatim>
-*runtime.properties:* Specifies various properties that can be picked at runtime. Falcon server keeps polling this file after a certain interval;
-and incorporates changes, if any.
+Tar can be found in {project dir}/target/falcon-${project.version}.tar.gz
-*Domain based settings (only applicable for Falcon 0.2):*
+Tar is structured as follows
-Falcon 0.2 and subsequent releases support domain based properties. The user can specify properties either for all domains
-(with prefixing the property with a '*' ) or for a particular domain (with prefixing the domain name to the property).
-Once the domain is set, the user can set an env variable,FALCON_DOMAIN as the domain that the Falcon is supposed to use.
+<verbatim>
-Please refer the example below:
+|- bin
+ |- falcon
+ |- falcon-start
+ |- falcon-stop
+|- conf
+ |- startup.properties
+ |- runtime.properties
+ |- client.properties
+ |- log4j.xml
+|- src
+|- docs
+|- client
+ |- lib (client support libs)
+|- server
+ |- webapp
+ |- classes (serer support classes)
+ |- lib (server support libs)
+ |- falcon.war
+|- logs (application log files & temp data files)
+ |- falcon.pid
-Example:
-Trying to set the config store property for all domains:
+</verbatim>
-*.config.store.uri=file:///var/lib/tomcat6/target/store
+---+++ Installing & running Falcon
-Trying to set config store property for a 'specific' domain:
+*Installing falcon*
+<verbatim>
+tar -xzvf falcon-${project.version}.tar.gz
+cd falcon-main-${project.version}
+</verbatim>
-qa.config.store.uri=file:///var/lib/tomcat6/target/store
+*Starting Falcon Server*
+<verbatim>
+bin/falcon-start
+</verbatim>
-To ensure that Falcon installation on your system uses the qa domain settings, just set the FALCON_DOMAIN value to 'qa' in your environment.
+*Using Falcon*
+<verbatim>
+bin/falcon admin -version
+Falcon server build version: {Version:"0.3-SNAPSHOT-rd7e2be9afa2a5dc96acd1ec9e325f39c6b2f17f7",Mode:"embedded"}
----++++ Security
+----
-*TO-DO*
\ No newline at end of file
+bin/falcon help
+(for more details about falcon cli usage)
+</verbatim>
+
+*Stopping Falcon Server*
+<verbatim>
+bin/falcon-stop
+</verbatim>
+
+---+++ Preparing oozie bundle for use with Falcon
+<verbatim>
+cd <<project home>>
+mkdir target/package
+src/bin/pacakge.sh <<hadoop-version>>
+
+>> ex. src/bin/pacakge.sh 1.1.2 or src/bin/pacakge.sh 0.20.2-cdh3u5
+>> oozie bundle available in target/package/oozie-3.2.0-incubating/distro/target/oozie-3.2.2-distro.tar.gz
+</verbatim>
\ No newline at end of file