http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/Security.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/Security.twiki b/trunk/releases/master/src/site/twiki/Security.twiki deleted file mode 100644 index 8955bdc..0000000 --- a/trunk/releases/master/src/site/twiki/Security.twiki +++ /dev/null @@ -1,387 +0,0 @@ ----+ Securing Falcon - ----++ Overview - -Apache Falcon enforces authentication and authorization which are detailed below. Falcon also -provides transport level security ensuring data confidentiality and integrity. - - ----++ Authentication (User Identity) - -Apache Falcon enforces authentication on protected resources. Once authentication has been established it sets a -signed HTTP Cookie that contains an authentication token with the user name, user principal, -authentication type and expiration time. - -It does so by using [[http://hadoop.apache .org/docs/current/hadoop-auth/index.html][Hadoop Auth]]. -Hadoop Auth is a Java library consisting of a client and a server components to enable Kerberos SPNEGO authentication -for HTTP. Hadoop Auth also supports additional authentication mechanisms on the client and the server side via 2 -simple interfaces. - - ----+++ Authentication Methods - -It supports 2 authentication methods, simple and kerberos out of the box. - ----++++ Pseudo/Simple Authentication - -Falcon authenticates the user by simply trusting the value of the query string parameter 'user.name'. This is the -default mode Falcon is configured with. - ----++++ Kerberos Authentication - -Falcon uses HTTP Kerberos SPNEGO to authenticate the user. - - ----++ Authorization - -Falcon also enforces authorization on Entities using ACLs (Access Control Lists). ACLs are useful -for implementing permission requirements and provide a way to set different permissions for -specific users or named groups. - -By default, support for authorization is disabled and can be enabled in startup.properties. - ----+++ ACLs in Entity - -All Entities now have ACL which needs to be present if authorization is enabled. Only owners who -own or created the entity will be allowed to update or delete their entities. - -An entity has ACLs (Access Control Lists) that are useful for implementing permission requirements -and provide a way to set different permissions for specific users or named groups. -<verbatim> - <ACL owner="test-user" group="test-group" permission="*"/> -</verbatim> -ACL indicates the Access control list for this cluster. -owner is the Owner of this entity. -group is the one which has access to read. -permission indicates the rwx is not enforced at this time. - ----+++ Super-User - -The super-user is the user with the same identity as falcon process itself. Loosely, if you -started the falcon, then you are the super-user. The super-user can do anything in that -permissions checks never fail for the super-user. There is no persistent notion of who was the -super-user; when the falcon is started the process identity determines who is the super-user -for now. The Falcon super-user does not have to be the super-user of the falcon host, nor is it -necessary that all clusters have the same super-user. Also, an experimenter running Falcon on a -personal workstation, conveniently becomes that installation's super-user without any configuration. - -Falcon also allows users to configure a super user group and allows users belonging to this -group to be a super user. - -ACL owner and group must be valid even if the authenticated user is a super-user. - ----+++ Group Memberships - -Once a user has been authenticated and a username has been determined, the list of groups is -determined by a group mapping service, configured by the hadoop.security.group.mapping property -in Hadoop. The default implementation, org.apache.hadoop.security.ShellBasedUnixGroupsMapping, -will shell out to the Unix bash -c groups command to resolve a list of groups for a user. - -Note that Falcon stores the user and group of an Entity as strings; there is no -conversion from user and group identity numbers as is conventional in Unix. - -The only limitation is that a user cannot add a group in ACL that he does not belong to. - ----+++ Authorization Provider - -Falcon provides a plugin-able provider interface for Authorization. It also ships with a default -implementation that enforces the following authorization policy. - ----++++ Entity and Instance Management Operations Policy - - * All Entity and Instance operations are authorized for users who created them, Owners and users with group memberships - * Reference to entities with in a feed or process is allowed with out enforcing permissions - -Any Feed or Process can refer to a Cluster entity not owned by the Feed or Process owner. Any Process can refer to a Feed entity not owned by the Process owner - -The authorization is enforced in the following way: - - * if admin resource, - * If authenticated user name matches the admin users configuration - * Else if groups of the authenticated user matches the admin groups configuration - * Else authorization exception is thrown - * Else if entities or instance resource - * If the authenticated user matches the owner in ACL for the entity - * Else if the groups of the authenticated user matches the group in ACL for the entity - * Else authorization exception is thrown - * Else if lineage resource - * All have read-only permissions, reason being folks should be able to examine the dependency and allow reuse - -To authenticate user for REST api calls, user should append "user.name=<username>" to the query. - -*operations on Entity Resource* - -| *Resource* | *Description* | *Authorization* | -| [[restapi/EntityValidate][api/entities/validate/:entity-type]] | Validate the entity | Owner/Group | -| [[restapi/EntitySubmit][api/entities/submit/:entity-type]] | Submit the entity | Owner/Group | -| [[restapi/EntityUpdate][api/entities/update/:entity-type/:entity-name]] | Update the entity | Owner/Group | -| [[restapi/EntitySubmitAndSchedule][api/entities/submitAndSchedule/:entity-type]] | Submit & Schedule the entity | Owner/Group | -| [[restapi/EntitySchedule][api/entities/schedule/:entity-type/:entity-name]] | Schedule the entity | Owner/Group | -| [[restapi/EntitySuspend][api/entities/suspend/:entity-type/:entity-name]] | Suspend the entity | Owner/Group | -| [[restapi/EntityResume][api/entities/resume/:entity-type/:entity-name]] | Resume the entity | Owner/Group | -| [[restapi/EntityDelete][api/entities/delete/:entity-type/:entity-name]] | Delete the entity | Owner/Group | -| [[restapi/EntityStatus][api/entities/status/:entity-type/:entity-name]] | Get the status of the entity | Owner/Group | -| [[restapi/EntityDefinition][api/entities/definition/:entity-type/:entity-name]] | Get the definition of the entity | Owner/Group | -| [[restapi/EntityList][api/entities/list/:entity-type?fields=:fields]] | Get the list of entities | Owner/Group | -| [[restapi/EntityDependencies][api/entities/dependencies/:entity-type/:entity-name]] | Get the dependencies of the entity | Owner/Group | - -*REST Call on Feed and Process Instances* - -| *Resource* | *Description* | *Authorization* | -| [[restapi/InstanceRunning][api/instance/running/:entity-type/:entity-name]] | List of running instances. | Owner/Group | -| [[restapi/InstanceStatus][api/instance/status/:entity-type/:entity-name]] | Status of a given instance | Owner/Group | -| [[restapi/InstanceKill][api/instance/kill/:entity-type/:entity-name]] | Kill a given instance | Owner/Group | -| [[restapi/InstanceSuspend][api/instance/suspend/:entity-type/:entity-name]] | Suspend a running instance | Owner/Group | -| [[restapi/InstanceResume][api/instance/resume/:entity-type/:entity-name]] | Resume a given instance | Owner/Group | -| [[restapi/InstanceRerun][api/instance/rerun/:entity-type/:entity-name]] | Rerun a given instance | Owner/Group | -| [[InstanceLogs][api/instance/logs/:entity-type/:entity-name]] | Get logs of a given instance | Owner/Group | - ----++++ Admin Resources Policy - -Only users belonging to admin users or groups have access to this resource. Admin membership is -determined by a static configuration parameter. - -| *Resource* | *Description* | *Authorization* | -| [[restapi/AdminVersion][api/admin/version]] | Get version of the server | No restriction | -| [[restapi/AdminStack][api/admin/stack]] | Get stack of the server | Admin User/Group | -| [[restapi/AdminConfig][api/admin/config/:config-type]] | Get configuration information of the server | Admin User/Group | - - ----++++ Lineage Resource Policy - -Lineage is read-only and hence all users can look at lineage for their respective entities. -*Note:* This gap will be fixed in a later release. - - ----++ Authentication Configuration - -Following is the Server Side Configuration Setup for Authentication. - ----+++ Common Configuration Parameters - -<verbatim> -# Authentication type must be specified: simple|kerberos -*.falcon.authentication.type=kerberos -</verbatim> - ----+++ Kerberos Configuration - -<verbatim> -##### Service Configuration - -# Indicates the Kerberos principal to be used in Falcon Service. -*.falcon.service.authentication.kerberos.principal=falcon/[email protected] - -# Location of the keytab file with the credentials for the Service principal. -*.falcon.service.authentication.kerberos.keytab=/etc/security/keytabs/falcon.service.keytab - -# name node principal to talk to config store -*.dfs.namenode.kerberos.principal=nn/[email protected] - -# Indicates how long (in seconds) falcon authentication token is valid before it has to be renewed. -*.falcon.service.authentication.token.validity=86400 - -##### SPNEGO Configuration - -# Authentication type must be specified: simple|kerberos|<class> -# org.apache.falcon.security.RemoteUserInHeaderBasedAuthenticationHandler can be used for backwards compatibility -*.falcon.http.authentication.type=kerberos - -# Indicates how long (in seconds) an authentication token is valid before it has to be renewed. -*.falcon.http.authentication.token.validity=36000 - -# The signature secret for signing the authentication tokens. -*.falcon.http.authentication.signature.secret=falcon - -# The domain to use for the HTTP cookie that stores the authentication token. -*.falcon.http.authentication.cookie.domain= - -# Indicates if anonymous requests are allowed when using 'simple' authentication. -*.falcon.http.authentication.simple.anonymous.allowed=true - -# Indicates the Kerberos principal to be used for HTTP endpoint. -# The principal MUST start with 'HTTP/' as per Kerberos HTTP SPNEGO specification. -*.falcon.http.authentication.kerberos.principal=HTTP/[email protected] - -# Location of the keytab file with the credentials for the HTTP principal. -*.falcon.http.authentication.kerberos.keytab=/etc/security/keytabs/spnego.service.keytab - -# The kerberos names rules is to resolve kerberos principal names, refer to Hadoop's KerberosName for more details. -*.falcon.http.authentication.kerberos.name.rules=DEFAULT - -# Comma separated list of black listed users -*.falcon.http.authentication.blacklisted.users= - -# Increase Jetty request buffer size to accommodate the generated Kerberos token -*.falcon.jetty.request.buffer.size=16192 -</verbatim> - ----+++ Pseudo/Simple Configuration - -<verbatim> -##### SPNEGO Configuration - -# Authentication type must be specified: simple|kerberos|<class> -# org.apache.falcon.security.RemoteUserInHeaderBasedAuthenticationHandler can be used for backwards compatibility -*.falcon.http.authentication.type=simple - -# Indicates how long (in seconds) an authentication token is valid before it has to be renewed. -*.falcon.http.authentication.token.validity=36000 - -# The signature secret for signing the authentication tokens. -*.falcon.http.authentication.signature.secret=falcon - -# The domain to use for the HTTP cookie that stores the authentication token. -*.falcon.http.authentication.cookie.domain= - -# Indicates if anonymous requests are allowed when using 'simple' authentication. -*.falcon.http.authentication.simple.anonymous.allowed=true - -# Comma separated list of black listed users -*.falcon.http.authentication.blacklisted.users= -</verbatim> - ----++ Authorization Configuration - ----+++ Enabling Authorization -By default, support for authorization is disabled and specifying ACLs in entities are optional. -To enable support for authorization, set falcon.security.authorization.enabled to true in the -startup configuration. - -<verbatim> -# Authorization Enabled flag: false|true -*.falcon.security.authorization.enabled=true -</verbatim> - ----+++ Authorization Provider - -Falcon provides a basic implementation for Authorization bundled, org.apache.falcon.security .DefaultFalconAuthorizationProvider. -This can be overridden by custom implementations in the startup configuration. - -<verbatim> -# Authorization Provider Fully Qualified Class Name -*.falcon.security.authorization.provider=org.apache.falcon.security.DefaultAuthorizationProvider -</verbatim> - ----+++ Super User Group - -Super user group is determined by the configuration: - -<verbatim> -# The name of the group of super-users -*.falcon.security.authorization.superusergroup=falcon -</verbatim> - ----+++ Admin Membership - -Administrative users are determined by the configuration: - -<verbatim> -# Admin Users, comma separated users -*.falcon.security.authorization.admin.users=falcon,ambari-qa,seetharam -</verbatim> - -Administrative groups are determined by the configuration: - -<verbatim> -# Admin Group Membership, comma separated users -*.falcon.security.authorization.admin.groups=falcon,testgroup,staff -</verbatim> - - ----++ SSL - -Falcon provides transport level security ensuring data confidentiality and integrity. This is -enabled by default for communicating over HTTP between the client and the server. - ----+++ SSL Configuration - -<verbatim> -*.falcon.enableTLS=true -*.keystore.file=/path/to/keystore/file -*.keystore.password=password -</verbatim> - ----+++ Distributed Falcon Setup - -Falcon should be configured to communicate with Prism over TLS in secure mode. Its not enabled by default. - - ----++ Changes to ownership and permissions of directories managed by Falcon - -| *Directory* | *Location* | *Owner* | *Permissions* | -| Configuration Store | ${config.store.uri} | falcon | 700 | -| Cluster Staging Location | ${cluster.staging-location} | falcon | 777 | -| Cluster Working Location | ${cluster.working-location} | falcon | 755 | -| Shared libs | {cluster.working}/{lib,libext} | falcon | 755 | -| Oozie coord/bundle XMLs | ${cluster.staging-location}/workflows/{entity}/{entity-name} | $user | cluster umask | -| App logs | ${cluster.staging-location}/workflows/{entity}/{entity-name}/logs | $user | cluster umask | - -*Note:* Please note that the cluster staging and working locations MUST be created prior to -submitting a cluster entity to Falcon. Also, note that the the parent dirs must have execute -permissions. - - ----++ Backwards compatibility - ----+++ Scheduled Entities - -Entities already scheduled with an earlier version of Falcon are not compatible with this version - ----+++ Falcon Clients - -Older Falcon clients are backwards compatible wrt Authentication and user information sent as part of the HTTP -header, Remote-User is still honoured when the authentication type is configured as below: - -<verbatim> -*.falcon.http.authentication.type=org.apache.falcon.security.RemoteUserInHeaderBasedAuthenticationHandler -</verbatim> - ----+++ Blacklisted super users for authentication - -The blacklist users used to have the following super users: hdfs, mapreduce, oozie, and falcon. -The list is externalized from code into Startup.properties file and is empty now and needs to be -configured specifically in the file. - - ----+++ Falcon Dashboard - -To initialize the current user for dashboard, user should append query param "user.name=<username>" to the REST api call. - -If dashboard user wishes to change the current user, they should do the following. - * delete the hadoop.auth cookie from browser cache. - * append query param "user.name=<new_user>" to the next REST API call. - -In Kerberos method, the browser must support HTTP Kerberos SPNEGO. - - ----++ Known Limitations - - * ActiveMQ topics are not secure but will be in the near future - * Entities already scheduled with an earlier version of Falcon are not compatible with this version as new - workflow parameters are being passed back into Falcon such as the user are required - * Use of hftp as the scheme for read only interface in cluster entity [[https://issues.apache.org/jira/browse/HADOOP-10215][will not work in Oozie]] - The alternative is to use webhdfs scheme instead and its been tested with DistCp. - - ----++ Examples - ----+++ Accessing the server using Falcon CLI (Java client) - -There is no change in the way the CLI is used. The CLI has been changed to work with the configured authentication -method. - ----+++ Accessing the server using curl - -Try accessing protected resources using curl. The protected resources are: - -<verbatim> -$ kinit -Please enter the password for venkatesh@LOCALHOST: - -$ curl http://localhost:15000/api/admin/version - -$ curl http://localhost:15000/api/admin/version?user.name=venkatesh - -$ curl --negotiate -u foo -b ~/cookiejar.txt -c ~/cookiejar.txt curl http://localhost:15000/api/admin/version -</verbatim>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/CommonCLI.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/CommonCLI.twiki b/trunk/releases/master/src/site/twiki/falconcli/CommonCLI.twiki deleted file mode 100644 index fab2ed1..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/CommonCLI.twiki +++ /dev/null @@ -1,21 +0,0 @@ ----++ Common CLI Options - ----+++Falcon URL - -Optional -url option indicating the URL of the Falcon system to run the command against can be provided. If not mentioned it will be picked from the system environment variable FALCON_URL. If FALCON_URL is not set then 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. - ----+++Proxy user support - -The -doAs option allows the current user to impersonate other users when interacting with the Falcon system. The current user must be configured as a proxyuser in the Falcon system. The proxyuser configuration may restrict from -which hosts a user may impersonate users, as well as users of which groups can be impersonated. - -<a href="../FalconDocumentation.html#Proxyuser_support">Proxyuser support described here.</a> - ----+++Debug Mode - -If you export FALCON_DEBUG=true then the Falcon CLI will output the Web Services API details used by any commands you execute. This is useful for debugging purposes to or see how the Falcon CLI works with the WS API. -Alternately, you can specify '-debug' through the CLI arguments to get the debug statements. - -Example: -$FALCON_HOME/bin/falcon entity -submit -type cluster -file /cluster/definition.xml -debug \ No newline at end of file http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/ContinueInstance.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/ContinueInstance.twiki b/trunk/releases/master/src/site/twiki/falconcli/ContinueInstance.twiki deleted file mode 100644 index 304e281..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/ContinueInstance.twiki +++ /dev/null @@ -1,8 +0,0 @@ ----+++Continue - -[[CommonCLI][Common CLI Options]] - -Continue option is used to continue the failed workflow instance. This option is valid only for process instances in terminal state, i.e. KILLED or FAILED. - -Usage: -$FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -continue -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/Definition.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/Definition.twiki b/trunk/releases/master/src/site/twiki/falconcli/Definition.twiki deleted file mode 100644 index 08d46c7..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/Definition.twiki +++ /dev/null @@ -1,8 +0,0 @@ ----+++Definition - -[[CommonCLI][Common CLI Options]] - -Definition option returns the entity definition submitted earlier during submit step. - -Usage: -$FALCON_HOME/bin/falcon entity -type [cluster|datasource|feed|process] -name <<name>> -definition http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/DeleteEntity.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/DeleteEntity.twiki b/trunk/releases/master/src/site/twiki/falconcli/DeleteEntity.twiki deleted file mode 100644 index f2b3080..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/DeleteEntity.twiki +++ /dev/null @@ -1,8 +0,0 @@ ----+++Delete - -[[CommonCLI][Common CLI Options]] - -Delete removes the submitted entity definition for the specified entity and put it into the archive. - -Usage: -$FALCON_HOME/bin/falcon entity -type [cluster|datasource|feed|process] -name <<name>> -delete http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/DependencyEntity.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/DependencyEntity.twiki b/trunk/releases/master/src/site/twiki/falconcli/DependencyEntity.twiki deleted file mode 100644 index bdef1d7..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/DependencyEntity.twiki +++ /dev/null @@ -1,10 +0,0 @@ ----+++Dependency - -[[CommonCLI][Common CLI Options]] - -With the use of dependency option, we can list all the entities on which the specified entity is dependent. -For example for a feed, dependency return the cluster name and for process it returns all the input feeds, -output feeds and cluster names. - -Usage: -$FALCON_HOME/bin/falcon entity -type [cluster|datasource|feed|process] -name <<name>> -dependency \ No newline at end of file http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/DependencyInstance.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/DependencyInstance.twiki b/trunk/releases/master/src/site/twiki/falconcli/DependencyInstance.twiki deleted file mode 100644 index 51508cc..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/DependencyInstance.twiki +++ /dev/null @@ -1,33 +0,0 @@ ----+++Dependency -Display the dependent instances which are dependent on the given instance. For example for a given process instance it will -list all the input feed instances(if any) and the output feed instances(if any). - -An example use case of this command is as follows: -Suppose you find out that the data in a feed instance was incorrect and you need to figure out which all process instances -consumed this feed instance so that you can reprocess them after correcting the feed instance. You can give the feed instance -and it will tell you which process instance produced this feed and which all process instances consumed this feed. - -NOTE: -1. instanceTime must be a valid instanceTime e.g. instanceTime of a feed should be in it's validity range on applicable clusters, - and it should be in the range of instances produced by the producer process(if any) - -2. For processes with inputs like latest() which vary with time the results are not guaranteed to be correct. - -Usage: -$FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -dependency -instanceTime "yyyy-MM-dd'T'HH:mm'Z'" - -For example: -$FALCON_HOME/bin/falcon instance -dependency -type feed -name out -instanceTime 2014-12-15T00:00Z -name: producer, type: PROCESS, cluster: local, instanceTime: 2014-12-15T00:00Z, tags: Output -name: consumer, type: PROCESS, cluster: local, instanceTime: 2014-12-15T00:03Z, tags: Input -name: consumer, type: PROCESS, cluster: local, instanceTime: 2014-12-15T00:04Z, tags: Input -name: consumer, type: PROCESS, cluster: local, instanceTime: 2014-12-15T00:02Z, tags: Input -name: consumer, type: PROCESS, cluster: local, instanceTime: 2014-12-15T00:05Z, tags: Input - - -Response: default/Success! - -Request Id: default/1125035965@qtp-503156953-7 - 447be0ad-1d38-4dce-b438-20f3de69b172 - - -<a href="../Restapi/InstanceDependencies.html">Optional params described here.</a> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/EdgeMetadata.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/EdgeMetadata.twiki b/trunk/releases/master/src/site/twiki/falconcli/EdgeMetadata.twiki deleted file mode 100644 index 477996e..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/EdgeMetadata.twiki +++ /dev/null @@ -1,11 +0,0 @@ ----+++ Edge - -[[CommonCLI][Common CLI Options]] - -Get the edge with the specified id. - -Usage: -$FALCON_HOME/bin/falcon metadata -edge -id <<id>> - -Example: -$FALCON_HOME/bin/falcon metadata -edge -id Q9n-Q-5g \ No newline at end of file http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/FalconCLI.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/FalconCLI.twiki b/trunk/releases/master/src/site/twiki/falconcli/FalconCLI.twiki deleted file mode 100644 index 0c0082f..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/FalconCLI.twiki +++ /dev/null @@ -1,112 +0,0 @@ ----+FalconCLI - -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. - ----+++Types of CLI Options - -CLI options are classified into : - - * <a href="#Common_CLI_Options">Common CLI Options</a> - * <a href="#Entity_Management_Commands">Entity Management Commands</a> - * <a href="#Instance_Management_Commands">Instance Management Commands</a> - * <a href="#Metadata_Commands">Metadata Commands</a> - * <a href="#Admin_Commands">Admin commands</a> - * <a href="#Recipe_Commands">Recipe commands</a> - - - ------------ - ----++Common CLI Options - ----+++Falcon URL - -Optional -url option indicating the URL of the Falcon system to run the command against can be provided. If not mentioned it will be picked from the system environment variable FALCON_URL. If FALCON_URL is not set then 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. - ----+++Proxy user support - -The -doAs option allows the current user to impersonate other users when interacting with the Falcon system. The current user must be configured as a proxyuser in the Falcon system. The proxyuser configuration may restrict from -which hosts a user may impersonate users, as well as users of which groups can be impersonated. - -<a href="../FalconDocumentation.html#Proxyuser_support">Proxyuser support described here.</a> - ----+++Debug Mode - -If you export FALCON_DEBUG=true then the Falcon CLI will output the Web Services API details used by any commands you execute. This is useful for debugging purposes to or see how the Falcon CLI works with the WS API. -Alternately, you can specify '-debug' through the CLI arguments to get the debug statements. -Example: -$FALCON_HOME/bin/falcon entity -submit -type cluster -file /cluster/definition.xml -debug - ------------ - ----++Entity Management Commands - -| *Command* | *Description* | -| [[Submit]] | Submit the entity definition. | -| [[Schedule]] | Scheduled the entity | -| [[SuspendEntity][Suspend]] | Suspends the scheduled entity | -| [[ResumeEntity][Resume]] | Puts a suspended entity back in action | -| [[DeleteEntity][Delete]] | Remove the submitted entity | -| [[ListEntity][List]] | Lists the particular type of entity | -| [[SummaryEntity][Summary]] | Shows summary of the type of entity | -| [[UpdateEntity][Update]] | Update already submitted entity | -| [[Touch]] | Force update already submitted entity | -| [[StatusEntity][Status]] | Return's the status of the entity | -| [[DependencyEntity][Dependency]] | List all the entities on which the specified entity is dependent| -| [[Definition]] | Return's the definition of the entity | -| [[Lookup]] | Return's the feed name for a path | -| [[SLAAlert]] | Return's the feed instance which have missed sla| - - ------------ ----++Instance Management Commands - -| *Command* | *Description* | -| [[KillInstance][Kill]] | Kills all the instances of specified process | -| [[SuspendInstance][Suspend]] | Suspends instances of a specified process | -| [[ContinueInstance][Continue]] | Continue the failed workflow instances | -| [[RerunInstance][Rerun]] | Rerun instances of specified process | -| [[ResumeInstance][Resume]] | Resume instance of specified process from suspended state | -| [[StatusInstance][Status]] | Gets the status of entity | -| [[ListInstance][List]] | Gets single or multiple instances | -| [[SummaryInstance][Summary]] | Gets consolidated status of the instances between the specified time period | -| [[RunningInstance][Running]] | Gets running instances of the mentioned process | -| [[FeedInstanceListing]] | Gets falcon feed instance availability | -| [[LogsInstance][Logs]] | Gets logs for instance | -| [[LifeCycleInstance][LifeCycle]] | Describes list of life cycles of a entity | -| [[TriageInstance][Triage]] | Traces entities ancestors for failure | -| [[ParamsInstance][Params]] | Displays workflow params | -| [[DependencyInstance][Dependency]] | Displays the dependent instances | - ------------ - ----++Metadata Commands - -| *Command* | *Description* | -|[[LineageMetadata][Lineage]] | Returns the relationship between processes and feeds | -|[[VertexMetadata][Vertex]] | Gets the vertex with the specified id | -|[[VerticesMetadata][Vertices]] | Gets all vertices for a key | -|[[VertexEdgesMetadata][Vertex Edges]] | Gets the adjacent vertices or edges of the vertex| -|[[EdgeMetadata][Edge]] | Gets the edge with the specified id | -|[[ListMetadata][List]] | Return list of all dimension of given type | -|[[RelationMetadata][Relations]] | Return all dimensions related to specified Dimension | - ------------ - ----++Admin Commands - -| *Command* | *Description* | -|[[HelpAdmin][Help]] | Return help options | -|[[VersionAdmin][Version]] | Return current falcon version | -|[[StatusAdmin][Status]] | Return the status of falcon | - ------------ - ----++Recipe Commands - -| *Command* | *Description* | -|[[SubmitRecipe][Submit]] | Submit the specified Recipe | - - - http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/FeedInstanceListing.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/FeedInstanceListing.twiki b/trunk/releases/master/src/site/twiki/falconcli/FeedInstanceListing.twiki deleted file mode 100644 index aa60d49..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/FeedInstanceListing.twiki +++ /dev/null @@ -1,11 +0,0 @@ ----+++FeedInstanceListing - -Get falcon feed instance availability. - -Usage: -$FALCON_HOME/bin/falcon instance -type feed -name <<name>> -listing - -Optional Args : -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" --colo <<colo>> - -<a href="../Restapi/FeedInstanceListing.html">Optional params described here.</a> http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/HelpAdmin.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/HelpAdmin.twiki b/trunk/releases/master/src/site/twiki/falconcli/HelpAdmin.twiki deleted file mode 100644 index 69b1378..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/HelpAdmin.twiki +++ /dev/null @@ -1,6 +0,0 @@ ----+++Help - -[[CommonCLI][Common CLI Options]] - -Usage: -$FALCON_HOME/bin/falcon admin -help http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/KillInstance.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/KillInstance.twiki b/trunk/releases/master/src/site/twiki/falconcli/KillInstance.twiki deleted file mode 100644 index 623921f..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/KillInstance.twiki +++ /dev/null @@ -1,14 +0,0 @@ ----+++Kill - -[[CommonCLI][Common CLI Options]] - -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. - -Note: -1. The start time and end time needs to be specified in TZ format. -Example: 01 Jan 2012 01:00 => 2012-01-01T01:00Z - -2. Process name is compulsory parameter for each instance management command. - -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'" http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/LifeCycleInstance.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/LifeCycleInstance.twiki b/trunk/releases/master/src/site/twiki/falconcli/LifeCycleInstance.twiki deleted file mode 100644 index bbcda55..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/LifeCycleInstance.twiki +++ /dev/null @@ -1,9 +0,0 @@ ----+++LifeCycle - -[[CommonCLI][Common CLI Options]] - -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. - -Usage: -$FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -status -lifecycle <<lifecycletype>> -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/LineageMetadata.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/LineageMetadata.twiki b/trunk/releases/master/src/site/twiki/falconcli/LineageMetadata.twiki deleted file mode 100644 index e668e03..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/LineageMetadata.twiki +++ /dev/null @@ -1,12 +0,0 @@ ----+++Lineage - - -Returns the relationship between processes and feeds in a given pipeline in [[http://www.graphviz.org/content/dot-language/][dot]] format. -You can use the output and view a graphical representation of DAG using an online graphviz viewer like [[http://www.webgraphviz.com/][this]]. - -Usage: - -$FALCON_HOME/bin/falcon metadata -lineage -pipeline my-pipeline - -pipeline is a mandatory option. - http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/ListEntity.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/ListEntity.twiki b/trunk/releases/master/src/site/twiki/falconcli/ListEntity.twiki deleted file mode 100644 index 0047c1b..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/ListEntity.twiki +++ /dev/null @@ -1,17 +0,0 @@ ----+++List - -[[CommonCLI][Common CLI Options]] - -Entities of a particular type can be listed with list sub-command. - -Usage: -$FALCON_HOME/bin/falcon entity -list - -Optional Args : -fields <<field1,field2>> --type <<[cluster|datasource|feed|process],[cluster|datasource|feed|process]>> --nameseq <<namesubsequence>> -tagkeys <<tagkeyword1,tagkeyword2>> --filterBy <<field1:value1,field2:value2>> -tags <<tagkey=tagvalue,tagkey=tagvalue>> --orderBy <<field>> -sortOrder <<sortOrder>> -offset 0 -numResults 10 - -<a href="../Restapi/EntityList.html">Optional params described here.</a> - http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/ListInstance.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/ListInstance.twiki b/trunk/releases/master/src/site/twiki/falconcli/ListInstance.twiki deleted file mode 100644 index 1203629..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/ListInstance.twiki +++ /dev/null @@ -1,20 +0,0 @@ ----+++List - -[[CommonCLI][Common CLI Options]] - -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 - -Example : Suppose a process has 3 instance, one has succeeded,one is in running state and other one is waiting, the expected output is: - -{"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 --allAttempts To get all the attempts for corresponding instances - -<a href="../Restapi/InstanceList.html">Optional params described here.</a> http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/ListMetadata.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/ListMetadata.twiki b/trunk/releases/master/src/site/twiki/falconcli/ListMetadata.twiki deleted file mode 100644 index 8adea21..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/ListMetadata.twiki +++ /dev/null @@ -1,13 +0,0 @@ ----+++ List - -[[CommonCLI][Common CLI Options]] - -Lists of all dimensions of given type. If the user provides optional param cluster, only the dimensions related to the cluster are listed. -Usage: -$FALCON_HOME/bin/falcon metadata -list -type [cluster_entity|datasource_entity|feed_entity|process_entity|user|colo|tags|groups|pipelines] - -Optional Args : -cluster <<cluster name>> - -Example: -$FALCON_HOME/bin/falcon metadata -list -type process_entity -cluster primary-cluster -$FALCON_HOME/bin/falcon metadata -list -type tags http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/LogsInstance.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/LogsInstance.twiki b/trunk/releases/master/src/site/twiki/falconcli/LogsInstance.twiki deleted file mode 100644 index ac40ec0..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/LogsInstance.twiki +++ /dev/null @@ -1,14 +0,0 @@ ----+++Logs - -[[CommonCLI][Common CLI Options]] - -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 - -<a href="../Restapi/InstanceLogs.html">Optional params described here.</a> http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/Lookup.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/Lookup.twiki b/trunk/releases/master/src/site/twiki/falconcli/Lookup.twiki deleted file mode 100644 index a9d9c4e..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/Lookup.twiki +++ /dev/null @@ -1,12 +0,0 @@ ----+++Lookup - -[[CommonCLI][Common CLI Options]] - -Lookup option tells you which feed does a given path belong to. This can be useful in several scenarios e.g. generally you would want to have a single definition for common feeds like metadata with same location -otherwise it can result in a problem (different retention durations can result in surprises for one team) If you want to check if there are multiple definitions of same metadata then you can pick -an instance of that and run through the lookup command like below. - -Usage: -$FALCON_HOME/bin/falcon entity -type feed -lookup -path /data/projects/my-hourly/2014/10/10/23/ - -If you have multiple feeds with location as /data/projects/my-hourly/${YEAR}/${MONTH}/${DAY}/${HOUR} then this command will return all of them. http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/ParamsInstance.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/ParamsInstance.twiki b/trunk/releases/master/src/site/twiki/falconcli/ParamsInstance.twiki deleted file mode 100644 index 9f217ba..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/ParamsInstance.twiki +++ /dev/null @@ -1,8 +0,0 @@ ----+++Params - -[[CommonCLI][Common CLI Options]] - -Displays the workflow params of a given instance. Where start time is considered as nominal time of that instance and end time won't be considered. - -Usage: -$FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -params -start "yyyy-MM-dd'T'HH:mm'Z'" http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/RelationMetadata.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/RelationMetadata.twiki b/trunk/releases/master/src/site/twiki/falconcli/RelationMetadata.twiki deleted file mode 100644 index e9bc970..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/RelationMetadata.twiki +++ /dev/null @@ -1,10 +0,0 @@ ----+++ Relations - -[[CommonCLI][Common CLI Options]] - -List all dimensions related to specified Dimension identified by dimension-type and dimension-name. -Usage: -$FALCON_HOME/bin/falcon metadata -relations -type [cluster_entity|feed_entity|process_entity|user|colo|tags|groups|pipelines] -name <<Dimension Name>> - -Example: -$FALCON_HOME/bin/falcon metadata -relations -type process_entity -name sample-process \ No newline at end of file http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/RerunInstance.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/RerunInstance.twiki b/trunk/releases/master/src/site/twiki/falconcli/RerunInstance.twiki deleted file mode 100644 index aac844c..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/RerunInstance.twiki +++ /dev/null @@ -1,10 +0,0 @@ ----+++Rerun - -[[CommonCLI][Common CLI Options]] - -Rerun option is used to rerun instances of a given process. On issuing a rerun, by default the execution resumes from the last failed node in the workflow. This option is valid only for process instances in terminal state, i.e. SUCCEEDED, KILLED or FAILED. -If one wants to forcefully rerun the entire workflow, -force should be passed along with -rerun -Additionally, you can also specify properties to override via a properties file. - -Usage: -$FALCON_HOME/bin/falcon instance -type <<feed/process>> -name <<name>> -rerun -start "yyyy-MM-dd'T'HH:mm'Z'" -end "yyyy-MM-dd'T'HH:mm'Z'" [-force] [-file <<properties file>>] http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/ResumeEntity.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/ResumeEntity.twiki b/trunk/releases/master/src/site/twiki/falconcli/ResumeEntity.twiki deleted file mode 100644 index 39be411..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/ResumeEntity.twiki +++ /dev/null @@ -1,8 +0,0 @@ ----+++Resume - -[[CommonCLI][Common CLI Options]] - -Puts a suspended process/feed back to active, which in turn resumes applicable oozie bundle. - -Usage: - $FALCON_HOME/bin/falcon entity -type [feed|process] -name <<name>> -resume http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/ResumeInstance.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/ResumeInstance.twiki b/trunk/releases/master/src/site/twiki/falconcli/ResumeInstance.twiki deleted file mode 100644 index 3790f47..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/ResumeInstance.twiki +++ /dev/null @@ -1,8 +0,0 @@ ----+++Resume - -[[CommonCLI][Common CLI Options]] - -Resume option is used to resume any instance that is in suspended state. - -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'" http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/RunningInstance.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/RunningInstance.twiki b/trunk/releases/master/src/site/twiki/falconcli/RunningInstance.twiki deleted file mode 100644 index f269358..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/RunningInstance.twiki +++ /dev/null @@ -1,13 +0,0 @@ ----+++Running - -[[CommonCLI][Common CLI Options]] - -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 - -<a href="../Restapi/InstanceRunning.html">Optional params described here.</a> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/SLAAlert.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/SLAAlert.twiki b/trunk/releases/master/src/site/twiki/falconcli/SLAAlert.twiki deleted file mode 100644 index e5270fa..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/SLAAlert.twiki +++ /dev/null @@ -1,49 +0,0 @@ ----+++SLAAlert - -[[CommonCLI][Common CLI Options]] - -<verbatim> -Since: 0.8 -</verbatim> - -This command lists all the feed instances which have missed sla and are still not available. If a feed instance missed -sla but is now available, then it will not be reported in results. The purpose of this API is alerting and hence it - doesn't return feed instances which missed SLA but are available as they don't require any action. - -* Currently sla monitoring is supported only for feeds. - -* Option end is optional and will default to current time if missing. - -* Option name is optional, if provided only instances of that feed will be considered. - -Usage: - -*Example 1* - -*$FALCON_HOME/bin/falcon entity -type feed -start 2014-09-05T00:00Z -slaAlert -end 2016-05-03T00:00Z -colo local* - -name: out, type: FEED, cluster: local, instanceTime: 2015-09-26T11:59Z, tags: Missed SLA High -name: out, type: FEED, cluster: local, instanceTime: 2015-09-26T12:00Z, tags: Missed SLA High -name: out, type: FEED, cluster: local, instanceTime: 2015-09-26T12:01Z, tags: Missed SLA High -name: out, type: FEED, cluster: local, instanceTime: 2015-09-26T12:02Z, tags: Missed SLA High -name: out, type: FEED, cluster: local, instanceTime: 2015-09-26T12:03Z, tags: Missed SLA High -name: out, type: FEED, cluster: local, instanceTime: 2015-09-26T12:04Z, tags: Missed SLA High -name: out, type: FEED, cluster: local, instanceTime: 2015-09-26T12:05Z, tags: Missed SLA High -name: out, type: FEED, cluster: local, instanceTime: 2015-09-26T12:06Z, tags: Missed SLA High -name: out, type: FEED, cluster: local, instanceTime: 2015-09-26T12:07Z, tags: Missed SLA High -name: out, type: FEED, cluster: local, instanceTime: 2015-09-26T12:08Z, tags: Missed SLA Low - - -Response: default/Success! - -Request Id: default/216978070@qtp-830047511-4 - f5a6c129-ab42-4feb-a2bf-c3baed356248 - -*Example 2* - -*$FALCON_HOME/bin/falcon entity -type feed -start 2014-09-05T00:00Z -slaAlert -end 2016-05-03T00:00Z -colo local -name in* - -name: in, type: FEED, cluster: local, instanceTime: 2015-09-26T06:00Z, tags: Missed SLA High - -Response: default/Success! - -Request Id: default/1580107885@qtp-830047511-7 - f16cbc51-5070-4551-ad25-28f75e5e4cf2 http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/Schedule.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/Schedule.twiki b/trunk/releases/master/src/site/twiki/falconcli/Schedule.twiki deleted file mode 100644 index c4422e7..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/Schedule.twiki +++ /dev/null @@ -1,22 +0,0 @@ ----+++Schedule - -[[CommonCLI][Common CLI Options]] - -Once submitted, an entity can be scheduled using schedule option. Process and feed can only be scheduled. - -Usage: -$FALCON_HOME/bin/falcon entity -type [process|feed] -name <<name>> -schedule - -Optional Args : - --skipDryRun When this argument is specified, Falcon skips oozie dryrun. - --doAs <username> - --properties <<key1:val1,...,keyN:valN>>. Specifying 'falcon.scheduler:native' as a property will schedule the entity on the the native scheduler of Falcon. Else, it will default to the engine specified in startup.properties. For details on Native scheduler, refer to [[FalconNativeScheduler][Falcon Native Scheduler]] - -Examples: - - $FALCON_HOME/bin/falcon entity -type process -name sampleProcess -schedule - - $FALCON_HOME/bin/falcon entity -type process -name sampleProcess -schedule -properties falcon.scheduler:native http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/StatusAdmin.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/StatusAdmin.twiki b/trunk/releases/master/src/site/twiki/falconcli/StatusAdmin.twiki deleted file mode 100644 index dadb8e5..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/StatusAdmin.twiki +++ /dev/null @@ -1,8 +0,0 @@ ----+++Status - -[[CommonCLI][Common CLI Options]] - -Status returns the current state of Falcon (running or stopped). -Usage: -$FALCON_HOME/bin/falcon admin -status - http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/StatusEntity.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/StatusEntity.twiki b/trunk/releases/master/src/site/twiki/falconcli/StatusEntity.twiki deleted file mode 100644 index 56d16f0..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/StatusEntity.twiki +++ /dev/null @@ -1,8 +0,0 @@ ----+++Status - -[[CommonCLI][Common CLI Options]] - -Status returns the current status of the entity. - -Usage: -$FALCON_HOME/bin/falcon entity -type [cluster|datasource|feed|process] -name <<name>> -status \ No newline at end of file http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/StatusInstance.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/StatusInstance.twiki b/trunk/releases/master/src/site/twiki/falconcli/StatusInstance.twiki deleted file mode 100644 index 047d334..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/StatusInstance.twiki +++ /dev/null @@ -1,21 +0,0 @@ ----+++Status - -[[CommonCLI][Common CLI Options]] - -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. -The job urls are populated for all actions of user workflow and non-succeeded actions of the main-workflow. The user then need not go to the underlying scheduler to get the job urls when needed to debug an issue in the job. - -Example : Suppose a process has 3 instance, one has succeeded,one is in running state and other one is waiting, the expected output is: - -{"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 --allAttempts To get all the attempts for corresponding instances - -<a href="../Restapi/InstanceStatus.html"> Optional params described here.</a> http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/Submit.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/Submit.twiki b/trunk/releases/master/src/site/twiki/falconcli/Submit.twiki deleted file mode 100644 index f2f7a49..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/Submit.twiki +++ /dev/null @@ -1,13 +0,0 @@ ----+++Submit - -[[CommonCLI][Common CLI Options]] - -Submit option is used to set up entity definition. - -Usage: -$FALCON_HOME/bin/falcon entity -submit -type [cluster|datasource|feed|process] -file <entity-definition.xml> - -Example: -$FALCON_HOME/bin/falcon entity -submit -type cluster -file /cluster/definition.xml - -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. http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/SubmitRecipe.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/SubmitRecipe.twiki b/trunk/releases/master/src/site/twiki/falconcli/SubmitRecipe.twiki deleted file mode 100644 index d14b00d..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/SubmitRecipe.twiki +++ /dev/null @@ -1,17 +0,0 @@ ----+++ Submit Recipe - -[[CommonCLI][Common CLI Options]] - -Submit the specified recipe. - -Usage: -$FALCON_HOME/bin/falcon recipe -name <name> -Name of the recipe. User should have defined <name>-template.xml and <name>.properties in the path specified by falcon.recipe.path in client.properties file. falcon.home path is used if its not specified in client.properties file. -If its not specified in client.properties file and also if files cannot be found at falcon.home, Falcon CLI will fail. - -Optional Args : -tool <recipeToolClassName> -Falcon provides a base tool that recipes can override. If this option is not specified the default Recipe Tool -RecipeTool defined is used. This option is required if user defines his own recipe tool class. - -Example: -$FALCON_HOME/bin/falcon recipe -name hdfs-replication \ No newline at end of file http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/SummaryEntity.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/SummaryEntity.twiki b/trunk/releases/master/src/site/twiki/falconcli/SummaryEntity.twiki deleted file mode 100644 index 800f9fc..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/SummaryEntity.twiki +++ /dev/null @@ -1,14 +0,0 @@ ----+++Summary - -[[CommonCLI][Common CLI Options]] - -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 - -<a href="../Restapi/EntitySummary.html">Optional params described here.</a> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/SummaryInstance.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/SummaryInstance.twiki b/trunk/releases/master/src/site/twiki/falconcli/SummaryInstance.twiki deleted file mode 100644 index f7ca0b4..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/SummaryInstance.twiki +++ /dev/null @@ -1,20 +0,0 @@ ----+++Summary - -[[CommonCLI][Common CLI Options]] - -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. - -Example : Suppose a process has 3 instance, one has succeeded,one is in running state and other one is waiting, the expected output is: - -{"status":"SUCCEEDED","message":"getSummary is successful", instancesSummary:[{"cluster": <<name>> "map":[{"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>> --filterBy <<field1:value1,field2:value2>> -lifecycle <<lifecycles>> --orderBy field -sortOrder <<sortOrder>> - -<a href="../Restapi/InstanceSummary.html">Optional params described here.</a> http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/SuspendEntity.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/SuspendEntity.twiki b/trunk/releases/master/src/site/twiki/falconcli/SuspendEntity.twiki deleted file mode 100644 index 7618e9c..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/SuspendEntity.twiki +++ /dev/null @@ -1,8 +0,0 @@ ----+++Suspend - -[[CommonCLI][Common CLI Options]] - -Suspend on an entity results in suspension of the oozie bundle that was scheduled earlier through the schedule function. No further instances are executed on a suspended entity. Only schedule-able entities(process/feed) can be suspended. - -Usage: -$FALCON_HOME/bin/falcon entity -type [feed|process] -name <<name>> -suspend \ No newline at end of file http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/SuspendInstance.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/SuspendInstance.twiki b/trunk/releases/master/src/site/twiki/falconcli/SuspendInstance.twiki deleted file mode 100644 index 221cf5c..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/SuspendInstance.twiki +++ /dev/null @@ -1,8 +0,0 @@ ----+++Suspend - -[[CommonCLI][Common CLI Options]] - -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. - -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'" http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/Touch.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/Touch.twiki b/trunk/releases/master/src/site/twiki/falconcli/Touch.twiki deleted file mode 100644 index afbd848..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/Touch.twiki +++ /dev/null @@ -1,10 +0,0 @@ ----+++Touch - -[[CommonCLI][Common CLI Options]] - -Force Update operation allows an already submitted/scheduled entity to be updated. - -Usage: -$FALCON_HOME/bin/falcon entity -type [feed|process] -name <<name>> -touch - -Optional Arg : -skipDryRun. When this argument is specified, Falcon skips oozie dryrun. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/TriageInstance.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/TriageInstance.twiki b/trunk/releases/master/src/site/twiki/falconcli/TriageInstance.twiki deleted file mode 100644 index c2c32cd..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/TriageInstance.twiki +++ /dev/null @@ -1,9 +0,0 @@ ----+++Triage - -[[CommonCLI][Common CLI Options]] - -Given a feed/process instance this command traces it's ancestors to find what all ancestors have failed. It's useful if -lot of instances are failing in a pipeline as it then finds out the root cause of the pipeline being stuck. - -Usage: -$FALCON_HOME/bin/falcon instance -triage -type <<feed/process>> -name <<name>> -start "yyyy-MM-dd'T'HH:mm'Z'" http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/UpdateEntity.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/UpdateEntity.twiki b/trunk/releases/master/src/site/twiki/falconcli/UpdateEntity.twiki deleted file mode 100644 index ae60559..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/UpdateEntity.twiki +++ /dev/null @@ -1,14 +0,0 @@ ----+++Update - -[[CommonCLI][Common CLI Options]] - -Update operation allows an already submitted/scheduled entity to be updated. Cluster and datasource updates are -currently not allowed. - -Usage: -$FALCON_HOME/bin/falcon entity -type [feed|process] -name <<name>> -update -file <<path_to_file>> - -Optional Arg : -skipDryRun. When this argument is specified, Falcon skips oozie dryrun. - -Example: -$FALCON_HOME/bin/falcon entity -type process -name hourly-reports-generator -update -file /process/definition.xml http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/VersionAdmin.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/VersionAdmin.twiki b/trunk/releases/master/src/site/twiki/falconcli/VersionAdmin.twiki deleted file mode 100644 index 453f6a1..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/VersionAdmin.twiki +++ /dev/null @@ -1,7 +0,0 @@ ----+++Version - -[[CommonCLI][Common CLI Options]] - -Version returns the current version of Falcon installed. -Usage: -$FALCON_HOME/bin/falcon admin -version http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/VertexEdgesMetadata.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/VertexEdgesMetadata.twiki b/trunk/releases/master/src/site/twiki/falconcli/VertexEdgesMetadata.twiki deleted file mode 100644 index e9182fc..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/VertexEdgesMetadata.twiki +++ /dev/null @@ -1,12 +0,0 @@ ----+++ Vertex Edges - -[[CommonCLI][Common CLI Options]] - -Get the adjacent vertices or edges of the vertex with the specified direction. - -Usage: -$FALCON_HOME/bin/falcon metadata -edges -id <<vertex-id>> -direction <<direction>> - -Example: -$FALCON_HOME/bin/falcon metadata -edges -id 4 -direction both -$FALCON_HOME/bin/falcon metadata -edges -id 4 -direction inE http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/VertexMetadata.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/VertexMetadata.twiki b/trunk/releases/master/src/site/twiki/falconcli/VertexMetadata.twiki deleted file mode 100644 index b2c62e8..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/VertexMetadata.twiki +++ /dev/null @@ -1,11 +0,0 @@ ----+++ Vertex - -[[CommonCLI][Common CLI Options]] - -Get the vertex with the specified id. - -Usage: -$FALCON_HOME/bin/falcon metadata -vertex -id <<id>> - -Example: -$FALCON_HOME/bin/falcon metadata -vertex -id 4 http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/falconcli/VerticesMetadata.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/falconcli/VerticesMetadata.twiki b/trunk/releases/master/src/site/twiki/falconcli/VerticesMetadata.twiki deleted file mode 100644 index 1b32ad5..0000000 --- a/trunk/releases/master/src/site/twiki/falconcli/VerticesMetadata.twiki +++ /dev/null @@ -1,11 +0,0 @@ ----+++ Vertices - -[[CommonCLI][Common CLI Options]] - -Get all vertices for a key index given the specified value. - -Usage: -$FALCON_HOME/bin/falcon metadata -vertices -key <<key>> -value <<value>> - -Example: -$FALCON_HOME/bin/falcon metadata -vertices -key type -value feed-instance http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/index.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/index.twiki b/trunk/releases/master/src/site/twiki/index.twiki deleted file mode 100644 index a1ee0a3..0000000 --- a/trunk/releases/master/src/site/twiki/index.twiki +++ /dev/null @@ -1,43 +0,0 @@ ----+ Falcon - Feed management and data processing platform - -Falcon is a feed processing and feed management system aimed at making it -easier for end consumers to onboard their feed processing and feed -management on hadoop clusters. - ----++ Why? - - * Establishes relationship between various data and processing elements on a Hadoop environment - - * Feed management services such as feed retention, replications across clusters, archival etc. - - * Easy to onboard new workflows/pipelines, with support for late data handling, retry policies - - * Integration with metastore/catalog such as Hive/HCatalog - - * Provide notification to end customer based on availability of feed groups - (logical group of related feeds, which are likely to be used together) - - * Enables use cases for local processing in colo and global aggregations - - * Captures Lineage information for feeds and processes - ----+ Getting Started - -Start with these simple steps to install an falcon instance [[InstallationSteps][Simple setup]]. Also refer -to Falcon architecture and documentation in [[FalconDocumentation][Documentation]]. [[OnBoarding][On boarding]] -describes steps to on-board a pipeline to Falcon. It also gives a sample pipeline for reference. -[[EntitySpecification][Entity Specification]] gives complete details of all Falcon entities. - -[[falconcli/FalconCLI][Falcon CLI]] implements [[restapi/ResourceList][Falcon's RESTful API]] and -describes various options for the command line utility provided by Falcon. - -Falcon provides OOTB [[HiveIntegration][lifecycle management for Tables in Hive (HCatalog)]] -such as table replication for BCP and table eviction. Falcon also enforces -[[Security][Security]] on protected resources and enables SSL. - -#LicenseInfo ----+ Licensing Information - -Falcon is distributed under [[http://www.apache.org/licenses/LICENSE-2.0][Apache License 2.0]]. - - http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/restapi/AdjacentVertices.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/restapi/AdjacentVertices.twiki b/trunk/releases/master/src/site/twiki/restapi/AdjacentVertices.twiki deleted file mode 100644 index 1e60866..0000000 --- a/trunk/releases/master/src/site/twiki/restapi/AdjacentVertices.twiki +++ /dev/null @@ -1,91 +0,0 @@ ----++ GET api/metadata/lineage/vertices/:id/:direction - * <a href="#Description">Description</a> - * <a href="#Parameters">Parameters</a> - * <a href="#Results">Results</a> - * <a href="#Examples">Examples</a> - ----++ Description -Get a list of adjacent vertices or edges with a direction. - ----++ Parameters - * :id is the id of the vertex. - * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. - * :direction is the direction associated with the edges. - - To get the adjacent out vertices of vertex pass direction as out, in to get adjacent in vertices - and both to get both in and out adjacent vertices. Similarly to get the out edges of vertex - pass outE, inE to get in edges and bothE to get the both in and out edges of vertex. - - * out : get the adjacent out vertices of vertex - * in : get the adjacent in vertices of vertex - * both : get the both adjacent in and out vertices of vertex - * outCount : get the number of out vertices of vertex - * inCount : get the number of in vertices of vertex - * bothCount : get the number of adjacent in and out vertices of vertex - * outIds : get the identifiers of out vertices of vertex - * inIds : get the identifiers of in vertices of vertex - * bothIds : get the identifiers of adjacent in and out vertices of vertex - ----++ Results -Adjacent vertices of the vertex for the specified direction. - ----++ Examples ----+++ Rest Call -<verbatim> -GET http://localhost:15000/api/metadata/lineage/vertices/4/out -</verbatim> ----+++ Result -<verbatim> -{ - "results": [ - { - "timestamp":"2014-04-21T20:55Z", - "name":"sampleFeed", - "type":"feed-instance", - "_id":8, - "_type":"vertex" - } - ], - "totalSize":1} -} -</verbatim> - ----+++ Rest Call -<verbatim> -GET http://localhost:15000/api/metadata/lineage/vertices/4/bothE -</verbatim> ----+++ Result -<verbatim> -{ - "results":[ - { - "_id":"Q5V-4-5g", - "_type":"edge", - "_outV":4, - "_inV":8, - "_label":"output" - } - ], - "totalSize":1 -} -</verbatim> - ----+++ Rest Call -<verbatim> -GET http://localhost:15000/api/metadata/lineage/vertices/4/bothE?doAs=joe -</verbatim> ----+++ Result -<verbatim> -{ - "results":[ - { - "_id":"Q5V-4-5g", - "_type":"edge", - "_outV":4, - "_inV":8, - "_label":"output" - } - ], - "totalSize":1 -} -</verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/restapi/AdminConfig.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/restapi/AdminConfig.twiki b/trunk/releases/master/src/site/twiki/restapi/AdminConfig.twiki deleted file mode 100644 index 675b19e..0000000 --- a/trunk/releases/master/src/site/twiki/restapi/AdminConfig.twiki +++ /dev/null @@ -1,35 +0,0 @@ ----++ GET /api/admin/config/:config-type - * <a href="#Description">Description</a> - * <a href="#Parameters">Parameters</a> - * <a href="#Results">Results</a> - * <a href="#Examples">Examples</a> - ----++ Description -Get configuration information of the falcon server. - ----++ Parameters - * :config-type can be build, deploy, startup or runtime - ----++ Results -Configuration information of the server. - ----++ Examples ----+++ Rest Call -<verbatim> -GET http://localhost:15000/api/admin/config/deploy -</verbatim> ----+++ Result -<verbatim> -{ - "properties": [ - { - "value": "embedded", - "key": "deploy.mode" - }, - { - "value": "all", - "key": "domain" - } - ] -} -</verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/restapi/AdminStack.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/restapi/AdminStack.twiki b/trunk/releases/master/src/site/twiki/restapi/AdminStack.twiki deleted file mode 100644 index 08903a2..0000000 --- a/trunk/releases/master/src/site/twiki/restapi/AdminStack.twiki +++ /dev/null @@ -1,40 +0,0 @@ ----++ GET /api/admin/stack - * <a href="#Description">Description</a> - * <a href="#Parameters">Parameters</a> - * <a href="#Results">Results</a> - * <a href="#Examples">Examples</a> - ----++ Description -Get stack trace of the falcon server. - ----++ Parameters - * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. - ----++ Results -Stack trace of the server. - ----++ Examples ----+++ Rest Call -<verbatim> -GET http://localhost:15000/api/admin/stack?doAs=joe -</verbatim> ----+++ Result -<verbatim> -Reference Handler -State: WAITING -java.lang.Object.wait(Native Method) -java.lang.Object.wait(Object.java:485) -java.lang.ref.Reference$ReferenceHandler.run(Reference.java:116)Finalizer - -... - -State: TIMED_WAITING -sun.misc.Unsafe.park(Native Method) -java.util.concurrent.locks.LockSupport.parkNanos(LockSupport.java:196) -java.util.concurrent.SynchronousQueue$TransferStack.awaitFulfill(SynchronousQueue.java:424) -java.util.concurrent.SynchronousQueue$TransferStack.transfer(SynchronousQueue.java:323) -java.util.concurrent.SynchronousQueue.poll(SynchronousQueue.java:874) -java.util.concurrent.ThreadPoolExecutor.getTask(ThreadPoolExecutor.java:955) -java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:917) -java.lang.Thread.run(Thread.java:695) -</verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/restapi/AdminVersion.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/restapi/AdminVersion.twiki b/trunk/releases/master/src/site/twiki/restapi/AdminVersion.twiki deleted file mode 100644 index 7db2d8f..0000000 --- a/trunk/releases/master/src/site/twiki/restapi/AdminVersion.twiki +++ /dev/null @@ -1,35 +0,0 @@ ----++ GET /api/admin/version - * <a href="#Description">Description</a> - * <a href="#Parameters">Parameters</a> - * <a href="#Results">Results</a> - * <a href="#Examples">Examples</a> - ----++ Description -Get version of the falcon server. - ----++ Parameters - * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. - ----++ Results -Version of the server. - ----++ Examples ----+++ Rest Call -<verbatim> -GET http://localhost:15000/api/admin/version?doAs=joe -</verbatim> ----+++ Result -<verbatim> -{ - "properties":[ - { - "key":"Version", - "value":"0.4-incubating-SNAPSHOT-rb47788d1112fcf949c22a3860934167237b395b0" - }, - { - "key":"Mode", - "value":"embedded" - } - ] -} -</verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/restapi/AllEdges.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/restapi/AllEdges.twiki b/trunk/releases/master/src/site/twiki/restapi/AllEdges.twiki deleted file mode 100644 index 303ac50..0000000 --- a/trunk/releases/master/src/site/twiki/restapi/AllEdges.twiki +++ /dev/null @@ -1,42 +0,0 @@ ----++ GET pi/metadata/lineage//edges/all - * <a href="#Description">Description</a> - * <a href="#Parameters">Parameters</a> - * <a href="#Results">Results</a> - * <a href="#Examples">Examples</a> - ----++ Description -Get all edges. - ----++ Parameters - * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. - ----++ Results -All edges in lineage graph. - ----++ Examples ----+++ Rest Call -<verbatim> -GET http://localhost:15000/api/metadata/lineage/edges/all?doAs=joe -</verbatim> ----+++ Result -<verbatim> -{ - "results": [ - { - "_id":"Q5V-4-5g", - "_type":"edge", - "_outV":4, - "_inV":8, - "_label":"output" - }, - { - "_id":"Q6t-c-5g", - "_type":"edge", - "_outV":12, - "_inV":16, - "_label":"output" - } - ], - "totalSize": 2 -} -</verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/restapi/AllVertices.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/restapi/AllVertices.twiki b/trunk/releases/master/src/site/twiki/restapi/AllVertices.twiki deleted file mode 100644 index d2beb48..0000000 --- a/trunk/releases/master/src/site/twiki/restapi/AllVertices.twiki +++ /dev/null @@ -1,43 +0,0 @@ ----++ GET api/metadata/lineage/vertices/all - * <a href="#Description">Description</a> - * <a href="#Parameters">Parameters</a> - * <a href="#Results">Results</a> - * <a href="#Examples">Examples</a> - ----++ Description -Get all vertices. - ----++ Parameters - * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. - ----++ Results -All vertices in lineage graph. - ----++ Examples ----+++ Rest Call -<verbatim> -GET http://localhost:15000/api/metadata/lineage/vertices/all?doAs=joe -</verbatim> ----+++ Result -<verbatim> -{ - "results": [ - { - "timestamp":"2014-04-21T20:55Z", - "name":"sampleIngestProcess\/2014-03-01T10:00Z", - "type":"process-instance", - "version":"2.0.0", - "_id":4, - "_type":"vertex" - }, - { - "timestamp":"2014-04-21T20:55Z", - "name":"rawEmailFeed\/2014-03-01T10:00Z", - "type":"feed-instance", - "_id":8, - "_type":"vertex" - } - ], - "totalSize": 2 -} -</verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/restapi/Edge.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/restapi/Edge.twiki b/trunk/releases/master/src/site/twiki/restapi/Edge.twiki deleted file mode 100644 index 7c4dbe5..0000000 --- a/trunk/releases/master/src/site/twiki/restapi/Edge.twiki +++ /dev/null @@ -1,34 +0,0 @@ ----++ GET api/metadata/lineage/edges/:id - * <a href="#Description">Description</a> - * <a href="#Parameters">Parameters</a> - * <a href="#Results">Results</a> - * <a href="#Examples">Examples</a> - ----++ Description -Gets the edge with specified id. - ----++ Parameters - * :id is the unique id of the edge. - * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. - ----++ Results -Edge with the specified id. - ----++ Examples ----+++ Rest Call -<verbatim> -GET http://localhost:15000/api/metadata/lineage/edges/Q6t-c-5g?doAs=joe -</verbatim> ----+++ Result -<verbatim> -{ - "results": - { - "_id":"Q6t-c-5g", - "_type":"edge", - "_outV":12, - "_inV":16, - "_label":"output" - } -} -</verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/restapi/EntityDefinition.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/restapi/EntityDefinition.twiki b/trunk/releases/master/src/site/twiki/restapi/EntityDefinition.twiki deleted file mode 100644 index 5e1165b..0000000 --- a/trunk/releases/master/src/site/twiki/restapi/EntityDefinition.twiki +++ /dev/null @@ -1,53 +0,0 @@ ----++ GET /api/entities/definition/:entity-type/:entity-name - * <a href="#Description">Description</a> - * <a href="#Parameters">Parameters</a> - * <a href="#Results">Results</a> - * <a href="#Examples">Examples</a> - ----++ Description -Get definition of the entity. - ----++ Parameters - * :entity-type can be cluster, feed or process. - * :entity-name is name of the entity. - * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. - ----++ Results -Definition of the entity. - ----++ Examples ----+++ Rest Call -<verbatim> -GET http://localhost:15000/api/entities/definition/process/SampleProcess?doAs=joe -</verbatim> ----+++ Result -<verbatim> -<?xml version="1.0" encoding="UTF-8" standalone="yes"?> -<process name="SampleProcess" xmlns="uri:falcon:process:0.1"> - <clusters> - <cluster name="primary-cluster"> - <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z"/> - </cluster> - </clusters> - <parallel>1</parallel> - <order>FIFO</order> - <frequency>hours(1)</frequency> - <timezone>UTC</timezone> - <inputs> - <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)"/> - </inputs> - <outputs> - <output name="output" feed="SampleOutput" instance="yesterday(0,0)"/> - </outputs> - <properties> - <property name="queueName" value="default"/> - <property name="ssh.host" value="localhost"/> - <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}"/> - </properties> - <workflow engine="oozie" path="/examples/apps/aggregator"/> - <retry policy="exp-backoff" delay="minutes(5)" attempts="3"/> - <late-process policy="exp-backoff" delay="hours(1)"> - <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput"/> - </late-process> -</process> -</verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/4e4b8457/trunk/releases/master/src/site/twiki/restapi/EntityDelete.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/master/src/site/twiki/restapi/EntityDelete.twiki b/trunk/releases/master/src/site/twiki/restapi/EntityDelete.twiki deleted file mode 100644 index a488943..0000000 --- a/trunk/releases/master/src/site/twiki/restapi/EntityDelete.twiki +++ /dev/null @@ -1,31 +0,0 @@ ----++ DELETE /api/entities/delete/:entity-type/:entity-name - * <a href="#Description">Description</a> - * <a href="#Parameters">Parameters</a> - * <a href="#Results">Results</a> - * <a href="#Examples">Examples</a> - ----++ Description -Delete the specified entity. - ----++ Parameters - * :entity-type can be feed or process. - * :entity-name is name of the feed or process. - * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. - ----++ Results -Results of the delete operation. - ----++ Examples ----+++ Rest Call -<verbatim> -DELETE http://localhost:15000/api/entities/delete/cluster/SampleProcess?doAs=joe -</verbatim> ----+++ Result -<verbatim> -{ - "requestId": "falcon\/17ff6ca6-1c8a-459f-9ba8-8fec480e384a\n", - "message": "falcon\/SampleProcess(cluster) removed successfully\n", - "status": "SUCCEEDED" -} -</verbatim> -
