falcon-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From b...@apache.org
Subject [01/49] falcon git commit: FALCON-2006 Update documentation on site for 0.10 release
Date Mon, 08 Aug 2016 23:15:35 GMT
Repository: falcon
Updated Branches:
  refs/heads/asf-site 82d0e6fca -> 4612c3f79


http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/trunk/releases/0.10/src/site/twiki/restapi/InstanceRerun.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/0.10/src/site/twiki/restapi/InstanceRerun.twiki b/trunk/releases/0.10/src/site/twiki/restapi/InstanceRerun.twiki
new file mode 100644
index 0000000..eef0e1a
--- /dev/null
+++ b/trunk/releases/0.10/src/site/twiki/restapi/InstanceRerun.twiki
@@ -0,0 +1,66 @@
+---++  POST /api/instance/rerun/:entity-type/:entity-name
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Rerun instances of an entity. On issuing a rerun, by default the execution resumes from the last failed node in the workflow.
+
+---++ Parameters
+   * :entity-type can either be a feed or a process.
+   * :entity-name is name of the entity.
+   * start is the start time of the instance that you want to refer to
+   * end is the end time of the instance that you want to refer to
+   * lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process.
+   * force <optional param> can be used to forcefully rerun the entire instance.
+   * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.
+
+---++ Results
+Results of the rerun command.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/instance/rerun/process/SampleProcess?colo=*&start=2013-04-03T07:00Z&end=2014-04-03T07:00Z
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "instances": [
+        {
+            "details": "",
+            "startTime": "2013-10-21T15:10:47-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+            "status": "RUNNING",
+            "instance": "2012-04-03T07:00Z"
+        }
+    ],
+    "requestId": "default\/7a3582bd-608c-45a7-9b74-1837b51ba6d5\n",
+    "message": "default\/RERUN\n",
+    "status": "SUCCEEDED"
+}
+</verbatim>
+
+<verbatim>
+POST http://localhost:15000/api/instance/rerun/process/SampleProcess?colo=*&start=2013-04-03T07:00Z&end=2014-04-03T07:00Z&force=true&doAs=joe
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "instances": [
+        {
+            "details": "",
+            "startTime": "2013-10-21T15:10:47-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+            "status": "RUNNING",
+            "instance": "2012-04-03T07:00Z"
+        }
+    ],
+    "requestId": "default\/7a3582bd-608c-45a7-9b74-1837b51ba6d5\n",
+    "message": "default\/RERUN\n",
+    "status": "SUCCEEDED"
+}
+</verbatim>

http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/trunk/releases/0.10/src/site/twiki/restapi/InstanceResume.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/0.10/src/site/twiki/restapi/InstanceResume.twiki b/trunk/releases/0.10/src/site/twiki/restapi/InstanceResume.twiki
new file mode 100644
index 0000000..1254785
--- /dev/null
+++ b/trunk/releases/0.10/src/site/twiki/restapi/InstanceResume.twiki
@@ -0,0 +1,43 @@
+---++  POST /api/instance/resume/:entity-type/:entity-name
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Resume suspended instances of an entity.
+
+---++ Parameters
+   * :entity-type can either be a feed or a process.
+   * :entity-name is name of the entity.
+   * start is the start time of the instance(s) that you want to refer to
+   * end is the end time of the instance(s) that you want to refer to
+   * lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process.
+   * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.
+
+---++ Results
+Results of the resume command.
+
+---++ Examples
+---+++ Rest Call
+           <verbatim>
+           POST http://localhost:15000/api/instance/resume/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&end=2014-04-03T07:00Z&doAs=joe
+           </verbatim>
+           ---+++ Result
+           <verbatim>
+           {
+               "instances": [
+                   {
+                       "details": "",
+                       "startTime": "2013-10-21T15:19:57-07:00",
+                       "cluster": "primary-cluster",
+                       "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+                       "status": "RUNNING",
+                       "instance": "2012-04-03T07:00Z"
+                   }
+               ],
+               "requestId": "default\/e88ff2e0-2af7-4829-a360-f92e95be2981\n",
+               "message": "default\/RESUME\n",
+               "status": "SUCCEEDED"
+           }
+           </verbatim>

