You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@falcon.apache.org by pa...@apache.org on 2016/03/10 10:38:05 UTC
[6/6] falcon git commit: Adding trunk files
Adding trunk files
Project: http://git-wip-us.apache.org/repos/asf/falcon/repo
Commit: http://git-wip-us.apache.org/repos/asf/falcon/commit/31b1d7e6
Tree: http://git-wip-us.apache.org/repos/asf/falcon/tree/31b1d7e6
Diff: http://git-wip-us.apache.org/repos/asf/falcon/diff/31b1d7e6
Branch: refs/heads/asf-site
Commit: 31b1d7e6a26fc7c3cb70e7230089064e0a02a9a8
Parents: 8e49379
Author: Pallavi Rao <pa...@inmobi.com>
Authored: Thu Mar 10 15:07:40 2016 +0530
Committer: Pallavi Rao <pa...@inmobi.com>
Committed: Thu Mar 10 15:07:40 2016 +0530
----------------------------------------------------------------------
.../src/site/twiki/Distributed-mode.twiki | 2 +-
.../general/src/site/twiki/Embedded-mode.twiki | 2 +-
.../src/site/twiki/EntitySpecification.twiki | 21 +-
.../src/site/twiki/FalconNativeScheduler.twiki | 2 +-
trunk/general/src/site/twiki/ImportExport.twiki | 34 +-
trunk/general/src/site/twiki/Recipes.twiki | 2 +-
.../src/site/twiki/falconcli/ListInstance.twiki | 1 +
.../site/twiki/falconcli/StatusInstance.twiki | 1 +
.../src/site/twiki/restapi/EntitySchedule.twiki | 70 +-
.../src/site/twiki/restapi/InstanceList.twiki | 51 +
.../src/site/twiki/restapi/InstanceStatus.twiki | 1 +
trunk/releases/master/pom.xml | 66 ++
.../master/src/site/resources/Architecture.png | Bin 0 -> 65687 bytes
.../src/site/resources/EntityDependency.png | Bin 0 -> 53036 bytes
.../master/src/site/resources/FeedSchedule.png | Bin 0 -> 84841 bytes
.../master/src/site/resources/PrismSetup.png | Bin 0 -> 103747 bytes
.../src/site/resources/ProcessSchedule.png | Bin 0 -> 85720 bytes
.../images/accessories-text-editor.png | Bin 0 -> 746 bytes
.../master/src/site/resources/images/add.gif | Bin 0 -> 397 bytes
.../resources/images/apache-incubator-logo.png | Bin 0 -> 4234 bytes
.../resources/images/apache-maven-project-2.png | Bin 0 -> 33442 bytes
.../images/application-certificate.png | Bin 0 -> 923 bytes
.../src/site/resources/images/contact-new.png | Bin 0 -> 736 bytes
.../resources/images/document-properties.png | Bin 0 -> 577 bytes
.../site/resources/images/drive-harddisk.png | Bin 0 -> 700 bytes
.../src/site/resources/images/falcon-logo.png | Bin 0 -> 13293 bytes
.../master/src/site/resources/images/fix.gif | Bin 0 -> 366 bytes
.../site/resources/images/icon_error_sml.gif | Bin 0 -> 633 bytes
.../src/site/resources/images/icon_help_sml.gif | Bin 0 -> 1072 bytes
.../src/site/resources/images/icon_info_sml.gif | Bin 0 -> 638 bytes
.../site/resources/images/icon_success_sml.gif | Bin 0 -> 604 bytes
.../site/resources/images/icon_warning_sml.gif | Bin 0 -> 625 bytes
.../site/resources/images/image-x-generic.png | Bin 0 -> 662 bytes
.../resources/images/internet-web-browser.png | Bin 0 -> 1017 bytes
.../images/logos/build-by-maven-black.png | Bin 0 -> 2294 bytes
.../images/logos/build-by-maven-white.png | Bin 0 -> 2260 bytes
.../resources/images/logos/maven-feather.png | Bin 0 -> 3330 bytes
.../site/resources/images/network-server.png | Bin 0 -> 536 bytes
.../site/resources/images/package-x-generic.png | Bin 0 -> 717 bytes
.../resources/images/profiles/pre-release.png | Bin 0 -> 32607 bytes
.../site/resources/images/profiles/retired.png | Bin 0 -> 22003 bytes
.../site/resources/images/profiles/sandbox.png | Bin 0 -> 33010 bytes
.../master/src/site/resources/images/remove.gif | Bin 0 -> 607 bytes
.../master/src/site/resources/images/rss.png | Bin 0 -> 474 bytes
.../master/src/site/resources/images/update.gif | Bin 0 -> 1090 bytes
.../src/site/resources/images/window-new.png | Bin 0 -> 583 bytes
trunk/releases/master/src/site/site.xml | 62 ++
.../master/src/site/twiki/Appendix.twiki | 55 +
.../master/src/site/twiki/Configuration.twiki | 122 +++
.../src/site/twiki/Distributed-mode.twiki | 198 ++++
.../master/src/site/twiki/Embedded-mode.twiki | 198 ++++
.../src/site/twiki/EntitySpecification.twiki | 996 +++++++++++++++++++
.../src/site/twiki/FalconDocumentation.twiki | 777 +++++++++++++++
.../site/twiki/FalconEmailNotification.twiki | 29 +
.../src/site/twiki/FalconNativeScheduler.twiki | 213 ++++
.../releases/master/src/site/twiki/HDFSDR.twiki | 34 +
.../releases/master/src/site/twiki/HiveDR.twiki | 74 ++
.../master/src/site/twiki/HiveIntegration.twiki | 372 +++++++
.../master/src/site/twiki/ImportExport.twiki | 242 +++++
.../src/site/twiki/InstallationSteps.twiki | 87 ++
.../releases/master/src/site/twiki/LICENSE.txt | 3 +
.../src/site/twiki/MigrationInstructions.twiki | 15 +
.../master/src/site/twiki/OnBoarding.twiki | 269 +++++
.../master/src/site/twiki/Operability.twiki | 110 ++
.../master/src/site/twiki/Recipes.twiki | 85 ++
.../master/src/site/twiki/Security.twiki | 387 +++++++
.../src/site/twiki/falconcli/CommonCLI.twiki | 21 +
.../site/twiki/falconcli/ContinueInstance.twiki | 8 +
.../src/site/twiki/falconcli/Definition.twiki | 8 +
.../src/site/twiki/falconcli/DeleteEntity.twiki | 8 +
.../site/twiki/falconcli/DependencyEntity.twiki | 10 +
.../twiki/falconcli/DependencyInstance.twiki | 33 +
.../src/site/twiki/falconcli/EdgeMetadata.twiki | 11 +
.../src/site/twiki/falconcli/FalconCLI.twiki | 112 +++
.../twiki/falconcli/FeedInstanceListing.twiki | 11 +
.../src/site/twiki/falconcli/HelpAdmin.twiki | 6 +
.../src/site/twiki/falconcli/KillInstance.twiki | 14 +
.../twiki/falconcli/LifeCycleInstance.twiki | 9 +
.../site/twiki/falconcli/LineageMetadata.twiki | 12 +
.../src/site/twiki/falconcli/ListEntity.twiki | 17 +
.../src/site/twiki/falconcli/ListInstance.twiki | 20 +
.../src/site/twiki/falconcli/ListMetadata.twiki | 13 +
.../src/site/twiki/falconcli/LogsInstance.twiki | 14 +
.../src/site/twiki/falconcli/Lookup.twiki | 12 +
.../site/twiki/falconcli/ParamsInstance.twiki | 8 +
.../site/twiki/falconcli/RelationMetadata.twiki | 10 +
.../site/twiki/falconcli/RerunInstance.twiki | 10 +
.../src/site/twiki/falconcli/ResumeEntity.twiki | 8 +
.../site/twiki/falconcli/ResumeInstance.twiki | 8 +
.../site/twiki/falconcli/RunningInstance.twiki | 13 +
.../src/site/twiki/falconcli/SLAAlert.twiki | 49 +
.../src/site/twiki/falconcli/Schedule.twiki | 22 +
.../src/site/twiki/falconcli/StatusAdmin.twiki | 8 +
.../src/site/twiki/falconcli/StatusEntity.twiki | 8 +
.../site/twiki/falconcli/StatusInstance.twiki | 21 +
.../src/site/twiki/falconcli/Submit.twiki | 13 +
.../src/site/twiki/falconcli/SubmitRecipe.twiki | 17 +
.../site/twiki/falconcli/SummaryEntity.twiki | 14 +
.../site/twiki/falconcli/SummaryInstance.twiki | 20 +
.../site/twiki/falconcli/SuspendEntity.twiki | 8 +
.../site/twiki/falconcli/SuspendInstance.twiki | 8 +
.../master/src/site/twiki/falconcli/Touch.twiki | 10 +
.../site/twiki/falconcli/TriageInstance.twiki | 9 +
.../src/site/twiki/falconcli/UpdateEntity.twiki | 14 +
.../src/site/twiki/falconcli/VersionAdmin.twiki | 7 +
.../twiki/falconcli/VertexEdgesMetadata.twiki | 12 +
.../site/twiki/falconcli/VertexMetadata.twiki | 11 +
.../site/twiki/falconcli/VerticesMetadata.twiki | 11 +
.../releases/master/src/site/twiki/index.twiki | 43 +
.../site/twiki/restapi/AdjacentVertices.twiki | 91 ++
.../src/site/twiki/restapi/AdminConfig.twiki | 35 +
.../src/site/twiki/restapi/AdminStack.twiki | 40 +
.../src/site/twiki/restapi/AdminVersion.twiki | 35 +
.../src/site/twiki/restapi/AllEdges.twiki | 42 +
.../src/site/twiki/restapi/AllVertices.twiki | 43 +
.../master/src/site/twiki/restapi/Edge.twiki | 34 +
.../site/twiki/restapi/EntityDefinition.twiki | 53 +
.../src/site/twiki/restapi/EntityDelete.twiki | 31 +
.../site/twiki/restapi/EntityDependencies.twiki | 43 +
.../src/site/twiki/restapi/EntityLineage.twiki | 40 +
.../src/site/twiki/restapi/EntityList.twiki | 164 +++
.../src/site/twiki/restapi/EntityResume.twiki | 30 +
.../src/site/twiki/restapi/EntitySchedule.twiki | 100 ++
.../src/site/twiki/restapi/EntityStatus.twiki | 30 +
.../src/site/twiki/restapi/EntitySubmit.twiki | 105 ++
.../twiki/restapi/EntitySubmitAndSchedule.twiki | 64 ++
.../src/site/twiki/restapi/EntitySummary.twiki | 74 ++
.../src/site/twiki/restapi/EntitySuspend.twiki | 30 +
.../src/site/twiki/restapi/EntityTouch.twiki | 31 +
.../src/site/twiki/restapi/EntityUpdate.twiki | 66 ++
.../src/site/twiki/restapi/EntityValidate.twiki | 170 ++++
.../twiki/restapi/FeedInstanceListing.twiki | 46 +
.../src/site/twiki/restapi/FeedLookup.twiki | 37 +
.../master/src/site/twiki/restapi/FeedSLA.twiki | 56 ++
.../master/src/site/twiki/restapi/Graph.twiki | 22 +
.../twiki/restapi/InstanceDependencies.twiki | 49 +
.../src/site/twiki/restapi/InstanceKill.twiki | 44 +
.../src/site/twiki/restapi/InstanceList.twiki | 151 +++
.../src/site/twiki/restapi/InstanceLogs.twiki | 113 +++
.../src/site/twiki/restapi/InstanceParams.twiki | 83 ++
.../src/site/twiki/restapi/InstanceRerun.twiki | 66 ++
.../src/site/twiki/restapi/InstanceResume.twiki | 43 +
.../site/twiki/restapi/InstanceRunning.twiki | 84 ++
.../src/site/twiki/restapi/InstanceStatus.twiki | 98 ++
.../site/twiki/restapi/InstanceSummary.twiki | 114 +++
.../site/twiki/restapi/InstanceSuspend.twiki | 44 +
.../src/site/twiki/restapi/MetadataList.twiki | 31 +
.../site/twiki/restapi/MetadataRelations.twiki | 46 +
.../src/site/twiki/restapi/ResourceList.twiki | 93 ++
.../master/src/site/twiki/restapi/Triage.twiki | 45 +
.../master/src/site/twiki/restapi/Vertex.twiki | 36 +
.../site/twiki/restapi/VertexProperties.twiki | 34 +
.../src/site/twiki/restapi/Vertices.twiki | 38 +
153 files changed, 7982 insertions(+), 24 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/general/src/site/twiki/Distributed-mode.twiki
----------------------------------------------------------------------
diff --git a/trunk/general/src/site/twiki/Distributed-mode.twiki b/trunk/general/src/site/twiki/Distributed-mode.twiki
index 617ab51..34fb092 100644
--- a/trunk/general/src/site/twiki/Distributed-mode.twiki
+++ b/trunk/general/src/site/twiki/Distributed-mode.twiki
@@ -13,7 +13,7 @@ $mvn clean assembly:assembly -DskipTests -DskipCheck=true -Pdistributed,hadoop-2
<verbatim>
-$ls {project dir}/target/
+$ls {project dir}/distro/target/
</verbatim>
It should give an output like below :
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/general/src/site/twiki/Embedded-mode.twiki
----------------------------------------------------------------------
diff --git a/trunk/general/src/site/twiki/Embedded-mode.twiki b/trunk/general/src/site/twiki/Embedded-mode.twiki
index 96ae8ab..d5c37a1 100644
--- a/trunk/general/src/site/twiki/Embedded-mode.twiki
+++ b/trunk/general/src/site/twiki/Embedded-mode.twiki
@@ -11,7 +11,7 @@ $mvn clean assembly:assembly -DskipTests -DskipCheck=true
</verbatim>
<verbatim>
-$ls {project dir}/target/
+$ls {project dir}/distro/target/
</verbatim>
It should give an output like below :
<verbatim>
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/general/src/site/twiki/EntitySpecification.twiki
----------------------------------------------------------------------
diff --git a/trunk/general/src/site/twiki/EntitySpecification.twiki b/trunk/general/src/site/twiki/EntitySpecification.twiki
index c4f5f76..d08c3a3 100644
--- a/trunk/general/src/site/twiki/EntitySpecification.twiki
+++ b/trunk/general/src/site/twiki/EntitySpecification.twiki
@@ -821,6 +821,7 @@ The following are some special properties, which when present are used by the Fa
---+++ Workflow
The workflow defines the workflow engine that should be used and the path to the workflow on hdfs.
+Libraries required can be specified using lib attribute in the workflow element and will be comma separated HDFS paths.
The workflow definition on hdfs contains the actual job that should run and it should confirm to
the workflow specification of the engine specified. The libraries required by the workflow should
be in lib folder inside the workflow path.
@@ -840,7 +841,7 @@ Syntax:
<verbatim>
<process name="[process name]">
...
- <workflow engine=[workflow engine] path=[workflow path]/>
+ <workflow engine=[workflow engine] path=[workflow path] lib=[comma separated lib paths]/>
...
</process>
</verbatim>
@@ -856,6 +857,7 @@ Example:
This defines the workflow engine to be oozie and the workflow xml is defined at
/projects/bootcamp/workflow/workflow.xml. The libraries are at /projects/bootcamp/workflow/lib.
+Libraries path can be overridden using lib attribute. e.g.: lib="/projects/bootcamp/wf/libs,/projects/bootcamp/oozie/libs" in the workflow element.
---++++ Pig
@@ -865,7 +867,7 @@ Example:
<verbatim>
<process name="sample-process">
...
- <workflow engine="pig" path="/projects/bootcamp/pig.script"/>
+ <workflow engine="pig" path="/projects/bootcamp/pig.script" lib="/projects/bootcamp/wf/libs,/projects/bootcamp/pig/libs"/>
...
</process>
</verbatim>
@@ -897,12 +899,12 @@ Feeds with Hive table storage will send one more parameter apart from the genera
<verbatim>$input_filter</verbatim>
---+++ Retry
-Retry policy defines how the workflow failures should be handled. Three retry policies are defined: periodic, exp-backoff(exponential backoff) and final. Depending on the delay and number of attempts, the workflow is re-tried after specific intervals.
+Retry policy defines how the workflow failures should be handled. Three retry policies are defined: periodic, exp-backoff(exponential backoff) and final. Depending on the delay and number of attempts, the workflow is re-tried after specific intervals. If user sets the onTimeout attribute to "true", retries will happen for TIMED_OUT instances.
Syntax:
<verbatim>
<process name="[process name]">
...
- <retry policy=[retry policy] delay=[retry delay] attempts=[retry attempts]/>
+ <retry policy=[retry policy] delay=[retry delay] attempts=[retry attempts] onTimeout=[retry onTimeout]/>
...
</process>
</verbatim>
@@ -911,12 +913,21 @@ Examples:
<verbatim>
<process name="sample-process">
...
- <retry policy="periodic" delay="minutes(10)" attempts="3"/>
+ <retry policy="periodic" delay="minutes(10)" attempts="3" onTimeout="true"/>
...
</process>
</verbatim>
The workflow is re-tried after 10 mins, 20 mins and 30 mins. With exponential backoff, the workflow will be re-tried after 10 mins, 20 mins and 40 mins.
+*NOTE :* If user does a manual rerun with -force option (using the instance rerun API), then the runId will get reset and user might see more Falcon system retries than configured in the process definition.
+
+To enable retries for instances for feeds, user will have to set the following properties in runtime.properties
+<verbatim>
+falcon.recipe.retry.policy=periodic
+falcon.recipe.retry.delay=minutes(30)
+falcon.recipe.retry.attempts=3
+falcon.recipe.retry.onTimeout=false
+<verbatim>
---+++ Late data
Late data handling defines how the late data should be handled. Each feed is defined with a late cut-off value which specifies the time till which late data is valid. For example, late cut-off of hours(6) means that data for nth hour can get delayed by upto 6 hours. Late data specification in process defines how this late data is handled.
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/general/src/site/twiki/FalconNativeScheduler.twiki
----------------------------------------------------------------------
diff --git a/trunk/general/src/site/twiki/FalconNativeScheduler.twiki b/trunk/general/src/site/twiki/FalconNativeScheduler.twiki
index 255f216..9ffc5e9 100644
--- a/trunk/general/src/site/twiki/FalconNativeScheduler.twiki
+++ b/trunk/general/src/site/twiki/FalconNativeScheduler.twiki
@@ -113,7 +113,7 @@ usage:
schema
</verbatim>
-Currently, MySQL and Derby are supported as state stores. We may extend support to other DBs in the future. Falcon has been tested against MySQL v5.5. If you are using MySQL ensure you also copy mysql-connector-java-<version>.jar under __$FALCON_HOME/server/webapp/falcon/WEB-INF/lib__ and __$FALCON_HOME/client/lib__
+Currently, MySQL, postgreSQL and Derby are supported as state stores. We may extend support to other DBs in the future. Falcon has been tested against MySQL v5.5 and PostgreSQL v9.5. If you are using MySQL ensure you also copy mysql-connector-java-<version>.jar under __$FALCON_HOME/server/webapp/falcon/WEB-INF/lib__ and __$FALCON_HOME/client/lib__
---++++ Using Derby as the State Store
Using Derby is ideal for QA and staging setup. Falcon comes bundled with a Derby connector and no explicit setup is required (although you can set it up) in terms creating the DB or tables.
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/general/src/site/twiki/ImportExport.twiki
----------------------------------------------------------------------
diff --git a/trunk/general/src/site/twiki/ImportExport.twiki b/trunk/general/src/site/twiki/ImportExport.twiki
index 5df9365..b0ce7ff 100644
--- a/trunk/general/src/site/twiki/ImportExport.twiki
+++ b/trunk/general/src/site/twiki/ImportExport.twiki
@@ -46,8 +46,12 @@ where {lib-dir} value varies in oozie deployments.
Where as, the export operation will use the write interface with url "jdbc:mysql://dbhost/test" with user
name "export_usr" and password specified in a HDFS file at the location "/user/ambari-qa/password-store/password_write_user".
- The default credential specifies the password using password text and will be used if either read or write interface
- does not provide credentials.
+ The default credential specified will be used if either the read or write interface does not provide its own
+ credentials. The default credential specifies the password using password alias feature available via hadoop credential
+ functionality. User will be able to create a password alias using "hadoop credential -create <alias> -provider
+ <provider-path>" command, where <alias> is a string and <provider-path> is a HDFS jceks file. During runtime,
+ the specified alias will be used to look up the password stored encrypted in the jceks hdfs file specified under
+ the providerPath element.
The available read and write interfaces enable database administrators to segregate read and write workloads.
@@ -76,9 +80,12 @@ where {lib-dir} value varies in oozie deployments.
</interface>
<!-- *** default credential *** -->
- <credential type="password-text">
+ <credential type="password-alias">
<userName>sqoop2_user</userName>
- <passwordText>sqoop</passwordText>
+ <passwordAlias>
+ <alias>sqoop.password.alias</alias>
+ <providerPath>hdfs://namenode:8020/user/ambari-qa/sqoop_password.jceks</providerPath>
+ </passwordAlias>
</credential>
</interfaces>
@@ -170,25 +177,25 @@ where {lib-dir} value varies in oozie deployments.
specified should exist in the source datasource.
Extraction type specifies whether to pull data from external datasource "full" everytime or "incrementally".
- The mergepolicy specifies how to organize (snapshot or append, i.e time series partiitons) the data on hadoop.
- The valid combinations are:
+ The mergepolicy specifies how to organize (snapshot or append, i.e time series partiitons) the data on hadoop.
+ The valid combinations are:
* [full,snapshot] - data is extracted in full and dumped into the feed instance location.
- * [incremental, append] - data is extracted incrementally using the key specified in the *deltacolumn*
- and added as a partition to the feed instance location.
+ * [incremental, append] - data is extracted incrementally using the key specified in the *deltacolumn*
+ and added as a partition to the feed instance location.
* [incremental, snapshot] - data is extracted incrementally and merged with already existing data on hadoop to
- produce one latest feed instance.*This feature is not supported currently*. The use case for this feature is
+ produce one latest feed instance.*This feature is not supported currently*. The use case for this feature is
to efficiently import very large dimention tables that have updates and inserts onto hadoop and make it available
as a snapshot with latest updates to consumers.
The following example defines an incremental extraction with append organization:
<verbatim>
- <import>
+ <import>
<source name="mysql-db" tableName="simple">
<extract type="incremental">
<deltacolumn>modified_time</deltacolumn>
<mergepolicy>append</mergepolicy>
- </extract>
+ </extract>
<fields>
<includes>
<field>id</field>
@@ -201,9 +208,9 @@ where {lib-dir} value varies in oozie deployments.
<argument name="--num-mappers" value="2"/>
</arguments>
</import>
- </verbatim>
+ </verbatim>
+
-
The fields option enables to control what fields get imported. By default, all fields get import. The "includes" option
brings only those fields specified. The "excludes" option brings all the fields other than specified.
@@ -211,7 +218,6 @@ where {lib-dir} value varies in oozie deployments.
in this case, Sqoop.
* *Export policy*
-
The export, like import, uses the datasource for connecting to the database. Load type specifies whether to insert
or only update data onto the external table. Fields option behaves the same way as in import policy.
The tableName specified should exist in the external datasource.
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/general/src/site/twiki/Recipes.twiki
----------------------------------------------------------------------
diff --git a/trunk/general/src/site/twiki/Recipes.twiki b/trunk/general/src/site/twiki/Recipes.twiki
index f6011c4..b5faa1e 100644
--- a/trunk/general/src/site/twiki/Recipes.twiki
+++ b/trunk/general/src/site/twiki/Recipes.twiki
@@ -23,7 +23,7 @@ replacing the parameters in the workflow definition.
---++ Falcon CLI recipe support
Falcon CLI functionality to support recipes has been added.
-<a href="./FalconCLI.html">Recipe command usage is defined here.</a>
+[[falconcli/FalconCLI][Falcon CLI]] Recipe command usage is defined here.
CLI accepts recipe option with a recipe name and optional tool and does the following:
* Validates the options; name option is mandatory and tool is optional and should be provided if user wants to override the base recipe tool
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/general/src/site/twiki/falconcli/ListInstance.twiki
----------------------------------------------------------------------
diff --git a/trunk/general/src/site/twiki/falconcli/ListInstance.twiki b/trunk/general/src/site/twiki/falconcli/ListInstance.twiki
index 28e9fed..1203629 100644
--- a/trunk/general/src/site/twiki/falconcli/ListInstance.twiki
+++ b/trunk/general/src/site/twiki/falconcli/ListInstance.twiki
@@ -15,5 +15,6 @@ $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -list
Optional Args : -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'"
-colo <<colo>> -lifecycle <<lifecycles>>
-filterBy <<field1:value1,field2:value2>> -orderBy field -sortOrder <<sortOrder>> -offset 0 -numResults 10
+-allAttempts To get all the attempts for corresponding instances
<a href="../Restapi/InstanceList.html">Optional params described here.</a>
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/general/src/site/twiki/falconcli/StatusInstance.twiki
----------------------------------------------------------------------
diff --git a/trunk/general/src/site/twiki/falconcli/StatusInstance.twiki b/trunk/general/src/site/twiki/falconcli/StatusInstance.twiki
index f0392b3..047d334 100644
--- a/trunk/general/src/site/twiki/falconcli/StatusInstance.twiki
+++ b/trunk/general/src/site/twiki/falconcli/StatusInstance.twiki
@@ -16,5 +16,6 @@ $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -status
Optional Args : -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -colo <<colo>>
-filterBy <<field1:value1,field2:value2>> -lifecycle <<lifecycles>>
-orderBy field -sortOrder <<sortOrder>> -offset 0 -numResults 10
+-allAttempts To get all the attempts for corresponding instances
<a href="../Restapi/InstanceStatus.html"> Optional params described here.</a>
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/general/src/site/twiki/restapi/EntitySchedule.twiki
----------------------------------------------------------------------
diff --git a/trunk/general/src/site/twiki/restapi/EntitySchedule.twiki b/trunk/general/src/site/twiki/restapi/EntitySchedule.twiki
index 263d152..0dede9b 100644
--- a/trunk/general/src/site/twiki/restapi/EntitySchedule.twiki
+++ b/trunk/general/src/site/twiki/restapi/EntitySchedule.twiki
@@ -12,15 +12,81 @@ Schedule an entity.
* :entity-name is name of the entity.
* skipDryRun : Optional query param, Falcon skips oozie dryrun when value is set to true.
* doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.
+ * properties <key1:val1,...,keyN:valN> : Optional query param, supplies a set of key-value pairs that will be available to the entity in the coordinator configuration. These values will not override properties with the same name predefined in the entity specification. For example, to change the scheduler used for scheduling the entity you would set the property _falcon.scheduler_ in the properties parameter to _native_ to use the Falcon Scheduler or to _oozie_ to use the Oozie Scheduler.
---++ Results
Result of the schedule command.
---++ Examples
+---+++ Oozie Workflow
+<verbatim>
+<workflow-app xmlns="uri:oozie:workflow:0.4" name="aggregator-wf">
+ <start to="aggregator" />
+ <action name="aggregator">
+ <java>
+ <job-tracker>${jobTracker}</job-tracker>
+ <name-node>${nameNode}</name-node>
+ <configuration>
+ <property>
+ <name>mapred.job.queue.name</name>
+ <value>${queueName}</value>
+ </property>
+ </configuration>
+ <main-class>com.company.hadoop.AggregatorJob</main-class>
+ <java-opts>-Dframework.instrumentation.host=${instrumentationServer}</java-opts>
+ <arg>--input.path=${inputBasePath}</arg>
+ <arg>--output.path=${outputBasePath}</arg>
+ </java>
+ <ok to="end" />
+ <error to="fail" />
+ </action>
+ <kill name="fail">
+ <message>Action failed, error message[${wf:errorMessage(wf:lastErrorNode())}]</message>
+ </kill>
+</workflow-app>
+</verbatim>
+---+++ Submitted Process
+<verbatim>
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
+<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
+ <clusters>
+ <cluster name="primary-cluster">
+ <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" />
+ </cluster>
+ </clusters>
+
+ <parallel>1</parallel>
+ <order>FIFO</order>
+ <frequency>hours(1)</frequency>
+
+ <inputs>
+ <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" />
+ </inputs>
+
+ <outputs>
+ <output name="output" feed="SampleOutput" instance="yesterday(0,0)" />
+ </outputs>
+
+ <properties>
+ <property name="queueName" value="default" />
+ <property name="ssh.host" value="localhost" />
+ <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" />
+ <property name="instrumentationServer" value="${coord:conf('instrumentation.host')}" />
+ </properties>
+
+ <workflow engine="oozie" path="/examples/apps/aggregator" />
+ <retry policy="exp-backoff" delay="minutes(5)" attempts="3" />
+
+ <late-process policy="exp-backoff" delay="hours(1)">
+ <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" />
+ </late-process>
+</process>
+</verbatim>
---+++ Rest Call
<verbatim>
-POST http://localhost:15000/api/entities/schedule/process/SampleProcess?skipDryRun=false&doAs=joe
+POST http://localhost:15000/api/entities/schedule/process/SampleProcess?skipDryRun=false&doAs=joe&properties=instrumentation.host:intrumentation.localdomain
</verbatim>
---+++ Result
<verbatim>
@@ -30,3 +96,5 @@ POST http://localhost:15000/api/entities/schedule/process/SampleProcess?skipDryR
"status": "SUCCEEDED"
}
</verbatim>
+---+++ Notes
+In this example, the value of _framework.instrumentation.host_ in the Oozie workflow will be _intrumentation.localdomain_ which is the property passed when the process is scheduled.
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/general/src/site/twiki/restapi/InstanceList.twiki
----------------------------------------------------------------------
diff --git a/trunk/general/src/site/twiki/restapi/InstanceList.twiki b/trunk/general/src/site/twiki/restapi/InstanceList.twiki
index 5dee8a5..214c22f 100644
--- a/trunk/general/src/site/twiki/restapi/InstanceList.twiki
+++ b/trunk/general/src/site/twiki/restapi/InstanceList.twiki
@@ -25,6 +25,7 @@ Get list of all instances of a given entity.
* offset <optional param> Show results from the offset, used for pagination. Defaults to 0.
* numResults <optional param> Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10.
* doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.
+ * allAttempts <optional query param> To get all the attempts for corresponding instances.
---++ Results
List of instances of given entity.
@@ -98,3 +99,53 @@ GET http://localhost:15000/api/instance/list/process/SampleProcess?colo=*&start=
"status": "SUCCEEDED"
}
</verbatim>
+
+
+---+++ Rest Call
+<verbatim>
+GET https://localhost:15443/api/instance/status/process/oozie-mr-process?user.name=narayan&start=2013-11-15T00:05Z&end=2013-11-15T01:00Z&colo=*&offset=0&allAttempts=true
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "status":"SUCCEEDED",
+ "message":"default/STATUS\n",
+ "requestId":"default/942519651@qtp-1386909980-16 - 5b11a8ba-402b-4cc7-969c-256e0ed18ae2\n",
+ "instances":[
+ {
+ "instance":"2013-11-15T00:05Z",
+ "status":"SUCCEEDED",
+ "logFile":"http://IM1948-X0:11000/oozie?job=0000010-160106121750678-oozie-oozi-W",
+ "cluster":"local",
+ "startTime":"2016-01-06T12:39:22+05:30",
+ "endTime":"2016-01-06T12:40:05+05:30",
+ "runId":0,
+ "details":"",
+ "actions":[
+ {
+ "action":"mr-node",
+ "status":"SUCCEEDED",
+ "logFile":"http://localhost:8088/proxy/application_1452062826344_0010/"
+ }
+ ]
+ },
+ {
+ "instance":"2013-11-15T00:05Z",
+ "status":"SUCCEEDED",
+ "logFile":"http://IM1948-X0:11000/oozie?job=0000011-160106121750678-oozie-oozi-W",
+ "cluster":"local",
+ "startTime":"2016-01-06T12:40:27+05:30",
+ "endTime":"2016-01-06T12:41:05+05:30",
+ "runId":0,
+ "details":"",
+ "actions":[
+ {
+ "action":"mr-node",
+ "status":"SUCCEEDED",
+ "logFile":"http://localhost:8088/proxy/application_1452062826344_0012/"
+ }
+ ]
+ }
+ ]
+}
+</verbatim>
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/general/src/site/twiki/restapi/InstanceStatus.twiki
----------------------------------------------------------------------
diff --git a/trunk/general/src/site/twiki/restapi/InstanceStatus.twiki b/trunk/general/src/site/twiki/restapi/InstanceStatus.twiki
index 53f512f..2b7b643 100644
--- a/trunk/general/src/site/twiki/restapi/InstanceStatus.twiki
+++ b/trunk/general/src/site/twiki/restapi/InstanceStatus.twiki
@@ -25,6 +25,7 @@ Get status of a specific instance of an entity.
* offset <optional param> Show results from the offset, used for pagination. Defaults to 0.
* numResults <optional param> Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10.
* doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.
+ * allAttempts <optional query param> To get all the attempts for corresponding instances.
---++ Results
Status of the specified instance along with job urls for all actions of user workflow and non-succeeded actions of the main-workflow.
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/pom.xml
----------------------------------------------------------------------
diff --git a/trunk/releases/master/pom.xml b/trunk/releases/master/pom.xml
new file mode 100644
index 0000000..dfa3758
--- /dev/null
+++ b/trunk/releases/master/pom.xml
@@ -0,0 +1,66 @@
+<?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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.apache.falcon</groupId>
+ <artifactId>falcon-website-releases</artifactId>
+ <version>0.2</version>
+ </parent>
+ <artifactId>falcon-website-master</artifactId>
+ <version>master</version>
+ <packaging>pom</packaging>
+
+ <name>Apache Falcon - Documentation vmaster</name>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-site-plugin</artifactId>
+ <version>3.3</version>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.maven.doxia</groupId>
+ <artifactId>doxia-module-twiki</artifactId>
+ <version>1.3</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.maven.wagon</groupId>
+ <artifactId>wagon-ssh-external</artifactId>
+ <version>2.6</version>
+ </dependency>
+ </dependencies>
+ <executions>
+ <execution>
+ <goals>
+ <goal>site</goal>
+ </goals>
+ <phase>prepare-package</phase>
+ </execution>
+ </executions>
+ <configuration>
+ <outputDirectory>../../../site/master</outputDirectory>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+
+</project>
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/Architecture.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/Architecture.png b/trunk/releases/master/src/site/resources/Architecture.png
new file mode 100644
index 0000000..0378b49
Binary files /dev/null and b/trunk/releases/master/src/site/resources/Architecture.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/EntityDependency.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/EntityDependency.png b/trunk/releases/master/src/site/resources/EntityDependency.png
new file mode 100644
index 0000000..9f11870
Binary files /dev/null and b/trunk/releases/master/src/site/resources/EntityDependency.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/FeedSchedule.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/FeedSchedule.png b/trunk/releases/master/src/site/resources/FeedSchedule.png
new file mode 100644
index 0000000..105c6b1
Binary files /dev/null and b/trunk/releases/master/src/site/resources/FeedSchedule.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/PrismSetup.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/PrismSetup.png b/trunk/releases/master/src/site/resources/PrismSetup.png
new file mode 100644
index 0000000..b0dc9a5
Binary files /dev/null and b/trunk/releases/master/src/site/resources/PrismSetup.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/ProcessSchedule.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/ProcessSchedule.png b/trunk/releases/master/src/site/resources/ProcessSchedule.png
new file mode 100644
index 0000000..a7dd788
Binary files /dev/null and b/trunk/releases/master/src/site/resources/ProcessSchedule.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/accessories-text-editor.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/accessories-text-editor.png b/trunk/releases/master/src/site/resources/images/accessories-text-editor.png
new file mode 100644
index 0000000..abc3366
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/accessories-text-editor.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/add.gif
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/add.gif b/trunk/releases/master/src/site/resources/images/add.gif
new file mode 100644
index 0000000..1cb3dbf
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/add.gif differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/apache-incubator-logo.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/apache-incubator-logo.png b/trunk/releases/master/src/site/resources/images/apache-incubator-logo.png
new file mode 100644
index 0000000..81fb31e
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/apache-incubator-logo.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/apache-maven-project-2.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/apache-maven-project-2.png b/trunk/releases/master/src/site/resources/images/apache-maven-project-2.png
new file mode 100644
index 0000000..6c096ec
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/apache-maven-project-2.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/application-certificate.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/application-certificate.png b/trunk/releases/master/src/site/resources/images/application-certificate.png
new file mode 100644
index 0000000..cc6aff6
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/application-certificate.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/contact-new.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/contact-new.png b/trunk/releases/master/src/site/resources/images/contact-new.png
new file mode 100644
index 0000000..ebc4316
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/contact-new.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/document-properties.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/document-properties.png b/trunk/releases/master/src/site/resources/images/document-properties.png
new file mode 100644
index 0000000..34c2409
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/document-properties.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/drive-harddisk.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/drive-harddisk.png b/trunk/releases/master/src/site/resources/images/drive-harddisk.png
new file mode 100644
index 0000000..d7ce475
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/drive-harddisk.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/falcon-logo.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/falcon-logo.png b/trunk/releases/master/src/site/resources/images/falcon-logo.png
new file mode 100644
index 0000000..0a9f6cf
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/falcon-logo.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/fix.gif
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/fix.gif b/trunk/releases/master/src/site/resources/images/fix.gif
new file mode 100644
index 0000000..b7eb3dc
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/fix.gif differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/icon_error_sml.gif
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/icon_error_sml.gif b/trunk/releases/master/src/site/resources/images/icon_error_sml.gif
new file mode 100644
index 0000000..12e9a01
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/icon_error_sml.gif differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/icon_help_sml.gif
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/icon_help_sml.gif b/trunk/releases/master/src/site/resources/images/icon_help_sml.gif
new file mode 100644
index 0000000..aaf20e6
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/icon_help_sml.gif differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/icon_info_sml.gif
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/icon_info_sml.gif b/trunk/releases/master/src/site/resources/images/icon_info_sml.gif
new file mode 100644
index 0000000..b776326
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/icon_info_sml.gif differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/icon_success_sml.gif
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/icon_success_sml.gif b/trunk/releases/master/src/site/resources/images/icon_success_sml.gif
new file mode 100644
index 0000000..0a19527
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/icon_success_sml.gif differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/icon_warning_sml.gif
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/icon_warning_sml.gif b/trunk/releases/master/src/site/resources/images/icon_warning_sml.gif
new file mode 100644
index 0000000..ac6ad6a
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/icon_warning_sml.gif differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/image-x-generic.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/image-x-generic.png b/trunk/releases/master/src/site/resources/images/image-x-generic.png
new file mode 100644
index 0000000..ab49efb
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/image-x-generic.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/internet-web-browser.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/internet-web-browser.png b/trunk/releases/master/src/site/resources/images/internet-web-browser.png
new file mode 100644
index 0000000..307d6ac
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/internet-web-browser.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/logos/build-by-maven-black.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/logos/build-by-maven-black.png b/trunk/releases/master/src/site/resources/images/logos/build-by-maven-black.png
new file mode 100644
index 0000000..919fd0f
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/logos/build-by-maven-black.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/logos/build-by-maven-white.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/logos/build-by-maven-white.png b/trunk/releases/master/src/site/resources/images/logos/build-by-maven-white.png
new file mode 100644
index 0000000..7d44c9c
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/logos/build-by-maven-white.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/logos/maven-feather.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/logos/maven-feather.png b/trunk/releases/master/src/site/resources/images/logos/maven-feather.png
new file mode 100644
index 0000000..b5ada83
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/logos/maven-feather.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/network-server.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/network-server.png b/trunk/releases/master/src/site/resources/images/network-server.png
new file mode 100644
index 0000000..1d12e19
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/network-server.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/package-x-generic.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/package-x-generic.png b/trunk/releases/master/src/site/resources/images/package-x-generic.png
new file mode 100644
index 0000000..8b7e9e6
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/package-x-generic.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/profiles/pre-release.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/profiles/pre-release.png b/trunk/releases/master/src/site/resources/images/profiles/pre-release.png
new file mode 100644
index 0000000..d448e85
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/profiles/pre-release.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/profiles/retired.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/profiles/retired.png b/trunk/releases/master/src/site/resources/images/profiles/retired.png
new file mode 100644
index 0000000..f89f6a2
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/profiles/retired.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/profiles/sandbox.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/profiles/sandbox.png b/trunk/releases/master/src/site/resources/images/profiles/sandbox.png
new file mode 100644
index 0000000..f88b362
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/profiles/sandbox.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/remove.gif
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/remove.gif b/trunk/releases/master/src/site/resources/images/remove.gif
new file mode 100644
index 0000000..fc65631
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/remove.gif differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/rss.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/rss.png b/trunk/releases/master/src/site/resources/images/rss.png
new file mode 100644
index 0000000..a9850ee
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/rss.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/update.gif
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/update.gif b/trunk/releases/master/src/site/resources/images/update.gif
new file mode 100644
index 0000000..b2a6d0b
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/update.gif differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/resources/images/window-new.png
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/resources/images/window-new.png b/trunk/releases/master/src/site/resources/images/window-new.png
new file mode 100644
index 0000000..0e12ef9
Binary files /dev/null and b/trunk/releases/master/src/site/resources/images/window-new.png differ
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/site.xml
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/site.xml b/trunk/releases/master/src/site/site.xml
new file mode 100644
index 0000000..aeb7a5e
--- /dev/null
+++ b/trunk/releases/master/src/site/site.xml
@@ -0,0 +1,62 @@
+<?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.
+-->
+<project name="Falcon" xmlns="http://maven.apache.org/DECORATION/1.3.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0 http://maven.apache.org/xsd/decoration-1.3.0.xsd">
+
+ <skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-fluido-skin</artifactId>
+ <version>1.3.0</version>
+ </skin>
+
+ <custom>
+ <fluidoSkin>
+ <project>Apache Falcon</project>
+ <sideBarEnabled>false</sideBarEnabled>
+ </fluidoSkin>
+ </custom>
+
+ <bannerLeft>
+ <name>Apache Falcon</name>
+ <src>./images/falcon-logo.png</src>
+ <width>200px</width>
+ <height>45px</height>
+ </bannerLeft>
+
+ <publishDate position="right"/>
+ <version position="right"/>
+
+ <body>
+ <head>
+ <script type="text/javascript">
+ $( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );
+ </script>
+ </head>
+
+ <breadcrumbs position="left">
+ <item name="Falcon" title="Apache Falcon" href="index.html"/>
+ </breadcrumbs>
+
+ <footer>
+ © 2011-2012 The Apache Software Foundation. Apache Falcon, Falcon, Apache, the Apache feather logo,
+ and the Apache Falcon project logo are trademarks of The Apache Software Foundation.
+ </footer>
+ </body>
+</project>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/twiki/Appendix.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/twiki/Appendix.twiki b/trunk/releases/master/src/site/twiki/Appendix.twiki
new file mode 100644
index 0000000..e3752fb
--- /dev/null
+++ b/trunk/releases/master/src/site/twiki/Appendix.twiki
@@ -0,0 +1,55 @@
+---+ Compatibility
+
+---++ 0.6-incubating Version Compatibility Matrix
+
+ * Hadoop 2.5.0 and above
+ * Oozie 4.0.0 and above
+ * Hive 0.11.0 and above
+ * HCatalog 0.11.0 and above
+ * Active MQ 5.4.3 and above
+ * Titan 0.4.2 and above but below 0.5
+
+
+---++ 0.6-incubating Tested Compatibility
+
+ * Hadoop 2.6.0
+ * Oozie 4.1.0
+ * Hive 0.14.0
+ * HCatalog 0.14.0
+ * Active MQ 5.4.3
+ * Titan 0.4.2
+ * Java 1.6, Java 1.7
+
+ Note : Oozie versions below 4.1.0 are not compatible with Java 1.7
+
+---++ 0.6-incubating Release Notes
+
+Major additions are listed below. Refer to CHANGES.txt for detailed issues addressed in this release.
+
+ * Security - Authorization, SSL
+ * Lineage - More complete with better API
+ * Recipes
+ * Usability improvements - Dry run, entity summary, Pagination, etc.
+ * Operability - Alerts, Audits, etc.
+ * Refactoring - Messaging, Orchestration of workflows, etc.
+ * Extension points for developers
+ * Many bug fixes
+
+
+---++ 0.6-incubating Upgrade Instructions
+
+Please follow these instructions when upgrading from an older release.
+
+---+++ Upgrading from 0.5-incubating
+
+0.6-incubating is backwards *incompatible* with 0.5-incubating. It is recommended that user do not
+migrate from 0.5 to 0.6. However if the user must migrate from 0.5-incubating to 0.6-incubating,
+user should [[https://cwiki.apache.org/confluence/display/FALCON/Index][follow these instructions]
+
+---+++ Upgrading from 0.4-incubating
+
+It is not possible to upgrade to 0.6-incubating from 0.4-incubating.
+
+---+++ Upgrading from 0.3-incubating
+
+It is not possible to upgrade to 0.6-incubating from 0.3-incubating.
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/twiki/Configuration.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/twiki/Configuration.twiki b/trunk/releases/master/src/site/twiki/Configuration.twiki
new file mode 100644
index 0000000..0df094f
--- /dev/null
+++ b/trunk/releases/master/src/site/twiki/Configuration.twiki
@@ -0,0 +1,122 @@
+---+Configuring Falcon
+
+By default config directory used by falcon is {package dir}/conf. To override this (to use the same conf with multiple
+falcon upgrades), set environment variable FALCON_CONF to the path of the conf dir.
+
+falcon-env.sh has been added to the falcon conf. This file can be used to set various environment variables that you
+need for you services.
+In addition you can set any other environment variables you might need. This file will be sourced by falcon scripts
+before any commands are executed. The following environment variables are available to set.
+
+<verbatim>
+# The java implementation to use. If JAVA_HOME is not found we expect java and jar to be in path
+#export JAVA_HOME=
+
+# any additional java opts you want to set. This will apply to both client and server operations
+#export FALCON_OPTS=
+
+# any additional java opts that you want to set for client only
+#export FALCON_CLIENT_OPTS=
+
+# java heap size we want to set for the client. Default is 1024MB
+#export FALCON_CLIENT_HEAP=
+
+# any additional opts you want to set for prism service.
+#export FALCON_PRISM_OPTS=
+
+# java heap size we want to set for the prism service. Default is 1024MB
+#export FALCON_PRISM_HEAP=
+
+# any additional opts you want to set for falcon service.
+#export FALCON_SERVER_OPTS=
+
+# java heap size we want to set for the falcon server. Default is 1024MB
+#export FALCON_SERVER_HEAP=
+
+# What is is considered as falcon home dir. Default is the base location of the installed software
+#export FALCON_HOME_DIR=
+
+# Where log files are stored. Default is logs directory under the base install location
+#export FALCON_LOG_DIR=
+
+# Where pid files are stored. Default is logs directory under the base install location
+#export FALCON_PID_DIR=
+
+# where the falcon active mq data is stored. Default is logs/data directory under the base install location
+#export FALCON_DATA_DIR=
+
+# Where do you want to expand the war file. By Default it is in /server/webapp dir under the base install dir.
+#export FALCON_EXPANDED_WEBAPP_DIR=
+</verbatim>
+
+---++Advanced Configurations
+
+---+++Configuring Monitoring plugin to register catalog partitions
+Falcon comes with a monitoring plugin that registers catalog partition. This comes in really handy during migration from
+ filesystem based feeds to hcatalog based feeds.
+This plugin enables the user to de-couple the partition registration and assume that all partitions are already on
+hcatalog even before the migration, simplifying the hcatalog migration.
+
+By default this plugin is disabled.
+To enable this plugin and leverage the feature, there are 3 pre-requisites:
+<verbatim>
+In {package dir}/conf/startup.properties, add
+*.workflow.execution.listeners=org.apache.falcon.catalog.CatalogPartitionHandler
+
+In the cluster definition, ensure registry endpoint is defined.
+Ex:
+<interface type="registry" endpoint="thrift://localhost:1109" version="0.13.3"/>
+
+In the feed definition, ensure the corresponding catalog table is mentioned in feed-properties
+Ex:
+<properties>
+ <property name="catalog.table" value="catalog:default:in_table#year={YEAR};month={MONTH};day={DAY};hour={HOUR};
+ minute={MINUTE}"/>
+</properties>
+</verbatim>
+
+*NOTE : for Mac OS users*
+<verbatim>
+If you are using a Mac OS, you will need to configure the FALCON_SERVER_OPTS (explained above).
+
+In {package dir}/conf/falcon-env.sh uncomment the following line
+#export FALCON_SERVER_OPTS=
+
+and change it to look as below
+export FALCON_SERVER_OPTS="-Djava.awt.headless=true -Djava.security.krb5.realm= -Djava.security.krb5.kdc="
+</verbatim>
+
+---+++Activemq
+
+* falcon server starts embedded active mq. To control this behaviour, set the following system properties using -D
+option in environment variable FALCON_OPTS:
+ * falcon.embeddedmq=<true/false> - Should server start embedded active mq, default true
+ * falcon.embeddedmq.port=<port> - Port for embedded active mq, default 61616
+ * falcon.embeddedmq.data=<path> - Data path for embedded active mq, default {package dir}/logs/data
+
+---+++Falcon System Notifications
+Some Falcon features such as late data handling, retries, metadata service, depend on JMS notifications sent when the Oozie workflow completes. These system notifications are sent as part of Falcon Post Processing action. Given that the post processing action is also a job, it is prone to failures and in case of failures, Falcon is blind to the status of the workflow. To alleviate this problem and make the notifications more reliable, you can enable Oozie's JMS notification feature and disable Falcon post-processing notification by making the following changes:
+ * In Falcon runtime.properties, set *.falcon.jms.notification.enabled to false. This will turn off JMS notification in post-processing.
+ * Copy notification related properties in oozie/conf/oozie-site.xml to oozie-site.xml of the Oozie installation. Restart Oozie so changes get reflected.
+
+*NOTE : If you disable Falcon post-processing JMS notification and not enable Oozie JMS notification, features such as failure retry, late data handling and metadata service will be disabled for all entities on the server.*
+
+---+++Enabling Falcon Native Scheudler
+You can either choose to schedule entities using Oozie's coordinator or using Falcon's native scheduler. To be able to schedule entities natively on Falcon, you will need to add some additional properties to <verbatim>$FALCON_HOME/conf/startup.properties</verbatim> before starting the Falcon Server. For details on the same, refer to [[FalconNativeScheduler][Falcon Native Scheduler]]
+
+---+++Adding Extension Libraries
+
+Library extensions allows users to add custom libraries to entity lifecycles such as feed retention, feed replication
+and process execution. This is useful for usecases such as adding filesystem extensions. To enable this, add the
+following configs to startup.properties:
+*.libext.paths=<paths to be added to all entity lifecycles>
+
+*.libext.feed.paths=<paths to be added to all feed lifecycles>
+
+*.libext.feed.retentions.paths=<paths to be added to feed retention workflow>
+
+*.libext.feed.replication.paths=<paths to be added to feed replication workflow>
+
+*.libext.process.paths=<paths to be added to process workflow>
+
+The configured jars are added to falcon classpath and the corresponding workflows.
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/twiki/Distributed-mode.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/twiki/Distributed-mode.twiki b/trunk/releases/master/src/site/twiki/Distributed-mode.twiki
new file mode 100644
index 0000000..34fb092
--- /dev/null
+++ b/trunk/releases/master/src/site/twiki/Distributed-mode.twiki
@@ -0,0 +1,198 @@
+---+Distributed Mode
+
+
+Following are the steps needed to package and deploy Falcon in Embedded Mode. You need to complete Steps 1-3 mentioned
+ [[InstallationSteps][here]] before proceeding further.
+
+---++Package Falcon
+Ensure that you are in the base directory (where you cloned Falcon). Let’s call it {project dir}
+
+<verbatim>
+$mvn clean assembly:assembly -DskipTests -DskipCheck=true -Pdistributed,hadoop-2
+</verbatim>
+
+
+<verbatim>
+$ls {project dir}/distro/target/
+</verbatim>
+
+It should give an output like below :
+<verbatim>
+apache-falcon-distributed-${project.version}-server.tar.gz
+apache-falcon-distributed-${project.version}-sources.tar.gz
+archive-tmp
+maven-shared-archive-resources
+</verbatim>
+
+ * apache-falcon-distributed-${project.version}-sources.tar.gz contains source files of Falcon repo.
+
+ * apache-falcon-distributed-${project.version}-server.tar.gz package contains project artifacts along with it's
+dependencies, configuration files and scripts required to deploy Falcon.
+
+
+Tar can be found in {project dir}/target/apache-falcon-distributed-${project.version}-server.tar.gz . This is the tar
+used for installing Falcon. Lets call it {falcon package}
+
+Tar is structured as follows.
+
+<verbatim>
+
+|- bin
+ |- falcon
+ |- falcon-start
+ |- falcon-stop
+ |- falcon-status
+ |- falcon-config.sh
+ |- service-start.sh
+ |- service-stop.sh
+ |- service-status.sh
+ |- prism-stop
+ |- prism-start
+ |- prism-status
+|- conf
+ |- startup.properties
+ |- runtime.properties
+ |- client.properties
+ |- prism.keystore
+ |- log4j.xml
+ |- falcon-env.sh
+|- docs
+|- client
+ |- lib (client support libs)
+|- server
+ |- webapp
+ |- falcon.war
+ |- prism.war
+|- oozie
+ |- conf
+ |- libext
+|- hadooplibs
+|- README
+|- NOTICE.txt
+|- LICENSE.txt
+|- DISCLAIMER.txt
+|- CHANGES.txt
+</verbatim>
+
+
+---++Installing & running Falcon
+
+---+++Installing Falcon
+
+Running Falcon in distributed mode requires bringing up both prism and server.As the name suggests Falcon prism splits
+the request it gets to the Falcon servers. It is a good practice to start prism and server with their corresponding
+configurations separately. Create separate directory for prism and server. Let's call them {falcon-prism-dir} and
+{falcon-server-dir} respectively.
+
+*For prism*
+<verbatim>
+$mkdir {falcon-prism-dir}
+$tar -xzvf {falcon package}
+</verbatim>
+
+*For server*
+<verbatim>
+$mkdir {falcon-server-dir}
+$tar -xzvf {falcon package}
+</verbatim>
+
+
+---+++Starting Prism
+
+<verbatim>
+cd {falcon-prism-dir}/falcon-distributed-${project.version}
+bin/prism-start [-port <port>]
+</verbatim>
+
+By default,
+* prism server starts at port 16443. To change the port, use -port option
+
+* falcon.enableTLS can be set to true or false explicitly to enable SSL, if not port that end with 443 will
+automatically put prism on https://
+
+* prism starts with conf from {falcon-prism-dir}/falcon-distributed-${project.version}/conf. To override this (to use
+the same conf with multiple prism upgrades), set environment variable FALCON_CONF to the path of conf dir. You can find
+the instructions for configuring Falcon [[Configuration][here]].
+
+*Enabling prism-client*
+*If prism is not started using default-port 16443 then edit the following property in
+{falcon-prism-dir}/falcon-distributed-${project.version}/conf/client.properties
+falcon.url=http://{machine-ip}:{prism-port}/
+
+
+---+++Starting Falcon Server
+
+<verbatim>
+$cd {falcon-server-dir}/falcon-distributed-${project.version}
+$bin/falcon-start [-port <port>]
+</verbatim>
+
+By default,
+* If falcon.enableTLS is set to true explicitly or not set at all, Falcon starts at port 15443 on https:// by default.
+
+* If falcon.enableTLS is set to false explicitly, Falcon starts at port 15000 on http://.
+
+* To change the port, use -port option.
+
+* If falcon.enableTLS is not set explicitly, port that ends with 443 will automatically put Falcon on https://. Any
+other port will put Falcon on http://.
+
+* server starts with conf from {falcon-server-dir}/falcon-distributed-${project.version}/conf. To override this (to use
+the same conf with multiple server upgrades), set environment variable FALCON_CONF to the path of conf dir. You can find
+ the instructions for configuring Falcon [[Configuration][here]].
+
+*Enabling server-client*
+*If server is not started using default-port 15443 then edit the following property in
+{falcon-server-dir}/falcon-distributed-${project.version}/conf/client.properties. You can find the instructions for
+configuring Falcon here.
+falcon.url=http://{machine-ip}:{server-port}/
+
+*NOTE* : https is the secure version of HTTP, the protocol over which data is sent between your browser and the website
+that you are connected to. By default Falcon runs in https mode. But user can configure it to http.
+
+
+---+++Using Falcon
+
+<verbatim>
+$cd {falcon-prism-dir}/falcon-distributed-${project.version}
+$bin/falcon admin -version
+Falcon server build version: {Version:"${project.version}-SNAPSHOT-rd7e2be9afa2a5dc96acd1ec9e325f39c6b2f17f7",
+Mode:"embedded"}
+
+$bin/falcon help
+(for more details about Falcon cli usage)
+</verbatim>
+
+
+---+++Dashboard
+
+Once Falcon / prism is started, you can view the status of Falcon entities using the Web-based dashboard. You can open
+your browser at the corresponding port to use the web UI.
+
+Falcon dashboard makes the REST api calls as user "falcon-dashboard". If this user does not exist on your Falcon and
+Oozie servers, please create the user.
+
+<verbatim>
+## create user.
+[root@falconhost ~] useradd -U -m falcon-dashboard -G users
+
+## verify user is created with membership in correct groups.
+[root@falconhost ~] groups falcon-dashboard
+falcon-dashboard : falcon-dashboard users
+[root@falconhost ~]
+</verbatim>
+
+
+---+++Stopping Falcon Server
+
+<verbatim>
+$cd {falcon-server-dir}/falcon-distributed-${project.version}
+$bin/falcon-stop
+</verbatim>
+
+---+++Stopping Falcon Prism
+
+<verbatim>
+$cd {falcon-prism-dir}/falcon-distributed-${project.version}
+$bin/prism-stop
+</verbatim>
http://git-wip-us.apache.org/repos/asf/falcon/blob/31b1d7e6/trunk/releases/master/src/site/twiki/Embedded-mode.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/master/src/site/twiki/Embedded-mode.twiki b/trunk/releases/master/src/site/twiki/Embedded-mode.twiki
new file mode 100644
index 0000000..d5c37a1
--- /dev/null
+++ b/trunk/releases/master/src/site/twiki/Embedded-mode.twiki
@@ -0,0 +1,198 @@
+---+Embedded Mode
+
+Following are the steps needed to package and deploy Falcon in Embedded Mode. You need to complete Steps 1-3 mentioned
+ [[InstallationSteps][here]] before proceeding further.
+
+---++Package Falcon
+Ensure that you are in the base directory (where you cloned Falcon). Let’s call it {project dir}
+
+<verbatim>
+$mvn clean assembly:assembly -DskipTests -DskipCheck=true
+</verbatim>
+
+<verbatim>
+$ls {project dir}/distro/target/
+</verbatim>
+It should give an output like below :
+<verbatim>
+apache-falcon-${project.version}-bin.tar.gz
+apache-falcon-${project.version}-sources.tar.gz
+archive-tmp
+maven-shared-archive-resources
+</verbatim>
+
+* apache-falcon-${project.version}-sources.tar.gz contains source files of Falcon repo.
+
+* apache-falcon-${project.version}-bin.tar.gz package contains project artifacts along with it's dependencies,
+configuration files and scripts required to deploy Falcon.
+
+Tar can be found in {project dir}/target/apache-falcon-${project.version}-bin.tar.gz
+
+Tar is structured as follows :
+
+<verbatim>
+
+|- bin
+ |- falcon
+ |- falcon-start
+ |- falcon-stop
+ |- falcon-status
+ |- falcon-config.sh
+ |- service-start.sh
+ |- service-stop.sh
+ |- service-status.sh
+|- conf
+ |- startup.properties
+ |- runtime.properties
+ |- prism.keystore
+ |- client.properties
+ |- log4j.xml
+ |- falcon-env.sh
+|- docs
+|- client
+ |- lib (client support libs)
+|- server
+ |- webapp
+ |- falcon.war
+|- data
+ |- falcon-store
+ |- graphdb
+ |- localhost
+|- examples
+ |- app
+ |- hive
+ |- oozie-mr
+ |- pig
+ |- data
+ |- entity
+ |- filesystem
+ |- hcat
+|- oozie
+ |- conf
+ |- libext
+|- logs
+|- hadooplibs
+|- README
+|- NOTICE.txt
+|- LICENSE.txt
+|- DISCLAIMER.txt
+|- CHANGES.txt
+</verbatim>
+
+
+---++Installing & running Falcon
+
+Running Falcon in embedded mode requires bringing up server.
+
+<verbatim>
+$tar -xzvf {falcon package}
+$cd falcon-${project.version}
+</verbatim>
+
+
+---+++Starting Falcon Server
+<verbatim>
+$cd falcon-${project.version}
+$bin/falcon-start [-port <port>]
+</verbatim>
+
+By default,
+* If falcon.enableTLS is set to true explicitly or not set at all, Falcon starts at port 15443 on https:// by default.
+
+* If falcon.enableTLS is set to false explicitly, Falcon starts at port 15000 on http://.
+
+* To change the port, use -port option.
+
+* If falcon.enableTLS is not set explicitly, port that ends with 443 will automatically put Falcon on https://. Any
+other port will put Falcon on http://.
+
+* Server starts with conf from {falcon-server-dir}/falcon-distributed-${project.version}/conf. To override this (to use
+the same conf with multiple server upgrades), set environment variable FALCON_CONF to the path of conf dir. You can find
+ the instructions for configuring Falcon [[Configuration][here]].
+
+
+---+++Enabling server-client
+If server is not started using default-port 15443 then edit the following property in
+{falcon-server-dir}/falcon-${project.version}/conf/client.properties
+
+falcon.url=http://{machine-ip}:{server-port}/
+
+
+---+++Using Falcon
+<verbatim>
+$cd falcon-${project.version}
+$bin/falcon admin -version
+Falcon server build version: {Version:"${project.version}-SNAPSHOT-rd7e2be9afa2a5dc96acd1ec9e325f39c6b2f17f7",Mode:
+"embedded",Hadoop:"${hadoop.version}"}
+
+$bin/falcon help
+(for more details about Falcon cli usage)
+</verbatim>
+
+*Note* : https is the secure version of HTTP, the protocol over which data is sent between your browser and the website
+that you are connected to. By default Falcon runs in https mode. But user can configure it to http.
+
+
+---+++Dashboard
+
+Once Falcon server is started, you can view the status of Falcon entities using the Web-based dashboard. You can open
+your browser at the corresponding port to use the web UI.
+
+Falcon dashboard makes the REST api calls as user "falcon-dashboard". If this user does not exist on your Falcon and
+Oozie servers, please create the user.
+
+<verbatim>
+## create user.
+[root@falconhost ~] useradd -U -m falcon-dashboard -G users
+
+## verify user is created with membership in correct groups.
+[root@falconhost ~] groups falcon-dashboard
+falcon-dashboard : falcon-dashboard users
+[root@falconhost ~]
+</verbatim>
+
+
+---++Running Examples using embedded package
+<verbatim>
+$cd falcon-${project.version}
+$bin/falcon-start
+</verbatim>
+Make sure the Hadoop and Oozie endpoints are according to your setup in
+examples/entity/filesystem/standalone-cluster.xml
+The cluster locations,staging and working dirs, MUST be created prior to submitting a cluster entity to Falcon.
+*staging* must have 777 permissions and the parent dirs must have execute permissions
+*working* must have 755 permissions and the parent dirs must have execute permissions
+<verbatim>
+$bin/falcon entity -submit -type cluster -file examples/entity/filesystem/standalone-cluster.xml
+</verbatim>
+Submit input and output feeds:
+<verbatim>
+$bin/falcon entity -submit -type feed -file examples/entity/filesystem/in-feed.xml
+$bin/falcon entity -submit -type feed -file examples/entity/filesystem/out-feed.xml
+</verbatim>
+Set-up workflow for the process:
+<verbatim>
+$hadoop fs -put examples/app /
+</verbatim>
+Submit and schedule the process:
+<verbatim>
+$bin/falcon entity -submitAndSchedule -type process -file examples/entity/filesystem/oozie-mr-process.xml
+$bin/falcon entity -submitAndSchedule -type process -file examples/entity/filesystem/pig-process.xml
+</verbatim>
+Generate input data:
+<verbatim>
+$examples/data/generate.sh <<hdfs endpoint>>
+</verbatim>
+Get status of instances:
+<verbatim>
+$bin/falcon instance -status -type process -name oozie-mr-process -start 2013-11-15T00:05Z -end 2013-11-15T01:00Z
+</verbatim>
+
+HCat based example entities are in examples/entity/hcat.
+
+
+---+++Stopping Falcon Server
+<verbatim>
+$cd falcon-${project.version}
+$bin/falcon-stop
+</verbatim>