http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.4-incubating/docs/InstallationSteps.html ---------------------------------------------------------------------- diff --git a/content/0.4-incubating/docs/InstallationSteps.html b/content/0.4-incubating/docs/InstallationSteps.html new file mode 100644 index 0000000..5f5d31b --- /dev/null +++ b/content/0.4-incubating/docs/InstallationSteps.html @@ -0,0 +1,356 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - Building & Installing Falcon</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> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/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="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">Building & Installing Falcon</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>Building & Installing Falcon<a name="Building__Installing_Falcon"></a></h3></div> +<div class="section"> +<h4>Building Falcon<a name="Building_Falcon"></a></h4> +<div class="source"> +<pre> +git clone https://git-wip-us.apache.org/repos/asf/falcon.git falcon + +cd falcon + +export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=256m" && mvn clean install [For hadoop 1] +export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=256m" && mvn clean install -Dhadoop.profile=2 [For hadoop 2] + +[optionally -Dhadoop.version=<<hadoop.version>> can be appended to build for a specific version of hadoop] + + +</pre></div> +<p>Once the build successfully completes, artifacts can be packaged for deployment. The package can be built in embedded or distributed mode.</p> +<p><b>Embedded Mode</b></p> +<div class="source"> +<pre> + +mvn clean assembly:assembly -DskipTests -DskipCheck=true [For hadoop 1] +mvn clean assembly:assembly -DskipTests -DskipCheck=true -Dhadoop.profile=2 [For hadoop 2] + + +</pre></div> +<p>Tar can be found in {project dir}/target/falcon-${project.version}-bin.tar.gz</p> +<p>Tar is structured as follows</p> +<div class="source"> +<pre> + +|- bin + |- falcon + |- falcon-start + |- falcon-stop + |- falcon-config.sh + |- service-start.sh + |- service-stop.sh +|- conf + |- startup.properties + |- runtime.properties + |- client.properties + |- log4j.xml + |- falcon-env.sh +|- docs +|- client + |- lib (client support libs) +|- server + |- webapp + |- falcon.war +|- hadooplibs +|- README +|- NOTICE.txt +|- LICENSE.txt +|- DISCLAIMER.txt +|- CHANGES.txt + +</pre></div> +<p><b>Distributed Mode</b></p> +<div class="source"> +<pre> + +mvn clean assembly:assembly -DskipTests -DskipCheck=true -P distributed -Dhadoop.profile=1 [For hadoop 1] +mvn clean assembly:assembly -DskipTests -DskipCheck=true -P distributed -Dhadoop.profile=2 [For hadoop 2] + + +</pre></div> +<p>Tar can be found in {project dir}/target/falcon-distributed-${project.version}-server.tar.gz</p> +<p>Tar is structured as follows</p> +<div class="source"> +<pre> + +|- bin + |- falcon + |- falcon-start + |- falcon-stop + |- falcon-config.sh + |- service-start.sh + |- service-stop.sh + |- prism-stop + |- prism-start +|- conf + |- startup.properties + |- runtime.properties + |- client.properties + |- log4j.xml + |- falcon-env.sh +|- docs +|- client + |- lib (client support libs) +|- server + |- webapp + |- falcon.war + |- prism.war +|- hadooplibs +|- README +|- NOTICE.txt +|- LICENSE.txt +|- DISCLAIMER.txt +|- CHANGES.txt + +</pre></div></div> +<div class="section"> +<h4>Installing & running Falcon<a name="Installing__running_Falcon"></a></h4> +<p><b>Installing falcon</b></p> +<div class="source"> +<pre> +tar -xzvf {falcon package} +cd falcon-distributed-${project.version} or falcon-${project.version} + +</pre></div> +<p><b>Configuring Falcon</b></p> +<p>By default config directory used by faclon is {package dir}/conf. To override this set environemnt variable FALCON_CONF to the path of the conf dir.</p> +<p>falcon-env.sh has been added to the falcon conf. This file can be used to set various enviornment variables that you need for you services. In addition you can set any other environment variables you might need. This file will be sourced by falcon scripts before any commands are exectuted. The following enviornment variables are available to set.</p> +<div class="source"> +<pre> +# The java implementation to use. If JAVA_HOME is not found we expect java and jar to be in path +#export JAVA_HOME= + +# any additional java opts you want to set. This will apply to both client and server operations +#export FALCON_OPTS= + +# any additional java opts that you want to set for client only +#export FALCON_CLIENT_OPTS= + +# java heap size we want to set for the client. Default is 1024MB +#export FALCON_CLIENT_HEAP= + +# any additional opts you want to set for prisim service. +#export FALCON_PRISM_OPTS= + +# java heap size we want to set for the prisim service. Default is 1024MB +#export FALCON_PRISM_HEAP= + +# any additional opts you want to set for falcon service. +#export FALCON_SERVER_OPTS= + +# java heap size we want to set for the falcon server. Default is 1024MB +#export FALCON_SERVER_HEAP= + +# What is is considered as falcon home dir. Default is the base locaion of the installed software +#export FALCON_HOME_DIR= + +# Where log files are stored. Defatult is logs directory under the base install location +#export FALCON_LOG_DIR= + +# Where pid files are stored. Defatult is logs directory under the base install location +#export FALCON_PID_DIR= + +# where the falcon active mq data is stored. Defatult is logs/data directory under the base install location +#export FALCON_DATA_DIR= + +# Where do you want to expand the war file. By Default it is in /server/webapp dir under the base install dir. +#export FALCON_EXPANDED_WEBAPP_DIR= + +</pre></div> +<p><b>Starting Falcon Server</b></p> +<div class="source"> +<pre> +bin/falcon-start [-port <port>] + +</pre></div> +<p>By default, * falcon server starts at port 15000. To change the port, use -port option * falcon server starts embedded active mq. To control this behaviour, set the following system properties using -D option in environment variable FALCON_OPTS:</p> +<ul> +<li>falcon.embeddedmq=<true/false> - Should server start embedded active mq, default true</li> +<li>falcon.emeddedmq.port=<port> - Port for embedded active mq, default 61616</li> +<li>falcon.embeddedmq.data=<path> - Data path for embedded active mq, default {package dir}/logs/data</li></ul>* falcon server starts with conf from {package dir}/conf. To override this (to use the same conf with multiple falcon upgrades), set environment variable FALCON_CONF to the path of conf dir +<p><b><i>Adding Extension Libraries</i></b> Library extensions allows users to add custom libraries to entity lifecycles such as feed retention, feed replication and process execution. This is useful for usecases such as adding filesystem extensions. To enable this, add the following configs to startup.properties: *.libext.paths=<paths to be added to all entity lifecycles> *.libext.feed.paths=<paths to be added to all feed lifecycles> *.libext.feed.retentions.paths=<paths to be added to feed retention workflow> *.libext.feed.replication.paths=<paths to be added to feed replication workflow> *.libext.process.paths=<paths to be added to process workflow></p> +<p>The configured jars are added to falcon classpath and the corresponding workflows</p> +<p><b>Starting Prism</b></p> +<div class="source"> +<pre> +bin/prism-start [-port <port>] + +</pre></div> +<p>By default, * falcon server starts at port 16000. To change the port, use -port option * prism starts with conf from {package dir}/conf. To override this (to use the same conf with multiple prism upgrades), set environment variable FALCON_CONF to the path of conf dir</p> +<p><b>Using Falcon</b></p> +<div class="source"> +<pre> +bin/falcon admin -version +Falcon server build version: {Version:"0.3-SNAPSHOT-rd7e2be9afa2a5dc96acd1ec9e325f39c6b2f17f7",Mode:"embedded"} + +---- + +bin/falcon help +(for more details about falcon cli usage) + +</pre></div> +<p><b>Dashboard</b></p> +<p>Once falcon / prism is started, you can view the status of falcon entities using the Web-based dashboard. The web UI works in both distributed and embedded mode. You can open your browser at the corresponding port to use the web UI.</p> +<p><b>Stopping Falcon Server</b></p> +<div class="source"> +<pre> +bin/falcon-stop + +</pre></div> +<p><b>Stopping Prism</b></p> +<div class="source"> +<pre> +bin/prism-stop + +</pre></div></div> +<div class="section"> +<h4>Running Examples using embedded package<a name="Running_Examples_using_embedded_package"></a></h4> +<div class="source"> +<pre> +bin/falcon-start + +</pre></div> +<p>Make sure the hadoop and oozie endpoints are according to your setup in examples/entity/standalone-cluster.xml</p> +<div class="source"> +<pre> +bin/falcon entity -submit -type cluster -file examples/entity/standalone-cluster.xml + +</pre></div> +<p>Submit input and output feeds:</p> +<div class="source"> +<pre> +bin/falcon entity -submit -type feed -file examples/entity/in-feed.xml +bin/falcon entity -submit -type feed -file examples/entity/out-feed.xml + +</pre></div> +<p>Set-up workflow for the process:</p> +<div class="source"> +<pre> +hadoop fs -put examples/app / + +</pre></div> +<p>Submit and schedule the process:</p> +<div class="source"> +<pre> +bin/falcon entity -submitAndSchedule -type process -file examples/entity/oozie-mr-process.xml +bin/falcon entity -submitAndSchedule -type process -file examples/entity/pig-process.xml + +</pre></div> +<p>Generate input data:</p> +<div class="source"> +<pre> +examples/data/generate.sh <<hdfs endpoint>> + +</pre></div> +<p>Get status of instances:</p> +<div class="source"> +<pre> +bin/falcon instance -status -type process -name oozie-mr-process -start 2013-11-15T00:05Z -end 2013-11-15T01:00Z + +</pre></div></div> +<div class="section"> +<h4>Preparing oozie bundle for use with Falcon<a name="Preparing_oozie_bundle_for_use_with_Falcon"></a></h4> +<div class="source"> +<pre> +cd <<project home>> +mkdir target/package +src/bin/pacakge.sh <<hadoop-version>> + +>> ex. src/bin/pacakge.sh 1.1.2 or src/bin/pacakge.sh 0.20.2-cdh3u5 +>> oozie bundle available in target/package/oozie-4.0.0/distro/target/oozie-4.0.0-distro.tar.gz + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2016 + <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>
http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.4-incubating/docs/OnBoarding.html ---------------------------------------------------------------------- diff --git a/content/0.4-incubating/docs/OnBoarding.html b/content/0.4-incubating/docs/OnBoarding.html new file mode 100644 index 0000000..a28943e --- /dev/null +++ b/content/0.4-incubating/docs/OnBoarding.html @@ -0,0 +1,377 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - Contents</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> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/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="../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">Contents</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>Contents<a name="Contents"></a></h3> +<p></p> +<ul> +<li><a href="#Onboarding Steps">Onboarding Steps</a></li> +<li><a href="#Sample Pipeline">Sample Pipeline</a></li> +<li><a href="./HiveIntegration.html">Hive Examples</a></li></ul></div> +<div class="section"> +<h4>Onboarding Steps<a name="Onboarding_Steps"></a></h4> +<p></p> +<ul> +<li>Create cluster definition for the cluster, specifying name node, job tracker, workflow engine endpoint, messaging endpoint. Refer to <a href="./EntitySpecification.html">cluster definition</a> for details.</li> +<li>Create Feed definitions for each of the input and output specifying frequency, data path, ownership. Refer to <a href="./EntitySpecification.html">feed definition</a> for details.</li> +<li>Create Process definition for your job. Process defines configuration for the workflow job. Important attributes are frequency, inputs/outputs and workflow path. Refer to <a href="./EntitySpecification.html">process definition</a> for process details.</li> +<li>Define workflow for your job using the workflow engine(only oozie is supported as of now). Refer <a class="externalLink" href="http://incubator.apache.org/oozie/docs/3.1.3/docs/WorkflowFunctionalSpec.html";>Oozie Workflow Specification</a>. The libraries required for the workflow should be available in lib folder in workflow path.</li> +<li>Set-up workflow definition, libraries and referenced scripts on hadoop.</li> +<li>Submit cluster definition</li> +<li>Submit and schedule feed and process definitions</li></ul></div> +<div class="section"> +<h4>Sample Pipeline<a name="Sample_Pipeline"></a></h4></div> +<div class="section"> +<h5>Cluster <a name="Cluster"></a></h5> +<p>Cluster definition that contains end points for name node, job tracker, oozie and jms server:</p> +<div class="source"> +<pre> +<?xml version="1.0"?> +<!-- + Cluster configuration + --> +<cluster colo="ua2" description="" name="corp" xmlns="uri:falcon:cluster:0.1" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> + <interfaces> + <interface type="readonly" endpoint="hftp://name-node.com:50070" version="0.20.2-cdh3u0" /> + + <interface type="write" endpoint="hdfs://name-node.com:54310" version="0.20.2-cdh3u0" /> + + <interface type="execute" endpoint="job-tracker:54311" version="0.20.2-cdh3u0" /> + + <interface type="workflow" endpoint="http://oozie.com:11000/oozie/" version="3.1.4" /> + + <interface type="messaging" endpoint="tcp://jms-server.com:61616?daemon=true" version="5.1.6" /> + </interfaces> + + <locations> + <location name="staging" path="/projects/falcon/staging" /> + <location name="temp" path="/tmp" /> + <location name="working" path="/projects/falcon/working" /> + </locations> +</cluster> + +</pre></div></div> +<div class="section"> +<h5>Input Feed<a name="Input_Feed"></a></h5> +<p>Hourly feed that defines feed path, frequency, ownership and validity:</p> +<div class="source"> +<pre> +<?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="corp" type="source"> + <validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" timezone="UTC" /> + <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> + +</pre></div></div> +<div class="section"> +<h5>Output Feed<a name="Output_Feed"></a></h5> +<p>Daily feed that defines feed path, frequency, ownership and validity:</p> +<div class="source"> +<pre> +<?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>days(1)</frequency> + + <late-arrival cut-off="hours(6)" /> + + <clusters> + <cluster name="corp" type="source"> + <validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" timezone="UTC" /> + <retention limit="months(24)" action="delete" /> + </cluster> + </clusters> + + <locations> + <location type="data" path="/projects/bootcamp/output/${YEAR}-${MONTH}-${DAY}/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> + +</pre></div></div> +<div class="section"> +<h5>Process<a name="Process"></a></h5> +<p>Sample process which runs daily at 6th hour on corp cluster. It takes one input - <a href="./SampleInput.html">SampleInput</a> for the previous day(24 instances). It generates one output - <a href="./SampleOutput.html">SampleOutput</a> for previous day. The workflow is defined at /projects/bootcamp/workflow/workflow.xml. Any libraries available for the workflow should be at /projects/bootcamp/workflow/lib. The process also defines properties queueName, ssh.host, and fileTimestamp which are passed to the workflow. In addition, Falcon exposes the following properties to the workflow: nameNode, jobTracker(hadoop properties), input and output(Input/Output properties).</p> +<div class="source"> +<pre> +<?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 name="SampleProcess"> + <cluster name="corp" /> + + <frequency>days(1)</frequency> + + <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" timezone="UTC" /> + + <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="reports" /> + <property name="ssh.host" value="host.com" /> + <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" /> + </properties> + + <workflow engine="oozie" path="/projects/bootcamp/workflow" /> + + <retry policy="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> + +</pre></div></div> +<div class="section"> +<h5>Oozie Workflow<a name="Oozie_Workflow"></a></h5> +<p>The sample user workflow contains 3 actions:</p> +<ul> +<li>Pig action - Executes pig script /projects/bootcamp/workflow/script.pig</li> +<li>concatenator - Java action that concatenates part files and generates a single file</li> +<li>file upload - ssh action that gets the concatenated file from hadoop and sends the file to a remote host</li></ul> +<div class="source"> +<pre> +<workflow-app xmlns="uri:oozie:workflow:0.2" name="sample-wf"> + <start to="pig" /> + + <action name="pig"> + <pig> + <job-tracker>${jobTracker}</job-tracker> + <name-node>${nameNode}</name-node> + <prepare> + <delete path="${output}"/> + </prepare> + <configuration> + <property> + <name>mapred.job.queue.name</name> + <value>${queueName}</value> + </property> + <property> + <name>mapreduce.fileoutputcommitter.marksuccessfuljobs</name> + <value>true</value> + </property> + </configuration> + <script>${nameNode}/projects/bootcamp/workflow/script.pig</script> + <param>input=${input}</param> + <param>output=${output}</param> + <file>lib/dependent.jar</file> + </pig> + <ok to="concatenator" /> + <error to="fail" /> + </action> + + <action name="concatenator"> + <java> + <job-tracker>${jobTracker}</job-tracker> + <name-node>${nameNode}</name-node> + <prepare> + <delete path="${nameNode}/projects/bootcamp/concat/data-${fileTimestamp}.csv"/> + </prepare> + <configuration> + <property> + <name>mapred.job.queue.name</name> + <value>${queueName}</value> + </property> + </configuration> + <main-class>com.wf.Concatenator</main-class> + <arg>${output}</arg> + <arg>${nameNode}/projects/bootcamp/concat/data-${fileTimestamp}.csv</arg> + </java> + <ok to="fileupload" /> + <error to="fail"/> + </action> + + <action name="fileupload"> + <ssh> + <host>localhost</host> + <command>/tmp/fileupload.sh</command> + <args>${nameNode}/projects/bootcamp/concat/data-${fileTimestamp}.csv</args> + <args>${wf:conf("ssh.host")}</args> + <capture-output/> + </ssh> + <ok to="fileUploadDecision" /> + <error to="fail"/> + </action> + + <decision name="fileUploadDecision"> + <switch> + <case to="end"> + ${wf:actionData('fileupload')['output'] == '0'} + </case> + <default to="fail"/> + </switch> + </decision> + + <kill name="fail"> + <message>Workflow failed, error message[${wf:errorMessage(wf:lastErrorNode())}]</message> + </kill> + + <end name="end" /> +</workflow-app> + +</pre></div></div> +<div class="section"> +<h5>File Upload Script<a name="File_Upload_Script"></a></h5> +<p>The script gets the file from hadoop, rsyncs the file to /tmp on remote host and deletes the file from hadoop</p> +<div class="source"> +<pre> +#!/bin/bash + +trap 'echo "output=$?"; exit $?' ERR INT TERM + +echo "Arguments: $@" +SRCFILE=$1 +DESTHOST=$3 + +FILENAME=`basename $SRCFILE` +rm -f /tmp/$FILENAME +hadoop fs -copyToLocal $SRCFILE /tmp/ +echo "Copied $SRCFILE to /tmp" + +rsync -ztv --rsh=ssh --stats /tmp/$FILENAME $DESTHOST:/tmp +echo "rsynced $FILENAME to $DESTUSER@$DESTHOST:$DESTFILE" + +hadoop fs -rmr $SRCFILE +echo "Deleted $SRCFILE" + +rm -f /tmp/$FILENAME +echo "output=0" + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2016 + <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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.4-incubating/docs/restapi/AdminConfig.html ---------------------------------------------------------------------- diff --git a/content/0.4-incubating/docs/restapi/AdminConfig.html b/content/0.4-incubating/docs/restapi/AdminConfig.html new file mode 100644 index 0000000..c0ac517 --- /dev/null +++ b/content/0.4-incubating/docs/restapi/AdminConfig.html @@ -0,0 +1,143 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/admin/config/:config-type</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> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/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="../../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/admin/config/:config-type</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/admin/config/:config-type<a name="GET_apiadminconfig:config-type"></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 configuration information of the falcon server.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:config-type can be build, deploy, startup or runtime</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Configuration information of the server.</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/admin/config/deploy +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "properties": [ + { + "value": "embedded", + "key": "deploy.mode" + }, + { + "value": "all", + "key": "domain" + } + ] +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2016 + <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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.4-incubating/docs/restapi/AdminStack.html ---------------------------------------------------------------------- diff --git a/content/0.4-incubating/docs/restapi/AdminStack.html b/content/0.4-incubating/docs/restapi/AdminStack.html new file mode 100644 index 0000000..02d1a5b --- /dev/null +++ b/content/0.4-incubating/docs/restapi/AdminStack.html @@ -0,0 +1,146 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/admin/stack</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> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/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="../../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/admin/stack</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/admin/stack<a name="GET_apiadminstack"></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 stack trace of the falcon server.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p>None.</p></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Stack trace of the server.</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/admin/stack +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +Reference Handler +State: WAITING +java.lang.Object.wait(Native Method) +java.lang.Object.wait(Object.java:485) +java.lang.ref.Reference$ReferenceHandler.run(Reference.java:116)Finalizer + +... + +State: TIMED_WAITING +sun.misc.Unsafe.park(Native Method) +java.util.concurrent.locks.LockSupport.parkNanos(LockSupport.java:196) +java.util.concurrent.SynchronousQueue$TransferStack.awaitFulfill(SynchronousQueue.java:424) +java.util.concurrent.SynchronousQueue$TransferStack.transfer(SynchronousQueue.java:323) +java.util.concurrent.SynchronousQueue.poll(SynchronousQueue.java:874) +java.util.concurrent.ThreadPoolExecutor.getTask(ThreadPoolExecutor.java:955) +java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:917) +java.lang.Thread.run(Thread.java:695) + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2016 + <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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.4-incubating/docs/restapi/AdminVersion.html ---------------------------------------------------------------------- diff --git a/content/0.4-incubating/docs/restapi/AdminVersion.html b/content/0.4-incubating/docs/restapi/AdminVersion.html new file mode 100644 index 0000000..27d8286 --- /dev/null +++ b/content/0.4-incubating/docs/restapi/AdminVersion.html @@ -0,0 +1,141 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/admin/version</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> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/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="../../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/admin/version</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/admin/version<a name="GET_apiadminversion"></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 version of the falcon server.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p>None.</p></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Version of the server.</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/admin/version +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "properties":[ + { + "key":"Version", + "value":"0.4-incubating-SNAPSHOT-rb47788d1112fcf949c22a3860934167237b395b0" + }, + { + "key":"Mode", + "value":"embedded" + } + ] +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2016 + <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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.4-incubating/docs/restapi/EntityDefinition.html ---------------------------------------------------------------------- diff --git a/content/0.4-incubating/docs/restapi/EntityDefinition.html b/content/0.4-incubating/docs/restapi/EntityDefinition.html new file mode 100644 index 0000000..d020585 --- /dev/null +++ b/content/0.4-incubating/docs/restapi/EntityDefinition.html @@ -0,0 +1,160 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/entities/definition/:entity-type/:entity-name</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> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/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="../../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/entities/definition/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/entities/definition/:entity-type/:entity-name<a name="GET_apientitiesdefinition:entity-type:entity-name"></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 definition of the entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can be cluster, feed or process.</li> +<li>:entity-name is name of the entity.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Definition of the entity.</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/entities/definition/process/SampleProcess +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +<?xml version="1.0" encoding="UTF-8" standalone="yes"?> +<process name="SampleProcess" xmlns="uri:falcon:process:0.1"> + <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> + <timezone>UTC</timezone> + <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> + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2016 + <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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.4-incubating/docs/restapi/EntityDelete.html ---------------------------------------------------------------------- diff --git a/content/0.4-incubating/docs/restapi/EntityDelete.html b/content/0.4-incubating/docs/restapi/EntityDelete.html new file mode 100644 index 0000000..4d57a63 --- /dev/null +++ b/content/0.4-incubating/docs/restapi/EntityDelete.html @@ -0,0 +1,137 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - DELETE /api/entities/delete/:entity-type/:entity-name</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> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/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="../../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">DELETE /api/entities/delete/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>DELETE /api/entities/delete/:entity-type/:entity-name<a name="DELETE_apientitiesdelete:entity-type:entity-name"></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>Delete the specified entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can be feed or process.</li> +<li>:entity-name is name of the feed or process.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Results of the delete operation.</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> +DELETE http://localhost:15000/api/entities/delete/cluster/SampleProcess +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "falcon\/17ff6ca6-1c8a-459f-9ba8-8fec480e384a\n", + "message": "falcon\/SampleProcess(cluster) removed successfully\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2016 + <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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.4-incubating/docs/restapi/EntityDependencies.html ---------------------------------------------------------------------- diff --git a/content/0.4-incubating/docs/restapi/EntityDependencies.html b/content/0.4-incubating/docs/restapi/EntityDependencies.html new file mode 100644 index 0000000..23d58ed --- /dev/null +++ b/content/0.4-incubating/docs/restapi/EntityDependencies.html @@ -0,0 +1,148 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/entities/dependencies/:entity-type/:entity-name</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> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/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="../../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/entities/dependencies/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/entities/dependencies/:entity-type/:entity-name<a name="GET_apientitiesdependencies:entity-type:entity-name"></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 dependencies of the entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can be cluster, feed or process.</li> +<li>:entity-name is name of the entity.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Dependenciess of the entity.</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/entities/dependencies/process/SampleProcess +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "entity": [ + { + "name": "SampleInput", + "type": "feed" + }, + { + "name": "SampleOutput", + "type": "feed" + }, + { + "name": "primary-cluster", + "type": "cluster" + } + ] +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2016 + <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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.4-incubating/docs/restapi/EntityList.html ---------------------------------------------------------------------- diff --git a/content/0.4-incubating/docs/restapi/EntityList.html b/content/0.4-incubating/docs/restapi/EntityList.html new file mode 100644 index 0000000..8c4e142 --- /dev/null +++ b/content/0.4-incubating/docs/restapi/EntityList.html @@ -0,0 +1,172 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/entities/list/:entity-type?fields=:fields</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> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/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="../../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/entities/list/:entity-type?fields=:fields</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/entities/list/:entity-type?fields=:fields<a name="GET_apientitieslist:entity-typefields:fields"></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 list of the entities.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can be cluster, feed or process.</li> +<li>:fields (optional) additional fields that the client are interested in, separated by commas.</li></ul>Currently falcon only support status as a valid field.</div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>List of the entities.</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/entities/list/feed +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "entity": [ + { + "name": "SampleOutput", + "type": "feed" + }, + { + "name": "SampleInput", + "type": "feed" + } + ] +} + +</pre></div></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET http://localhost:15000/api/entities/list/feed?fields=status +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "entity": [ + { + "name" : "SampleOutput", + "type" : "feed", + "status": "RUNNING" + }, + { + "name": "SampleInput", + "type": "feed", + "status": "RUNNING" + } + ] +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2016 + <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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.4-incubating/docs/restapi/EntityResume.html ---------------------------------------------------------------------- diff --git a/content/0.4-incubating/docs/restapi/EntityResume.html b/content/0.4-incubating/docs/restapi/EntityResume.html new file mode 100644 index 0000000..e346d25 --- /dev/null +++ b/content/0.4-incubating/docs/restapi/EntityResume.html @@ -0,0 +1,137 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - POST /api/entities/resume/:entity-type/:entity-name</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> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/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="../../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">POST /api/entities/resume/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST /api/entities/resume/:entity-type/:entity-name<a name="POST_apientitiesresume:entity-type:entity-name"></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>Resume a supended entity.</p></div> +<div class="section"> +<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></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Result of the resume command.</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> +POST http://localhost:15000/api/entities/resume/process/SampleProcess +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "default\/106582a9-130f-4903-8b8f-f95d7b286c30\n", + "message": "default\/SampleProcess(process) resumed successfully\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2016 + <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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.4-incubating/docs/restapi/EntitySchedule.html ---------------------------------------------------------------------- diff --git a/content/0.4-incubating/docs/restapi/EntitySchedule.html b/content/0.4-incubating/docs/restapi/EntitySchedule.html new file mode 100644 index 0000000..0fe0e39 --- /dev/null +++ b/content/0.4-incubating/docs/restapi/EntitySchedule.html @@ -0,0 +1,137 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - POST /api/entities/schedule/:entity-type/:entity-name</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> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/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="../../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">POST /api/entities/schedule/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST /api/entities/schedule/:entity-type/:entity-name<a name="POST_apientitiesschedule:entity-type:entity-name"></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>Schedule an entity.</p></div> +<div class="section"> +<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></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Result of the schedule command.</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> +POST http://localhost:15000/api/entities/schedule/process/SampleProcess +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "default\/ee735c95-98bd-41b8-a705-2e78bcfcdcd9\n", + "message": "default\/SampleProcess(process) scheduled successfully\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2016 + <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> http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.4-incubating/docs/restapi/EntityStatus.html ---------------------------------------------------------------------- diff --git a/content/0.4-incubating/docs/restapi/EntityStatus.html b/content/0.4-incubating/docs/restapi/EntityStatus.html new file mode 100644 index 0000000..6403cf1 --- /dev/null +++ b/content/0.4-incubating/docs/restapi/EntityStatus.html @@ -0,0 +1,137 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-03-11 + | 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="20160311" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/entities/status/:entity-type/:entity-name</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> + + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href="http://falcon.incubator.apache.org/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="../../index.html" title="Home"> + Home</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/entities/status/:entity-type/:entity-name</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324424"; class="externalLink" title="Released: 2014-02-02"> + Released: 2014-02-02</a> + </li> + + <li class="divider pull-right">|</li> + + <li class="pull-right"> <a href="http://archive.apache.org/dist/incubator/falcon/"; class="externalLink" title="0.4-incubating"> + 0.4-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/entities/status/:entity-type/:entity-name<a name="GET_apientitiesstatus:entity-type:entity-name"></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 status of the entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type can be cluster, feed or process.</li> +<li>:entity-name is name of the entity.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Status of the entity.</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/entities/status/process/SampleProcess +Remote-User: rgautam + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "default\/4d35b382-852a-4bc7-9972-b9db3493322a\n", + "message": "default\/SUBMITTED\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2016 + <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>