http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/trunk/releases/0.10/src/site/twiki/restapi/InstanceRunning.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/0.10/src/site/twiki/restapi/InstanceRunning.twiki b/trunk/releases/0.10/src/site/twiki/restapi/InstanceRunning.twiki
new file mode 100644
index 0000000..3d1cabc
--- /dev/null
+++ b/trunk/releases/0.10/src/site/twiki/restapi/InstanceRunning.twiki
@@ -0,0 +1,84 @@
+---++  GET /api/instance/running/:entity-type/:entity-name
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Get a list of instances currently running for a given entity.
+
+---++ Parameters
+   * :entity-type Valid options are cluster, feed or process.
+   * :entity-name Name of the entity.
+   * colo <optional param> Colo on which the query should be run.
+   * lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).
+   * filterBy <optional param>  Filter results by list of field:value pairs. Example: filterBy=CLUSTER:primary-cluster
+      * Supported filter fields are CLUSTER, SOURCECLUSTER, STARTEDAFTER.
+      * Query will do an AND among filterBy fields.
+   * orderBy <optional param> Field by which results should be ordered.
+      * Supports ordering by "status","startTime","endTime","cluster".
+   * sortOrder <optional param> Valid options are "asc" and "desc"
+   * 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.
+
+---++ Results
+List of instances currently running.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=*
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "instances": [
+        {
+            "startTime": "2013-10-21T14:39:28-07:00",
+            "cluster": "primary-cluster",
+            "status": "RUNNING",
+            "instance": "2012-04-03T06:00Z"
+        }
+    ],
+    "requestId": "default\/12e9a7d4-3b4f-4a76-b471-c8f3786a62a0\n",
+    "message": "default\/Running Instances\n",
+    "status": "SUCCEEDED"
+}
+</verbatim>
+
+
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2&doAs=joe
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "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": "RUNNING",
+            "instance": "2012-04-03T07:00Z"
+        },
+        {
+            "details": "",
+            "endTime": "2013-10-21T14:42:27-07:00",
+            "startTime": "2013-10-21T14:41:57-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W",
+            "status": "RUNNING",
+            "instance": "2012-04-03T08:00Z"
+        },
+    ],
+
+    "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+    "message": "default\/STATUS\n",
+    "status": "SUCCEEDED"
+}
+</verbatim>
+

http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/trunk/releases/0.10/src/site/twiki/restapi/InstanceSearch.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/0.10/src/site/twiki/restapi/InstanceSearch.twiki b/trunk/releases/0.10/src/site/twiki/restapi/InstanceSearch.twiki
new file mode 100644
index 0000000..4744240
--- /dev/null
+++ b/trunk/releases/0.10/src/site/twiki/restapi/InstanceSearch.twiki
@@ -0,0 +1,97 @@
+---++  GET /api/instance/search
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Get the list of instances that meet search criteria.
+
+---++ Parameters
+   * :type <optional param> Comma-separated entity types. Valid entity types are feed, process or datasource.
+   * nameseq <optional param> Subsequence of entity name. Not case sensitive.
+      * The entity name needs to contain all the characters in the subsequence in the same order.
+      * Example 1: "sample1" will match the entity named "SampleFeed1-2".
+      * Example 2: "mhs" will match the entity named "New-My-Hourly-Summary".
+   * tagkeys <optional param> Keywords in tags, separated by comma. Not case sensitive.
+      * The returned entities will have tags that match all the tag keywords.
+   * instanceStatus <optional param> Valid options are RUNNING, SUCCEEDED, FAILED, WAITING, SUSPENDED, KILLED, TIMEOUT.
+   * start <optional param> Show instances from this nominal time. Format: yyyy-MM-dd'T'HH:mm'Z'.
+      * By default, it is set to (end - (10 * entityFrequency)).
+   * end <optional param> Show instances up to this nominal time. Format: yyyy-MM-dd'T'HH:mm'Z'.
+      * Default is set to now.
+   * orderBy <optional param> Field by which results should be ordered. Sorted by descending order.
+      * If not specified, instances of the same entity will be listed together in the result.
+      * Current valid option: status. Coming soon: sorting by name, nominal time, running time.
+   * 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.
+
+---++ Results
+A list of instances.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/search?nameseq=usbill&start=2012-04-03T00:00Z
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "instances": [
+        {
+	 “name":"SampleUSHealthBill”,
+	 “type":"FEED”,
+	 “tags”: {"tag":["related=ushealthcare","department=billingDepartment"]},
+            “nominalTime": "2012-04-03T07:00Z"
+            "cluster": "primary-cluster",
+            "status": "SUCCEEDED",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+            "startTime": "2013-10-21T14:39:56-07:00",
+            "endTime": "2013-10-21T14:40:26-07:00",
+        }
+    ],
+    "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+    "message": "Instances Search Results",
+    "status": "SUCCEEDED”
+}
+</verbatim>
+
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/search?nameseq=samplebill&tagkeys=billing,healthcare&start=2012-04-03T00:00Z&instanceStatus=succeeded&orderBy=nominalTime&offset=2&numResults=2
+</verbatim>
+---+++ Result
+<verbatim>
+ {
+    "instances": [
+        {
+	 "name":"SampleHealthBill",
+	 "type":"PROCESS",
+	 "tags”: {"tag":["related=healthcare","department=billingDepartment"]},
+            “nominalTime": "2012-04-03T08:00Z"
+            "cluster": "primary-cluster",
+            "status": "SUCCEEDED",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W",
+            "startTime": "2013-10-21T14:41:56-07:00",
+            "endTime": "2013-10-21T14:42:26-07:00",
+        },
+        {
+	 "name":"SampleUSHealthBill",
+	 "type":"FEED”,
+	 "tags": {"tag":["related=ushealthcare","department=billingDepartment"]},
+            “nominalTime": "2012-04-03T07:00Z"
+            "cluster": "primary-cluster",
+            "status": "SUCCEEDED",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+            "startTime": "2013-10-21T14:39:56-07:00",
+            "endTime": "2013-10-21T14:40:26-07:00",
+        },
+    ],
+
+    "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+    "message": "Instances Search Results",
+    "status": "SUCCEEDED”
+}
+</verbatim>

