Return-Path: X-Original-To: apmail-falcon-commits-archive@minotaur.apache.org Delivered-To: apmail-falcon-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 6A13D186CF for ; Fri, 11 Mar 2016 04:54:44 +0000 (UTC) Received: (qmail 69451 invoked by uid 500); 11 Mar 2016 04:54:44 -0000 Delivered-To: apmail-falcon-commits-archive@falcon.apache.org Received: (qmail 69254 invoked by uid 500); 11 Mar 2016 04:54:44 -0000 Mailing-List: contact commits-help@falcon.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@falcon.apache.org Delivered-To: mailing list commits@falcon.apache.org Received: (qmail 66474 invoked by uid 99); 11 Mar 2016 04:54:40 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 11 Mar 2016 04:54:40 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 4555DDFBDB; Fri, 11 Mar 2016 04:54:40 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: pallavi@apache.org To: commits@falcon.apache.org Date: Fri, 11 Mar 2016 04:55:24 -0000 Message-Id: <329cedaf425a46f0aa6be962c1c08c5f@git.apache.org> In-Reply-To: <2cfe11a056884fd0850abc5a02de7486@git.apache.org> References: <2cfe11a056884fd0850abc5a02de7486@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [46/51] [partial] falcon git commit: FALCON-1830 Make changes to generate html under content folder http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/docs/restapi/EntitySubmitAndSchedule.html ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/docs/restapi/EntitySubmitAndSchedule.html b/content/0.3-incubating/docs/restapi/EntitySubmitAndSchedule.html new file mode 100644 index 0000000..9ed98f1 --- /dev/null +++ b/content/0.3-incubating/docs/restapi/EntitySubmitAndSchedule.html @@ -0,0 +1,170 @@ + + + + + + + + + Falcon - POST /api/entities/submitAndSchedule/:entity-type + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

POST /api/entities/submitAndSchedule/:entity-type

+

+
+
+

Description

+

Submits and schedules an entity.

+
+

Parameters

+

+
    +
  • :entity-type can either be a feed or a process.
+
+

Results

+

Result of the submit and schedule command.

+
+

Examples

+
+

Rest Call

+
+
+POST http://localhost:15000/api/entities/submitAndSchedule/process
+Remote-User: rgautam
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
+<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
+    <clusters>
+      <cluster name="primary-cluster">
+	<validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" />
+      </cluster>
+    </clusters>
+
+    <parallel>1</parallel>
+    <order>FIFO</order>
+    <frequency>hours(1)</frequency>
+
+    <inputs>
+        <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" />
+    </inputs>
+
+    <outputs>
+        <output name="output" feed="SampleOutput" instance="yesterday(0,0)" />
+    </outputs>
+
+    <properties>
+        <property name="queueName" value="default" />
+        <property name="ssh.host" value="localhost" />
+        <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" />
+    </properties>
+
+    <workflow engine="oozie" path="/examples/apps/aggregator" />
+    <retry policy="exp-backoff" delay="minutes(5)" attempts="3" />
+    
+    <late-process policy="exp-backoff" delay="hours(1)">
+        <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" />
+    </late-process>
+</process>
+
+
+
+

Result

