You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@falcon.apache.org by aj...@apache.org on 2015/09/09 15:49:55 UTC
svn commit: r1702009 [13/14] - in /falcon: site/ site/0.3-incubating/
site/0.4-incubating/ site/0.5-incubating/ site/0.6-incubating/ site/0.6.1/
site/0.7/ site/0.7/css/ site/0.7/images/ site/0.7/images/logos/
site/0.7/images/profiles/ site/0.7/img/ sit...
Added: falcon/trunk/releases/0.7/src/site/twiki/OnBoarding.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/OnBoarding.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/OnBoarding.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/OnBoarding.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,269 @@
+---++ Contents
+ * <a href="#Onboarding Steps">Onboarding Steps</a>
+ * <a href="#Sample Pipeline">Sample Pipeline</a>
+ * [[HiveIntegration][Hive Examples]]
+
+---+++ Onboarding Steps
+ * Create cluster definition for the cluster, specifying name node, job tracker, workflow engine endpoint, messaging endpoint. Refer to [[EntitySpecification][cluster definition]] for details.
+ * Create Feed definitions for each of the input and output specifying frequency, data path, ownership. Refer to [[EntitySpecification][feed definition]] for details.
+ * Create Process definition for your job. Process defines configuration for the workflow job. Important attributes are frequency, inputs/outputs and workflow path. Refer to [[EntitySpecification][process definition]] for process details.
+ * Define workflow for your job using the workflow engine(only oozie is supported as of now). Refer [[http://oozie.apache.org/docs/3.1.3-incubating/WorkflowFunctionalSpec.html][Oozie Workflow Specification]]. The libraries required for the workflow should be available in lib folder in workflow path.
+ * Set-up workflow definition, libraries and referenced scripts on hadoop.
+ * Submit cluster definition
+ * Submit and schedule feed and process definitions
+
+
+---+++ Sample Pipeline
+---++++ Cluster
+Cluster definition that contains end points for name node, job tracker, oozie and jms server:
+The cluster locations MUST be created prior to submitting a cluster entity to Falcon.
+*staging* must have 777 permissions and the parent dirs must have execute permissions
+*working* must have 755 permissions and the parent dirs must have execute permissions
+
+<verbatim>
+<?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="2.5.0" />
+
+ <interface type="write" endpoint="hdfs://name-node.com:54310" version="2.5.0" />
+
+ <interface type="execute" endpoint="job-tracker:54311" version="2.5.0" />
+
+ <interface type="workflow" endpoint="http://oozie.com:11000/oozie/" version="4.0.1" />
+
+ <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>
+</verbatim>
+
+---++++ Input Feed
+Hourly feed that defines feed path, frequency, ownership and validity:
+<verbatim>
+<?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>
+</verbatim>
+
+---++++ Output Feed
+Daily feed that defines feed path, frequency, ownership and validity:
+<verbatim>
+<?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>
+</verbatim>
+
+---++++ Process
+Sample process which runs daily at 6th hour on corp cluster. It takes one input - !SampleInput for the previous day(24 instances). It generates one output - !SampleOutput 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).
+
+<verbatim>
+<?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="periodic" 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>
+</verbatim>
+
+---++++ Oozie Workflow
+The sample user workflow contains 3 actions:
+ * Pig action - Executes pig script /projects/bootcamp/workflow/script.pig
+ * concatenator - Java action that concatenates part files and generates a single file
+ * file upload - ssh action that gets the concatenated file from hadoop and sends the file to a remote host
+
+<verbatim>
+<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>
+</verbatim>
+
+---++++ File Upload Script
+The script gets the file from hadoop, rsyncs the file to /tmp on remote host and deletes the file from hadoop
+<verbatim>
+#!/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"
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/Operability.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/Operability.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/Operability.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/Operability.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,110 @@
+---+ Operationalizing Falcon
+
+---++ Overview
+
+Apache Falcon provides various tools to operationalize Falcon consisting of Alerts for
+unrecoverable errors, Audits of user actions, Metrics, and Notifications. They are detailed below.
+
+++ Lineage
+
+Currently Lineage has no way to access or restore information about entity instances created during the time lineage
+was disabled. Information about entities however, is preserved and bootstrapped when lineage is enabled. If you have to
+reset the graph db then you can delete the graph db files as specified in the startup.properties and restart the falcon.
+Please note: you will loose all the information about the instances if you delete the graph db.
+
+---++ Monitoring
+
+Falcon provides monitoring of various events by capturing metrics of those events.
+The metric numbers can then be used to monitor performance and health of the Falcon system and
+the entire processing pipelines.
+
+Falcon also exposes [[https://github.com/thinkaurelius/titan/wiki/Titan-Performance-and-Monitoring][metrics for titandb]]
+
+Users can view the logs of these events in the metric.log file, by default this file is created
+under ${user.dir}/logs/ directory. Users may also extend the Falcon monitoring framework to send
+events to systems like Mondemand/lwes by implementingorg.apache.falcon.plugin.MonitoringPlugin
+interface.
+
+The following events are captured by Falcon for logging the metrics:
+ 1. New cluster definitions posted to Falcon (success & failures)
+ 1. New feed definition posted to Falcon (success & failures)
+ 1. New process definition posted to Falcon (success & failures)
+ 1. Process update events (success & failures)
+ 1. Feed update events (success & failures)
+ 1. Cluster update events (success & failures)
+ 1. Process suspend events (success & failures)
+ 1. Feed suspend events (success & failures)
+ 1. Process resume events (success & failures)
+ 1. Feed resume events (success & failures)
+ 1. Process remove events (success & failures)
+ 1. Feed remove events (success & failures)
+ 1. Cluster remove events (success & failures)
+ 1. Process instance kill events (success & failures)
+ 1. Process instance re-run events (success & failures)
+ 1. Process instance generation events
+ 1. Process instance failure events
+ 1. Process instance auto-retry events
+ 1. Process instance retry exhaust events
+ 1. Feed instance deletion event
+ 1. Feed instance deletion failure event (no retries)
+ 1. Feed instance replication event
+ 1. Feed instance replication failure event
+ 1. Feed instance replication auto-retry event
+ 1. Feed instance replication retry exhaust event
+ 1. Feed instance late arrival event
+ 1. Feed instance post cut-off arrival event
+ 1. Process re-run due to late feed event
+ 1. Transaction rollback failed event
+
+The metric logged for an event has the following properties:
+ 1. Action - Name of the event.
+ 2. Dimensions - A list of name/value pairs of various attributes for a given action.
+ 3. Status- Status of an action FAILED/SUCCEEDED.
+ 4. Time-taken - Time taken in nanoseconds for a given action.
+
+An example for an event logged for a submit of a new process definition:
+
+ 2012-05-04 12:23:34,026 {Action:submit, Dimensions:{entityType=process}, Status: SUCCEEDED, Time-taken:97087000 ns}
+
+Users may parse the metric.log or capture these events from custom monitoring frameworks and can plot various graphs
+or send alerts according to their requirements.
+
+
+---++ Notifications
+
+Falcon creates a JMS topic for every process/feed that is scheduled in Falcon.
+The implementation class and the broker url of the JMS engine are read from the dependent cluster's definition.
+Users may register consumers on the required topic to check the availability or status of feed instances.
+
+For a given process that is scheduled, the name of the topic is same as the process name.
+Falcon sends a Map message for every feed produced by the instance of a process to the JMS topic.
+The JMS !MapMessage sent to a topic has the following properties:
+entityName, feedNames, feedInstancePath, workflowId, runId, nominalTime, timeStamp, brokerUrl, brokerImplClass, entityType, operation, logFile, topicName, status, brokerTTL;
+
+For a given feed that is scheduled, the name of the topic is same as the feed name.
+Falcon sends a map message for every feed instance that is deleted/archived/replicated depending upon the retention policy set in the feed definition.
+The JMS !MapMessage sent to a topic has the following properties:
+entityName, feedNames, feedInstancePath, workflowId, runId, nominalTime, timeStamp, brokerUrl, brokerImplClass, entityType, operation, logFile, topicName, status, brokerTTL;
+
+The JMS messages are automatically purged after a certain period (default 3 days) by the Falcon JMS house-keeping service.TTL (Time-to-live) for JMS message
+can be configured in the Falcon's startup.properties file.
+
+
+---++ Alerts
+
+Falcon generates alerts for unrecoverable errors into a log file by default.
+Users can view these alerts in the alerts.log file, by default this file is created
+under ${user.dir}/logs/ directory.
+
+Users may also extend the Falcon Alerting plugin to send events to systems like Nagios, etc. by
+extending org.apache.falcon.plugin.AlertingPlugin interface.
+
+
+---++ Audits
+
+Falcon audits all user activity and captures them into a log file by default.
+Users can view these audits in the audit.log file, by default this file is created
+under ${user.dir}/logs/ directory.
+
+Users may also extend the Falcon Audit plugin to send audits to systems like Apache Argus, etc. by
+extending org.apache.falcon.plugin.AuditingPlugin interface.
Added: falcon/trunk/releases/0.7/src/site/twiki/Recipes.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/Recipes.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/Recipes.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/Recipes.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,77 @@
+---+ Falcon Recipes
+
+---++ Overview
+
+A Falcon recipe is a static process template with parameterized workflow to realize a specific use case. Recipes are
+defined in user space. Recipes will not have support for update or lifecycle management.
+
+For example:
+
+ * Replicating directories from one HDFS cluster to another (not timed partitions)
+ * Replicating hive metadata (database, table, views, etc.)
+ * Replicating between HDFS and Hive - either way
+ * Data masking etc.
+
+---++ Proposal
+
+Falcon provides a Process abstraction that encapsulates the configuration for a user workflow with scheduling
+controls. All recipes can be modeled as a Process with in Falcon which executes the user workflow periodically. The
+process and its associated workflow are parameterized. The user will provide a properties file with name value pairs
+that are substituted by falcon before scheduling it. Falcon translates these recipes as a process entity by
+replacing the parameters in the workflow definition.
+
+---++ Falcon CLI recipe support
+
+Falcon CLI functionality to support recipes has been added.
+<a href="./FalconCLI.html">Recipe command usage is defined here.</a>
+
+CLI accepts recipe option with a recipe name and optional tool and does the following:
+ * Validates the options; name option is mandatory and tool is optional and should be provided if user wants to override the base recipe tool
+ * Looks for <name>-workflow.xml, <name>-template.xml and <name>.properties file in the path specified by falcon.recipe.path in client.properties. If files cannot be found then Falcon CLI will fail
+ * Invokes a Tool to substitute the properties in the templated process for the recipe. By default invokes base tool if tool option is not passed. Tool is responsible for generating process entity at the path specified by FalconCLI
+ * Validates the generated entity
+ * Submit and schedule this entity
+ * Generated process entity files are stored in tmp directory
+
+---++ Base Recipe tool
+
+Falcon provides a base tool that recipes can override. Base Recipe tool does the following:
+ * Expects recipe template file path, recipe properties file path and path where process entity to be submitted should be generated. Validates these arguments
+ * Validates the artifacts i.e. workflow and/or lib files specified in the recipe template exists on local filesystem or HDFS at the specified path else returns error
+ * Copies if the artifacts exists on local filesystem
+ * If workflow is on local FS then falcon.recipe.workflow.path in recipe property file is mandatory for it to be copied to HDFS. If templated process requires custom libs falcon.recipe.workflow.lib.path property is mandatory for them to be copied from Local FS to HDFS. Recipe tool will copy the local artifacts only if these properties are set in properties file
+ * Looks for the patten ##[A-Za-z0-9_.]*## in the templated process and substitutes it with the properties. Process entity generated after the substitution is written to the empty file passed by FalconCLI
+
+---++ Recipe template file format
+
+ * Any templatized string should be in the format ##[A-Za-z0-9_.]*##.
+ * There should be a corresponding entry in the recipe properties file "falcon.recipe.<templatized-string> = <value to be substituted>"
+
+<verbatim>
+Example: If the entry in recipe template is <workflow name="##workflow.name##"> there should be a corresponding entry in the recipe properties file falcon.recipe.workflow.name=hdfs-dr-workflow
+</verbatim>
+
+---++ Recipe properties file format
+
+ * Regular key value pair properties file
+ * Property key should be prefixed by "falcon.recipe."
+
+<verbatim>
+Example: falcon.recipe.workflow.name=hdfs-dr-workflow
+Recipe template will have <workflow name="##workflow.name##">. Recipe tool will look for the patten ##workflow.name##
+and replace it with the property value "hdfs-dr-workflow". Substituted template will have <workflow name="hdfs-dr-workflow">
+</verbatim>
+
+---++ Managing the scheduled recipe process
+ * Scheduled recipe process is similar to regular process
+ * List : falcon entity -type process -name <recipe-process-name> -list
+ * Status : falcon entity -type process -name <recipe-process-name> -status
+ * Delete : falcon entity -type process -name <recipe-process-name> -delete
+
+---++ Sample recipes
+
+ * Sample recipes are published in addons/recipes
+
+---++ Packaging
+
+ * There is no packaging for recipes at this time but will be added soon.
Added: falcon/trunk/releases/0.7/src/site/twiki/Security.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/Security.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/Security.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/Security.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,387 @@
+---+ Securing Falcon
+
+---++ Overview
+
+Apache Falcon enforces authentication and authorization which are detailed below. Falcon also
+provides transport level security ensuring data confidentiality and integrity.
+
+
+---++ Authentication (User Identity)
+
+Apache Falcon enforces authentication on protected resources. Once authentication has been established it sets a
+signed HTTP Cookie that contains an authentication token with the user name, user principal,
+authentication type and expiration time.
+
+It does so by using [[http://hadoop.apache .org/docs/current/hadoop-auth/index.html][Hadoop Auth]].
+Hadoop Auth is a Java library consisting of a client and a server components to enable Kerberos SPNEGO authentication
+for HTTP. Hadoop Auth also supports additional authentication mechanisms on the client and the server side via 2
+simple interfaces.
+
+
+---+++ Authentication Methods
+
+It supports 2 authentication methods, simple and kerberos out of the box.
+
+---++++ Pseudo/Simple Authentication
+
+Falcon authenticates the user by simply trusting the value of the query string parameter 'user.name'. This is the
+default mode Falcon is configured with.
+
+---++++ Kerberos Authentication
+
+Falcon uses HTTP Kerberos SPNEGO to authenticate the user.
+
+
+---++ Authorization
+
+Falcon also enforces authorization on Entities using ACLs (Access Control Lists). ACLs are useful
+for implementing permission requirements and provide a way to set different permissions for
+specific users or named groups.
+
+By default, support for authorization is disabled and can be enabled in startup.properties.
+
+---+++ ACLs in Entity
+
+All Entities now have ACL which needs to be present if authorization is enabled. Only owners who
+own or created the entity will be allowed to update or delete their entities.
+
+An entity has ACLs (Access Control Lists) that are useful for implementing permission requirements
+and provide a way to set different permissions for specific users or named groups.
+<verbatim>
+ <ACL owner="test-user" group="test-group" permission="*"/>
+</verbatim>
+ACL indicates the Access control list for this cluster.
+owner is the Owner of this entity.
+group is the one which has access to read.
+permission indicates the rwx is not enforced at this time.
+
+---+++ Super-User
+
+The super-user is the user with the same identity as falcon process itself. Loosely, if you
+started the falcon, then you are the super-user. The super-user can do anything in that
+permissions checks never fail for the super-user. There is no persistent notion of who was the
+super-user; when the falcon is started the process identity determines who is the super-user
+for now. The Falcon super-user does not have to be the super-user of the falcon host, nor is it
+necessary that all clusters have the same super-user. Also, an experimenter running Falcon on a
+personal workstation, conveniently becomes that installation's super-user without any configuration.
+
+Falcon also allows users to configure a super user group and allows users belonging to this
+group to be a super user.
+
+ACL owner and group must be valid even if the authenticated user is a super-user.
+
+---+++ Group Memberships
+
+Once a user has been authenticated and a username has been determined, the list of groups is
+determined by a group mapping service, configured by the hadoop.security.group.mapping property
+in Hadoop. The default implementation, org.apache.hadoop.security.ShellBasedUnixGroupsMapping,
+will shell out to the Unix bash -c groups command to resolve a list of groups for a user.
+
+Note that Falcon stores the user and group of an Entity as strings; there is no
+conversion from user and group identity numbers as is conventional in Unix.
+
+The only limitation is that a user cannot add a group in ACL that he does not belong to.
+
+---+++ Authorization Provider
+
+Falcon provides a plugin-able provider interface for Authorization. It also ships with a default
+implementation that enforces the following authorization policy.
+
+---++++ Entity and Instance Management Operations Policy
+
+ * All Entity and Instance operations are authorized for users who created them, Owners and users with group memberships
+ * Reference to entities with in a feed or process is allowed with out enforcing permissions
+
+Any Feed or Process can refer to a Cluster entity not owned by the Feed or Process owner. Any Process can refer to a Feed entity not owned by the Process owner
+
+The authorization is enforced in the following way:
+
+ * if admin resource,
+ * If authenticated user name matches the admin users configuration
+ * Else if groups of the authenticated user matches the admin groups configuration
+ * Else authorization exception is thrown
+ * Else if entities or instance resource
+ * If the authenticated user matches the owner in ACL for the entity
+ * Else if the groups of the authenticated user matches the group in ACL for the entity
+ * Else authorization exception is thrown
+ * Else if lineage resource
+ * All have read-only permissions, reason being folks should be able to examine the dependency and allow reuse
+
+To authenticate user for REST api calls, user should append "user.name=<username>" to the query.
+
+*operations on Entity Resource*
+
+| *Resource* | *Description* | *Authorization* |
+| [[restapi/EntityValidate][api/entities/validate/:entity-type]] | Validate the entity | Owner/Group |
+| [[restapi/EntitySubmit][api/entities/submit/:entity-type]] | Submit the entity | Owner/Group |
+| [[restapi/EntityUpdate][api/entities/update/:entity-type/:entity-name]] | Update the entity | Owner/Group |
+| [[restapi/EntitySubmitAndSchedule][api/entities/submitAndSchedule/:entity-type]] | Submit & Schedule the entity | Owner/Group |
+| [[restapi/EntitySchedule][api/entities/schedule/:entity-type/:entity-name]] | Schedule the entity | Owner/Group |
+| [[restapi/EntitySuspend][api/entities/suspend/:entity-type/:entity-name]] | Suspend the entity | Owner/Group |
+| [[restapi/EntityResume][api/entities/resume/:entity-type/:entity-name]] | Resume the entity | Owner/Group |
+| [[restapi/EntityDelete][api/entities/delete/:entity-type/:entity-name]] | Delete the entity | Owner/Group |
+| [[restapi/EntityStatus][api/entities/status/:entity-type/:entity-name]] | Get the status of the entity | Owner/Group |
+| [[restapi/EntityDefinition][api/entities/definition/:entity-type/:entity-name]] | Get the definition of the entity | Owner/Group |
+| [[restapi/EntityList][api/entities/list/:entity-type?fields=:fields]] | Get the list of entities | Owner/Group |
+| [[restapi/EntityDependencies][api/entities/dependencies/:entity-type/:entity-name]] | Get the dependencies of the entity | Owner/Group |
+
+*REST Call on Feed and Process Instances*
+
+| *Resource* | *Description* | *Authorization* |
+| [[restapi/InstanceRunning][api/instance/running/:entity-type/:entity-name]] | List of running instances. | Owner/Group |
+| [[restapi/InstanceStatus][api/instance/status/:entity-type/:entity-name]] | Status of a given instance | Owner/Group |
+| [[restapi/InstanceKill][api/instance/kill/:entity-type/:entity-name]] | Kill a given instance | Owner/Group |
+| [[restapi/InstanceSuspend][api/instance/suspend/:entity-type/:entity-name]] | Suspend a running instance | Owner/Group |
+| [[restapi/InstanceResume][api/instance/resume/:entity-type/:entity-name]] | Resume a given instance | Owner/Group |
+| [[restapi/InstanceRerun][api/instance/rerun/:entity-type/:entity-name]] | Rerun a given instance | Owner/Group |
+| [[InstanceLogs][api/instance/logs/:entity-type/:entity-name]] | Get logs of a given instance | Owner/Group |
+
+---++++ Admin Resources Policy
+
+Only users belonging to admin users or groups have access to this resource. Admin membership is
+determined by a static configuration parameter.
+
+| *Resource* | *Description* | *Authorization* |
+| [[restapi/AdminVersion][api/admin/version]] | Get version of the server | No restriction |
+| [[restapi/AdminStack][api/admin/stack]] | Get stack of the server | Admin User/Group |
+| [[restapi/AdminConfig][api/admin/config/:config-type]] | Get configuration information of the server | Admin User/Group |
+
+
+---++++ Lineage Resource Policy
+
+Lineage is read-only and hence all users can look at lineage for their respective entities.
+*Note:* This gap will be fixed in a later release.
+
+
+---++ Authentication Configuration
+
+Following is the Server Side Configuration Setup for Authentication.
+
+---+++ Common Configuration Parameters
+
+<verbatim>
+# Authentication type must be specified: simple|kerberos
+*.falcon.authentication.type=kerberos
+</verbatim>
+
+---+++ Kerberos Configuration
+
+<verbatim>
+##### Service Configuration
+
+# Indicates the Kerberos principal to be used in Falcon Service.
+*.falcon.service.authentication.kerberos.principal=falcon/_HOST@EXAMPLE.COM
+
+# Location of the keytab file with the credentials for the Service principal.
+*.falcon.service.authentication.kerberos.keytab=/etc/security/keytabs/falcon.service.keytab
+
+# name node principal to talk to config store
+*.dfs.namenode.kerberos.principal=nn/_HOST@EXAMPLE.COM
+
+# Indicates how long (in seconds) falcon authentication token is valid before it has to be renewed.
+*.falcon.service.authentication.token.validity=86400
+
+##### SPNEGO Configuration
+
+# Authentication type must be specified: simple|kerberos|<class>
+# org.apache.falcon.security.RemoteUserInHeaderBasedAuthenticationHandler can be used for backwards compatibility
+*.falcon.http.authentication.type=kerberos
+
+# Indicates how long (in seconds) an authentication token is valid before it has to be renewed.
+*.falcon.http.authentication.token.validity=36000
+
+# The signature secret for signing the authentication tokens.
+*.falcon.http.authentication.signature.secret=falcon
+
+# The domain to use for the HTTP cookie that stores the authentication token.
+*.falcon.http.authentication.cookie.domain=
+
+# Indicates if anonymous requests are allowed when using 'simple' authentication.
+*.falcon.http.authentication.simple.anonymous.allowed=true
+
+# Indicates the Kerberos principal to be used for HTTP endpoint.
+# The principal MUST start with 'HTTP/' as per Kerberos HTTP SPNEGO specification.
+*.falcon.http.authentication.kerberos.principal=HTTP/_HOST@EXAMPLE.COM
+
+# Location of the keytab file with the credentials for the HTTP principal.
+*.falcon.http.authentication.kerberos.keytab=/etc/security/keytabs/spnego.service.keytab
+
+# The kerberos names rules is to resolve kerberos principal names, refer to Hadoop's KerberosName for more details.
+*.falcon.http.authentication.kerberos.name.rules=DEFAULT
+
+# Comma separated list of black listed users
+*.falcon.http.authentication.blacklisted.users=
+
+# Increase Jetty request buffer size to accommodate the generated Kerberos token
+*.falcon.jetty.request.buffer.size=16192
+</verbatim>
+
+---+++ Pseudo/Simple Configuration
+
+<verbatim>
+##### SPNEGO Configuration
+
+# Authentication type must be specified: simple|kerberos|<class>
+# org.apache.falcon.security.RemoteUserInHeaderBasedAuthenticationHandler can be used for backwards compatibility
+*.falcon.http.authentication.type=simple
+
+# Indicates how long (in seconds) an authentication token is valid before it has to be renewed.
+*.falcon.http.authentication.token.validity=36000
+
+# The signature secret for signing the authentication tokens.
+*.falcon.http.authentication.signature.secret=falcon
+
+# The domain to use for the HTTP cookie that stores the authentication token.
+*.falcon.http.authentication.cookie.domain=
+
+# Indicates if anonymous requests are allowed when using 'simple' authentication.
+*.falcon.http.authentication.simple.anonymous.allowed=true
+
+# Comma separated list of black listed users
+*.falcon.http.authentication.blacklisted.users=
+</verbatim>
+
+---++ Authorization Configuration
+
+---+++ Enabling Authorization
+By default, support for authorization is disabled and specifying ACLs in entities are optional.
+To enable support for authorization, set falcon.security.authorization.enabled to true in the
+startup configuration.
+
+<verbatim>
+# Authorization Enabled flag: false|true
+*.falcon.security.authorization.enabled=true
+</verbatim>
+
+---+++ Authorization Provider
+
+Falcon provides a basic implementation for Authorization bundled, org.apache.falcon.security .DefaultFalconAuthorizationProvider.
+This can be overridden by custom implementations in the startup configuration.
+
+<verbatim>
+# Authorization Provider Fully Qualified Class Name
+*.falcon.security.authorization.provider=org.apache.falcon.security.DefaultAuthorizationProvider
+</verbatim>
+
+---+++ Super User Group
+
+Super user group is determined by the configuration:
+
+<verbatim>
+# The name of the group of super-users
+*.falcon.security.authorization.superusergroup=falcon
+</verbatim>
+
+---+++ Admin Membership
+
+Administrative users are determined by the configuration:
+
+<verbatim>
+# Admin Users, comma separated users
+*.falcon.security.authorization.admin.users=falcon,ambari-qa,seetharam
+</verbatim>
+
+Administrative groups are determined by the configuration:
+
+<verbatim>
+# Admin Group Membership, comma separated users
+*.falcon.security.authorization.admin.groups=falcon,testgroup,staff
+</verbatim>
+
+
+---++ SSL
+
+Falcon provides transport level security ensuring data confidentiality and integrity. This is
+enabled by default for communicating over HTTP between the client and the server.
+
+---+++ SSL Configuration
+
+<verbatim>
+*.falcon.enableTLS=true
+*.keystore.file=/path/to/keystore/file
+*.keystore.password=password
+</verbatim>
+
+---+++ Distributed Falcon Setup
+
+Falcon should be configured to communicate with Prism over TLS in secure mode. Its not enabled by default.
+
+
+---++ Changes to ownership and permissions of directories managed by Falcon
+
+| *Directory* | *Location* | *Owner* | *Permissions* |
+| Configuration Store | ${config.store.uri} | falcon | 700 |
+| Cluster Staging Location | ${cluster.staging-location} | falcon | 777 |
+| Cluster Working Location | ${cluster.working-location} | falcon | 755 |
+| Shared libs | {cluster.working}/{lib,libext} | falcon | 755 |
+| Oozie coord/bundle XMLs | ${cluster.staging-location}/workflows/{entity}/{entity-name} | $user | cluster umask |
+| App logs | ${cluster.staging-location}/workflows/{entity}/{entity-name}/logs | $user | cluster umask |
+
+*Note:* Please note that the cluster staging and working locations MUST be created prior to
+submitting a cluster entity to Falcon. Also, note that the the parent dirs must have execute
+permissions.
+
+
+---++ Backwards compatibility
+
+---+++ Scheduled Entities
+
+Entities already scheduled with an earlier version of Falcon are not compatible with this version
+
+---+++ Falcon Clients
+
+Older Falcon clients are backwards compatible wrt Authentication and user information sent as part of the HTTP
+header, Remote-User is still honoured when the authentication type is configured as below:
+
+<verbatim>
+*.falcon.http.authentication.type=org.apache.falcon.security.RemoteUserInHeaderBasedAuthenticationHandler
+</verbatim>
+
+---+++ Blacklisted super users for authentication
+
+The blacklist users used to have the following super users: hdfs, mapreduce, oozie, and falcon.
+The list is externalized from code into Startup.properties file and is empty now and needs to be
+configured specifically in the file.
+
+
+---+++ Falcon Dashboard
+
+To initialize the current user for dashboard, user should append query param "user.name=<username>" to the REST api call.
+
+If dashboard user wishes to change the current user, they should do the following.
+ * delete the hadoop.auth cookie from browser cache.
+ * append query param "user.name=<new_user>" to the next REST API call.
+
+In Kerberos method, the browser must support HTTP Kerberos SPNEGO.
+
+
+---++ Known Limitations
+
+ * ActiveMQ topics are not secure but will be in the near future
+ * Entities already scheduled with an earlier version of Falcon are not compatible with this version as new
+ workflow parameters are being passed back into Falcon such as the user are required
+ * Use of hftp as the scheme for read only interface in cluster entity [[https://issues.apache.org/jira/browse/HADOOP-10215][will not work in Oozie]]
+ The alternative is to use webhdfs scheme instead and its been tested with DistCp.
+
+
+---++ Examples
+
+---+++ Accessing the server using Falcon CLI (Java client)
+
+There is no change in the way the CLI is used. The CLI has been changed to work with the configured authentication
+method.
+
+---+++ Accessing the server using curl
+
+Try accessing protected resources using curl. The protected resources are:
+
+<verbatim>
+$ kinit
+Please enter the password for venkatesh@LOCALHOST:
+
+$ curl http://localhost:15000/api/admin/version
+
+$ curl http://localhost:15000/api/admin/version?user.name=venkatesh
+
+$ curl --negotiate -u foo -b ~/cookiejar.txt -c ~/cookiejar.txt curl http://localhost:15000/api/admin/version
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/index.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/index.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/index.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/index.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,19 @@
+---+++ Contents
+
+ * <a href="./InstallationSteps.html">Simple setup</a>
+
+ * <a href="./FalconArchitecture.html">Overview</a>
+
+ * <a href="./HiveIntegration.html">Hive Integration</a>
+
+ * <a href="./Security.html">Security</a>
+
+ * <a href="./OnBoarding.html">On boarding</a>
+
+ * <a href="./EntitySpecification.html">Entity specification</a>
+
+ * <a href="./FalconCLI.html">CLI</a>
+
+ * <a href="./Operability.html">Operability</a>
+
+ * <a href="./restapi/ResourceList.html">Rest API</a>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/AdjacentVertices.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/AdjacentVertices.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/AdjacentVertices.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/AdjacentVertices.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,70 @@
+---++ GET api/metadata/lineage/vertices/:id/:direction
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get a list of adjacent vertices or edges with a direction.
+
+---++ Parameters
+ * :id is the id of the vertex.
+ * :direction is the direction associated with the edges.
+
+ To get the adjacent out vertices of vertex pass direction as out, in to get adjacent in vertices
+ and both to get both in and out adjacent vertices. Similarly to get the out edges of vertex
+ pass outE, inE to get in edges and bothE to get the both in and out edges of vertex.
+
+ * out : get the adjacent out vertices of vertex
+ * in : get the adjacent in vertices of vertex
+ * both : get the both adjacent in and out vertices of vertex
+ * outCount : get the number of out vertices of vertex
+ * inCount : get the number of in vertices of vertex
+ * bothCount : get the number of adjacent in and out vertices of vertex
+ * outIds : get the identifiers of out vertices of vertex
+ * inIds : get the identifiers of in vertices of vertex
+ * bothIds : get the identifiers of adjacent in and out vertices of vertex
+
+---++ Results
+Adjacent vertices of the vertex for the specified direction.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/metadata/lineage/vertices/4/out
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "results": [
+ {
+ "timestamp":"2014-04-21T20:55Z",
+ "name":"sampleFeed",
+ "type":"feed-instance",
+ "_id":8,
+ "_type":"vertex"
+ }
+ ],
+ "totalSize":1}
+}
+</verbatim>
+
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/metadata/lineage/vertices/4/bothE
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "results":[
+ {
+ "_id":"Q5V-4-5g",
+ "_type":"edge",
+ "_outV":4,
+ "_inV":8,
+ "_label":"output"
+ }
+ ],
+ "totalSize":1
+}
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/AdminConfig.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/AdminConfig.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/AdminConfig.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/AdminConfig.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,35 @@
+---++ GET /api/admin/config/:config-type
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get configuration information of the falcon server.
+
+---++ Parameters
+ * :config-type can be build, deploy, startup or runtime
+
+---++ Results
+Configuration information of the server.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/admin/config/deploy
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "properties": [
+ {
+ "value": "embedded",
+ "key": "deploy.mode"
+ },
+ {
+ "value": "all",
+ "key": "domain"
+ }
+ ]
+}
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/AdminStack.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/AdminStack.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/AdminStack.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/AdminStack.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,39 @@
+---++ GET /api/admin/stack
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get stack trace of the falcon server.
+
+---++ Parameters
+None.
+---++ Results
+Stack trace of the server.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/admin/stack
+</verbatim>
+---+++ Result
+<verbatim>
+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)
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/AdminVersion.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/AdminVersion.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/AdminVersion.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/AdminVersion.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,34 @@
+---++ GET /api/admin/version
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get version of the falcon server.
+
+---++ Parameters
+None.
+---++ Results
+Version of the server.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/admin/version
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "properties":[
+ {
+ "key":"Version",
+ "value":"0.4-incubating-SNAPSHOT-rb47788d1112fcf949c22a3860934167237b395b0"
+ },
+ {
+ "key":"Mode",
+ "value":"embedded"
+ }
+ ]
+}
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/AllEdges.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/AllEdges.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/AllEdges.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/AllEdges.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,42 @@
+---++ GET pi/metadata/lineage//edges/all
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get all edges.
+
+---++ Parameters
+None.
+
+---++ Results
+All edges in lineage graph.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/metadata/lineage/edges/all
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "results": [
+ {
+ "_id":"Q5V-4-5g",
+ "_type":"edge",
+ "_outV":4,
+ "_inV":8,
+ "_label":"output"
+ },
+ {
+ "_id":"Q6t-c-5g",
+ "_type":"edge",
+ "_outV":12,
+ "_inV":16,
+ "_label":"output"
+ }
+ ],
+ "totalSize": 2
+}
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/AllVertices.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/AllVertices.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/AllVertices.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/AllVertices.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,43 @@
+---++ GET api/metadata/lineage/vertices/all
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get all vertices.
+
+---++ Parameters
+None.
+
+---++ Results
+All vertices in lineage graph.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/metadata/lineage/vertices/all
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "results": [
+ {
+ "timestamp":"2014-04-21T20:55Z",
+ "name":"sampleIngestProcess\/2014-03-01T10:00Z",
+ "type":"process-instance",
+ "version":"2.0.0",
+ "_id":4,
+ "_type":"vertex"
+ },
+ {
+ "timestamp":"2014-04-21T20:55Z",
+ "name":"rawEmailFeed\/2014-03-01T10:00Z",
+ "type":"feed-instance",
+ "_id":8,
+ "_type":"vertex"
+ }
+ ],
+ "totalSize": 2
+}
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/Edge.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/Edge.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/Edge.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/Edge.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,33 @@
+---++ GET api/metadata/lineage/edges/:id
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Gets the edge with specified id.
+
+---++ Parameters
+ * :id is the unique id of the edge.
+
+---++ Results
+Edge with the specified id.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/metadata/lineage/edges/Q6t-c-5g
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "results":
+ {
+ "_id":"Q6t-c-5g",
+ "_type":"edge",
+ "_outV":12,
+ "_inV":16,
+ "_label":"output"
+ }
+}
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityDefinition.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityDefinition.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityDefinition.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityDefinition.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,52 @@
+---++ GET /api/entities/definition/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get definition of the entity.
+
+---++ Parameters
+ * :entity-type can be cluster, feed or process.
+ * :entity-name is name of the entity.
+
+---++ Results
+Definition of the entity.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/entities/definition/process/SampleProcess
+</verbatim>
+---+++ Result
+<verbatim>
+<?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>
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityDelete.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityDelete.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityDelete.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityDelete.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,30 @@
+---++ DELETE /api/entities/delete/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Delete the specified entity.
+
+---++ Parameters
+ * :entity-type can be feed or process.
+ * :entity-name is name of the feed or process.
+
+---++ Results
+Results of the delete operation.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+DELETE http://localhost:15000/api/entities/delete/cluster/SampleProcess
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "requestId": "falcon\/17ff6ca6-1c8a-459f-9ba8-8fec480e384a\n",
+ "message": "falcon\/SampleProcess(cluster) removed successfully\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
+
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityDependencies.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityDependencies.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityDependencies.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityDependencies.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,42 @@
+---++ GET /api/entities/dependencies/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get dependencies of the entity.
+
+---++ Parameters
+ * :entity-type can be cluster, feed or process.
+ * :entity-name is name of the entity.
+
+---++ Results
+Dependenciess of the entity.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/entities/dependencies/process/SampleProcess
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "entity": [
+ {
+ "name": "SampleInput",
+ "type": "feed",
+ "tag": [Input]
+ },
+ {
+ "name": "SampleOutput",
+ "type": "feed"
+ "tag": [Output]
+ },
+ {
+ "name": "primary-cluster",
+ "type": "cluster"
+ }
+ ]
+}
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityLineage.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityLineage.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityLineage.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityLineage.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,39 @@
+---++ GET api/metadata/lineage/entities?pipeline=:pipeline
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+It returns the graph depicting the relationship between the various processes and feeds in a given pipeline.
+
+---++ Parameters
+ * :pipeline is the name of the pipeline
+
+---++ Results
+It returns a json graph
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/metadata/lineage/entities?pipeline=my-pipeline
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "vertices": ["my-minutely-process", "my-hourly-process"],
+ "edges":
+ [
+ {
+ "from" : "my-minutely-process",
+ "to" : "my-hourly-process",
+ "label" : "my-minutely-feed"
+ },
+ {
+ "from" : "my-hourly-process",
+ "to" : "my-minutely-process",
+ "label" : "my-hourly-feedback"
+ }
+ ]
+}
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityList.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityList.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityList.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityList.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,163 @@
+---++ GET /api/entities/list/:entity-type?fields=:fields
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get list of the entities.
+
+---++ Parameters
+ * :entity-type Comma-separated entity types. Can be empty. Valid entity types are cluster, feed or process.
+ * fields <optional param> Fields of entity that the user wants to view, separated by commas.
+ * Valid options are STATUS, TAGS, PIPELINES, CLUSTERS.
+ * nameseq <optional param> Subsequence of entity name. Not case sensitive.
+ * The entity name needs to contain all the characters in the subsequence in the same order.
+ * Example 1: "sample1" will match the entity named "SampleFeed1-2".
+ * Example 2: "mhs" will match the entity named "New-My-Hourly-Summary".
+ * tagkeys <optional param> Keywords in tags, separated by comma. Not case sensitive.
+ * The returned entities will have tags that match all the tag keywords.
+ * filterBy <optional param> Filter results by list of field:value pairs. Example: filterBy=STATUS:RUNNING,PIPELINES:clickLogs
+ * Supported filter fields are NAME, STATUS, PIPELINES, CLUSTER.
+ * Query will do an AND among filterBy fields.
+ * tags <optional param> Return list of entities that have specified tags, separated by a comma. Query will do AND on tag values.
+ * Example: tags=consumer=consumer@xyz.com,owner=producer@xyz.com
+ * orderBy <optional param> Field by which results should be ordered.
+ * Supports ordering by "name".
+ * sortOrder <optional param> Valid options are "asc" and "desc"
+ * offset <optional param> Show results from the offset, used for pagination. Defaults to 0.
+ * numResults <optional param> Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10.
+ * Note:
+ * We have two filtering parameters for entity tags: "tags" and "tagkeys". "tags" does the exact match in key=value fashion, while "tagkeys" finds all the entities with the given key as a substring in the tags. This "tagkeys" filter is introduced for the user who doesn't remember the exact tag but some keywords in the tag. It also helps users to save the time of typing long tags.
+ * The returned entities will match all the filtering criteria.
+
+---++ Results
+Total number of results and a list of entities.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/entities/list/feed
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "totalResults":"2â,
+ "entity": [
+ {
+ "name": "SampleOutput",
+ "type": "feed"
+ },
+ {
+ "name": "SampleInput",
+ "type": "feed"
+ }
+ ]
+}
+</verbatim>
+
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/entities/list
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "totalResults":"4â,
+ "entity": [
+ {
+ "name" : "SampleCluster1",
+ "type" : "cluster"
+ }
+ {
+ "name" : "SampleOutput",
+ "type" : "feed"
+ },
+ {
+ "name" : "SampleInput",
+ "type" : "feed"
+ }
+ {
+ "name" : "SampleProcess1",
+ "type" : "process"
+ }
+ ]
+}
+</verbatim>
+
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/entities/list/feed?fields=status
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "totalResults":"2â,
+ "entity": [
+ {
+ "name" : "SampleOutput",
+ "type" : "feed",
+ "status": "RUNNING"
+ },
+ {
+ "name": "SampleInput",
+ "type": "feed",
+ "status": "RUNNING"
+ }
+ ]
+}
+</verbatim>
+
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/entities/list/process?filterBy=STATUS:RUNNING,PIPELINES:dataReplication&fields=status,pipelines,tags&tags=consumer=consumer@xyz.com&orderBy=name&offset=2&numResults=2
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "totalResults":"10â,
+ "entity": [
+ {
+ "name" : "SampleProcess1",
+ "type" : "process",
+ "status": "RUNNING",
+ "pipelines": "dataReplication",
+ "tags": "consumer=consumer@xyz.com"
+ },
+ {
+ "name": "SampleProcess3",
+ "type": "process",
+ "status": "RUNNING",
+ "pipelines": "dataReplication",
+ "tags": "consumer=consumer@xyz.com,owner=producer@xyz.com"
+ }
+ ]
+}
+</verbatim>
+
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/entities/list/feed,process?nameseq=samplebill&tagkeys=billing,healthcare&numResults=2&offset=1&fields=status,clusters,tags
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "totalResults":"4â,
+ "entityâ:[
+ {
+ "type":"FEEDâ,
+ "name":"SampleUSHealthBillâ,
+ "status":"SUBMITTEDâ,
+ "tagsâ: {"tag":["related=ushealthcare","department=billingDepartment"]},
+ "clusters": {"cluster":["SampleCluster1","primaryClusterâ]}
+ },
+ {
+ "type":"PROCESSâ,
+ "name":"SampleHealthBillâ,
+ "status":"SUBMITTEDâ,
+ "tagsâ: {"tag":["related=healthcare","department=billingDepartment"]},
+ "clusters": {"cluster":"primaryClusterâ}
+ }
+ ]
+}
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityResume.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityResume.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityResume.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityResume.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,29 @@
+---++ POST /api/entities/resume/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Resume a supended entity.
+
+---++ Parameters
+ * :entity-type can either be a feed or a process.
+ * :entity-name is name of the entity.
+
+---++ Results
+Result of the resume command.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/resume/process/SampleProcess
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "requestId": "default\/106582a9-130f-4903-8b8f-f95d7b286c30\n",
+ "message": "default\/SampleProcess(process) resumed successfully\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySchedule.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySchedule.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySchedule.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySchedule.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,31 @@
+---++ POST /api/entities/schedule/:entity-type/:entity-name?skipDryRun=false
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Schedule an entity.
+
+---++ Parameters
+ * :entity-type can either be a feed or a process.
+ * :entity-name is name of the entity.
+ * skipDryRun : Optional query param, Falcon skips oozie dryrun when value is set to true.
+
+
+---++ Results
+Result of the schedule command.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/schedule/process/SampleProcess
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "requestId": "default\/ee735c95-98bd-41b8-a705-2e78bcfcdcd9\n",
+ "message": "default\/SampleProcess(process) scheduled successfully\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityStatus.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityStatus.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityStatus.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityStatus.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,29 @@
+---++ GET /api/entities/status/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get status of the entity.
+
+---++ Parameters
+ * :entity-type can be cluster, feed or process.
+ * :entity-name is name of the entity.
+
+---++ Results
+Status of the entity.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/entities/status/process/SampleProcess
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "requestId": "default\/4d35b382-852a-4bc7-9972-b9db3493322a\n",
+ "message": "default\/SUBMITTED\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySubmit.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySubmit.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySubmit.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySubmit.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,104 @@
+---++ POST api/entities/submit/:entity-type
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Submit the given entity.
+
+---++ Parameters
+:entity-type can be cluster, feed or process.
+
+---++ Results
+Result of the submission.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/submit/feed
+<?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>
+</verbatim>
+
+---+++ Result
+<verbatim>
+{
+ "requestId": "default\/d72a41f7-6420-487b-8199-62d66e492e35\n",
+ "message": "default\/Submit successful (feed) SampleInput\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
+
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/submit/process
+<?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>
+</verbatim>
+
+---+++ Result
+<verbatim>
+{
+ "requestId": "default\/e5cc8230-f356-4566-9b65-536abdff8aa3\n",
+ "message": "default\/Submit successful (process) SampleProcess\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySubmitAndSchedule.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySubmitAndSchedule.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySubmitAndSchedule.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySubmitAndSchedule.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,63 @@
+---++ POST /api/entities/submitAndSchedule/:entity-type?skipDryRun=false
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Submits and schedules an entity.
+
+---++ Parameters
+ * :entity-type can either be a feed or a process.
+ * skipDryRun : Optional query param, Falcon skips oozie dryrun when value is set to true.
+
+---++ Results
+Result of the submit and schedule command.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/submitAndSchedule/process
+<?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>
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "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"
+}
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySummary.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySummary.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySummary.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySummary.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,73 @@
+---++ GET /api/entities/summary/:entity-type
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Given an EntityType and cluster, get list of entities along with summary of N recent instances of each entity
+
+---++ Parameters
+ * :entity-type Valid options are feed or process.
+ * cluster Show entities that belong to this cluster.
+ * start <optional param> Show entity summaries from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+ * By default, it is set to (end - 2 days).
+ * end <optional param> Show entity summary up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+ * Default is set to now.
+ * fields <optional param> Fields of entity that the user wants to view, separated by commas.
+ * Valid options are STATUS, TAGS, PIPELINES.
+ * filterBy <optional param> Filter results by list of field:value pairs. Example: filterBy=STATUS:RUNNING,PIPELINES:clickLogs
+ * Supported filter fields are NAME, STATUS, PIPELINES, CLUSTER.
+ * Query will do an AND among filterBy fields.
+ * tags <optional param> Return list of entities that have specified tags, separated by a comma. Query will do AND on tag values.
+ * Example: tags=consumer=consumer@xyz.com,owner=producer@xyz.com
+ * orderBy <optional param> Field by which results should be ordered.
+ * Supports ordering by "name".
+ * sortOrder <optional param> Valid options are "asc" and "desc"
+ * offset <optional param> Show results from the offset, used for pagination. Defaults to 0.
+ * numResults <optional param> Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10.
+ * numInstances <optional param> Number of recent instances to show per entity. Only integers > 0 are valid, Default is 7.
+
+---++ Results
+Show entities along with summary of N instances for each entity.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/entities/summary/feed?cluster=primary-cluster&filterBy=STATUS:RUNNING&fields=status&tags=consumer=consumer@xyz.com&orderBy=name&offset=0&numResults=1&numInstances=2
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "entitySummary": [
+ {
+ "name" : "SampleOutput",
+ "type" : "feed",
+ "status": "RUNNING",
+ "instances": [
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "RUNNING",
+ "instance": "2012-04-03T07:00Z"
+ },
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:42:27-07:00",
+ "startTime": "2013-10-21T14:41:57-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W",
+ "status": "RUNNING",
+ "instance": "2012-04-03T08:00Z"
+ },
+ ]
+ }
+ ]
+ "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+ "message": "default\/STATUS\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySuspend.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySuspend.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySuspend.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/EntitySuspend.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,29 @@
+---++ POST /api/entities/suspend/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Suspend 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
+<verbatim>
+POST http://localhost:15000/api/entities/suspend/process/SampleProcess
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "requestId": "default\/fe5f2b6c-1f2e-49fc-af3a-342079f0b46b\n",
+ "message": "default\/SampleProcess(process) suspended successfully\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityTouch.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityTouch.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityTouch.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityTouch.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,30 @@
+---++ POST api/entities/touch/:entity-type/:entity-name?skipDryRun=true
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Force updates the entity.
+
+---++ Parameters
+ * :entity-type can be feed or process.
+ * :entity-name is name of the feed or process.
+ * skipDryRun : Optional query param, Falcon skips oozie dryrun when value is set to true.
+
+---++ Results
+Result of the validation.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/touch/process/SampleProcess
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "requestId": "touch\/default\/d6aaa328-6836-4818-a212-515bb43d8b86\n\n",
+ "message": "touch\/default\/SampleProcess updated successfully\n\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
\ No newline at end of file
Added: falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityUpdate.twiki
URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityUpdate.twiki?rev=1702009&view=auto
==============================================================================
--- falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityUpdate.twiki (added)
+++ falcon/trunk/releases/0.7/src/site/twiki/restapi/EntityUpdate.twiki Wed Sep 9 13:49:51 2015
@@ -0,0 +1,65 @@
+---++ POST api/entities/update/:entity-type/:entity-name?skipDryRun=false
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Updates the submitted entity.
+
+---++ Parameters
+ * :entity-type can be feed or process.
+ * :entity-name is name of the feed or process.
+ * skipDryRun : Optional query param, Falcon skips oozie dryrun when value is set to true.
+
+---++ Results
+Result of the validation.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/update/process/SampleProcess
+<?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>
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "requestId": "update\/default\/d6aaa328-6836-4818-a212-515bb43d8b86\n\n",
+ "message": "update\/default\/SampleProcess updated successfully\n\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
+