http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/trunk/releases/0.10/src/site/twiki/restapi/InstanceStatus.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/0.10/src/site/twiki/restapi/InstanceStatus.twiki b/trunk/releases/0.10/src/site/twiki/restapi/InstanceStatus.twiki
new file mode 100644
index 0000000..2b7b643
--- /dev/null
+++ b/trunk/releases/0.10/src/site/twiki/restapi/InstanceStatus.twiki
@@ -0,0 +1,98 @@
+---++  GET /api/instance/status/:entity-type/:entity-name
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Get status of a specific instance of an entity.
+
+---++ Parameters
+   * :entity-type Valid options are cluster, feed or process.
+   * :entity-name Name of the entity.
+   * start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+      * By default, it is set to (end - (10 * entityFrequency)).
+   * end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+      * Default is set to now.
+   * colo <optional param> Colo on which the query should be run.
+   * lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).
+   * filterBy <optional param>  Filter results by list of field:value pairs. Example: filterBy=STATUS:RUNNING,CLUSTER:primary-cluster
+      * Supported filter fields are STATUS, CLUSTER, SOURCECLUSTER, STARTEDAFTER.
+      * Query will do an AND among filterBy fields.
+   * orderBy <optional param> Field by which results should be ordered.
+      * Supports ordering by "status","startTime","endTime","cluster".
+   * sortOrder <optional param> Valid options are "asc" and "desc"
+   * 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.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET https://localhost:15443/api/instance/status/process/WordCount?start=2014-11-04T16:00Z&colo=*
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "instances": [
+        {
+            "details": "",
+            "endTime": "2014-11-05T16:08:10+05:30",
+            "startTime": "2014-11-05T16:07:29+05:30",
+            "cluster": "local",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000011-141105155430303-oozie-oozi-W",
+            "status": "SUCCEEDED",
+            "instance": "2014-11-04T16:00Z",
+            "actions": [
+                {
+                    "action": "wordcount-mr",
+                    "status": "SUCCEEDED",
+                    "logFile": "http:\/\/localhost:50030\/jobdetails.jsp?jobid=job_201411051553_0005"
+                }
+            ]
+        }
+    ],
+    "requestId": "default\/b9fc3cba-1b46-4d1f-8196-52c795ea3580\n",
+    "message": "default\/STATUS\n",
+    "status": "SUCCEEDED"
+}
+</verbatim>
+
+
+---+++ Rest Call
+<verbatim>
+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&doAs=joe
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "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"
+}
+</verbatim>