+
+
+{
+    "requestId": "schedule\/default\/b5b40931-175b-4b15-8f2b-02ef2e66f06b\n\nsubmit\/default\/b5b40931-175b-4b15-8f2b-02ef2e66f06b\n\n",
+    "message": "schedule\/default\/SampleProcess(process) scheduled successfully\n\nsubmit\/default\/Submit successful (process) SampleProcess\n\n",
+    "status": "SUCCEEDED"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/docs/restapi/EntitySuspend.html ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/docs/restapi/EntitySuspend.html b/content/0.3-incubating/docs/restapi/EntitySuspend.html new file mode 100644 index 0000000..b3dfb78 --- /dev/null +++ b/content/0.3-incubating/docs/restapi/EntitySuspend.html @@ -0,0 +1,137 @@ + + + + + + + + + Falcon - POST /api/entities/suspend/:entity-type/:entity-name + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

POST /api/entities/suspend/:entity-type/:entity-name

+

+
+
+

Description

+

Suspend an entity.

+
+

Parameters

+

+
    +
  • :entity-type can either be a feed or a process.
    • +
  • :entity-name is name of the entity.
+
+

Results

+

Status of the entity.

+
+

Examples

+
+

Rest Call

+
+
+POST http://localhost:15000/api/entities/suspend/process/SampleProcess
+Remote-User: rgautam
+
+
+
+

Result

+
+
+{
+    "requestId": "default\/fe5f2b6c-1f2e-49fc-af3a-342079f0b46b\n",
+    "message": "default\/SampleProcess(process) suspended successfully\n",
+    "status": "SUCCEEDED"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/docs/restapi/EntityUpdate.html ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/docs/restapi/EntityUpdate.html b/content/0.3-incubating/docs/restapi/EntityUpdate.html new file mode 100644 index 0000000..be75a93 --- /dev/null +++ b/content/0.3-incubating/docs/restapi/EntityUpdate.html @@ -0,0 +1,171 @@ + + + + + + + + + Falcon - POST api/entities/update/:entity-type/:entity-name + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

POST api/entities/update/:entity-type/:entity-name

+

+
+
+

Description

+

Updates the submitted entity.

+
+

Parameters

+

+
    +
  • :entity-type can be feed or process.
    • +
  • :entity-name is name of the feed or process.
+
+

Results

+

Result of the validation.

+
+

Examples

+
+

Rest Call

+
+
+POST http://localhost:15000/api/entities/update/process/SampleProcess
+Remote-User: rgautam
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
+<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
+    <clusters>
+      <cluster name="primary-cluster">
+	<validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" />
+      </cluster>
+    </clusters>
+
+    <parallel>1</parallel>
+    <order>FIFO</order>
+    <frequency>hours(1)</frequency>
+
+    <inputs>
+        <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" />
+    </inputs>
+
+    <outputs>
+        <output name="output" feed="SampleOutput" instance="yesterday(0,0)" />
+    </outputs>
+
+    <properties>
+        <property name="queueName" value="default" />
+        <property name="ssh.host" value="localhost" />
+        <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" />
+    </properties>
+
+    <workflow engine="oozie" path="/examples/apps/aggregator" />
+    <retry policy="exp-backoff" delay="minutes(5)" attempts="3" />
+    
+    <late-process policy="exp-backoff" delay="hours(1)">
+        <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" />
+    </late-process>
+</process>
+
+
+
+

Result

+
+
+{
+    "requestId": "update\/default\/d6aaa328-6836-4818-a212-515bb43d8b86\n\n",
+    "message": "update\/default\/SampleProcess updated successfully\n\n",
+    "status": "SUCCEEDED"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/docs/restapi/EntityValidate.html ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/docs/restapi/EntityValidate.html b/content/0.3-incubating/docs/restapi/EntityValidate.html new file mode 100644 index 0000000..cb97184 --- /dev/null +++ b/content/0.3-incubating/docs/restapi/EntityValidate.html @@ -0,0 +1,290 @@ + + + + + + + + + Falcon - POST api/entities/validate/entity-type + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

POST api/entities/validate/entity-type

+

+
+
+

Description

+

Validates the submitted entity.

+
+

Parameters

+

:entity-type can be cluster, feed or process.

+
+

Results

+

Result of the validation.

+
+

Examples

+
+

Rest Call

+
+
+POST http://localhost:15000/api/entities/validate/cluster
+Remote-User: rgautam
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<cluster xmlns="uri:falcon:cluster:0.1" name="primary-cluster" description="Primary Cluster" colo="west-coast">
+    <interfaces>
+        <interface type="readonly" endpoint="hftp://localhost:50070" version="1.1.1"/>
+        <interface type="write" endpoint="hdfs://localhost:9000" version="1.1.1"/>
+        <interface type="execute" endpoint="localhost:9001" version="1.1.1"/>
+        <interface type="workflow" endpoint="http://localhost:11000/oozie/" version="3.3.0"/>
+        <interface type="messaging" endpoint="tcp://localhost:61616?daemon=true" version="5.4.3"/>
+    </interfaces>
+    <locations>
+        <location name="staging" path="/apps/falcon/staging"/>
+        <location name="temp" path="/tmp"/>
+        <location name="working" path="/apps/falcon/working"/>
+    </locations>
+</cluster>
+
+
+
+

Result

+
+
+{
+    "requestId": "dd3f6c3a-a6f1-4c50-97fb-3f9a3f698e10",
+    "message": "Validated successfully (CLUSTER) primary-cluster",
+    "status": "SUCCEEDED"
+}
+
+
+
+

Rest Call

+
+
+POST http://localhost:15000/api/entities/validate/feed
+Remote-User: rgautam
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Hourly sample input data -->
+
+<feed description="sample input data"
+      name="SampleInput" xmlns="uri:falcon:feed:0.1"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <groups>group</groups>
+    <frequency>hours(1)</frequency>
+    <late-arrival cut-off="hours(6)" />
+    <clusters>
+        <cluster name="primary-cluster" type="source">
+            <!--validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" timezone="UTC" /-->
+            <validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" />
+            <retention limit="months(24)" action="delete" />
+        </cluster>
+    </clusters>
+
+    <locations>
+        <location type="data" path="/projects/bootcamp/data/${YEAR}-${MONTH}-${DAY}-${HOUR}/SampleInput" />
+        <location type="stats" path="/projects/bootcamp/stats/SampleInput" />
+        <location type="meta" path="/projects/bootcamp/meta/SampleInput" />
+    </locations>
+
+    <ACL owner="suser" group="users" permission="0755" />
+
+    <schema location="/none" provider="none" />
+</feed>
+
+
+
+

Result

+
+
+{
+    "requestId": "c85b190e-e653-493a-a863-d62de9c2e3b0",
+    "message": "Validated successfully (FEED) SampleInput",
+    "status": "SUCCEEDED"
+}
+
+
+
+

Rest Call

+
+
+POST http://localhost:15000/api/entities/validate/feed
+Remote-User: rgautam
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample output data -->
+
+<feed description="sample output data" name="SampleOutput" xmlns="uri:falcon:feed:0.1"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <groups>group</groups>
+    <frequency>hours(1)</frequency>
+    <late-arrival cut-off="hours(6)" />
+    <clusters>
+        <cluster name="primary-cluster" type="source">
+            <!--validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" timezone="UTC" /-->
+            <validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" />
+            <retention limit="months(24)" action="delete" />
+        </cluster>
+    </clusters>
+    <locations>
+        <location type="data" path="/projects/bootcamp/output/${YEAR}-${MONTH}-${DAY}-${HOUR}/SampleOutput" />
+        <location type="stats" path="/projects/bootcamp/stats/SampleOutput" />
+        <location type="meta" path="/projects/bootcamp/meta/SampleOutput" />
+    </locations>
+    <ACL owner="suser" group="users" permission="0755" />
+    <schema location="/none" provider="none" />
+</feed>
+
+
+
+

Result

+
+
+{
+    "requestId": "60781732-460e-4c6c-ba86-a75fae574b05",
+    "message": "Validated successfully (FEED) SampleOutput",
+    "status": "SUCCEEDED"
+}
+
+
+
+

Rest Call

+
+
+POST http://localhost:15000/api/entities/validate/process
+Remote-User: rgautam
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
+<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
+    <clusters>
+      <cluster name="primary-cluster">
+	<validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" />
+      </cluster>
+    </clusters>
+
+    <parallel>1</parallel>
+    <order>FIFO</order>
+    <frequency>hours(1)</frequency>
+
+    <inputs>
+        <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" />
+    </inputs>
+
+    <outputs>
+        <output name="output" feed="SampleOutput" instance="yesterday(0,0)" />
+    </outputs>
+
+    <properties>
+        <property name="queueName" value="default" />
+        <property name="ssh.host" value="localhost" />
+        <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" />
+    </properties>
+
+    <workflow engine="oozie" path="/examples/apps/aggregator" />
+    <retry policy="exp-backoff" delay="minutes(5)" attempts="3" />
+    
+    <late-process policy="exp-backoff" delay="hours(1)">
+        <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" />
+    </late-process>
+</process>
+
+
+
+

Result

+
+
+{
+    "requestId": "e4a965c6-c7a2-41d9-ba08-2e77f1c43f57",
+    "message": "Validated successfully (PROCESS) SampleProcess",
+    "status": "SUCCEEDED"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/docs/restapi/InstanceKill.html ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/docs/restapi/InstanceKill.html b/content/0.3-incubating/docs/restapi/InstanceKill.html new file mode 100644 index 0000000..1b57562 --- /dev/null +++ b/content/0.3-incubating/docs/restapi/InstanceKill.html @@ -0,0 +1,149 @@ + + + + + + + + + Falcon - POST /api/instance/kill/:entity-type/:entity-name + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

POST /api/instance/kill/:entity-type/:entity-name

+

+
+
+

Description

+

Kill a currently running instance.

+
+

Parameters

+

+
    +
  • :entity-type can either be a feed or a process.
    • +
  • :entity-name is name of the entity.
    • +
  • start start time of the entity.
+
+

Results

+

Result of the kill operation.

+
+

Examples

+
+

Rest Call

+
+
+POST http://localhost:15000/api/instance/kill/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+Remote-User: rgautam
+
+
+
+

Result

+
+
+{
+    "instances": [
+        {
+            "details": "",
+            "endTime": "2013-10-21T15:26:59-07:00",
+            "startTime": "2013-10-21T15:19:57-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+            "status": "KILLED",
+            "instance": "2012-04-03T07:00Z"
+        }
+    ],
+    "requestId": "default\/23b3cfee-ee22-40c0-825d-39c322587d5f\n",
+    "message": "default\/KILL\n",
+    "status": "SUCCEEDED"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/docs/restapi/InstanceLogs.html ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/docs/restapi/InstanceLogs.html b/content/0.3-incubating/docs/restapi/InstanceLogs.html new file mode 100644 index 0000000..d3ef00a --- /dev/null +++ b/content/0.3-incubating/docs/restapi/InstanceLogs.html @@ -0,0 +1,156 @@ + + + + + + + + + Falcon - GET /api/instance/logs/:entity-type/:entity-name + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

GET /api/instance/logs/:entity-type/:entity-name

+

+
+
+

Description

+

Get log of a specific instance 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 instace that you want to refer to
+
+

Results

+

Log of specified instance.

+
+

Examples

+
+

Rest Call

+
+
+GET http://localhost:15000/api/instance/logs/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+Remote-User: rgautam
+
+
+
+

Result

+
+
+{
+    "instances": [
+        {
+            "actions": [
+                {
+                    "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/000\/pig_SUCCEEDED.log",
+                    "status": "SUCCEEDED",
+                    "action": "pig"
+                }
+            ],
+            "details": "",
+            "endTime": "2013-10-21T14:40:26-07:00",
+            "startTime": "2013-10-21T14:39:56-07:00",
+            "cluster": "primary-cluster",
+            "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/000\/oozie.log",
+            "status": "SUCCEEDED",
+            "instance": "2012-04-03T07:00Z"
+        }
+    ],
+    "requestId": "default\/3527038e-8334-4e50-8173-76c4fa430d0b\n",
+    "message": "default\/STATUS\n",
+    "status": "SUCCEEDED"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/docs/restapi/InstanceRerun.html ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/docs/restapi/InstanceRerun.html b/content/0.3-incubating/docs/restapi/InstanceRerun.html new file mode 100644 index 0000000..69942a8 --- /dev/null +++ b/content/0.3-incubating/docs/restapi/InstanceRerun.html @@ -0,0 +1,148 @@ + + + + + + + + + Falcon - POST /api/instance/rerun/:entity-type/:entity-name + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

POST /api/instance/rerun/:entity-type/:entity-name

+

+
+
+

Description

+

Rerun a specific instance 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 that you want to refer to
+
+

Results

+

Results of the rerun command.

+
+

Examples

+
+

Rest Call

+
+
+POST http://localhost:15000/api/instance/rerun/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+Remote-User: rgautam
+
+
+
+

Result

+
+
+{
+    "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"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/docs/restapi/InstanceResume.html ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/docs/restapi/InstanceResume.html b/content/0.3-incubating/docs/restapi/InstanceResume.html new file mode 100644 index 0000000..44b943c --- /dev/null +++ b/content/0.3-incubating/docs/restapi/InstanceResume.html @@ -0,0 +1,148 @@ + + + + + + + + + Falcon - POST /api/instance/resume/:entity-type/:entity-name + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

POST /api/instance/resume/:entity-type/:entity-name

+

+
+
+

Description

+

Resume a specific instance 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 that you want to refer to
+
+

Results

+

Results of the resume command.

+
+

Examples

+
+

Rest Call

+
+
+POST http://localhost:15000/api/instance/resume/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+Remote-User: rgautam
+
+
+
+

Result

+
+
+{
+    "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"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/docs/restapi/InstanceRunning.html ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/docs/restapi/InstanceRunning.html b/content/0.3-incubating/docs/restapi/InstanceRunning.html new file mode 100644 index 0000000..3cd7b27 --- /dev/null +++ b/content/0.3-incubating/docs/restapi/InstanceRunning.html @@ -0,0 +1,145 @@ + + + + + + + + + Falcon - GET /api/instance/running/:entity-type/:entity-name + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

GET /api/instance/running/:entity-type/:entity-name

+

+
+
+

Description

+

Get a list of instances currently running for a given entity.

+
+

Parameters

+

+
    +
  • :entity-type can either be a feed or a process.
    • +
  • :entity-name is name of the entity.
+
+

Results

+

List of instances currently running.

+
+

Examples

+
+

Rest Call

+
+
+GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=*
+Remote-User: rgautam
+
+
+
+

Result

+
+
+{
+    "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"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/docs/restapi/InstanceStatus.html ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/docs/restapi/InstanceStatus.html b/content/0.3-incubating/docs/restapi/InstanceStatus.html new file mode 100644 index 0000000..ad6349b --- /dev/null +++ b/content/0.3-incubating/docs/restapi/InstanceStatus.html @@ -0,0 +1,149 @@ + + + + + + + + + Falcon - GET /api/instance/status/:entity-type/:entity-name + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

GET /api/instance/status/:entity-type/:entity-name

+

+
+
+

Description

+

Get status of a specific instance 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 that you want to refer to
+
+

Results

+

Status of the specified instance.

+
+

Examples

+
+

Rest Call

+
+
+GET http://localhost:15000/api/instance/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+Remote-User: rgautam
+
+
+
+

Result

+
+
+{
+    "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"
+        }
+    ],
+    "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+    "message": "default\/STATUS\n",
+    "status": "SUCCEEDED"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/docs/restapi/InstanceSuspend.html ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/docs/restapi/InstanceSuspend.html b/content/0.3-incubating/docs/restapi/InstanceSuspend.html new file mode 100644 index 0000000..d555592 --- /dev/null +++ b/content/0.3-incubating/docs/restapi/InstanceSuspend.html @@ -0,0 +1,149 @@ + + + + + + + + + Falcon - POST /api/instance/suspend/:entity-type/:entity-name + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

POST /api/instance/suspend/:entity-type/:entity-name

+

+
+
+

Description

+

Suspend a specific instance 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 that you want to refer to
+
+

Results

+

Results of the suspend command.

+
+

Examples

+
+

Rest Call

+
+
+POST http://localhost:15000/api/instance/suspend/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+Remote-User: rgautam
+
+
+
+

Result

+
+
+{
+    "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"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/docs/restapi/ResourceList.html ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/docs/restapi/ResourceList.html b/content/0.3-incubating/docs/restapi/ResourceList.html new file mode 100644 index 0000000..05a4018 --- /dev/null +++ b/content/0.3-incubating/docs/restapi/ResourceList.html @@ -0,0 +1,215 @@ + + + + + + + + + Falcon - RESTful Resources + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

RESTful Resources

+

+
+
+

REST Call on Admin Resource

+

+ + + + + + + + + + + + + + + + +
Call TypeResourceDescription
GETapi/admin/stackGet stack of the server
GETapi/admin/versionGet version of the server
GETapi/admin/config/:config-typeGet configuration information of the server
+
+

REST Call on Entity Resource

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Call TypeResourceDescription
POSTapi/entities/validate/:entity-typeValidate the entity
POSTapi/entities/submit/:entity-typeSubmit the entity
POSTapi/entities/update/:entity-type/:entity-nameUpdate the entity
POSTapi/entities/submitAndSchedule/:entity-typeSubmit & Schedule the entity
POSTapi/entities/schedule/:entity-type/:entity-nameSchedule the entity
POSTapi/entities/suspend/:entity-type/:entity-nameSuspend the entity
POSTapi/entities/resume/:entity-type/:entity-nameResume the entity
DELETEapi/entities/delete/:entity-type/:entity-nameDelete the entity
GETapi/entities/status/:entity-type/:entity-nameGet the status of the entity
GETapi/entities/definition/:entity-type/:entity-nameGet the definition of the entity
GETapi/entities/list/:entity-typeGet the list of entities
GETapi/entities/dependencies/:entity-type/:entity-nameGet the dependencies of the entity
+
+

REST Call on Feed and Process Instances

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Call TypeResourceDescription
GETapi/instance/running/:entity-type/:entity-nameList of running instances.
GETapi/instance/status/:entity-type/:entity-nameStatus of a given instance
POSTapi/instance/kill/:entity-type/:entity-nameKill a given instance
POSTapi/instance/suspend/:entity-type/:entity-nameSuspend a running instance
POSTapi/instance/resume/:entity-type/:entity-nameResume a given instance
POSTapi/instance/rerun/:entity-type/:entity-nameRerun a given instance
GETapi/instance/logs/:entity-type/:entity-nameGet logs of a given instance
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/images/Architecture.png ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/images/Architecture.png b/content/0.3-incubating/images/Architecture.png new file mode 100644 index 0000000..0378b49 Binary files /dev/null and b/content/0.3-incubating/images/Architecture.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/images/EntityDependency.png ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/images/EntityDependency.png b/content/0.3-incubating/images/EntityDependency.png new file mode 100644 index 0000000..9f11870 Binary files /dev/null and b/content/0.3-incubating/images/EntityDependency.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/images/FeedSchedule.png ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/images/FeedSchedule.png b/content/0.3-incubating/images/FeedSchedule.png new file mode 100644 index 0000000..105c6b1 Binary files /dev/null and b/content/0.3-incubating/images/FeedSchedule.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/images/PrismSetup.png ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/images/PrismSetup.png b/content/0.3-incubating/images/PrismSetup.png new file mode 100644 index 0000000..b0dc9a5 Binary files /dev/null and b/content/0.3-incubating/images/PrismSetup.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/images/ProcessSchedule.png ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/images/ProcessSchedule.png b/content/0.3-incubating/images/ProcessSchedule.png new file mode 100644 index 0000000..a7dd788 Binary files /dev/null and b/content/0.3-incubating/images/ProcessSchedule.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/images/accessories-text-editor.png ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/images/accessories-text-editor.png b/content/0.3-incubating/images/accessories-text-editor.png new file mode 100644 index 0000000..abc3366 Binary files /dev/null and b/content/0.3-incubating/images/accessories-text-editor.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/images/add.gif ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/images/add.gif b/content/0.3-incubating/images/add.gif new file mode 100644 index 0000000..1cb3dbf Binary files /dev/null and b/content/0.3-incubating/images/add.gif differ http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/images/apache-incubator-logo.png ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/images/apache-incubator-logo.png b/content/0.3-incubating/images/apache-incubator-logo.png new file mode 100644 index 0000000..81fb31e Binary files /dev/null and b/content/0.3-incubating/images/apache-incubator-logo.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/images/apache-maven-project-2.png ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/images/apache-maven-project-2.png b/content/0.3-incubating/images/apache-maven-project-2.png new file mode 100644 index 0000000..6c096ec Binary files /dev/null and b/content/0.3-incubating/images/apache-maven-project-2.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/images/application-certificate.png ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/images/application-certificate.png b/content/0.3-incubating/images/application-certificate.png new file mode 100644 index 0000000..cc6aff6 Binary files /dev/null and b/content/0.3-incubating/images/application-certificate.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/images/contact-new.png ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/images/contact-new.png b/content/0.3-incubating/images/contact-new.png new file mode 100644 index 0000000..ebc4316 Binary files /dev/null and b/content/0.3-incubating/images/contact-new.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/images/document-properties.png ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/images/document-properties.png b/content/0.3-incubating/images/document-properties.png new file mode 100644 index 0000000..34c2409 Binary files /dev/null and b/content/0.3-incubating/images/document-properties.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/images/drive-harddisk.png ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/images/drive-harddisk.png b/content/0.3-incubating/images/drive-harddisk.png new file mode 100644 index 0000000..d7ce475 Binary files /dev/null and b/content/0.3-incubating/images/drive-harddisk.png differ