You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@falcon.apache.org by sr...@apache.org on 2014/09/12 11:43:51 UTC
svn commit: r1624488 [5/7] - in /incubator/falcon: site/
site/0.3-incubating/ site/0.4-incubating/ site/docs/ site/docs/restapi/
trunk/ trunk/general/src/site/twiki/docs/
trunk/general/src/site/twiki/docs/restapi/
Modified: incubator/falcon/site/docs/restapi/InstanceStatus.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceStatus.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceStatus.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceStatus.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - GET /api/instance/status/:entity-type/:entity-name</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -263,10 +263,26 @@
<h3>Parameters<a name="Parameters"></a></h3>
<p></p>
<ul>
-<li>:entity-type can either be a feed or a process.</li>
-<li>:entity-name is name of the entity.</li>
-<li>start is the start time of the instance that you want to refer to</li>
-<li>end <optional param> is the end time of the instance that you want to refer to</li></ul></div>
+<li>:entity-type Valid options are cluster, feed or process.</li>
+<li>:entity-name Name of the entity.</li>
+<li>start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+<ul>
+<li>By default, it is set to (end - (10 * entityFrequency)).</li></ul></li>
+<li>end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+<ul>
+<li>Default is set to now.</li></ul></li>
+<li>colo <optional param> Colo on which the query should be run.</li>
+<li>lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).</li>
+<li>filterBy <optional param> Filter results by list of field:value pairs. Example: filterBy=STATUS:RUNNING,CLUSTER:primary-cluster
+<ul>
+<li>Supported filter fields are STATUS, CLUSTER, SOURCECLUSTER, STARTEDAFTER.</li>
+<li>Query will do an AND among filterBy fields.</li></ul></li>
+<li>orderBy <optional param> Field by which results should be ordered.
+<ul>
+<li>Supports ordering by "status","startTime","endTime","cluster".</li></ul></li>
+<li>sortOrder <optional param> Valid options are "asc" and "desc"</li>
+<li>offset <optional param> Show results from the offset, used for pagination. Defaults to 0.</li>
+<li>numResults <optional param> Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10.</li></ul></div>
<div class="section">
<h3>Results<a name="Results"></a></h3>
<p>Status of the specified instance.</p></div>
@@ -277,7 +293,6 @@
<div class="source">
<pre>
GET http://localhost:15000/api/instance/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
-Remote-User: rgautam
</pre></div></div>
<div class="section">
@@ -302,6 +317,45 @@ Remote-User: rgautam
}
</pre></div></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/instance/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=STATUS:SUCCEEDED,CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T07:00Z"
+ },
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:42:26-07:00",
+ "startTime": "2013-10-21T14:41:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T08:00Z"
+ },
+ ],
+
+ "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+ "message": "default\/STATUS\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
</div>
</div>
Modified: incubator/falcon/site/docs/restapi/InstanceSummary.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceSummary.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceSummary.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceSummary.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - GET /api/instance/summary/:entity-type/:entity-name</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -263,10 +263,16 @@
<h3>Parameters<a name="Parameters"></a></h3>
<p></p>
<ul>
-<li>:entity-type can either be a feed or a process.</li>
-<li>:entity-name is name of the entity.</li>
-<li>start is the start time of the instance that you want to refer to</li>
-<li>end <optional param> is the end time of the instance that you want to refer to</li></ul></div>
+<li>:entity-type Valid options are cluster, feed or process.</li>
+<li>:entity-name Name of the entity.</li>
+<li>start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+<ul>
+<li>By default, it is set to (end - (10 * entityFrequency)).</li></ul></li>
+<li>end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+<ul>
+<li>Default is set to now.</li></ul></li>
+<li>colo <optional param> Colo on which the query should be run.</li>
+<li>lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).</li></ul></div>
<div class="section">
<h3>Results<a name="Results"></a></h3>
<p>Summary of the instances over the specified time range</p></div>
@@ -277,7 +283,6 @@
<div class="source">
<pre>
GET http://localhost:15000/api/instance/summary/process/WordCount?colo=*&start=2014-01-21T13:00Z&end=2014-01-21T16:00Z
-Remote-User: suhas
</pre></div></div>
<div class="section">
@@ -296,7 +301,7 @@ Remote-User: suhas
"entry":
{
"key":"SUCCEEDED",
- "value":"3"
+ "key2":"value"
}
}
}
Modified: incubator/falcon/site/docs/restapi/InstanceSuspend.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceSuspend.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceSuspend.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceSuspend.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - POST /api/instance/suspend/:entity-type/:entity-name</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -265,7 +265,8 @@
<ul>
<li>:entity-type can either be a feed or a process.</li>
<li>:entity-name is name of the entity.</li>
-<li>start is the start time of the instance that you want to refer to</li></ul></div>
+<li>start is the start time of the instance that you want to refer to</li>
+<li>lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process.</li></ul></div>
<div class="section">
<h3>Results<a name="Results"></a></h3>
<p>Results of the suspend command.</p></div>
@@ -276,7 +277,6 @@
<div class="source">
<pre>
POST http://localhost:15000/api/instance/suspend/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
-Remote-User: rgautam
</pre></div></div>
<div class="section">
Modified: incubator/falcon/site/docs/restapi/ResourceList.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/ResourceList.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/ResourceList.html (original)
+++ incubator/falcon/site/docs/restapi/ResourceList.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - RESTful Resources</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -249,12 +249,33 @@
<div id="bodyColumn" >
<div class="section">
-<h2>RESTful Resources<a name="RESTful_Resources"></a></h2>
+<h2>RESTful Resources<a name="RESTful_Resources"></a></h2></div>
+<div class="section">
+<h3>Resource List<a name="Resource_List"></a></h3>
<p></p>
<ul>
<li><a href="#REST_Call_on_Entity_Resource">REST Call on Entity Resource</a></li>
<li><a href="#REST_Call_on_Feed_and_Process_Instances">REST Call on Feed/Process Instances</a></li>
-<li><a href="#REST_Call_on_Admin_Resource">REST Call on Admin Resource</a></li></ul></div>
+<li><a href="#REST_Call_on_Admin_Resource">REST Call on Admin Resource</a></li>
+<li><a href="#REST_Call_on_Lineage_Graph">REST Call on Lineage Graph Resource</a></li></ul></div>
+<div class="section">
+<h3>Authentication<a name="Authentication"></a></h3>
+<p>When security is off (Pseudo/Simple), the authenticated user is the username specified in the user.name query parameter. If the user.name parameter is not set, the server may either set the authenticated user to a default web user, if there is any, or return an error response.</p>
+<p>When security is on (kerberos), authentication is performed by Kerberos SPNEGO.</p>
+<p>Below are examples using the curl command tool.</p>
+<p>Authentication when security is off (Pseudo/Simple):</p>
+<div class="source">
+<pre>
+curl -i "http://<HOST>:<PORT>/<PATH>?[user.name=<USER>&]<PARAM>=..."
+
+</pre></div>
+<p>Authentication using Kerberos SPNEGO when security is on:</p>
+<div class="source">
+<pre>
+curl -i --negotiate -u : "http://<HOST>:<PORT>/<PATH>?<PARAM>=..."
+
+</pre></div>
+<p>See also: <a href="./../Security.twiki.html">Security in Falcon</a></p></div>
<div class="section">
<h3>REST Call on Admin Resource<a name="REST_Call_on_Admin_Resource"></a></h3>
<p></p>
@@ -325,10 +346,14 @@
<td>Get the definition of the entity</td></tr>
<tr class="b">
<td>GET</td>
-<td><a href="./EntityList.html">api/entities/list/:entity-type?fields=:fields</a></td>
+<td><a href="./EntityList.html">api/entities/list/:entity-type</a></td>
<td>Get the list of entities</td></tr>
<tr class="a">
<td>GET</td>
+<td><a href="./EntitySummary.html">api/entities/summary/:entity-type/:cluster</a></td>
+<td>Get instance summary of all entities</td></tr>
+<tr class="b">
+<td>GET</td>
<td><a href="./EntityDependencies.html">api/entities/dependencies/:entity-type/:entity-name</a></td>
<td>Get the dependencies of the entity</td></tr></table></div>
<div class="section">
@@ -345,28 +370,76 @@
<td>List of running instances.</td></tr>
<tr class="a">
<td>GET</td>
-<td><a href="./InstanceStatus.html">api/instance/status/:entity-type/:entity-name</a>]</td>
-<td>Status of a given instance</td></tr>
+<td><a href="./InstanceList.html">api/instance/list/:entity-type/:entity-name</a></td>
+<td>List of instances</td></tr>
<tr class="b">
+<td>GET</td>
+<td><a href="./InstanceStatus.html">api/instance/status/:entity-type/:entity-name</a></td>
+<td>Status of a given instance</td></tr>
+<tr class="a">
<td>POST</td>
-<td><a href="./InstanceKill.html">api/instance/kill/:entity-type/:entity-name</a>]</td>
+<td><a href="./InstanceKill.html">api/instance/kill/:entity-type/:entity-name</a></td>
<td>Kill a given instance</td></tr>
-<tr class="a">
+<tr class="b">
<td>POST</td>
-<td><a href="./InstanceSuspend.html">api/instance/suspend/:entity-type/:entity-name</a>]</td>
+<td><a href="./InstanceSuspend.html">api/instance/suspend/:entity-type/:entity-name</a></td>
<td>Suspend a running instance</td></tr>
-<tr class="b">
+<tr class="a">
<td>POST</td>
-<td><a href="./InstanceResume.html">api/instance/resume/:entity-type/:entity-name</a>]</td>
+<td><a href="./InstanceResume.html">api/instance/resume/:entity-type/:entity-name</a></td>
<td>Resume a given instance</td></tr>
-<tr class="a">
+<tr class="b">
<td>POST</td>
-<td><a href="./InstanceRerun.html">api/instance/rerun/:entity-type/:entity-name</a>]</td>
+<td><a href="./InstanceRerun.html">api/instance/rerun/:entity-type/:entity-name</a></td>
<td>Rerun a given instance</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./InstanceLogs.html">api/instance/logs/:entity-type/:entity-name</a></td>
+<td>Get logs of a given instance</td></tr>
<tr class="b">
<td>GET</td>
-<td><a href="./InstanceLogs.html">api/instance/logs/:entity-type/:entity-name</a>]</td>
-<td>Get logs of a given instance</td></tr></table></div>
+<td><a href="./InstanceSummary.html">api/instance/summary/:entity-type/:entity-name</a></td>
+<td>Return summary of instances for an entity</td></tr></table></div>
+<div class="section">
+<h3>REST Call on Lineage Graph<a name="REST_Call_on_Lineage_Graph"></a></h3>
+<p></p>
+<table border="0" class="table table-striped">
+<tr class="a">
+<th>Call Type</th>
+<th>Resource</th>
+<th>Description</th></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./Graph.html">api/graphs/lineage/serialize</a></td>
+<td>dump the graph</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./AllVertices.html">api/graphs/lineage/vertices/all</a></td>
+<td>get all vertices</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./Vertices.html">api/graphs/lineage/vertices?key=:key&value=:value</a></td>
+<td>get all vertices for a key index</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./Vertex.html">api/graphs/lineage/vertices/:id</a></td>
+<td>get the vertex with the specified id</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./VertexProperties.html">api/graphs/lineage/vertices/properties/:id?relationships=:true</a></td>
+<td>get the properties of the vertex with the specified id</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./AdjacentVertices.html">api/graphs/lineage/vertices/:id/:direction</a></td>
+<td>get the adjacent vertices or edges of the vertex with the specified direction</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./AllEdges.html">api/graphs/lineage//edges/all</a></td>
+<td>get all edges</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./Edge.html">api/graphs/lineage/edges/:id</a></td>
+<td>get the edge with the specified id</td></tr></table></div>
</div>
</div>
Added: incubator/falcon/site/docs/restapi/Vertex.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/Vertex.html?rev=1624488&view=auto
==============================================================================
--- incubator/falcon/site/docs/restapi/Vertex.html (added)
+++ incubator/falcon/site/docs/restapi/Vertex.html Fri Sep 12 09:43:48 2014
@@ -0,0 +1,320 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-09-12
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/graphs/lineage/vertices/:id</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" />
+
+
+ <script type="text/javascript" src="../../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarEnabled">
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container" style="width: 68%;"><div class="nav-collapse">
+
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Falcon <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../index.html" title="About">About</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Index" title="Wiki">Wiki</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/News" title="News">News</a>
+</li>
+
+ <li> <a href="https://git-wip-us.apache.org/repos/asf/incubator-falcon.git" title="Git">Git</a>
+</li>
+
+ <li> <a href="https://svn.apache.org/repos/asf/incubator/falcon" title="Svn">Svn</a>
+</li>
+
+ <li> <a href="https://issues.apache.org/jira/browse/FALCON" title="Jira">Jira</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy" title="Powered by">Powered by</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements" title="Acknowledgements">Acknowledgements</a>
+</li>
+
+ <li> <a href="http://blogs.apache.org/falcon/" title="Blog">Blog</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../project-info.html" title="Summary">Summary</a>
+</li>
+
+ <li> <a href="../../mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4" title="IRC">IRC</a>
+</li>
+
+ <li> <a href="../../team-list.html" title="Team">Team</a>
+</li>
+
+ <li> <a href="../../issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
+</li>
+
+ <li> <a href="../../source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+
+ <li> <a href="../../license.html" title="License">License</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.3-incubating" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.4-incubating" title="0.4-incubating">0.4-incubating</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap" title="Roadmap">Roadmap</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../docs/GettingStarted.html" title="current">current</a>
+</li>
+
+ <li> <a href="../../0.3-incubating/index.html" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="../../0.4-incubating/index.html" title="0.4-incubating">0.4-incubating</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../slides/falcon-overview.html" title="Overview">Overview</a>
+</li>
+
+ <li> <a href="../../slides/falcon-user-guide.html" title="User Guide">User Guide</a>
+</li>
+
+ <li> <a href="../../docs/GettingStarted.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="../../docs/FalconArchitecture.html" title="Architecture">Architecture</a>
+</li>
+
+ <li> <a href="../../docs/InstallationSteps.html" title="Installation">Installation</a>
+</li>
+
+ <li> <a href="../../docs/OnBoarding.html" title="On Boarding">On Boarding</a>
+</li>
+
+ <li> <a href="../../docs/EntitySpecification.html" title="Entity Specification">Entity Specification</a>
+</li>
+
+ <li> <a href="../../docs/FalconCLI.html" title="Client (Falcon CLI)">Client (Falcon CLI)</a>
+</li>
+
+ <li> <a href="../../docs/restapi/ResourceList.html" title="Rest API">Rest API</a>
+</li>
+
+ <li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
+</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+ <form id="search-form" action="http://www.google.com/search" method="get" class="navbar-search pull-right" >
+
+ <input value="http://falcon.incubator.apache.org" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
+
+
+
+
+
+ <iframe src="http://www.facebook.com/plugins/like.php?href=http://falcon.incubator.apache.org/falcon-website-general&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"
+ scrolling="no" frameborder="0"
+ style="border:none; width:80px; height:20px; margin-top: 10px;" class="pull-right" ></iframe>
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+ <ul class="nav pull-right"><li style="margin-top: 10px;">
+
+ <div class="g-plusone" data-href="http://falcon.incubator.apache.org/falcon-website-general" data-size="medium" width="60px" align="right" ></div>
+
+ </li></ul>
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="../../../index.html" id="bannerLeft">
+ <img src="../../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">
+ <a href="../../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET api/graphs/lineage/vertices/:id</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/graphs/lineage/vertices/:id<a name="GET_apigraphslineagevertices:id"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Gets the vertex with specified id.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:id is the unique id of the vertex.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Vertex with the specified id.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/graphs/lineage/vertices/4
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "results": [
+ {
+ "timestamp":"2014-04-21T20:55Z",
+ "name":"sampleIngestProcess",
+ "type":"process-instance",
+ "version":"2.0.0",
+ "_id":4,
+ "_type":"vertex"
+ }
+ ]
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2014
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
Added: incubator/falcon/site/docs/restapi/VertexProperties.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/VertexProperties.html?rev=1624488&view=auto
==============================================================================
--- incubator/falcon/site/docs/restapi/VertexProperties.html (added)
+++ incubator/falcon/site/docs/restapi/VertexProperties.html Fri Sep 12 09:43:48 2014
@@ -0,0 +1,318 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-09-12
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/graphs/lineage/vertices/properties/:id?relationships=:true</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" />
+
+
+ <script type="text/javascript" src="../../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarEnabled">
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container" style="width: 68%;"><div class="nav-collapse">
+
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Falcon <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../index.html" title="About">About</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Index" title="Wiki">Wiki</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/News" title="News">News</a>
+</li>
+
+ <li> <a href="https://git-wip-us.apache.org/repos/asf/incubator-falcon.git" title="Git">Git</a>
+</li>
+
+ <li> <a href="https://svn.apache.org/repos/asf/incubator/falcon" title="Svn">Svn</a>
+</li>
+
+ <li> <a href="https://issues.apache.org/jira/browse/FALCON" title="Jira">Jira</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy" title="Powered by">Powered by</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements" title="Acknowledgements">Acknowledgements</a>
+</li>
+
+ <li> <a href="http://blogs.apache.org/falcon/" title="Blog">Blog</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../project-info.html" title="Summary">Summary</a>
+</li>
+
+ <li> <a href="../../mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4" title="IRC">IRC</a>
+</li>
+
+ <li> <a href="../../team-list.html" title="Team">Team</a>
+</li>
+
+ <li> <a href="../../issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
+</li>
+
+ <li> <a href="../../source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+
+ <li> <a href="../../license.html" title="License">License</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.3-incubating" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.4-incubating" title="0.4-incubating">0.4-incubating</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap" title="Roadmap">Roadmap</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../docs/GettingStarted.html" title="current">current</a>
+</li>
+
+ <li> <a href="../../0.3-incubating/index.html" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="../../0.4-incubating/index.html" title="0.4-incubating">0.4-incubating</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../slides/falcon-overview.html" title="Overview">Overview</a>
+</li>
+
+ <li> <a href="../../slides/falcon-user-guide.html" title="User Guide">User Guide</a>
+</li>
+
+ <li> <a href="../../docs/GettingStarted.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="../../docs/FalconArchitecture.html" title="Architecture">Architecture</a>
+</li>
+
+ <li> <a href="../../docs/InstallationSteps.html" title="Installation">Installation</a>
+</li>
+
+ <li> <a href="../../docs/OnBoarding.html" title="On Boarding">On Boarding</a>
+</li>
+
+ <li> <a href="../../docs/EntitySpecification.html" title="Entity Specification">Entity Specification</a>
+</li>
+
+ <li> <a href="../../docs/FalconCLI.html" title="Client (Falcon CLI)">Client (Falcon CLI)</a>
+</li>
+
+ <li> <a href="../../docs/restapi/ResourceList.html" title="Rest API">Rest API</a>
+</li>
+
+ <li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
+</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+ <form id="search-form" action="http://www.google.com/search" method="get" class="navbar-search pull-right" >
+
+ <input value="http://falcon.incubator.apache.org" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
+
+
+
+
+
+ <iframe src="http://www.facebook.com/plugins/like.php?href=http://falcon.incubator.apache.org/falcon-website-general&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"
+ scrolling="no" frameborder="0"
+ style="border:none; width:80px; height:20px; margin-top: 10px;" class="pull-right" ></iframe>
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+ <ul class="nav pull-right"><li style="margin-top: 10px;">
+
+ <div class="g-plusone" data-href="http://falcon.incubator.apache.org/falcon-website-general" data-size="medium" width="60px" align="right" ></div>
+
+ </li></ul>
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="../../../index.html" id="bannerLeft">
+ <img src="../../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">
+ <a href="../../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET api/graphs/lineage/vertices/properties/:id?relationships=:true</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/graphs/lineage/vertices/properties/:id?relationships=:true<a name="GET_apigraphslineageverticesproperties:idrelationships:true"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Gets the properties of the vertex with specified id.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:id is the unique id of the vertex.</li>
+<li>:relationships has default value of false. Pass true if relationships should be fetched.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Properties associated with the specified vertex.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/graphs/lineage/vertices/properties/40004?relationships=true
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "results":
+ {
+ "timestamp":"2014-04-25T22:20Z",
+ "name":"local",
+ "type":"cluster-entity"
+ },
+ "totalSize":3
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2014
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
Added: incubator/falcon/site/docs/restapi/Vertices.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/Vertices.html?rev=1624488&view=auto
==============================================================================
--- incubator/falcon/site/docs/restapi/Vertices.html (added)
+++ incubator/falcon/site/docs/restapi/Vertices.html Fri Sep 12 09:43:48 2014
@@ -0,0 +1,322 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-09-12
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/graphs/lineage/vertices?key=:key&value=:value</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" />
+
+
+ <script type="text/javascript" src="../../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script>
+
+ </head>
+ <body class="topBarEnabled">
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container" style="width: 68%;"><div class="nav-collapse">
+
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Falcon <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../index.html" title="About">About</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Index" title="Wiki">Wiki</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/News" title="News">News</a>
+</li>
+
+ <li> <a href="https://git-wip-us.apache.org/repos/asf/incubator-falcon.git" title="Git">Git</a>
+</li>
+
+ <li> <a href="https://svn.apache.org/repos/asf/incubator/falcon" title="Svn">Svn</a>
+</li>
+
+ <li> <a href="https://issues.apache.org/jira/browse/FALCON" title="Jira">Jira</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy" title="Powered by">Powered by</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements" title="Acknowledgements">Acknowledgements</a>
+</li>
+
+ <li> <a href="http://blogs.apache.org/falcon/" title="Blog">Blog</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../project-info.html" title="Summary">Summary</a>
+</li>
+
+ <li> <a href="../../mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4" title="IRC">IRC</a>
+</li>
+
+ <li> <a href="../../team-list.html" title="Team">Team</a>
+</li>
+
+ <li> <a href="../../issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
+</li>
+
+ <li> <a href="../../source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+
+ <li> <a href="../../license.html" title="License">License</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.3-incubating" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.4-incubating" title="0.4-incubating">0.4-incubating</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap" title="Roadmap">Roadmap</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../docs/GettingStarted.html" title="current">current</a>
+</li>
+
+ <li> <a href="../../0.3-incubating/index.html" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="../../0.4-incubating/index.html" title="0.4-incubating">0.4-incubating</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../../slides/falcon-overview.html" title="Overview">Overview</a>
+</li>
+
+ <li> <a href="../../slides/falcon-user-guide.html" title="User Guide">User Guide</a>
+</li>
+
+ <li> <a href="../../docs/GettingStarted.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="../../docs/FalconArchitecture.html" title="Architecture">Architecture</a>
+</li>
+
+ <li> <a href="../../docs/InstallationSteps.html" title="Installation">Installation</a>
+</li>
+
+ <li> <a href="../../docs/OnBoarding.html" title="On Boarding">On Boarding</a>
+</li>
+
+ <li> <a href="../../docs/EntitySpecification.html" title="Entity Specification">Entity Specification</a>
+</li>
+
+ <li> <a href="../../docs/FalconCLI.html" title="Client (Falcon CLI)">Client (Falcon CLI)</a>
+</li>
+
+ <li> <a href="../../docs/restapi/ResourceList.html" title="Rest API">Rest API</a>
+</li>
+
+ <li> <a href="../../docs/HiveIntegration.html" title="Hive Integration">Hive Integration</a>
+</li>
+
+ <li> <a href="../../docs/Security.html" title="Security">Security</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+ <form id="search-form" action="http://www.google.com/search" method="get" class="navbar-search pull-right" >
+
+ <input value="http://falcon.incubator.apache.org" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
+
+
+
+
+
+ <iframe src="http://www.facebook.com/plugins/like.php?href=http://falcon.incubator.apache.org/falcon-website-general&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"
+ scrolling="no" frameborder="0"
+ style="border:none; width:80px; height:20px; margin-top: 10px;" class="pull-right" ></iframe>
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+ <ul class="nav pull-right"><li style="margin-top: 10px;">
+
+ <div class="g-plusone" data-href="http://falcon.incubator.apache.org/falcon-website-general" data-size="medium" width="60px" align="right" ></div>
+
+ </li></ul>
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="../../../index.html" id="bannerLeft">
+ <img src="../../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">
+ <a href="../../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET api/graphs/lineage/vertices?key=:key&value=:value</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/graphs/lineage/vertices?key=:key&value=:value<a name="GET_apigraphslineageverticeskey:keyvalue:value"></a></h3>
+<p></p>
+<ul>
+<li><a href="#Description">Description</a></li>
+<li><a href="#Parameters">Parameters</a></li>
+<li><a href="#Results">Results</a></li>
+<li><a href="#Examples">Examples</a></li></ul></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3>
+<p>Get all vertices for a key index given the specified value.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:key is the key to be matched.</li>
+<li>:value is the associated value of the key.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>All vertices matching given property key and a value.</p></div>
+<div class="section">
+<h3>Examples<a name="Examples"></a></h3></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/graphs/lineage/vertices?key=name&value=sampleIngestProcess
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "results": [
+ {
+ "timestamp":"2014-04-21T20:55Z",
+ "name":"sampleIngestProcess",
+ "type":"process-instance",
+ "version":"2.0.0",
+ "_id":4,
+ "_type":"vertex"
+ }
+ ],
+ "totalSize": 1
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2014
+ <a href="http://www.apache.org">Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
Modified: incubator/falcon/site/issue-tracking.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/issue-tracking.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/issue-tracking.html (original)
+++ incubator/falcon/site/issue-tracking.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - Issue Tracking</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
Modified: incubator/falcon/site/license.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/license.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/license.html (original)
+++ incubator/falcon/site/license.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - Project License</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
Modified: incubator/falcon/site/mail-lists.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/mail-lists.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/mail-lists.html (original)
+++ incubator/falcon/site/mail-lists.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - Project Mailing Lists</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
Modified: incubator/falcon/site/project-info.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/project-info.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/project-info.html (original)
+++ incubator/falcon/site/project-info.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - Project Information</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
Modified: incubator/falcon/site/source-repository.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/source-repository.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/source-repository.html (original)
+++ incubator/falcon/site/source-repository.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - Source Repository</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
Modified: incubator/falcon/site/team-list.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/team-list.html?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/site/team-list.html (original)
+++ incubator/falcon/site/team-list.html Fri Sep 12 09:43:48 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-05
+ | Generated by Apache Maven Doxia at 2014-09-12
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140705" />
+ <meta name="Date-Revision-yyyymmdd" content="20140912" />
<meta http-equiv="Content-Language" content="en" />
<title>Falcon - Team list</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -239,7 +239,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2014-07-05</li>
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-12</li>
</ul>
</div>
@@ -359,7 +359,23 @@
<td>Talend</td>
<td>committer, IPMC</td>
<td>+01:00</td>
-<td><span id="developer-11">+01:00</span></td></tr></table></div>
+<td><span id="developer-11">+01:00</span></td></tr>
+<tr class="b">
+<td><a name="rostafiychuk"></a>rostafiychuk</td>
+<td>Ruslan Ostafiychuk</td>
+<td><a class="externalLink" href="mailto:rostafiychuk@apache.org">rostafiychuk@apache.org</a></td>
+<td>Hortonworks</td>
+<td>committer</td>
+<td>+03:00</td>
+<td><span id="developer-12">+03:00</span></td></tr>
+<tr class="a">
+<td><a name="raghav"></a>raghav</td>
+<td>Raghav Kumar Gautam</td>
+<td><a class="externalLink" href="mailto:raghav@apache.org">raghav@apache.org</a></td>
+<td>Hortonworks</td>
+<td>committer</td>
+<td>-08:00</td>
+<td><span id="developer-13">-08:00</span></td></tr></table></div>
<div class="section">
<h3>Contributors<a name="Contributors"></a></h3><a name="Contributors"></a>
<p>There are no contributors listed for this project. Please check back again later.</p><script type="text/javascript">
@@ -386,6 +402,8 @@ function init(){
offsetDate('developer-9', '-8');
offsetDate('developer-10', '0');
offsetDate('developer-11', '0');
+ offsetDate('developer-12', '0');
+ offsetDate('developer-13', '0');
}
window.onLoad = init();
Modified: incubator/falcon/trunk/general/src/site/twiki/docs/EntitySpecification.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/EntitySpecification.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff
==============================================================================
--- incubator/falcon/trunk/general/src/site/twiki/docs/EntitySpecification.twiki (original)
+++ incubator/falcon/trunk/general/src/site/twiki/docs/EntitySpecification.twiki Fri Sep 12 09:43:48 2014
@@ -4,7 +4,7 @@
* <a href="#Process_Specification">Process Specification</a>
---++ Cluster Specification
-The [[https://git-wip-us.apache.org/repos/asf?p=incubator-falcon.git;a=blob_plain;f=client/src/main/resources/cluster-0.1.xsd;hb=HEAD][Cluster XSD specification]] is available here:
+The cluster XSD specification is available here:
A cluster contains different interfaces which are used by Falcon like readonly, write, workflow and messaging.
A cluster is referenced by feeds and processes which are on-boarded to Falcon by its name.
@@ -17,7 +17,9 @@ The colo specifies the colo to which thi
be unique.
-A cluster has varies interfaces as described below:
+---+++ Interfaces
+
+A cluster has various interfaces as described below:
<verbatim>
<interface type="readonly" endpoint="hftp://localhost:50010" version="0.20.2" />
</verbatim>
@@ -35,7 +37,7 @@ using the same write interface.
<interface type="execute" endpoint="localhost:8021" version="0.20.2" />
</verbatim>
An execute interface specifies the interface for job tracker, it's endpoint is the value of mapred.job.tracker.
-Falcon uses this interface to submit the processes as jobs on JobTracker defined here.
+Falcon uses this interface to submit the processes as jobs on !JobTracker defined here.
<verbatim>
<interface type="workflow" endpoint="http://localhost:11000/oozie/" version="3.1" />
@@ -56,15 +58,32 @@ Although Hive metastore supports both RP
</verbatim>
A messaging interface specifies the interface for sending feed availability messages, it's endpoint is broker url with tcp address.
+---+++ Locations
+
A cluster has a list of locations defined:
<verbatim>
<location name="staging" path="/projects/falcon/staging" />
+<location name="working" path="/projects/falcon/working" />
</verbatim>
Location has the name and the path, name is the type of locations like staging, temp and working.
and path is the hdfs path for each location.
Falcon would use the location to do intermediate processing of entities in hdfs and hence Falcon
should have read/write/execute permission on these locations.
+---+++ ACL
+
+A cluster has ACL (Access Control List) useful for implementing permission requirements
+and provide a way to set different permissions for specific users or named groups.
+<verbatim>
+ <ACL owner="test-user" group="test-group" permission="*"/>
+</verbatim>
+ACL indicates the Access control list for this cluster.
+owner is the Owner of this entity.
+group is the one which has access to read.
+permission indicates the permission.
+
+---+++ Custom Properties
+
A cluster has a list of properties:
A key-value pair, which are propagated to the workflow engine.
<verbatim>
@@ -74,7 +93,7 @@ Ideally JMS impl class name of messaging
should be defined here.
---++ Feed Specification
-The [[https://git-wip-us.apache.org/repos/asf?p=incubator-falcon.git;a=blob_plain;f=client/src/main/resources/feed-0.1.xsd;hb=HEAD][Feed XSD specification]] is available here.
+The Feed XSD specification is available here.
a Feed defines various attributes of feed like feed location, frequency, late-arrival handling
and retention policies.
A feed can be scheduled on a cluster, once a feed is scheduled its retention and replication process are triggered in a given cluster.
@@ -128,7 +147,7 @@ Location specifies where the feed is ava
A location tag specifies the type of location like data, meta, stats and the corresponding paths for them.
A feed should at least define the location for type data, which specifies the HDFS path pattern where the feed is generated
periodically. ex: type="data" path="/projects/TrafficHourly/${YEAR}-${MONTH}-${DAY}/traffic"
-The granularity of date pattern in the path should be atleast that of a frequency of a feed.
+The granularity of date pattern in the path should be at least that of a frequency of a feed.
Other location type which are supported are stats and meta paths, if a process references a feed then the meta and stats
paths are available as a property in a process.
@@ -176,8 +195,8 @@ Examples:
</verbatim>
A feed can define multiple partitions, if a referenced cluster defines partitions then the number of partitions in feed has to be equal to or more than the cluster partitions.
-*Note:* This will only apply for FileSystem storage but not Table storage as partitions are defined and maintained in
-Hive (Hcatalog) registry.
+*Note:* This will only apply for !FileSystem storage but not Table storage as partitions are defined and maintained in
+Hive (HCatalog) registry.
---+++ Groups
@@ -215,9 +234,21 @@ A late-arrival specifies the cut-off per
The cut-off period is specified by expression frequency(times), ex: if the feed can arrive late
upto 8 hours then late-arrival's cut-off="hours(8)"
-*Note:* This will only apply for FileSystem storage but not Table storage until a future time.
+*Note:* This will only apply for !FileSystem storage but not Table storage until a future time.
----++++ Custom Properties
+---+++ ACL
+
+A feed has ACL (Access Control List) useful for implementing permission requirements
+and provide a way to set different permissions for specific users or named groups.
+<verbatim>
+ <ACL owner="test-user" group="test-group" permission="*"/>
+</verbatim>
+ACL indicates the Access control list for this cluster.
+owner is the Owner of this entity.
+group is the one which has access to read.
+permission indicates the permission.
+
+---+++ Custom Properties
<verbatim>
<properties>
@@ -227,20 +258,20 @@ upto 8 hours then late-arrival's cut-off
<property name="jobPriority" value="VERY_HIGH"/>
<property name="timeout" value="hours(1)"/>
<property name="parallel" value="3"/>
+ <property name="maxMaps" value="8"/>
+ <property name="mapBandwidthKB" value="1024"/>
</properties>
</verbatim>
A key-value pair, which are propagated to the workflow engine. "queueName" and "jobPriority" are special properties
-available to user to specify the hadoop job queue and priority, the same value is used by Falcons launcher job.
+available to user to specify the Hadoop job queue and priority, the same value is used by Falcons launcher job.
"timeout" and "parallel" are other special properties which decides replication instance's timeout value while
-waiting for the feed instance and parallel decides the concurrent replication instances that can run at any given time.
+waiting for the feed instance and parallel decides the concurrent replication instances that can run at any given time. "maxMaps" represents the maximum number of maps used during replication. "mapBandwidthKB" represents the bandwidth in KB/s used by each mapper during replication.
---++ Process Specification
-The [[https://git-wip-us.apache.org/repos/asf?p=incubator-falcon.git;a=blob_plain;f=client/src/main/resources/process-0.1.xsd;hb=HEAD][Process XSD specification]] is available here.
-
-A process defines configuration for a workflow. A workflow is a directed acyclic graph(DAG) which defines the job for the workflow engine. A process definition defines the configurations required to run the workflow job. For example, process defines the frequency at which the workflow should run, the clusters on which the workflow should run, the inputs and outputs for the workflow, how the workflow failures should be handled, how the late inputs should be handled and so on.
+A process defines configuration for a workflow. A workflow is a directed acyclic graph(DAG) which defines the job for the workflow engine. A process definition defines the configurations required to run the workflow job. For example, process defines the frequency at which the workflow should run, the clusters on which the workflow should run, the inputs and outputs for the workflow, how the workflow failures should be handled, how the late inputs should be handled and so on.
The different details of process are:
----++++ Name
+---+++ Name
Each process is identified with a unique name.
Syntax:
<verbatim>
@@ -249,7 +280,24 @@ Syntax:
</process>
</verbatim>
----++++ Cluster
+---+++ Tags
+An optional list of comma separated tags which are used for classification of processes.
+Syntax:
+<verbatim>
+...
+ <tags>consumer=consumer@xyz.com, owner=producer@xyz.com, department=forecasting</tags>
+</verbatim>
+
+---+++ Pipelines
+An optional list of comma separated word strings, specifies the data processing pipeline(s) to which this process belongs.
+Only letters, numbers and underscore are allowed for pipeline string.
+Syntax:
+<verbatim>
+...
+ <pipelines>test_Pipeline, dataReplication, clickStream_pipeline</pipelines>
+</verbatim>
+
+---+++ Cluster
The cluster on which the workflow should run. A process should contain one or more clusters. Cluster definition for the cluster name gives the end points for workflow execution, name node, job tracker, messaging and so on. Each cluster inturn has validity mentioned, which tell the times between which the job should run on that specified cluster.
Syntax:
<verbatim>
@@ -270,18 +318,19 @@ Syntax:
</process>
</verbatim>
----++++ Parallel
-Parallel defines how many instances of the workflow can run concurrently. It should be a positive interger > 0. For example, concurrency of 1 ensures that only one instance of the workflow can run at a time. The next instance will start only after the running instance completes.
+---+++ Parallel
+Parallel defines how many instances of the workflow can run concurrently. It should be a positive integer > 0.
+For example, parallel of 1 ensures that only one instance of the workflow can run at a time. The next instance will start only after the running instance completes.
Syntax:
<verbatim>
<process name="[process name]">
...
- <concurrency>[concurrency]</concurrency>
+ <parallel>[parallel]</parallel>
...
</process>
</verbatim>
----++++ Order
+---+++ Order
Order defines the order in which the ready instances are picked up. The possible values are FIFO(First In First Out), LIFO(Last In First Out), and ONLYLAST(Last Only).
Syntax:
<verbatim>
@@ -292,7 +341,7 @@ Syntax:
</process>
</verbatim>
----++++ Timeout
+---+++ Timeout
A optional Timeout specifies the maximum time an instance waits for a dataset before being killed by the workflow engine, a time out is specified like frequency.
If timeout is not specified, falcon computes a default timeout for a process based on its frequency, which is six times of the frequency of process or 30 minutes if computed timeout is less than 30 minutes.
<verbatim>
@@ -303,7 +352,7 @@ If timeout is not specified, falcon comp
</process>
</verbatim>
----++++ Frequency
+---+++ Frequency
Frequency defines how frequently the workflow job should run. For example, hours(1) defines the frequency as hourly, days(7) defines weekly frequency. The values for timeunit can be minutes/hours/days/months and the frequency number should be a positive integer > 0.
Syntax:
<verbatim>
@@ -314,7 +363,7 @@ Syntax:
</process>
</verbatim>
----++++ Validity
+---+++ Validity
Validity defines how long the workflow should run. It has 3 components - start time, end time and timezone. Start time and end time are timestamps defined in yyyy-MM-dd'T'HH:mm'Z' format and should always be in UTC. Timezone is used to compute the next instances starting from start time. The workflow will start at start time and end before end time specified on a given cluster. So, there will not be a workflow instance at end time.
Syntax:
<verbatim>
@@ -346,7 +395,7 @@ The daily workflow will start on Jan 1st
</verbatim>
The hourly workflow will start on March 11th 2012 at 00:40 PST, the next instances will be at 01:40 PST, 03:40 PDT, 04:40 PDT and so on till 23:40 PDT. So, there will be just 23 instances of the workflow for March 11th 2012 because of DST switch.
----++++ Inputs
+---+++ Inputs
Inputs define the input data for the workflow. The workflow job will start executing only after the schedule time and when all the inputs are available. There can be 0 or more inputs and each of the input maps to a feed. The path and frequency of input data is picked up from feed definition. Each input should also define start and end instances in terms of [[FalconDocumentation][EL expressions]] and can optionally specify specific partition of input that the workflow requires. The components in partition should be subset of partitions defined in the feed.
For each input, Falcon will create a property with the input name that contains the comma separated list of input paths. This property can be used in workflow actions like pig scripts and so on.
@@ -446,7 +495,7 @@ Example workflow configuration:
</verbatim>
----++++ Optional Inputs
+---+++ Optional Inputs
User can mention one or more inputs as optional inputs. In such cases the job does not wait on those inputs which are
mentioned as optional. If they are present it considers them otherwise continue with the compulsory ones.
Example:
@@ -473,10 +522,10 @@ Example:
</process>
</verbatim>
-*Note:* This is only supported for FileSystem storage but not Table storage at this point.
+*Note:* This is only supported for !FileSystem storage but not Table storage at this point.
----++++ Outputs
+---+++ Outputs
Outputs define the output data that is generated by the workflow. A process can define 0 or more outputs. Each output is mapped to a feed and the output path is picked up from feed definition. The output instance that should be generated is specified in terms of [[FalconDocumentation][EL expression]].
For each output, Falcon creates a property with output name that contains the path of output data. This can be used in workflows to store in the path.
@@ -560,28 +609,28 @@ Example workflow configuration:
</configuration>
</verbatim>
----++++ Properties
+---+++ Custom Properties
The properties are key value pairs that are passed to the workflow. These properties are optional and can be used
in workflow to parameterize the workflow.
-Synatx:
+Syntax:
<verbatim>
<process name="[process name]">
...
<properties>
- <propery name=[key] value=[value]/>
+ <property name=[key] value=[value]/>
...
</properties>
...
</process>
</verbatim>
-queueName and jobPriority are special properites, which when present are used by the Falcon's launcher job, the same property is also availalble in workflow which can be used to propogate to pig or M/R job.
+queueName and jobPriority are special properties, which when present are used by the Falcon's launcher job, the same property is also available in workflow which can be used to propagate to pig or M/R job.
<verbatim>
<property name="queueName" value="hadoopQueue"/>
<property name="jobPriority" value="VERY_HIGH"/>
</verbatim>
----++++ Workflow
+---+++ Workflow
The workflow defines the workflow engine that should be used and the path to the workflow on hdfs.
The workflow definition on hdfs contains the actual job that should run and it should confirm to
@@ -593,11 +642,11 @@ be available for the workflow.
There are 2 engines supported today.
----+++++ Oozie
+---++++ Oozie
As part of oozie workflow engine support, users can embed a oozie workflow.
-Refer to oozie [[http://incubator.apache.org/oozie/overview.html][workflow overview]] and
-[[http://incubator.apache.org/oozie/docs/3.1.3/docs/WorkflowFunctionalSpec.html][workflow specification]] for details.
+Refer to oozie [[http://oozie.apache.org/docs/4.0.0/DG_Overview.html][workflow overview]] and
+[[http://oozie.apache.org/docs/4.0.0/WorkflowFunctionalSpec.html][workflow specification]] for details.
Syntax:
<verbatim>
@@ -620,7 +669,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.
----+++++ Pig
+---++++ Pig
Falcon also adds the Pig engine which enables users to embed a Pig script as a process.
@@ -639,7 +688,7 @@ This defines the workflow engine to be p
Feeds with Hive table storage will send one more parameter apart from the general ones:
<verbatim>$input_filter</verbatim>
----+++++ Hive
+---++++ Hive
Falcon also adds the Hive engine as part of Hive Integration which enables users to embed a Hive script as a process.
This would enable users to create materialized queries in a declarative way.
@@ -659,7 +708,7 @@ This defines the workflow engine to be h
Feeds with Hive table storage will send one more parameter apart from the general ones:
<verbatim>$input_filter</verbatim>
----++++ Retry
+---+++ Retry
Retry policy defines how the workflow failures should be handled. Two retry policies are defined: backoff and exp-backoff(exponential backoff). Depending on the delay and number of attempts, the workflow is re-tried after specific intervals.
Syntax:
<verbatim>
@@ -680,7 +729,7 @@ Examples:
</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.
----++++ Late data
+---+++ 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.
Late data policy defines how frequently check is done to detect late data. The policies supported are: backoff, exp-backoff(exponention backoff) and final(at feed's late cut-off). The policy along with delay defines the interval at which late data check is done.
@@ -722,4 +771,17 @@ Example:
</verbatim>
This late handling specifies that late data detection should run at feed's late cut-off which is 6 hours in this case. If there is late data, Falcon should run the workflow specified at /projects/bootcamp/workflow/lateinput1/workflow.xml
-*Note:* This is only supported for FileSystem storage but not Table storage at this point.
+*Note:* This is only supported for !FileSystem storage but not Table storage at this point.
+
+---+++ ACL
+
+A process has ACL (Access Control List) useful for implementing permission requirements
+and provide a way to set different permissions for specific users or named groups.
+<verbatim>
+ <ACL owner="test-user" group="test-group" permission="*"/>
+</verbatim>
+ACL indicates the Access control list for this cluster.
+owner is the Owner of this entity.
+group is the one which has access to read.
+permission indicates the permission.
+