http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/trunk/releases/0.10/src/site/twiki/restapi/InstanceSummary.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/0.10/src/site/twiki/restapi/InstanceSummary.twiki b/trunk/releases/0.10/src/site/twiki/restapi/InstanceSummary.twiki
new file mode 100644
index 0000000..0e1ffee
--- /dev/null
+++ b/trunk/releases/0.10/src/site/twiki/restapi/InstanceSummary.twiki
@@ -0,0 +1,114 @@
+---++  GET /api/instance/summary/:entity-type/:entity-name
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Get summary of instance/instances of an entity.
+
+---++ Parameters
+   * :entity-type Valid options are feed or process.
+   * :entity-name Name of the entity.
+   * start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+       * By default, it is set to (end - (10 * entityFrequency)).
+   * end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+       * Default is set to now.
+   * colo <optional param> Colo on which the query should be run.
+   * lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).
+   * filterBy <optional param>  Filter results by list of field:value pairs.
+   Example1: filterBy=STATUS:RUNNING,CLUSTER:primary-cluster
+   Example2: filterBy=Status:RUNNING,Status:KILLED
+       * Supported filter fields are STATUS, CLUSTER
+       * Query will do an AND among filterBy fields.
+   * orderBy <optional param> Field by which results should be ordered.
+       * Supports ordering by "cluster".
+   * sortOrder <optional param> Valid options are "asc" and "desc"
+   Example: orderBy=cluster sortOrder=asc
+   * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.
+
+---++ Results
+Summary of the instances over the specified time range
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/summary/process/WordCount?colo=*&start=2014-01-21T13:00Z&end=2014-01-21T16:00Z
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "status":"SUCCEEDED",
+    "message":"default/SUMMARY\n",
+    "requestId":"default/c344567b-da73-44d5-bcd4-bf456524934c\n",
+    "instancesSummary":
+        {
+            "cluster":"local",
+            "map":
+                {
+                    "entry":
+                        {
+                            "key":"SUCCEEDED",
+                            "value":"value"
+                         }
+                }
+            }
+        }
+}
+</verbatim>
+
+---+++ Rest Call
+<verbatim>
+GET https://localhost:16443/api/instance/summary/process/WordCount?filterBy=Status:KILLED,Status:RUNNING&start=2015-06-24T16:00Z&end=2015-06-24T23:00Z&colo=*
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "status":"SUCCEEDED",
+    "message":"local/SUMMARY\n",
+    "requestId":"local/1246061948@qtp-1059149611-5 - 34d8c3bb-f461-4fd5-87cd-402c9c6b1ed2\n",
+    "instancesSummary":[
+        {
+            "cluster":"local",
+            "map":{
+                "entry":{
+                    "key":"RUNNING",
+                    "value":"1"
+                },
+                "entry":{
+                    "key":"KILLED",
+                    "value":"1"
+                }
+            }
+        }
+    ]
+}
+</verbatim>
+
+---+++ Rest Call
+<verbatim>
+GET https://localhost:16443/api/instance/summary/process/WordCount?orderBy=cluster&sortOrder=asc&start=2015-06-24T16:00Z&end=2015-06-24T23:00Z&colo=*&doAs=joe
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "status":"SUCCEEDED",
+    "message":"local/SUMMARY\n",
+    "requestId":"local/1246061948@qtp-1059149611-5 - 42e2040d-6b6e-4bfd-a090-83db5ed1a429\n",
+    "instancesSummary":[
+        {
+            "cluster":"local",
+            "map":{
+                "entry":{
+                    "key":"SUCCEEDED",
+                    "value":"6"
+                },
+                "entry":{
+                    "key":"KILLED",
+                    "value":"1"
+                }
+            }
+        }
+    ]
+}
+</verbatim>

http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/trunk/releases/0.10/src/site/twiki/restapi/InstanceSuspend.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/0.10/src/site/twiki/restapi/InstanceSuspend.twiki b/trunk/releases/0.10/src/site/twiki/restapi/InstanceSuspend.twiki
new file mode 100644
index 0000000..2ba8663
--- /dev/null
+++ b/trunk/releases/0.10/src/site/twiki/restapi/InstanceSuspend.twiki
@@ -0,0 +1,44 @@
+---++  POST /api/instance/suspend/:entity-type/:entity-name
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Suspend instances of an entity.
+
+---++ Parameters
+   * :entity-type can either be a feed or a process.
+   * :entity-name is name of the entity.
+   * start is the start time of the instance(s) that you want to refer to
+   * end is the end time of the instance(s) that you want to refer to
+   * lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process.
+   * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.
+
+---++ Results
+Results of the suspend command.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/instance/suspend/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&end=2014-04-03T07:00Z&doAs=joe
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "instances": [
+        {
+            "details": "",
+            "endTime": "2013-10-21T15:15:01-07:00",
+            "startTime": "2013-10-21T15:14:32-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+            "status": "SUCCEEDED",
+            "instance": "2012-04-03T07:00Z"
+        }
+    ],
+    "requestId": "default\/ff07e45b-b6da-4f47-ae96-9182bd8a7e53\n",
+    "message": "default\/SUSPEND\n",
+    "status": "SUCCEEDED"
+}
+</verbatim>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/trunk/releases/0.10/src/site/twiki/restapi/MetadataList.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/0.10/src/site/twiki/restapi/MetadataList.twiki b/trunk/releases/0.10/src/site/twiki/restapi/MetadataList.twiki
new file mode 100644
index 0000000..98abf46
--- /dev/null
+++ b/trunk/releases/0.10/src/site/twiki/restapi/MetadataList.twiki
@@ -0,0 +1,31 @@
+---++  GET api/metadata/discovery/:type/list
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Get all dimensions of specified type.
+
+---++ Parameters
+   * :type Valid dimension types are cluster_entity,feed_entity, process_entity, user, colo, tags, groups, pipelines
+   * cluster <optional query param> Show dimensions related to this cluster.
+   * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.
+
+
+---++ Results
+List of dimensions that match requested type [and cluster].
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/metadata/discovery/process_entity/list?cluster=primary-cluster&doAs=joe
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "results": ["sampleIngestProcess","testProcess","anotherProcess"],
+    "totalSize": 3
+}
+</verbatim>
+

