http://git-wip-us.apache.org/repos/asf/falcon/blob/82d0e6fc/content/0.3-incubating/docs/FalconArchitecture.html ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/docs/FalconArchitecture.html b/content/0.3-incubating/docs/FalconArchitecture.html new file mode 100644 index 0000000..2cfc48e --- /dev/null +++ b/content/0.3-incubating/docs/FalconArchitecture.html @@ -0,0 +1,551 @@ +<!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=12324423"; class="externalLink" title="Released: 2013-08-15"> + Released: 2013-08-15</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.3-incubating"> + 0.3-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>Contents<a name="Contents"></a></h3> +<p></p> +<ul> +<li><a href="#Architecture">Architecture</a></li> +<li><a href="#Control_flow">Control flow</a></li> +<li><a href="#Modes_Of_Deployment">Modes Of Deployment</a></li> +<li><a href="#Entity_Management_actions">Entity Management actions</a></li> +<li><a href="#Instance_Management_actions">Instance Management actions</a></li> +<li><a href="#Retention">Retention</a></li> +<li><a href="#Replication">Replication</a></li> +<li><a href="#Cross_entity_validations">Cross entity validations</a></li> +<li><a href="#Updating_process_and_feed_definition">Updating process and feed definition</a></li> +<li><a href="#Handling_late_input_data">Handling late input data</a></li> +<li><a href="#Idempotency">Idempotency</a></li> +<li><a href="#Alerting_and_Monitoring">Alerting and Monitoring</a></li> +<li><a href="#Falcon_EL_Expressions">Falcon EL Expressions</a></li></ul></div> +<div class="section"> +<h3>Architecture<a name="Architecture"></a></h3></div> +<div class="section"> +<h4>Introduction<a name="Introduction"></a></h4> +<p>Falcon is a feed and process management platform over hadoop. Falcon essentially transforms user's feed and process configurations into repeated actions through a standard workflow engine (Apache Oozie). Falcon by itself doesn't do any heavy lifting. All the functions and workflow state management requirements are delegated to the workflow scheduler. The only thing that Falcon maintains is the dependencies and relationship between these entities. This is adequate to provide integrated and seamless experience to the developers using the falcon platform.</p></div> +<div class="section"> +<h4>Falcon Architecture - Overview<a name="Falcon_Architecture_-_Overview"></a></h4> +<p><img src="../images/Architecture.png" alt="" /></p></div> +<div class="section"> +<h4>Scheduler<a name="Scheduler"></a></h4> +<p>Falcon system has picked Apache Oozie as the default scheduler. However the system is open for integration with other schedulers. Lot of the data processing in hadoop requires scheduling to be based on both data availability as well as time. Apache Oozie currently supports these capabilities off the shelf and hence the choice.</p></div> +<div class="section"> +<h4>Control flow<a name="Control_flow"></a></h4> +<p>Though the actual responsibility of the workflow is with the scheduler (Oozie), Falcon remains in the execution path, by subscribing to messages that each of the workflow may generate. When Falcon generates a workflow in Oozie, it does so, after instrumenting the workflow with additional steps which includes messaging via JMS. Falcon system itself subscribes to these control messages and can perform actions such as retries, handling late input arrival etc.</p></div> +<div class="section"> +<h5>Feed Schedule flow<a name="Feed_Schedule_flow"></a></h5> +<p><img src="../images/FeedSchedule.png" alt="" /></p></div> +<div class="section"> +<h5>Process Schedule flow<a name="Process_Schedule_flow"></a></h5> +<p><img src="../images/ProcessSchedule.png" alt="" /></p></div> +<div class="section"> +<h3>Modes Of Deployment<a name="Modes_Of_Deployment"></a></h3> +<p>There are two basic components of Falcon set up. Falcon Prism and Falcon Server. As the name suggests Falcon Prism splits the request it gets to the Falcon Servers. More details below:</p></div> +<div class="section"> +<h4>Stand Alone Mode<a name="Stand_Alone_Mode"></a></h4> +<p>Stand alone mode is useful when the hadoop jobs and relevant data processing involves only one hadoop cluster. In this mode there is single Falcon server that contacts with oozie to schedule jobs on Hadoop. All the process / feed request like submit, schedule, suspend, kill are sent to this server only. For running in this mode one should use the falcon which has been built for standalone mode, or build using standalone option if using source code.</p></div> +<div class="section"> +<h4>Distributed Mode<a name="Distributed_Mode"></a></h4> +<p>Distributed mode is the mode which you might me using most of the time. This is for orgs which have multiple instances of hadoop clusters, and multiple workflow schedulers to handle them. Here we have 2 components: Prism and Server. Both Prism and server have there own setup (runtime and startup properties) and there config locations. In this mode Prism acts as a contact point for Falcon servers. Below are the requests that can be sent to prism and server in this mode:</p> +<p>Prism: submit, schedule, submitAndSchedule, Suspend, Resume, Kill, instance management Server: schedule, suspend, resume, instance management</p> +<p>As observed above submit and kill are kept exclusively as Prism operations to keep all the config stores in sync and to support feature of idempotency. Request may also be sent from prism but directed to a specific server using the option "-colo" from CLI or append the same in web request, if using API.</p> +<p>When a cluster is submitted it is by default sent to all the servers configured in the prism. When is feed is SUBMIT / SCHEDULED request is only sent to the servers specified in the feed / process definitions. Servers are mentioned in the feed / process via CLUSTER tags in xml definition.</p></div> +<div class="section"> +<h5>Prism Setup<a name="Prism_Setup"></a></h5> +<p><img src="../images/PrismSetup.png" alt="" /></p></div> +<div class="section"> +<h4>Configuration Store<a name="Configuration_Store"></a></h4> +<p>Configuration store is file system based store that the Falcon system maintains where the entity definitions are stored. File System used for the configuration store can either be a local file system or HDFS file system. It is recommended that the store be maintained outside of the system where Falcon is deployed. This is needed for handling issues relating to disk failures or other permanent failures of the system where Falcon is deployed. Configuration store also maintains an archive location where prior versions of the configuration or deleted configurations are maintained. They are never accessed by the Falcon system and they merely serve to track historical changes to the entity definitions.</p></div> +<div class="section"> +<h4>Atomic Actions<a name="Atomic_Actions"></a></h4> +<p>Often times when Falcon performs entity management actions, it may need to do several individual actions. If one of the action were to fail, then the system could be in an inconsistent state. To avoid this, all individual operations performed are recorded into a transaction journal. This journal is then used to undo the overall user action. In some cases, it is not possible to undo the action. In such cases, Falcon attempts to keep the system in an consistent state.</p></div> +<div class="section"> +<h3>Entity Management actions<a name="Entity_Management_actions"></a></h3></div> +<div class="section"> +<h4>Submit<a name="Submit"></a></h4> +<p>Entity submit action allows a new cluster/feed/process to be setup within Falcon. Submitted entity is not scheduled, meaning it would simply be in the configuration store within Falcon. Besides validating against the schema for the corresponding entity being added, the Falcon system would also perform inter-field validations within the configuration file and validations across dependent entities.</p></div> +<div class="section"> +<h4>List<a name="List"></a></h4> +<p>List all the entities within the falcon config store for the entity type being requested. This will include both scheduled and submitted entity configurations.</p></div> +<div class="section"> +<h4>Dependency<a name="Dependency"></a></h4> +<p>Returns the dependencies of the requested entity. Dependency list include both forward and backward dependencies (depends on & is dependent on). For example, a feed would show process that are dependent on the feed and the clusters that it depends on.</p></div> +<div class="section"> +<h4>Schedule<a name="Schedule"></a></h4> +<p>Feeds or Processes that are already submitted and present in the config store can be scheduled. Upon schedule, Falcon system wraps the required repeatable action as a bundle of oozie coordinators and executes them on the Oozie scheduler. (It is possible to extend Falcon to use an alternate workflow engine other than Oozie). Falcon overrides the workflow instance's external id in Oozie to reflect the process/feed and the nominal time. This external Id can then be used for instance management functions.</p></div> +<div class="section"> +<h4>Suspend<a name="Suspend"></a></h4> +<p>This action is applicable only on scheduled entity. This triggers suspend on the oozie bundle that was scheduled earlier through the schedule function. No further instances are executed on a suspended process/feed.</p></div> +<div class="section"> +<h4>Resume<a name="Resume"></a></h4> +<p>Puts a suspended process/feed back to active, which in turn resumes applicable oozie bundle.</p></div> +<div class="section"> +<h4>Status<a name="Status"></a></h4> +<p>Gets the current status of the entity.</p></div> +<div class="section"> +<h4>Definition<a name="Definition"></a></h4> +<p>Gets the current entity definition as stored in the configuration store. Please note that user documentations in the entity will not be retained.</p></div> +<div class="section"> +<h4>Delete<a name="Delete"></a></h4> +<p>Delete operation on the entity removes any scheduled activity on the workflow engine, besides removing the entity from the falcon configuration store. Delete operation on an entity would only succeed if there are no dependent entities on the deleted entity.</p></div> +<div class="section"> +<h4>Update<a name="Update"></a></h4> +<p>Update operation allows an already submitted/scheduled entity to be updated. Cluster update is currently not allowed. Feed update can cause cascading update to all the processes already scheduled. The following set of actions are performed in Oozie to realize an update.</p> +<p></p> +<ul> +<li>Suspend the previously scheduled Oozie coordinator. This is prevent any new action from being triggered.</li> +<li>Update the coordinator to set the end time to "now"</li> +<li>Resume the suspended coordinators</li> +<li>Schedule as per the new process/feed definition with the start time as "now"</li></ul></div> +<div class="section"> +<h3>Instance Management actions<a name="Instance_Management_actions"></a></h3> +<p>Instance Manager gives user the option to control individual instances of the process based on their instance start time (start time of that instance). Start time needs to be given in standard TZ format. Example: 01 Jan 2012 01:00 => 2012-01-01T01:00Z</p> +<p>All the instance management operations (except running) allow single instance or list of instance within a Date range to be acted on. Make sure the dates are valid. i.e. are within the start and end time of process itself.</p> +<p>For every query in instance management the process name is a compulsory parameter.</p> +<p>Parameters -start and -end are used to mention the date range within which you want the instance to be operated upon.</p> +<p>-start: using only "-start" without "-end" will conduct the desired operation only on single instance given by date along with start.</p> +<p>-end: "-end" can only be used along with "-start" . It corresponds to the end date till which instance need to operated upon.</p> +<p></p> +<ul> +<li>1. <b>status</b>: -status option via CLI can be used to get the status of a single or multiple instances. If the instance is not yet materialized but is within the process validity range, WAITING is returned as the state. Along with the status of the instance log location is also returned.</li></ul> +<p></p> +<ul> +<li>2. <b>running</b>: -running returns all the running instance of the process. It does not take any start or end dates but simply return all the instances in state RUNNING at that given time.</li></ul> +<p></p> +<ul> +<li>3. <b>rerun</b>: -rerun is the option that you will use most often from instance management. As the name suggest this option is used to rerun a particular instance or instances of the process. The rerun option reruns all parent workflow for the instance, which in turn rerun all the sub-workflows for it. This option is valid for any instance in terminal state, i.e. KILLED, SUCCEEDED, FAILED. User can also set properties in the request, which will give options what types of actions should be rerun like, only failed, run all etc. These properties are dependent on the workflow engine being used along with falcon.</li></ul> +<p></p> +<ul> +<li>4. <b>suspend</b>: -suspend is used to suspend a instance or instances for the given process. This option pauses the parent workflow at the state, which it was in at the time of execution of this command. This command is similar to SUSPEND process command in functionality only difference being, SUSPEND process suspends all the instance whereas suspend instance suspend only that instance or instances in the range.</li></ul> +<p></p> +<ul> +<li>5. <b>resume</b>: -resume option is used to resume any instance that is in suspended state. (Note: due to a bug in oozie �resume option in some cases may not actually resume the suspended instance/ instances)</li> +<li>6. <b>kill</b>: -kill option can be used to kill an instance or multiple instances</li></ul> +<p>In all the cases where your request is syntactically correct but logically not, the instance / instances are returned with the same status as earlier. Example: trying to resume a KILLED / SUCCEEDED instance will return the instance with KILLED / SUCCEEDED, without actually performing any operation. This is so because only an instance in SUSPENDED state can be resumed. Same thing is valid for rerun a SUSPENDED or RUNNING options etc.</p></div> +<div class="section"> +<h3>Retention<a name="Retention"></a></h3> +<p>In coherence with it's feed lifecycle management philosophy, Falcon allows the user to retain data in the system for a specific period of time for a scheduled feed. The user can specify the retention period in the respective feed/data xml in the following manner for each cluster the feed can belong to :</p> +<div class="source"> +<pre> +<clusters> + <cluster name="corp" type="source"> + <validity start="2012-01-30T00:00Z" end="2013-03-31T23:59Z" + timezone="UTC" /> + <retention limit="hours(10)" action="delete" /> + </cluster> + </clusters> + +</pre></div> +<p>The 'limit' attribute can be specified in units of minutes/hours/days/months, and a corresponding numeric value can be attached to it. It essentially instructs the system to retain data spanning from the current moment to the time specified in the attribute spanning backwards in time. Any data beyond the limit (past/future) is erased from the system.</p></div> +<div class="section"> +<h4>Example:<a name="Example:"></a></h4> +<p>If retention period is 10 hours, and the policy kicks in at time 't', the data retained by system is essentially the one falling in between [t-10h,t]. Any data in the boundaries [-�,t-10h) and (t,�] is removed from the system.</p> +<p>The 'action' attribute can attain values of DELETE/ARCHIVE. Based upon the tag value, the data eligible for removal is either deleted/archived.</p></div> +<div class="section"> +<h4>NOTE: Falcon 0.1/0.2 releases support Delete operation only<a name="NOTE:_Falcon_0.10.2_releases_support_Delete_operation_only"></a></h4></div> +<div class="section"> +<h4>When does retention policy come into play, aka when is retention really performed?<a name="When_does_retention_policy_come_into_play_aka_when_is_retention_really_performed"></a></h4> +<p>Retention policy in Falcon kicks off on the basis of the time value specified by the user. Here are the basic rules:</p> +<p></p> +<ul> +<li>If the retention policy specified is less than 24 hours: In this event, the retention policy automatically kicks off every 6 hours.</li> +<li>If the retention policy specified is more than 24 hours: In this event, the retention policy automatically kicks off every 24 hours.</li> +<li>As soon as a feed is successfully scheduled: the retention policy is triggered immediately regardless of the current timestamp/state of the system.</li></ul> +<p>Relation between feed path and retention policy: Retention policy for a particular scheduled feed applies only to the eligible feed path specified in the feed xml. Any other paths that do not conform to the specified feed path are left unaffected by the retention policy.</p></div> +<div class="section"> +<h3>Replication<a name="Replication"></a></h3> +<p>Falcon's feed lifecycle management also supports Feed replication across different clusters out-of-the-box. Multiple source clusters and target clusters can be defined in feed definition. Falcon replicates the data using hadoop's distcp version 2 across different clusters whenever a feed is scheduled.</p> +<p>The frequency at which the data is replicated is governed by the frequency specified in the feed definition. Ideally, the feeds data path should have the same granularity as that for frequency of the feed, i.e. if the frequency of the feed is hours(3), then the data path should be to level /${YEAR}/${MONTH}/${DAY}/${HOUR}.</p> +<div class="source"> +<pre> + <clusters> + <cluster name="sourceCluster1" type="source" partition="${cluster.name}" delay="minutes(40)"> + <validity start="2021-11-01T00:00Z" end="2021-12-31T00:00Z"/> + </cluster> + <cluster name="sourceCluster2" type="source" partition="COUNTRY/${cluster.name}"> + <validity start="2021-11-01T00:00Z" end="2021-12-31T00:00Z"/> + </cluster> + <cluster name="backupCluster" type="target"> + <validity start="2011-11-01T00:00Z" end="2011-12-31T00:00Z"/> + </cluster> + </clusters> + +</pre></div> +<p>If more than 1 source cluster is defined, then partition expression is compulsory, a partition can also have a constant. The expression is required to avoid copying data from different source location to the same target location, also only the data in the partition is considered for replication if it is present. The partitions defined in the cluster should be less than or equal to the number of partition declared in the feed definition.</p> +<p>Falcon uses pull based replication mechanism, meaning in every target cluster, for a given source cluster, a coordinator is scheduled which pulls the data using distcp from source cluster. So in the above example, 2 coordinators are scheduled in backupCluster, one which pulls the data from sourceCluster1 and another from sourceCluster2. Also, for every feed instance which is replicated Falcon sends a JMS message on success or failure of replication instance.</p> +<p>Replication can be scheduled with the past date, the time frame considered for replication is the minimum overlapping window of start and end time of source and target cluster, ex: if s1 and e1 is the start and end time of source cluster respectively, and s2 and e2 of target cluster, then the coordinator is scheduled in target cluster with start time max(s1,s2) and min(e1,e2).</p> +<p>A feed can also optionally specify the delay for replication instance in the cluster tag, the delay governs the replication instance delays. If the frequency of the feed is hours(2) and delay is hours(1), then the replication instance will run every 2 hours and replicates data with an offset of 1 hour, i.e. at 09:00 UTC, feed instance which is eligible for replication is 08:00; and 11:00 UTC, feed instance of 10:00 UTC is eligible and so on.</p></div> +<div class="section"> +<h4>Where is the feed path defined?<a name="Where_is_the_feed_path_defined"></a></h4> +<p>It's defined in the feed xml within the location tag.</p> +<p><b>Example:</b></p> +<div class="source"> +<pre> +<locations> + <location type="data" path="/retention/testFolders/${YEAR}-${MONTH}-${DAY}" /> +</locations> + +</pre></div> +<p>Now, if the above path contains folders in the following fashion:</p> +<p>/retention/testFolders/${YEAR}-${MONTH}-${DAY} /retention/testFolders/${YEAR}-${MONTH}/someFolder</p> +<p>The feed retention policy would only act on the former and not the latter.</p> +<p>Users may choose to override the feed path specific to a cluster, so every cluster may have a different feed path. <b>Example:</b></p> +<div class="source"> +<pre> +<clusters> + <cluster name="testCluster" type="source"> + <validity start="2011-11-01T00:00Z" end="2011-12-31T00:00Z"/> + <locations> + <location type="data" path="/projects/falcon/clicks/${YEAR}-${MONTH}-${DAY}" /> + <location type="stats" path="/projects/falcon/clicksStats/${YEAR}-${MONTH}-${DAY}" /> + <location type="meta" path="/projects/falcon/clicksMetaData/${YEAR}-${MONTH}-${DAY}" /> + </locations> + </cluster> + </clusters> + +</pre></div></div> +<div class="section"> +<h4>Relation between feed's retention limit and feed's late arrival cut off period:<a name="Relation_between_feeds_retention_limit_and_feeds_late_arrival_cut_off_period:"></a></h4> +<p>For reasons that are obvious, Falcon has an external validation that ensures that the user always specifies the feed retention limit to be more than the feed's allowed late arrival period. If this rule is violated by the user, the feed submission call itself throws back an error.</p></div> +<div class="section"> +<h3>Cross entity validations<a name="Cross_entity_validations"></a></h3></div> +<div class="section"> +<h4>Entity Dependencies in a nutshell<a name="Entity_Dependencies_in_a_nutshell"></a></h4> +<p><img src="../images/EntityDependency.png" alt="" /></p> +<p>The above schematic shows the dependencies between entities in Falcon. The arrow in above diagram points from a dependency to the dependent.</p> +<p>Let's just get one simple rule stated here, which we will keep referring to time and again while talking about entities: A dependency in the system cannot be removed unless all it's dependents are removed first. This holds true for all transitive dependencies also.</p> +<p>Now, let's follow it up with a simple illustration of an Falcon Job:</p> +<p>Let's consider a process P that refers to feed F1 as an input feed, and generates feed F2 as an output feed. These feeds/processes are supposed to be associated with a cluster C1.</p> +<p>The order of submission of this job would be in the following order:</p> +<p>C1->F1/F2(in any order)->P</p> +<p>The order of removal of this job from the system is in the exact opposite order, i.e.:</p> +<p>P->F1/F2(in any order)->C1</p> +<p>Please note that there might be multiple process referring to a particular feed, or a single feed belonging to multiple clusters. In that event, any of the dependencies cannot be removed unless ALL of their dependents are removed first. Attempting to do so will result in an error message and a 400 Bad Request operation.</p></div> +<div class="section"> +<h4>Other cross validations between entities in Falcon system<a name="Other_cross_validations_between_entities_in_Falcon_system"></a></h4> +<p><b>Cluster-Feed Cross validations:</b></p> +<p></p> +<ul> +<li>The cluster(s) referenced by feed (inside the <clusters> tag) should be present in the system at the time</li></ul>of submission. Any exception to this results in a feed submission failure. Note that a feed might be referring to more than a single cluster. The identifier for the same is the 'name' attribute for the individual cluster. +<p><b>Example:</b></p> +<p><b>Feed XML:</b></p> +<div class="source"> +<pre> + <clusters> + <cluster name="corp" type="source"> + <validity start="2009-01-01T00:00Z" end="2012-12-31T23:59Z" + timezone="UTC" /> + <retention limit="months(6)" action="delete" /> + </cluster> + </clusters> + +</pre></div> +<p><b>Cluster corp's XML:</b></p> +<div class="source"> +<pre> +<cluster colo="gs" description="" name="corp" xmlns="uri:falcon:cluster:0.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> + +</pre></div> +<p><b>Cluster-Process Cross validations:</b></p> +<p></p> +<ul> +<li>In a similar relationship to that of feed and a cluster, a process also refers to the relevant cluster by the</li></ul>'name' attribute. Any exception results in a process submission failure.</div> +<div class="section"> +<h4>Example:<a name="Example:"></a></h4></div> +<div class="section"> +<h4>Process XML:<a name="Process_XML:"></a></h4> +<div class="source"> +<pre> +<process name="agregator-coord16"> + <cluster name="corp"/>.... + +</pre></div></div> +<div class="section"> +<h4>Cluster corp's XML:<a name="Cluster_corps_XML:"></a></h4> +<div class="source"> +<pre> +<cluster colo="gs" description="" name="corp" xmlns="uri:falcon:cluster:0.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> + +</pre></div> +<p><b>Feed-Process Cross Validations:</b></p> +<p>1. The process <input> and feeds designated as input feeds for the job:</p> +<p>For every feed referenced in the <input> tag in a process definition, following rules are applied when the process is due for submission:</p> +<p></p> +<ul> +<li>The feed having a value associated with the 'feed' attribute in input tag should be present in</li></ul>the system. The corresponding attribute in the feed definition is the 'name' attribute in the <feed> tag. +<p><b>Example:</b></p> +<p><b>Process xml:</b></p> +<div class="source"> +<pre> +<input end-instance="now(0,20)" start-instance="now(0,-60)" +feed="raaw-logs16" name="inputData"/> + +</pre></div> +<p><b>Feed xml:</b></p> +<div class="source"> +<pre> +<feed description="clicks log" name="raaw-logs16".... + +</pre></div> +<p>* The time interpretation for corresponding tags indicating the start and end instances for a particular input feed in the process xml should lie well within the timespan of the period specified in <validity> tag of the particular feed.</p> +<p><b>Example:</b></p> +<p>1. In the following scenario, process submission will result in an error:</p> +<p><b>Process XML:</b></p> +<div class="source"> +<pre> +<input end-instance="now(0,20)" start-instance="now(0,-60)" + feed="raaw-logs16" name="inputData"/> + +</pre></div> +<p><b>Feed XML:</b></p> +<div class="source"> +<pre> +<validity start="2009-01-01T00:00Z" end="2009-12-31T23:59Z"..... + +</pre></div> +<p>Explanation: The process timelines for the feed range between a 40 minute interval between [-60m,-20m] from the current timestamp (which lets assume is 'today' as per the 'now' directive). However, the feed validity is between a 1 year period in 2009, which makes it anachronistic.</p> +<p>2. The following example would work just fine:</p> +<p><b>Process XML:</b></p> +<div class="source"> +<pre> +<input end-instance="now(0,20)" start-instance="now(0,-60)" + feed="raaw-logs16" name="inputData"/> + +</pre></div> +<p><b>Feed XML:</b></p> +<div class="source"> +<pre> +validity start="2009-01-01T00:00Z" end="2012-12-31T23:59Z" ....... + +</pre></div> +<p>since at the time of charting this document (03/03/2012), the feed validity is able to encapsulate the process input's start and end instances.</p> +<p>Failure to follow any of the above rules would result in a process submission failure.</p> +<p><b>NOTE:</b> Even though the above check ensures that the timelines are not anachronistic, if the input data is not present in the system for the specified time period, the process can be submitted and scheduled, but all instances created would result in a WAITING state unless data is actually provided in the cluster.</p></div> +<div class="section"> +<h3>Updating process and feed definition<a name="Updating_process_and_feed_definition"></a></h3> +<p>Any changes in feed/process can be done by updating its definition. After the update, any new workflows which are to be scheduled after the update call will pick up the new changes. Feed/process name and start time can't be updated. Updating a process triggers updates to the workflow that is triggered in the workflow engine. Updating feed updates feed workflows like retention, replication etc. and also updates the processes that reference the feed.</p></div> +<div class="section"> +<h3>Handling late input data<a name="Handling_late_input_data"></a></h3> +<p>Falcon system can handle late arrival of input data and appropriately re-trigger processing for the affected instance. From the perspective of late handling, there are two main configuration parameters late-arrival cut-off and late-inputs section in feed and process entity definition that are central. These configurations govern how and when the late processing happens. In the current implementation (oozie based) the late handling is very simple and basic. The falcon system looks at all dependent input feeds for a process and computes the max late cut-off period. Then it uses a scheduled messaging framework, like the one available in Apache ActiveMQ or Java's <a href="./DelayQueue.html">DelayQueue</a> to schedule a message with a cut-off period, then after a cut-off period the message is dequeued and Falcon checks for changes in the feed data which is recorded in HDFS in latedata file by falcons "record-size" action, if it detects any changes then the workflow will be r erun with the new set of feed data.</p> +<p><b>Example:</b> The late rerun policy can be configured in the process definition. Falcon supports 3 policies, periodic, exp-backoff and final. Delay specifies, how often the feed data should be checked for changes, also one needs to explicitly set the feed names in late-input which needs to be checked for late data.</p> +<div class="source"> +<pre> + <late-process policy="exp-backoff" delay="hours(1)"> + <late-input input="impression" workflow-path="hdfs://impression/late/workflow" /> + <late-input input="clicks" workflow-path="hdfs://clicks/late/workflow" /> + </late-process> + +</pre></div></div> +<div class="section"> +<h3>Idempotency<a name="Idempotency"></a></h3> +<p>All the operations in Falcon are Idempotent. That is if you make same request to the falcon server / prism again you will get a SUCCESSFUL return if it was SUCCESSFUL in the first attempt. For example, you submit a new process / feed and get SUCCESSFUL message return. Now if you run the same command / api request on same entity you will again get a SUCCESSFUL message. Same is true for other operations like schedule, kill, suspend and resume. Idempotency also by takes care of the condition when request is sent through prism and fails on one or more servers. For example prism is configured to send request to 3 servers. First user sends a request to SUBMIT a process on all 3 of them, and receives a response SUCCESSFUL from all of them. Then due to some issue one of the servers goes down, and user send a request to schedule the submitted process. This time he will receive a response with PARTIAL status and a FAILURE message from the server that has gone down. If the users check he wi ll find the process would have been started and running on the 2 SUCCESSFUL servers. Now the issue with server is figured out and it is brought up. Sending the SCHEDULE request again through prism will result in a SUCCESSFUL response from prism as well as other three servers, but this time PROCESS will be SCHEDULED only on the server which had failed earlier and other two will keep running as before.</p></div> +<div class="section"> +<h3>Alerting and Monitoring<a name="Alerting_and_Monitoring"></a></h3></div> +<div class="section"> +<h4>Alerting<a name="Alerting"></a></h4> +<p>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.</p> +<p>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.</p> +<p>The following events are captured by Falcon for logging the metrics:</p> +<ol style="list-style-type: decimal"> +<li>New cluster definitions posted to Falcon (success & failures)</li> +<li>New feed definition posted to Falcon (success & failures)</li> +<li>New process definition posted to Falcon (success & failures)</li> +<li>Process update events (success & failures)</li> +<li>Feed update events (success & failures)</li> +<li>Cluster update events (success & failures)</li> +<li>Process suspend events (success & failures)</li> +<li>Feed suspend events (success & failures)</li> +<li>Process resume events (success & failures)</li> +<li>Feed resume events (success & failures)</li> +<li>Process remove events (success & failures)</li> +<li>Feed remove events (success & failures)</li> +<li>Cluster remove events (success & failures)</li> +<li>Process instance kill events (success & failures)</li> +<li>Process instance re-run events (success & failures)</li> +<li>Process instance generation events</li> +<li>Process instance failure events</li> +<li>Process instance auto-retry events</li> +<li>Process instance retry exhaust events</li> +<li>Feed instance deletion event</li> +<li>Feed instance deletion failure event (no retries)</li> +<li>Feed instance replication event</li> +<li>Feed instance replication failure event</li> +<li>Feed instance replication auto-retry event</li> +<li>Feed instance replication retry exhaust event</li> +<li>Feed instance late arrival event</li> +<li>Feed instance post cut-off arrival event</li> +<li>Process re-run due to late feed event</li> +<li>Transaction rollback failed event</li></ol> +<p>The metric logged for an event has the following properties:</p> +<ol style="list-style-type: decimal"> +<li>Action - Name of the event.</li> +<li>Dimensions - A list of name/value pairs of various attributes for a given action.</li> +<li>Status- Status of an action FAILED/SUCCEEDED.</li> +<li>Time-taken - Time taken in nano seconds for a given action.</li></ol> +<p>An example for an event logged for a submit of a new process definition:</p> +<p>2012-05-04 12:23:34,026 {Action:submit, Dimensions:{entityType=process}, Status: SUCCEEDED, Time-taken:97087000 ns}</p> +<p>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.</p></div> +<div class="section"> +<h4>Notifications<a name="Notifications"></a></h4> +<p>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.</p> +<p>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 <a href="./MapMessage.html">MapMessage</a> sent to a topic has the following properties: entityName, feedNames, feedInstancePath, workflowId, runId, nominalTime, timeStamp, brokerUrl, brokerImplClass, entityType, operation, logFile, topicName, status, brokerTTL;</p> +<p>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 <a href="./MapMessage.html">MapMessage</a> sent to a topic has the following properties: entityName, feedNames, feedInstancePath, workflowId, runId, nominalTime, timeStamp, brokerUrl, brokerImplClass, entityType, operation, logFile, topicName, status, brokerTTL;</p> +<p>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.</p></div> +<div class="section"> +<h3>Falcon EL Expressions<a name="Falcon_EL_Expressions"></a></h3> +<p>Falcon expression language can be used in process definition for giving the start and end instance for various feeds.</p> +<p>Before going into how to use falcon EL expressions it is necessary to understand what does instance and instance start time refer to with respect to Falcon.</p> +<p>Lets consider a part of process definition below:</p> +<div class="source"> +<pre> +<?xml version="1.0" encoding="UTF-8" standalone="yes"?> +<process name="testProcess"> + <clusters> + <cluster name="corp"> + <validity start="2010-01-02T01:00Z" end="2011-01-03T03:00Z" /> + </cluster> + </clusters> + <parallel>2</parallel> + <order>LIFO</order> + <timeout>hours(3)</timeout> + <frequency>minutes(30)</frequency> + + <inputs> + <input end-instance="now(0,20)" start-instance="now(0,-60)" + feed="input-log" name="inputData"/> + </inputs> +<outputs> + <output instance="now(0,0)" feed="output-log" + name="outputData" /> +</outputs> +... +... +... +... +</process> + +</pre></div> +<p>The above definition says that the process will start at 2nd of Jan 2010 at 1 am and will end at 3rd of Jan 2011 at 3 am on cluster corp. Also process will start a user-defined workflow (which we will call instance) every 30 mins.</p> +<p>This means starting 2010-01-02T01:00Z every 30 mins a instance will start will run user defined workflow. Now if this workflow needs some input data and produce some output, user needs to give that in <inputs> and <outputs> tags. Since the inputs that the process takes can be distributed over a wide range we use the limits by giving "start" and "end" instance for input. Output is only one location so only instance is given. The timeout specifies, the how long a given instance should wait for input data before being terminated by the workflow engine.</p> +<p>Coming back to instance start time, since a instance will start every 30 mins starting 2010-01-02T01:00Z, the time it is scheduled to start is called its instance time. For example first few instance time for above example are:</p> +<p><pre>Instance Number instance start Time</pre></p> +<p><pre>1 2010-01-02T01:00Z</pre> <pre>2 2010-01-02T01:30Z</pre> <pre>3 2010-01-02T02:00Z</pre> <pre>4 2010-01-02T02:30Z</pre> <pre>. .</pre> <pre>. .</pre> <pre>. .</pre> <pre>. .</pre></p> +<p>Now lets go to how to use expression language. Only thing to keep in mind is all EL evaluation are done based on the start time of that instance, and very instance will have different inputs / outputs based on the feed instance given in process definition.</p> +<p>All the parameters in various El can be both positive, zero or negative values. Positive values indicate so many units in future, zero means the base time EL has been resolved to, and negative values indicate corresponding units in past.</p> +<p><b><i>Note: if no instance is created at the resolved time, then the instance immediately before it is considered.</i></b></p> +<p>Falcon currently support following ELs:</p> +<p></p> +<ul> +<li>1. <b>now(hours,minutes)</b>: now refer to the instance start time. Hours and minutes given are in reference with the start time of instance. For example now(-2,40) corresponds to feed instance at -2 hr and +40 minutes i.e. feed instance 80 mins before the instance start time. Id user would have given now(0,-80) it would have correspond to the same.</li> +<li>2. <b>today(hours,minutes)</b>: hours and minutes given in this EL corresponds to instance from the start day of instance start time. Ie. If instance start is at 2010-01-02T01:30Z then today(-3,-20) will mean instance created at 2010-01-01T20:40 and today(3,20) will correspond to 2010-01-02T3:20Z.</li></ul> +<p></p> +<ul> +<li>3. <b>yesterday(hours,minutes)</b>: As the name suggest EL yesterday picks up feed instances with respect to start of day yesterday. Hours and minutes are added to the 00 hours starting yesterday, Example: yesterday(24,30) will actually correspond to 00:30 am of today, for 2010-01-02T01:30Z this would mean 2010-01-02:00:30 feed.</li></ul> +<p></p> +<ul> +<li>4. <b>currentMonth(day,hour,minute)</b>: Current month takes the reference to start of the month with respect to instance start time. One thing to keep in mind is that day is added to the first day of the month. So the value of day is the number of days you want to add to the first day of the month. For example: for instance start time 2010-01-12T01:30Z and El as currentMonth(3,2,40) will correspond to feed created at 2010-01-04T02:40Z and currentMonth(0,0,0) will mean 2010-01-01T00:00Z.</li></ul> +<p></p> +<ul> +<li>5. <b>lastMonth(day,hour,minute)</b>: Parameters for lastMonth is same as currentMonth, only difference being the reference is shifted to one month back. For instance start 2010-01-12T01:30Z lastMonth(2,3,30) will correspond to feed instance at 2009-12-03:T03:30Z</li></ul> +<p></p> +<ul> +<li>6. <b>currentYear(month,day,hour,minute)</b>: The month,day,hour, minutes in the pareamter are added with reference to the start of year of instance start time. For our exmple start time 2010-01-02:00:30 reference will go back to 2010-01-01:T00:00Z. Also similar to days, months are added to the 1st month that Jan. So currentYear(0,2,2,20) will mean 2010-01-03T02:20Z while currentYear(11,2,2,20) will mean 2010-12-03T02:20Z</li></ul> +<p></p> +<ul> +<li>7. <b>lastYear(month,day,hour,minute)</b>: This is exactly similary to currentYear in usage> only difference being start reference is taken to start of previous year. For example: lastYear(4,2,2,20) will corrospond to feed insatnce created at 2009-05-03T02:20Z and lastYear(12,2,2,20) will corrospond to feed at 2010-01-03T02:20Z.</li></ul> +<p></p> +<ul> +<li>8. <b>latest(number of latest instance)</b>: This will simply make you input consider the number of latest available instance of the feed given as parameter. For example: latest(0) will consider the last available instance of feed, where as latest latest(-1) will consider second last available feed and latest(-3) will consider 4th last available feed.</li></ul></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.3-incubating/docs/FalconCLI.html ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/docs/FalconCLI.html b/content/0.3-incubating/docs/FalconCLI.html new file mode 100644 index 0000000..2d5a6ef --- /dev/null +++ b/content/0.3-incubating/docs/FalconCLI.html @@ -0,0 +1,322 @@ +<!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 - FalconCLI</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="">FalconCLI</li> + + + + + + <li class="pull-right"> <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314429&version=12324423"; class="externalLink" title="Released: 2013-08-15"> + Released: 2013-08-15</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.3-incubating"> + 0.3-incubating</a> + </li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h2>FalconCLI<a name="FalconCLI"></a></h2> +<p>FalconCLI is a interface between user and Falcon. It is a command line utility provided by Falcon. FalconCLI supports Entity Management, Instance Management and Admin operations.There is a set of web services that are used by FalconCLI to interact with Falcon.</p></div> +<div class="section"> +<h3>Entity Management Operations<a name="Entity_Management_Operations"></a></h3></div> +<div class="section"> +<h4>Submit<a name="Submit"></a></h4> +<p>Entity submit action allows a new cluster/feed/process to be setup within Falcon. Submitted entity is not scheduled, meaning it would simply be in the configuration store within Falcon. Besides validating against the schema for the corresponding entity being added, the Falcon system would also perform inter-field validations within the configuration file and validations across dependent entities.</p> +<div class="source"> +<pre> +Example: +$FALCON_HOME/bin/falcon entity -submit -type cluster -file /cluster/definition.xml + +</pre></div> +<p>Note: The url option in the above and all subsequent commands is optional. If not mentioned it will be picked from client.properties file. If the option is not provided and also not set in client.properties, Falcon CLI will fail.</p></div> +<div class="section"> +<h4>Schedule<a name="Schedule"></a></h4> +<p>Feeds or Processes that are already submitted and present in the config store can be scheduled. Upon schedule, Falcon system wraps the required repeatable action as a bundle of oozie coordinators and executes them on the Oozie scheduler. (It is possible to extend Falcon to use an alternate workflow engine other than Oozie). Falcon overrides the workflow instance's external id in Oozie to reflect the process/feed and the nominal time. This external Id can then be used for instance management functions.</p> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon entity -type [process|feed] -name <<name>> -schedule + +Example: +$FALCON_HOME/bin/falcon entity -type process -name sampleProcess -schedule + +</pre></div></div> +<div class="section"> +<h4>Suspend<a name="Suspend"></a></h4> +<p>This action is applicable only on scheduled entity. This triggers suspend on the oozie bundle that was scheduled earlier through the schedule function. No further instances are executed on a suspended process/feed.</p> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon entity -type [feed|process] -name <<name>> -suspend + +</pre></div></div> +<div class="section"> +<h4>Resume<a name="Resume"></a></h4> +<p>Puts a suspended process/feed back to active, which in turn resumes applicable oozie bundle.</p> +<div class="source"> +<pre> +Usage: + $FALCON_HOME/bin/falcon entity -type [feed|process] -name <<name>> -resume + +</pre></div></div> +<div class="section"> +<h4>Delete<a name="Delete"></a></h4> +<p>Delete operation on the entity removes any scheduled activity on the workflow engine, besides removing the entity from the falcon configuration store. Delete operation on an entity would only succeed if there are no dependent entities on the deleted entity.</p> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon entity -type [cluster|feed|process] -name <<name>> -delete + +</pre></div></div> +<div class="section"> +<h4>List<a name="List"></a></h4> +<p>List all the entities within the falcon config store for the entity type being requested. This will include both scheduled and submitted entity configurations.</p> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon entity -type [cluster|feed|process] -list + +</pre></div></div> +<div class="section"> +<h4>Update<a name="Update"></a></h4> +<p>Update operation allows an already submitted/scheduled entity to be updated. Cluster update is currently not allowed. Feed update can cause cascading update to all the processes already scheduled. The following set of actions are performed in Oozie to realize an update.</p> +<p></p> +<ul> +<li>Suspend the previously scheduled Oozie coordinator. This is prevent any new action from being triggered.</li> +<li>Update the coordinator to set the end time to "now"</li> +<li>Resume the suspended coordiantors</li> +<li>Schedule as per the new process/feed definition with the start time as "now"</li></ul> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon entity -type [feed|process] -name <<name>> -update + +</pre></div></div> +<div class="section"> +<h4>Status<a name="Status"></a></h4> +<p>Status returns the current status of the entity.</p> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon entity -type [cluster|feed|process] -name <<name>> -status + +</pre></div></div> +<div class="section"> +<h4>Dependency<a name="Dependency"></a></h4> +<p>Returns the dependencies of the requested entity. Dependency list include both forward and backward dependencies (depends on & is dependent on). For ex, a feed would show process that are dependent on the feed and the clusters that it depends on.'</p> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon entity -type [cluster|feed|process] -name <<name>> -dependency + +</pre></div></div> +<div class="section"> +<h4>Definition<a name="Definition"></a></h4> +<p>Gets the current entity definition as stored in the configuration store. Please note that user documentations in the entity will not be retained.</p> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon entity -type [cluster|feed|process] -name <<name>> -definition + +</pre></div></div> +<div class="section"> +<h3>Instance Management Options<a name="Instance_Management_Options"></a></h3> +<p>Instance Manager gives user the option to control individual instances of the process based on their instance start time (start time of that instance). Start time needs to be given in standard TZ format. Example: 01 Jan 2012 01:00 => 2012-01-01T01:00Z</p> +<p>All the instance management operations (except running) allow single instance or list of instance within a Date range to be acted on. Make sure the dates are valid. i.e are within the start and end time of process itself.</p> +<p>For every query in instance management the process name is a compulsory parameter.</p> +<p>Parameters -start and -end are used to mention the date range within which you want the instance to be operated upon.</p> +<p>-start: using only "-start" without "-end" will conduct the desired operation only on single instance given by date along with start.</p> +<p>-end: "-end" can only be used along with "-start" . It corresponds to the end date till which instance need to operated upon.</p> +<p></p> +<ul> +<li>1. <b>status</b>: -status option via CLI can be used to get the status of a single or multiple instances. If the instance is not yet materialized but is within the process validity range, WAITING is returned as the state.Along with the status of the instance log location is also returned.</li></ul> +<p></p> +<ul> +<li>2. <b>running</b>: -running returns all the running instance of the process. It does not take any start or end dates but simply return all the instances in state RUNNING at that given time.</li></ul> +<p></p> +<ul> +<li>3. <b>rerun</b>: -rerun is the option that you will use most often from instance management. As the name suggest this option is used to rerun a particular instance or instances of the process. The rerun option reruns all parent workflow for the instance, which in turn rerun all the sub-workflows for it. This option is valid for any instance in terminal state, i.e. KILLED, SUCCEEDED, FAILED. User can also set properties in the request, which will give options what types of actions should be rerun like, only failed, run all etc. These properties are dependent on the workflow engine being used along with falcon.</li></ul> +<p></p> +<ul> +<li>4. <b>suspend</b>: -suspend is used to suspend a instance or instances for the given process. This option pauses the parent workflow at the state, which it was in at the time of execution of this command. This command is similar to SUSPEND process command in functionality only difference being, SUSPEND process suspends all the instance whereas suspend instance suspend only that instance or instances in the range.</li></ul> +<p></p> +<ul> +<li>5. <b>resume</b>: -resume option is used to resume any instance that is in suspended state. (Note: due to a bug in oozie �resume option in some cases may not actually resume the suspended instance/ instances)</li> +<li>6. <b>kill</b>: -kill option can be used to kill an instance or multiple instances</li></ul> +<p>In all the cases where your request is syntactically correct but logically not, the instance / instances are returned with the same status as earlier. Example: trying to resume a KILLED / SUCCEEDED instance will return the instance with KILLED / SUCCEEDED, without actually performing any operation. This is so because only an instance in SUSPENDED state can be resumed. Same thing is valid for rerun a SUSPENDED or RUNNING options etc.</p></div> +<div class="section"> +<h4>Status<a name="Status"></a></h4> +<p>Status option via CLI can be used to get the status of a single or multiple instances. If the instance is not yet materialized but is within the process validity range, WAITING is returned as the state. Along with the status of the instance time is also returned. Log location gives the oozie workflow url If the instance is in WAITING state, missing dependencies are listed</p> +<p>Example : Suppose a process has 3 instance, one has succeeded,one is in running state and other one is waiting, the expected output is:</p> +<p>{"status":"SUCCEEDED","message":"getStatus is successful","instances":[{"instance":"2012-05-07T05:02Z","status":"SUCCEEDED","logFile":"http://oozie-dashboard-url"},{"instance":"2012-05-07T05:07Z","status":"RUNNING","logFile":"http://oozie-dashboard-url"}, {"instance":"2010-01-02T11:05Z","status":"WAITING"}]</p> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -status -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" + +</pre></div></div> +<div class="section"> +<h4>Kill<a name="Kill"></a></h4> +<p>Kill sub-command is used to kill all the instances of the specified process whose nominal time is between the given start time and end time.</p> +<p>Note: 1. For all the instance management sub-commands, if end time is not specified, Falcon will perform the actions on all the instances whose instance time falls after the start time.</p> +<p>2. The start time and end time needs to be specified in TZ format. Example: 01 Jan 2012 01:00 => 2012-01-01T01:00Z</p> +<p>3. Process name is compulsory parameter for each instance management command.</p> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -kill -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" + +</pre></div></div> +<div class="section"> +<h4>Suspend<a name="Suspend"></a></h4> +<p>Suspend is used to suspend a instance or instances for the given process. This option pauses the parent workflow at the state, which it was in at the time of execution of this command.</p> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -suspend -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" + +</pre></div></div> +<div class="section"> +<h4>Continue<a name="Continue"></a></h4> +<p>Continue option is used to continue the failed workflow instance. This option is valid only for process instances in terminal state, i.e. SUCCEDDED, KILLED or FAILED.</p> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -re-run -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" + +</pre></div></div> +<div class="section"> +<h4>Rerun<a name="Rerun"></a></h4> +<p>Rerun option is used to rerun instances of a given process. This option is valid only for process instances in terminal state, i.e. SUCCEDDED, KILLED or FAILED. Optionally, you can specify the properties to override.</p> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -re-run -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" [-file <<properties file>>] + +</pre></div></div> +<div class="section"> +<h4>Resume<a name="Resume"></a></h4> +<p>Resume option is used to resume any instance that is in suspended state.</p> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -resume -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" + +</pre></div></div> +<div class="section"> +<h4>Running<a name="Running"></a></h4> +<p>Running option provides all the running instances of the mentioned process.</p> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -running + +</pre></div></div> +<div class="section"> +<h4>Logs<a name="Logs"></a></h4> +<p>Get logs for instance actions</p> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -logs -start "yyyy-MM-dd'T'HH:mm'Z'" [-end "yyyy-MM-dd'T'HH:mm'Z'"] [-runid <<runid>>] + +</pre></div></div> +<div class="section"> +<h3>Admin Options<a name="Admin_Options"></a></h3></div> +<div class="section"> +<h4>Help<a name="Help"></a></h4> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon admin -version + +</pre></div></div> +<div class="section"> +<h4>Version<a name="Version"></a></h4> +<p>Version returns the current verion of Falcon installed.</p> +<div class="source"> +<pre> +Usage: +$FALCON_HOME/bin/falcon admin -help + +</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.3-incubating/docs/InstallationSteps.html ---------------------------------------------------------------------- diff --git a/content/0.3-incubating/docs/InstallationSteps.html b/content/0.3-incubating/docs/InstallationSteps.html new file mode 100644 index 0000000..ef1c00e --- /dev/null +++ b/content/0.3-incubating/docs/InstallationSteps.html @@ -0,0 +1,188 @@ +<!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=12324423"; class="externalLink" title="Released: 2013-08-15"> + Released: 2013-08-15</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.3-incubating"> + 0.3-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> +<p>Download sources from <a class="externalLink" href="http://www.apache.org/dist/incubator/falcon/0.3-incubating/falcon-0.3-incubating-sources.tar.gz";>http://www.apache.org/dist/incubator/falcon/0.3-incubating/falcon-0.3-incubating-sources.tar.gz</a></p> +<div class="source"> +<pre> + +tar -xzvf falcon-0.3-incubating-sources.tar.gz + +cd falcon-0.3-incubating-sources + +export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=256m" && mvn clean assembly:assembly -DskipTests -DskipCheck=true + +[optionally -Dhadoop.version=<<hadoop.version>> can be appended to build for a specific version of hadoop] +[Falcon has currently not been tested with secure Hadoop / Hadoop 2.0] + +Tar can be found in target/falcon-0.3-incubating-bin.tar.gz + +Tar is structured as follows + +<verbatim> + +|- bin + |- falcon + |- falcon-start + |- falcon-stop +|- conf + |- startup.properties + |- runtime.properties + |- client.properties + |- log4j.xml +|- src +|- docs +|- client + |- lib (client support libs) +|- server + |- webapp + |- classes (serer support classes) + |- lib (server support libs) + |- falcon.war +|- logs (application log files & temp data files) + |- falcon.pid + + +</pre></div> +<p>PS: By default the falcon is built for embedded mode.</p></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-0.3-incubating-bin.tar.gz +cd falcon-0.3-incubating-bin + +</pre></div> +<p><b>Starting Falcon Server</b></p> +<div class="source"> +<pre> +bin/falcon-start + +</pre></div> +<p><b>Using Falcon</b></p> +<div class="source"> +<pre> +bin/falcon admin -version +Falcon server build version: {Version:"0.3-incubating-r4380d446a912252a8c173c43a858ab1a38443c47",Mode:"embedded"} + +---- + +bin/falcon help +(for more details about falcon cli usage) + +</pre></div> +<p><b>Stopping Falcon Server</b></p> +<div class="source"> +<pre> +bin/falcon-stop + +</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-3.2.0-incubating/distro/target/oozie-3.2.2-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>
