Return-Path: X-Original-To: apmail-falcon-commits-archive@minotaur.apache.org Delivered-To: apmail-falcon-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 083D117215 for ; Wed, 18 Feb 2015 11:37:31 +0000 (UTC) Received: (qmail 59209 invoked by uid 500); 18 Feb 2015 11:30:51 -0000 Delivered-To: apmail-falcon-commits-archive@falcon.apache.org Received: (qmail 59173 invoked by uid 500); 18 Feb 2015 11:30:51 -0000 Mailing-List: contact commits-help@falcon.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@falcon.apache.org Delivered-To: mailing list commits@falcon.apache.org Received: (qmail 59153 invoked by uid 99); 18 Feb 2015 11:30:51 -0000 Received: from eris.apache.org (HELO hades.apache.org) (140.211.11.105) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 18 Feb 2015 11:30:51 +0000 Received: from hades.apache.org (localhost [127.0.0.1]) by hades.apache.org (ASF Mail Server at hades.apache.org) with ESMTP id B80D7AC0051 for ; Wed, 18 Feb 2015 11:30:50 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1660598 [1/2] - in /falcon/site: ./ 0.3-incubating/docs/ 0.4-incubating/docs/ 0.5-incubating/ 0.6-incubating/ restapi/ Date: Wed, 18 Feb 2015 11:30:49 -0000 To: commits@falcon.apache.org From: sriksun@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20150218113050.B80D7AC0051@hades.apache.org> Author: sriksun Date: Wed Feb 18 11:30:48 2015 New Revision: 1660598 URL: http://svn.apache.org/r1660598 Log: Fixing broken restapi links Modified: falcon/site/0.3-incubating/docs/EntitySpecification.html falcon/site/0.4-incubating/docs/EntitySpecification.html falcon/site/0.4-incubating/docs/FalconArchitecture.html falcon/site/0.4-incubating/docs/InstallationSteps.html falcon/site/0.5-incubating/FalconDocumentation.html falcon/site/0.5-incubating/InstallationSteps.html falcon/site/0.6-incubating/FalconCLI.html falcon/site/0.6-incubating/FalconDocumentation.html falcon/site/0.6-incubating/InstallationSteps.html falcon/site/0.6-incubating/Security.html falcon/site/Appendix.html falcon/site/EntitySpecification.html falcon/site/FalconCLI.html falcon/site/FalconDocumentation.html falcon/site/GettingStarted.html falcon/site/HiveIntegration.html falcon/site/InstallationSteps.html falcon/site/MigrationInstructions.html falcon/site/OnBoarding.html falcon/site/Operability.html falcon/site/Security.html falcon/site/index-new.html falcon/site/index.html falcon/site/issue-tracking.html falcon/site/license.html falcon/site/mail-lists.html falcon/site/project-info.html falcon/site/recipes.html falcon/site/restapi/AdjacentVertices.html falcon/site/restapi/AdminConfig.html falcon/site/restapi/AdminStack.html falcon/site/restapi/AdminVersion.html falcon/site/restapi/AllEdges.html falcon/site/restapi/AllVertices.html falcon/site/restapi/Edge.html falcon/site/restapi/EntityDefinition.html falcon/site/restapi/EntityDelete.html falcon/site/restapi/EntityDependencies.html falcon/site/restapi/EntityLineage.html falcon/site/restapi/EntityList.html falcon/site/restapi/EntityResume.html falcon/site/restapi/EntitySchedule.html falcon/site/restapi/EntityStatus.html falcon/site/restapi/EntitySubmit.html falcon/site/restapi/EntitySubmitAndSchedule.html falcon/site/restapi/EntitySummary.html falcon/site/restapi/EntitySuspend.html falcon/site/restapi/EntityTouch.html falcon/site/restapi/EntityUpdate.html falcon/site/restapi/EntityValidate.html falcon/site/restapi/FeedInstanceListing.html falcon/site/restapi/Graph.html falcon/site/restapi/InstanceKill.html falcon/site/restapi/InstanceList.html falcon/site/restapi/InstanceLogs.html falcon/site/restapi/InstanceParams.html falcon/site/restapi/InstanceRerun.html falcon/site/restapi/InstanceResume.html falcon/site/restapi/InstanceRunning.html falcon/site/restapi/InstanceStatus.html falcon/site/restapi/InstanceSummary.html falcon/site/restapi/InstanceSuspend.html falcon/site/restapi/MetadataList.html falcon/site/restapi/MetadataRelations.html falcon/site/restapi/ResourceList.html falcon/site/restapi/Vertex.html falcon/site/restapi/VertexProperties.html falcon/site/restapi/Vertices.html falcon/site/source-repository.html falcon/site/team-list.html Modified: falcon/site/0.3-incubating/docs/EntitySpecification.html URL: http://svn.apache.org/viewvc/falcon/site/0.3-incubating/docs/EntitySpecification.html?rev=1660598&r1=1660597&r2=1660598&view=diff ============================================================================== --- falcon/site/0.3-incubating/docs/EntitySpecification.html (original) +++ falcon/site/0.3-incubating/docs/EntitySpecification.html Wed Feb 18 11:30:48 2015 @@ -79,7 +79,7 @@
  • Process Specification
  • Cluster Specification

    -

    The Cluster XSD specification is available here:

    +

    The Cluster XSD specification is available here:

    A cluster contains different interfaces which are used by Falcon like readonly, write, workflow and messaging. A cluster is referenced by feeds and processes which are on-boarded to Falcon by its name.

    Following are the tags defined in a cluster.xml:

    @@ -136,7 +136,7 @@

    Ideally JMS impl class name of messaging engine (brokerImplClass) should be defined here.

    Feed Specification

    -

    The [[https://git-wip-us.apache.org/repos/asf?p=incubator-falcon.git;a=blob_plain;f=client/src/main/resources/feed-0.1.xsd;hb=v0.3][Feed XSD specification] is available here.

    +

    The [[https://git-wip-us.apache.org/repos/asf?p=falcon.git;a=blob_plain;f=client/src/main/resources/feed-0.1.xsd;hb=v0.3][Feed XSD specification] is available here.

    a Feed defines various attributes of feed like feed location, frequency, late-arrival handling and retention policies. A feed can be scheduled on a cluster, once a feed is scheduled its retention and replication process are triggered in a given cluster.

    @@ -215,7 +215,7 @@ xmlns:xsi="http://www.w3.org/2001/X
     

    A key-value pair, which are propagated to the workflow engine. "queueName" and "jobPriority" are special properties available to user to specify the hadoop job queue and priority, the same value is used by Falcons launcher job.

    Process Specification

    -

    The Process XSD specification is available here.

    +

    The Process XSD specification is available here.

    A process defines configuration for a workflow. A workflow is a directed acyclic graph(DAG) which defines the job for the workflow engine. A process definition defines the configurations required to run the workflow job. For example, process defines the frequency at which the workflow should run, the clusters on which the workflow should run, the inputs and outputs for the workflow, how the workflow failures should be handled, how the late inputs should be handled and so on.

    The different details of process are:

    Modified: falcon/site/0.4-incubating/docs/EntitySpecification.html URL: http://svn.apache.org/viewvc/falcon/site/0.4-incubating/docs/EntitySpecification.html?rev=1660598&r1=1660597&r2=1660598&view=diff ============================================================================== --- falcon/site/0.4-incubating/docs/EntitySpecification.html (original) +++ falcon/site/0.4-incubating/docs/EntitySpecification.html Wed Feb 18 11:30:48 2015 @@ -79,7 +79,7 @@
  • Process Specification
  • Cluster Specification

    -

    The Cluster XSD specification is available here:

    +

    The Cluster XSD specification is available here:

    A cluster contains different interfaces which are used by Falcon like readonly, write, workflow and messaging. A cluster is referenced by feeds and processes which are on-boarded to Falcon by its name.

    Following are the tags defined in a cluster.xml:

    @@ -142,7 +142,7 @@

    Ideally JMS impl class name of messaging engine (brokerImplClass) should be defined here.

    Feed Specification

    -

    The Feed XSD specification is available here.

    +

    The Feed XSD specification is available here.

    A Feed defines various attributes of feed like feed location, frequency, late-arrival handling and retention policies. A feed can be scheduled on a cluster, once a feed is scheduled its retention and replication process are triggered in a given cluster.

    @@ -283,7 +283,7 @@ catalog:$database-name:$table-name#parti
     

    A key-value pair, which are propagated to the workflow engine. "queueName" and "jobPriority" are special properties available to user to specify the hadoop job queue and priority, the same value is used by Falcons launcher job. "timeout" and "parallel" are other special properties which decides replication instance's timeout value while waiting for the feed instance and parallel decides the concurrent replication instances that can run at any given time.

    Process Specification

    -

    The Process XSD specification is available here.

    +

    The Process XSD specification is available here.

    A process defines configuration for a workflow. A workflow is a directed acyclic graph(DAG) which defines the job for the workflow engine. A process definition defines the configurations required to run the workflow job. For example, process defines the frequency at which the workflow should run, the clusters on which the workflow should run, the inputs and outputs for the workflow, how the workflow failures should be handled, how the late inputs should be handled and so on.

    The different details of process are:

    Modified: falcon/site/0.4-incubating/docs/FalconArchitecture.html URL: http://svn.apache.org/viewvc/falcon/site/0.4-incubating/docs/FalconArchitecture.html?rev=1660598&r1=1660597&r2=1660598&view=diff ============================================================================== --- falcon/site/0.4-incubating/docs/FalconArchitecture.html (original) +++ falcon/site/0.4-incubating/docs/FalconArchitecture.html Wed Feb 18 11:30:48 2015 @@ -170,7 +170,7 @@ catalog:$database-name:$table-name#parti

    Entity Management actions

    -

    All the following operation can also be done using Falcon's RESTful API.

    +

    All the following operation can also be done using Falcon's RESTful API.

    Submit

    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.

    Modified: falcon/site/0.4-incubating/docs/InstallationSteps.html URL: http://svn.apache.org/viewvc/falcon/site/0.4-incubating/docs/InstallationSteps.html?rev=1660598&r1=1660597&r2=1660598&view=diff ============================================================================== --- falcon/site/0.4-incubating/docs/InstallationSteps.html (original) +++ falcon/site/0.4-incubating/docs/InstallationSteps.html Wed Feb 18 11:30:48 2015 @@ -76,7 +76,7 @@

    Building Falcon

    -git clone https://git-wip-us.apache.org/repos/asf/incubator-falcon.git falcon
    +git clone https://git-wip-us.apache.org/repos/asf/falcon.git falcon
     
     cd falcon
     
    
    Modified: falcon/site/0.5-incubating/FalconDocumentation.html
    URL: http://svn.apache.org/viewvc/falcon/site/0.5-incubating/FalconDocumentation.html?rev=1660598&r1=1660597&r2=1660598&view=diff
    ==============================================================================
    --- falcon/site/0.5-incubating/FalconDocumentation.html (original)
    +++ falcon/site/0.5-incubating/FalconDocumentation.html Wed Feb 18 11:30:48 2015
    @@ -173,7 +173,7 @@ catalog:$database-name:$table-name#parti
     

    Entity Management actions

    -

    All the following operation can also be done using Falcon's RESTful API.

    +

    All the following operation can also be done using Falcon's RESTful API.

    Submit

    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.

    Modified: falcon/site/0.5-incubating/InstallationSteps.html URL: http://svn.apache.org/viewvc/falcon/site/0.5-incubating/InstallationSteps.html?rev=1660598&r1=1660597&r2=1660598&view=diff ============================================================================== --- falcon/site/0.5-incubating/InstallationSteps.html (original) +++ falcon/site/0.5-incubating/InstallationSteps.html Wed Feb 18 11:30:48 2015 @@ -76,7 +76,7 @@

    Building Falcon

    -git clone https://git-wip-us.apache.org/repos/asf/incubator-falcon.git falcon
    +git clone https://git-wip-us.apache.org/repos/asf/falcon.git falcon
     
     cd falcon
     
    
    Modified: falcon/site/0.6-incubating/FalconCLI.html
    URL: http://svn.apache.org/viewvc/falcon/site/0.6-incubating/FalconCLI.html?rev=1660598&r1=1660597&r2=1660598&view=diff
    ==============================================================================
    --- falcon/site/0.6-incubating/FalconCLI.html (original)
    +++ falcon/site/0.6-incubating/FalconCLI.html Wed Feb 18 11:30:48 2015
    @@ -102,13 +102,13 @@
     

    Entities of a particular type can be listed with list sub-command.

    Usage: $FALCON_HOME/bin/falcon entity -type [cluster|feed|process] -list

    Optional Args : -fields <<field1,field2>> -filterBy <<field1:value1,field2:value2>> -tags <<tagkey=tagvalue,tagkey=tagvalue>> -orderBy <<field>> -sortOrder <<sortOrder>> -offset 0 -numResults 10

    -

    Optional params described here.

    +

    Optional params described here.

    Summary

    Summary of entities of a particular type and a cluster will be listed. Entity summary has N most recent instances of entity.

    Usage: $FALCON_HOME/bin/falcon entity -type [feed|process] -summary

    Optional Args : -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -fields <<field1,field2>> -filterBy <<field1:value1,field2:value2>> -tags <<tagkey=tagvalue,tagkey=tagvalue>> -orderBy <<field>> -sortOrder <<sortOrder>> -offset 0 -numResults 10 -numInstances 7

    -

    Optional params described here.

    +

    Optional params described here.

    Update

    Update operation allows an already submitted/scheduled entity to be updated. Cluster update is currently not allowed.

    @@ -157,7 +157,7 @@

    {"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"}]

    Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -status

    Optional Args : -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -colo <<colo>> -filterBy <<field1:value1,field2:value2>> -lifecycle <<lifecycles>> -orderBy field -sortOrder <<sortOrder>> -offset 0 -numResults 10

    -

    Optional params described here.

    +

    Optional params described here.

    List

    List option via CLI can be used to get single or multiple instances. If the instance is not yet materialized but is within the process validity range, WAITING is returned as the state. Instance time is also returned. Log location gives the oozie workflow url If the instance is in WAITING state, missing dependencies are listed

    @@ -165,7 +165,7 @@

    {"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"}]

    Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -list

    Optional Args : -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -colo <<colo>> -lifecycle <<lifecycles>> -filterBy <<field1:value1,field2:value2>> -orderBy field -sortOrder <<sortOrder>> -offset 0 -numResults 10

    -

    Optional params described here.

    +

    Optional params described here.

    Summary

    Summary option via CLI can be used to get the consolidated status of the instances between the specified time period. Each status along with the corresponding instance count are listed for each of the applicable colos. The unscheduled instances between the specified time period are included as UNSCHEDULED in the output to provide more clarity.

    @@ -173,25 +173,25 @@

    {"status":"SUCCEEDED","message":"getSummary is successful", "cluster": <<name>> [{"SUCCEEDED":"1"}, {"WAITING":"1"}, {"RUNNING":"1"}]}

    Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -summary

    Optional Args : -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -colo <<colo>> -lifecycle <<lifecycles>>

    -

    Optional params described here.

    +

    Optional params described here.

    Running

    Running option provides all the running instances of the mentioned process.

    Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -running

    Optional Args : -colo <<colo>> -lifecycle <<lifecycles>> -filterBy <<field1:value1,field2:value2>> -orderBy <<field>> -sortOrder <<sortOrder>> -offset 0 -numResults 10

    -

    Optional params described here.

    +

    Optional params described here.

    FeedInstanceListing

    Get falcon feed instance availability.

    Usage: $FALCON_HOME/bin/falcon instance -entity feed -name <<name>> -listing

    Optional Args : -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -colo <<colo>>

    -

    Optional params described here.

    +

    Optional params described here.

    Logs

    Get logs for instance actions

    Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -logs

    Optional Args : -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -runid <<runid>> -colo <<colo>> -lifecycle <<lifecycles>> -filterBy <<field1:value1,field2:value2>> -orderBy field -sortOrder <<sortOrder>> -offset 0 -numResults 10

    -

    Optional params described here.

    +

    Optional params described here.

    LifeCycle

    Describes list of life cycles of a entity , for feed it can be replication/retention and for process it can be execution. This can be used with instance management options. Default values are replication for feed and execution for process.

    Modified: falcon/site/0.6-incubating/FalconDocumentation.html URL: http://svn.apache.org/viewvc/falcon/site/0.6-incubating/FalconDocumentation.html?rev=1660598&r1=1660597&r2=1660598&view=diff ============================================================================== --- falcon/site/0.6-incubating/FalconDocumentation.html (original) +++ falcon/site/0.6-incubating/FalconDocumentation.html Wed Feb 18 11:30:48 2015 @@ -176,7 +176,7 @@ catalog:$database-name:$table-name#parti

    Entity Management actions

    -

    All the following operation can also be done using Falcon's RESTful API.

    +

    All the following operation can also be done using Falcon's RESTful API.

    Submit

    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.

    Modified: falcon/site/0.6-incubating/InstallationSteps.html URL: http://svn.apache.org/viewvc/falcon/site/0.6-incubating/InstallationSteps.html?rev=1660598&r1=1660597&r2=1660598&view=diff ============================================================================== --- falcon/site/0.6-incubating/InstallationSteps.html (original) +++ falcon/site/0.6-incubating/InstallationSteps.html Wed Feb 18 11:30:48 2015 @@ -76,7 +76,7 @@

    Building Falcon

    -git clone https://git-wip-us.apache.org/repos/asf/incubator-falcon.git falcon
    +git clone https://git-wip-us.apache.org/repos/asf/falcon.git falcon
     
     cd falcon
     
    
    Modified: falcon/site/0.6-incubating/Security.html
    URL: http://svn.apache.org/viewvc/falcon/site/0.6-incubating/Security.html?rev=1660598&r1=1660597&r2=1660598&view=diff
    ==============================================================================
    --- falcon/site/0.6-incubating/Security.html (original)
    +++ falcon/site/0.6-incubating/Security.html Wed Feb 18 11:30:48 2015
    @@ -147,51 +147,51 @@
     Description
     Authorization
     
    -api/entities/validate/:entity-type
    +api/entities/validate/:entity-type
     Validate the entity
     Owner/Group
     
    -api/entities/submit/:entity-type
    +api/entities/submit/:entity-type
     Submit the entity
     Owner/Group
     
    -api/entities/update/:entity-type/:entity-name
    +api/entities/update/:entity-type/:entity-name
     Update the entity
     Owner/Group
     
    -api/entities/submitAndSchedule/:entity-type
    +api/entities/submitAndSchedule/:entity-type
     Submit & Schedule the entity
     Owner/Group
     
    -api/entities/schedule/:entity-type/:entity-name
    +api/entities/schedule/:entity-type/:entity-name
     Schedule the entity
     Owner/Group
     
    -api/entities/suspend/:entity-type/:entity-name
    +api/entities/suspend/:entity-type/:entity-name
     Suspend the entity
     Owner/Group
     
    -api/entities/resume/:entity-type/:entity-name
    +api/entities/resume/:entity-type/:entity-name
     Resume the entity
     Owner/Group
     
    -api/entities/delete/:entity-type/:entity-name
    +api/entities/delete/:entity-type/:entity-name
     Delete the entity
     Owner/Group
     
    -api/entities/status/:entity-type/:entity-name
    +api/entities/status/:entity-type/:entity-name
     Get the status of the entity
     Owner/Group
     
    -api/entities/definition/:entity-type/:entity-name
    +api/entities/definition/:entity-type/:entity-name
     Get the definition of the entity
     Owner/Group
     
    -api/entities/list/:entity-type?fields=:fields
    +api/entities/list/:entity-type?fields=:fields
     Get the list of entities
     Owner/Group
     
    -api/entities/dependencies/:entity-type/:entity-name
    +api/entities/dependencies/:entity-type/:entity-name
     Get the dependencies of the entity
     Owner/GroupREST Call on Feed and Process Instances
     

    @@ -201,27 +201,27 @@ Description Authorization -api/instance/running/:entity-type/:entity-name +api/instance/running/:entity-type/:entity-name List of running instances. Owner/Group -api/instance/status/:entity-type/:entity-name +api/instance/status/:entity-type/:entity-name Status of a given instance Owner/Group -api/instance/kill/:entity-type/:entity-name +api/instance/kill/:entity-type/:entity-name Kill a given instance Owner/Group -api/instance/suspend/:entity-type/:entity-name +api/instance/suspend/:entity-type/:entity-name Suspend a running instance Owner/Group -api/instance/resume/:entity-type/:entity-name +api/instance/resume/:entity-type/:entity-name Resume a given instance Owner/Group -api/instance/rerun/:entity-type/:entity-name +api/instance/rerun/:entity-type/:entity-name Rerun a given instance Owner/Group @@ -238,15 +238,15 @@ Description Authorization -api/admin/version +api/admin/version Get version of the server No restriction -api/admin/stack +api/admin/stack Get stack of the server Admin User/Group -api/admin/config/:config-type +api/admin/config/:config-type Get configuration information of the server Admin User/Group
    Modified: falcon/site/Appendix.html URL: http://svn.apache.org/viewvc/falcon/site/Appendix.html?rev=1660598&r1=1660597&r2=1660598&view=diff ============================================================================== --- falcon/site/Appendix.html (original) +++ falcon/site/Appendix.html Wed Feb 18 11:30:48 2015 @@ -116,9 +116,6 @@ Documentation
    +

    Optional params described here.

    Summary

    Summary of entities of a particular type and a cluster will be listed. Entity summary has N most recent instances of entity.

    Usage: $FALCON_HOME/bin/falcon entity -type [feed|process] -summary

    Optional Args : -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -fields <<field1,field2>> -filterBy <<field1:value1,field2:value2>> -tags <<tagkey=tagvalue,tagkey=tagvalue>> -orderBy <<field>> -sortOrder <<sortOrder>> -offset 0 -numResults 10 -numInstances 7

    -

    Optional params described here.

    +

    Optional params described here.

    Update

    Update operation allows an already submitted/scheduled entity to be updated. Cluster update is currently not allowed.

    @@ -345,7 +342,7 @@

    {"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"}]

    Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -status

    Optional Args : -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -colo <<colo>> -filterBy <<field1:value1,field2:value2>> -lifecycle <<lifecycles>> -orderBy field -sortOrder <<sortOrder>> -offset 0 -numResults 10

    -

    Optional params described here.

    +

    Optional params described here.

    List

    List option via CLI can be used to get single or multiple instances. If the instance is not yet materialized but is within the process validity range, WAITING is returned as the state. Instance time is also returned. Log location gives the oozie workflow url If the instance is in WAITING state, missing dependencies are listed

    @@ -353,7 +350,7 @@

    {"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"}]

    Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -list

    Optional Args : -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -colo <<colo>> -lifecycle <<lifecycles>> -filterBy <<field1:value1,field2:value2>> -orderBy field -sortOrder <<sortOrder>> -offset 0 -numResults 10

    -

    Optional params described here.

    +

    Optional params described here.

    Summary

    Summary option via CLI can be used to get the consolidated status of the instances between the specified time period. Each status along with the corresponding instance count are listed for each of the applicable colos. The unscheduled instances between the specified time period are included as UNSCHEDULED in the output to provide more clarity.

    @@ -361,25 +358,25 @@

    {"status":"SUCCEEDED","message":"getSummary is successful", "cluster": <<name>> [{"SUCCEEDED":"1"}, {"WAITING":"1"}, {"RUNNING":"1"}]}

    Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -summary

    Optional Args : -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -colo <<colo>> -lifecycle <<lifecycles>>

    -

    Optional params described here.

    +

    Optional params described here.

    Running

    Running option provides all the running instances of the mentioned process.

    Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -running

    Optional Args : -colo <<colo>> -lifecycle <<lifecycles>> -filterBy <<field1:value1,field2:value2>> -orderBy <<field>> -sortOrder <<sortOrder>> -offset 0 -numResults 10

    -

    Optional params described here.

    +

    Optional params described here.

    FeedInstanceListing

    Get falcon feed instance availability.

    Usage: $FALCON_HOME/bin/falcon instance -entity feed -name <<name>> -listing

    Optional Args : -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -colo <<colo>>

    -

    Optional params described here.

    +

    Optional params described here.

    Logs

    Get logs for instance actions

    Usage: $FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -logs

    Optional Args : -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" -runid <<runid>> -colo <<colo>> -lifecycle <<lifecycles>> -filterBy <<field1:value1,field2:value2>> -orderBy field -sortOrder <<sortOrder>> -offset 0 -numResults 10

    -

    Optional params described here.

    +

    Optional params described here.

    LifeCycle

    Describes list of life cycles of a entity , for feed it can be replication/retention and for process it can be execution. This can be used with instance management options. Default values are replication for feed and execution for process.

    Modified: falcon/site/FalconDocumentation.html URL: http://svn.apache.org/viewvc/falcon/site/FalconDocumentation.html?rev=1660598&r1=1660597&r2=1660598&view=diff ============================================================================== --- falcon/site/FalconDocumentation.html (original) +++ falcon/site/FalconDocumentation.html Wed Feb 18 11:30:48 2015 @@ -116,9 +116,6 @@ Documentation

    Entity Management actions

    -

    All the following operation can also be done using Falcon's RESTful API.

    +

    All the following operation can also be done using Falcon's RESTful API.

    Submit

    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.

    Modified: falcon/site/GettingStarted.html URL: http://svn.apache.org/viewvc/falcon/site/GettingStarted.html?rev=1660598&r1=1660597&r2=1660598&view=diff ============================================================================== --- falcon/site/GettingStarted.html (original) +++ falcon/site/GettingStarted.html Wed Feb 18 11:30:48 2015 @@ -1,13 +1,13 @@ - + Falcon - Apache Falcon - Data management and processing platform @@ -116,9 +116,6 @@ Documentation Modified: falcon/site/HiveIntegration.html URL: http://svn.apache.org/viewvc/falcon/site/HiveIntegration.html?rev=1660598&r1=1660597&r2=1660598&view=diff ============================================================================== --- falcon/site/HiveIntegration.html (original) +++ falcon/site/HiveIntegration.html Wed Feb 18 11:30:48 2015 @@ -116,9 +116,6 @@ Documentation