http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/trunk/releases/0.10/src/site/twiki/restapi/MetadataRelations.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/0.10/src/site/twiki/restapi/MetadataRelations.twiki b/trunk/releases/0.10/src/site/twiki/restapi/MetadataRelations.twiki
new file mode 100644
index 0000000..b29fd2a
--- /dev/null
+++ b/trunk/releases/0.10/src/site/twiki/restapi/MetadataRelations.twiki
@@ -0,0 +1,46 @@
+---++  GET api/metadata/discovery/:dimension-type/:dimension-name/relations
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Get all relations of a specific dimension.
+
+---++ Parameters
+   * :type Valid dimension types are cluster_entity,feed_entity, process_entity, user, colo, tags, groups, pipelines
+   * :name Name of the dimension.
+   * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.
+
+---++ Results
+Get all relations of a specific dimension.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/metadata/discovery/process_entity/sample-process/relations?doAs=joe
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "timestamp":"2014-09-09T01:31Z",
+    "userWorkflowEngine":"pig",
+    "name":"sample-process",
+    "type":"PROCESS_ENTITY",
+    "userWorkflowName":"imp-click-join-workflow",
+    "version":"1.0.9",
+    "inVertices":[
+        {"name":"clicks-feed","type":"FEED_ENTITY","label":"input"},
+        {"name":"impression-feed","type":"FEED_ENTITY","label":"input"},
+        {"name":"sample-process\/2014-01-01T01:00Z","type":"PROCESS_INSTANCE","label":"instance-of"}
+    ],
+    "outVertices":[
+        {"name":"Critical","type":"TAGS","label":"classified-as"},
+        {"name":"testPipeline","type":"PIPELINES","label":"pipeline"},
+        {"name":"primary-cluster","type":"CLUSTER_ENTITY","label":"runs-on"},
+        {"name":"imp-click-join2","type":"FEED_ENTITY","label":"output"},
+        {"name":"imp-click-join1","type":"FEED_ENTITY","label":"output"},
+        {"name":"falcon-user","type":"USER","label":"owned-by"}
+    ]
+}
+</verbatim>

