You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@falcon.apache.org by ve...@apache.org on 2014/09/24 20:26:11 UTC
[3/3] git commit: FALCON-651 Typos in Falcon Documentation.
Contributed by Ajay Yadav
FALCON-651 Typos in Falcon Documentation. Contributed by Ajay Yadav
Project: http://git-wip-us.apache.org/repos/asf/incubator-falcon/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-falcon/commit/4da62d1c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-falcon/tree/4da62d1c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-falcon/diff/4da62d1c
Branch: refs/heads/master
Commit: 4da62d1c52b1a4bc7f866b07329235b149bbe8ca
Parents: 6150b8a
Author: Venkatesh Seetharam <ve...@apache.org>
Authored: Wed Sep 24 11:25:54 2014 -0700
Committer: Venkatesh Seetharam <ve...@apache.org>
Committed: Wed Sep 24 11:25:54 2014 -0700
----------------------------------------------------------------------
CHANGES.txt | 2 +
docs/src/site/twiki/FalconCLI.twiki | 7 +-
docs/src/site/twiki/FalconDocumentation.twiki | 2 +-
.../src/site/twiki/restapi/InstanceParams.twiki | 84 ++++++++++++++++++++
4 files changed, 93 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/4da62d1c/CHANGES.txt
----------------------------------------------------------------------
diff --git a/CHANGES.txt b/CHANGES.txt
index af00fe3..b8ac906 100755
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -33,6 +33,8 @@ Trunk (Unreleased)
FALCON-263 API to get workflow parameters. (pavan kumar kolamuri via Shwetha GS)
IMPROVEMENTS
+ FALCON-651 Typos in Falcon Documentation (Ajay Yadav via Venkatesh Seetharam)
+
FALCON-576 Update Installation notes for Mac OS (Ajay Yadav via
Venkatesh Seetharam)
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/4da62d1c/docs/src/site/twiki/FalconCLI.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/FalconCLI.twiki b/docs/src/site/twiki/FalconCLI.twiki
index b61feeb..1d536a1 100644
--- a/docs/src/site/twiki/FalconCLI.twiki
+++ b/docs/src/site/twiki/FalconCLI.twiki
@@ -75,7 +75,12 @@ Update operation allows an already submitted/scheduled entity to be updated. Clu
not allowed.
Usage:
-$FALCON_HOME/bin/falcon entity -type [feed|process] -name <<name>> -update [-effective <<effective time>>]
+$FALCON_HOME/bin/falcon entity -type [feed|process] -name <<name>> -update [-effective <<effective time>>] -file
+<<path_to_file>>
+
+Example:
+$FALCON_HOME/bin/falcon entity -type process -name HourlyReportsGenerator -update -file /process/definition.xml
+
---+++Status
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/4da62d1c/docs/src/site/twiki/FalconDocumentation.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/FalconDocumentation.twiki b/docs/src/site/twiki/FalconDocumentation.twiki
index bff32c6..efa9efd 100644
--- a/docs/src/site/twiki/FalconDocumentation.twiki
+++ b/docs/src/site/twiki/FalconDocumentation.twiki
@@ -258,7 +258,7 @@ With the integration of Hive, Falcon also provides retention for tables in Hive
---+++ Example:
If retention period is 10 hours, and the policy kicks in at time 't', the data retained by system is essentially the
-one falling in between [t-10h,t]. Any data in the boundaries [-�,t-10h) and (t,�] is removed from the system.
+one in range [t-10h, t]. Any data before t-10h and after t is removed from the system.
The 'action' attribute can attain values of DELETE/ARCHIVE. Based upon the tag value, the data eligible for removal is either
deleted/archived.
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/4da62d1c/docs/src/site/twiki/restapi/InstanceParams.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/InstanceParams.twiki b/docs/src/site/twiki/restapi/InstanceParams.twiki
new file mode 100644
index 0000000..af8ab62
--- /dev/null
+++ b/docs/src/site/twiki/restapi/InstanceParams.twiki
@@ -0,0 +1,84 @@
+---++ GET /api/instance/params/: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 along with the information for workflow params.
+
+---++ 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".
+ * 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.
+
+
+---++ 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
+</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>
+
+