http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/trunk/releases/0.10/src/site/twiki/restapi/ResourceList.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/0.10/src/site/twiki/restapi/ResourceList.twiki b/trunk/releases/0.10/src/site/twiki/restapi/ResourceList.twiki
new file mode 100644
index 0000000..5a4c253
--- /dev/null
+++ b/trunk/releases/0.10/src/site/twiki/restapi/ResourceList.twiki
@@ -0,0 +1,118 @@
+---+ RESTful Resources
+
+---++ Resource List
+   * <a href="#REST_Call_on_Entity_Resource">REST Call on Entity Resource</a>
+   * <a href="#REST_Call_on_Feed_and_Process_Instances">REST Call on Feed/Process Instances</a>
+   * <a href="#REST_Call_on_Admin_Resource">REST Call on Admin Resource</a>
+   * <a href="#REST_Call_on_Lineage_Graph">REST Call on Lineage Graph Resource</a>
+   * <a href="#REST_Call_on_Metadata_Resource">REST Call on Metadata Resource</a>
+   * <a href="#REST_Call_on_Extension_Artifact">REST Call on Extension artifact</a>
+   * <a href="#REST_Call_on_Extension_Job Management">REST Call on Extension Job Management</a>
+
+---++ Authentication
+
+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.
+
+When security is on (kerberos), authentication is performed by Kerberos SPNEGO.
+
+Below are examples using the curl command tool.
+
+Authentication when security is off (Pseudo/Simple):
+<verbatim>
+curl -i "http://<HOST>:<PORT>/<PATH>?[user.name=<USER>&]<PARAM>=..."
+</verbatim>
+
+Authentication using Kerberos SPNEGO when security is on:
+<verbatim>
+curl -i --negotiate -u : "http://<HOST>:<PORT>/<PATH>?<PARAM>=..."
+</verbatim>
+
+See also: [[../Security.twiki][Security in Falcon]]
+
+The current version of the rest api's documentation is also hosted on the Falcon server and Prism Server (in distributed mode) at the url http://<HOST>:<PORT>/docs
+
+---++ REST Call on Admin Resource
+
+| *Call Type* | *Resource*                                     | *Description*                               |
+| GET         | [[AdminStack][api/admin/stack]]                | Get stack of the server                     |
+| GET         | [[AdminVersion][api/admin/version]]            | Get version of the server                   |
+| GET         | [[AdminConfig][api/admin/config/:config-type]] | Get configuration information of the server |
+| GET         | [[AdminSafemode][api/admin/setSafeMode/:mode]] | Set safemode to true/false in falcon server |
+
+---++ REST Call on Entity Resource
+
+| *Call Type* | *Resource*                                                                  | *Description*                      |
+| POST        | [[EntityValidate][api/entities/validate/:entity-type]]                      | Validate the entity                |
+| POST        | [[EntitySubmit][api/entities/submit/:entity-type]]                          | Submit the entity                  |
+| POST        | [[EntityUpdate][api/entities/update/:entity-type/:entity-name]]             | Update the entity                  |
+| POST        | [[EntitySubmitAndSchedule][api/entities/submitAndSchedule/:entity-type]]    | Submit & Schedule the entity       |
+| POST        | [[EntitySchedule][api/entities/schedule/:entity-type/:entity-name]]         | Schedule the entity                |
+| POST        | [[EntitySuspend][api/entities/suspend/:entity-type/:entity-name]]           | Suspend the entity                 |
+| POST        | [[EntityResume][api/entities/resume/:entity-type/:entity-name]]             | Resume the entity                  |
+| DELETE      | [[EntityDelete][api/entities/delete/:entity-type/:entity-name]]             | Delete the entity                  |
+| GET         | [[EntityStatus][api/entities/status/:entity-type/:entity-name]]             | Get the status of the entity       |
+| GET         | [[EntityDefinition][api/entities/definition/:entity-type/:entity-name]]     | Get the definition of the entity   |
+| GET         | [[EntityList][api/entities/list/{:entity-type}]]                            | Get the list of entities           |
+| GET         | [[EntitySummary][api/entities/summary/:entity-type/:cluster]]               | Get instance summary of all entities |
+| GET         | [[EntityDependencies][api/entities/dependencies/:entity-type/:entity-name]] | Get the dependencies of the entity |
+| GET         | [[FeedSLA][api/entities/sla-alert/:entity-type]]                            | Get pending feed instances which missed sla |
+| GET         | [[FeedLookup][api/entities/lookup/feed/]]                                   | Get feed for given path            |
+
+---++ REST Call on Feed and Process Instances
+
+| *Call Type* | *Resource*                                                                  | *Description*                |
+| GET         | [[InstanceRunning][api/instance/running/:entity-type/:entity-name]]         | List of running instances.   |
+| GET         | [[InstanceParams][api/instance/params/:entity-type/:entity-name]]           | List of entity instances along with their workflow params.   |
+| GET         | [[InstanceList][api/instance/list/:entity-type/:entity-name]]               | List of instances   |
+| GET         | [[InstanceStatus][api/instance/status/:entity-type/:entity-name]]           | Status of a given instance   |
+| POST        | [[InstanceKill][api/instance/kill/:entity-type/:entity-name]]               | Kill a given instance        |
+| POST        | [[InstanceSuspend][api/instance/suspend/:entity-type/:entity-name]]         | Suspend a running instance   |
+| POST        | [[InstanceResume][api/instance/resume/:entity-type/:entity-name]]           | Resume a given instance      |
+| POST        | [[InstanceRerun][api/instance/rerun/:entity-type/:entity-name]]             | Rerun a given instance       |
+| GET         | [[InstanceLogs][api/instance/logs/:entity-type/:entity-name]]               | Get logs of a given instance |
+| GET         | [[Triage][api/instance/triage/:entity-type/:entity-name]]                   | Triage an instance to see it's stuck lineage |
+| GET         | [[InstanceSummary][api/instance/summary/:entity-type/:entity-name]]         | Return summary of instances for an entity |
+| GET         | [[InstanceDependency][api/instance/dependencies/:entity-type/:entity-name]] | Return dependent instances for a given instance |
+
+---++ REST Call on Metadata Lineage Resource
+
+| *Call Type* | *Resource*                                                                             | *Description*                                                                 |
+| GET         | [[Graph][api/metadata/lineage/serialize]]                                              | dump the graph                                                                |
+| GET         | [[AllVertices][api/metadata/lineage/vertices/all]]                                     | get all vertices                                                              |
+| GET         | [[Vertices][api/metadata/lineage/vertices?key=:key&value=:value]]                      | get all vertices for a key index                                              |
+| GET         | [[Vertex][api/metadata/lineage/vertices/:id]]                                          | get the vertex with the specified id                                          |
+| GET         | [[VertexProperties][api/metadata/lineage/vertices/properties/:id?relationships=:true]] | get the properties of the vertex with the specified id                        |
+| GET         | [[AdjacentVertices][api/metadata/lineage/vertices/:id/:direction]]                     | get the adjacent vertices or edges of the vertex with the specified direction |
+| GET         | [[AllEdges][api/metadata/lineage/edges/all]]                                           | get all edges                                                                 |
+| GET         | [[Edge][api/metadata/lineage/edges/:id]]                                               | get the edge with the specified id                                            |
+| GET         | [[EntityLineage][api/metadata/lineage/entities?pipeline=:name]]                        | Get lineage graph for processes and feeds in the specified pipeline           |
+
+---++ REST Call on Metadata Discovery Resource
+
+| *Call Type* | *Resource*                                                                                     | *Description*                       |
+| GET         | [[MetadataList][api/metadata/discovery/:dimension-type/list]]                                  | list of dimensions                  |
+| GET         | [[MetadataRelations][api/metadata/discovery/:dimension-type/:dimension-name/relations]]        | Return all relations of a dimension |
+
+---++ REST Call on Extension Artifact
+
+| *Call Type* | *Resource*                                                        | *Description*                                                          |
+| GET         | [[ExtensionEnumeration][api/extension/enumerate]]                 | List all the extensions supported                                      |
+| GET         | [[ExtensionDescription][api/extension/describe/:extension­name]]  | Return the README of the specified extension                           |
+| GET         | [[ExtensionDefinition][api/extension/definition/:extension­name]] | Return a JSON document describing the extension invocation parameters  |
+
+
+---++ REST Call on Extension Job Management
+
+| *Call Type* | *Resource*                                                                       | *Description*                                                          |
+| GET         | [[ExtensionList][api/extension/list/:extension­name]]                            | List jobs generated from an extension                                  |
+| GET         | [[ExtensionInstances][api/extension/instances/:job-name]]                        | List instances of an extension job                                     |
+| POST        | [[ExtensionValidate][api/extension/validate/:extension­name]]                    | Validate an extension job                                              |
+| POST        | [[ExtensionSubmit][api/extension/submit/:extension­name]]                        | Submit an extension job                                                |
+| POST        | [[ExtensionUpdate][api/extension/update/:extension­name]]                        | Update an extension job                                                |
+| POST        | [[ExtensionSubmitAndSchedule][api/extension/submitAndSchedule/:extension­name]]  | Submit and schedule an extension job                                   |
+| POST        | [[ExtensionSchedule][api/extension/schedule/:job-name]]                          | Schedule an extension job                                              |
+| POST        | [[ExtensionSuspend][api/extension/suspend/:job-name]]                            | Suspend an extension job                                               |
+| POST        | [[ExtensionResume][api/extension/resume/:job-name]]                              | Resume an extension job                                                |
+| POST        | [[ExtensionDelete][api/extension/delete/:job-name]]                              | Delete an extension job                                                |
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/trunk/releases/0.10/src/site/twiki/restapi/Triage.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/0.10/src/site/twiki/restapi/Triage.twiki b/trunk/releases/0.10/src/site/twiki/restapi/Triage.twiki
new file mode 100644
index 0000000..9ff95c8
--- /dev/null
+++ b/trunk/releases/0.10/src/site/twiki/restapi/Triage.twiki
@@ -0,0 +1,45 @@
+---++  GET api/instance/triage/:entity-type/:entity-name
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Given a feed/process instance this command traces it's ancestors to find what all ancestors have failed. It's useful if
+lot of instances are failing in a pipeline as it then finds out the root cause of the pipeline being stuck.
+
+
+---++ Parameters
+   * :entity-type type of entity(feed/process).
+   * :entity-name name of the feed/process.
+   * :start instance time of the entity instance.
+   * :colo <optional param> name of the colo on which you want to triage
+   * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.
+
+---++ Results
+It returns a json graph
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/triage/feed/my-feed?start=2015-03-02T00:00Z&colo=local&doAs=joe
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "vertices": ["(FEED) my-feed (2015-03-02T00:00Z) [Unavailable]", "(PROCESS) producer-process (2015-03-01T10:00Z) [TIMEDOUT]", "(FEED) input-feed-for-producer (2015-03-01T00:00Z) [Available]"],
+    "edges":
+    [
+        {
+         "from"  : "(PROCESS) producer-process (2015-03-01T10:00Z) [TIMEDOUT]",
+         "to"    : "(FEED) my-feed (2015-03-02T00:00Z) [Unavailable]",
+         "label" : "produces"
+        },
+        {
+         "from"  : "(FEED) input-feed-for-producer (2015-03-01T00:00Z) [Available]",
+         "to"    : "(PROCESS) producer-process (2015-03-01T10:00Z) [TIMEDOUT]",
+         "label" : "consumed by"
+        }
+    ]
+}
+</verbatim>

http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/trunk/releases/0.10/src/site/twiki/restapi/Vertex.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/0.10/src/site/twiki/restapi/Vertex.twiki b/trunk/releases/0.10/src/site/twiki/restapi/Vertex.twiki
new file mode 100644
index 0000000..82f5bfb
--- /dev/null
+++ b/trunk/releases/0.10/src/site/twiki/restapi/Vertex.twiki
@@ -0,0 +1,36 @@
+---++  GET api/metadata/lineage/vertices/:id
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Gets the vertex with specified id.
+
+---++ Parameters
+   * :id is the unique id of the vertex.
+   * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.
+
+---++ Results
+Vertex with the specified id.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/metadata/lineage/vertices/4?doAs=joe
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "results": [
+        {
+            "timestamp":"2014-04-21T20:55Z",
+            "name":"sampleIngestProcess",
+            "type":"process-instance",
+            "version":"2.0.0",
+            "_id":4,
+            "_type":"vertex"
+        }
+    ]
+}
+</verbatim>

http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/trunk/releases/0.10/src/site/twiki/restapi/VertexProperties.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/0.10/src/site/twiki/restapi/VertexProperties.twiki b/trunk/releases/0.10/src/site/twiki/restapi/VertexProperties.twiki
new file mode 100644
index 0000000..11c64b5
--- /dev/null
+++ b/trunk/releases/0.10/src/site/twiki/restapi/VertexProperties.twiki
@@ -0,0 +1,34 @@
+---++  GET api/metadata/lineage/vertices/properties/:id?relationships=:true
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Gets the properties of the vertex with specified id.
+
+---++ Parameters
+   * :id is the unique id of the vertex.
+   * :relationships has default value of false. Pass true if relationships should be fetched.
+   * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.
+
+---++ Results
+ Properties associated with the specified vertex.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/metadata/lineage/vertices/properties/40004?relationships=true&doAs=joe
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "results":
+        {
+            "timestamp":"2014-04-25T22:20Z",
+            "name":"local",
+            "type":"cluster-entity"
+        },
+    "totalSize":3
+}
+</verbatim>

http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/trunk/releases/0.10/src/site/twiki/restapi/Vertices.twiki
----------------------------------------------------------------------
diff --git a/trunk/releases/0.10/src/site/twiki/restapi/Vertices.twiki b/trunk/releases/0.10/src/site/twiki/restapi/Vertices.twiki
new file mode 100644
index 0000000..643e6e9
--- /dev/null
+++ b/trunk/releases/0.10/src/site/twiki/restapi/Vertices.twiki
@@ -0,0 +1,38 @@
+---++  GET api/metadata/lineage/vertices?key=:key&value=:value
+   * <a href="#Description">Description</a>
+   * <a href="#Parameters">Parameters</a>
+   * <a href="#Results">Results</a>
+   * <a href="#Examples">Examples</a>
+
+---++ Description
+Get all vertices for a key index given the specified value.
+
+---++ Parameters
+   * :key is the key to be matched.
+   * :value is the associated value of the key.
+   * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.
+
+---++ Results
+All vertices matching given property key and a value.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/metadata/lineage/vertices?key=name&value=sampleIngestProcess&doAs=joe
+</verbatim>
+---+++ Result
+<verbatim>
+{
+    "results": [
+        {
+            "timestamp":"2014-04-21T20:55Z",
+            "name":"sampleIngestProcess",
+            "type":"process-instance",
+            "version":"2.0.0",
+            "_id":4,
+            "_type":"vertex"
+        }
+    ],
+    "totalSize": 1
+}
+</verbatim>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/trunk/releases/pom.xml
----------------------------------------------------------------------
diff --git a/trunk/releases/pom.xml b/trunk/releases/pom.xml
index 3877001..26f82d0 100644
--- a/trunk/releases/pom.xml
+++ b/trunk/releases/pom.xml
@@ -22,7 +22,7 @@
     <parent>
         <groupId>org.apache.falcon</groupId>
         <artifactId>falcon-website</artifactId>
-        <version>0.10-SNAPSHOT</version>
+        <version>0.11-SNAPSHOT</version>
     </parent>
     <artifactId>falcon-website-releases</artifactId>
     <version>0.2</version>
@@ -39,6 +39,7 @@
         <module>0.7</module>
         <module>0.8</module>
         <module>0.9</module>
+        <module>0.10</module>
     </modules>
 
 </project>


Mime
View raw message