Repository: falcon Updated Branches: refs/heads/master 4da2dc90b -> 5e4b06b7c
FALCON-1426 Add documentation for Falcon Email notification (Contributed by Peeyush Bishnoi) Project: http://git-wip-us.apache.org/repos/asf/falcon/repo Commit: http://git-wip-us.apache.org/repos/asf/falcon/commit/5e4b06b7 Tree: http://git-wip-us.apache.org/repos/asf/falcon/tree/5e4b06b7 Diff: http://git-wip-us.apache.org/repos/asf/falcon/diff/5e4b06b7 Branch: refs/heads/master Commit: 5e4b06b7c1aaa1f8aa4142bed0781596e8c21db0 Parents: 4da2dc9 Author: Pallavi Rao <[email protected]> Authored: Tue Sep 22 14:29:21 2015 +0530 Committer: Pallavi Rao <[email protected]> Committed: Tue Sep 22 14:29:21 2015 +0530 ---------------------------------------------------------------------- CHANGES.txt | 2 ++ docs/src/site/twiki/EntitySpecification.twiki | 22 +++++++++++++++ docs/src/site/twiki/FalconDocumentation.twiki | 4 +++ .../site/twiki/FalconEmailNotification.twiki | 29 ++++++++++++++++++++ 4 files changed, 57 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/falcon/blob/5e4b06b7/CHANGES.txt ---------------------------------------------------------------------- diff --git a/CHANGES.txt b/CHANGES.txt index 1492f5b..33349b4 100755 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -10,6 +10,8 @@ Trunk (Unreleased) IMPROVEMENTS FALCON-1434 Enhance schedule API to accept key-value properties(Pallavi Rao) + FALCON-1426 Add documentation for Falcon Email notification (Peeyush Bishnoi via Pallavi Rao) + FALCON-1425 Provide Email based plugin to send Notification once instance completed(Peeyush Bishnoi via Ajay Yadava) FALCON-1205 SLAService to keep track of missing SLAs for feeds(Ajay Yadava) http://git-wip-us.apache.org/repos/asf/falcon/blob/5e4b06b7/docs/src/site/twiki/EntitySpecification.twiki ---------------------------------------------------------------------- diff --git a/docs/src/site/twiki/EntitySpecification.twiki b/docs/src/site/twiki/EntitySpecification.twiki index bf45598..d4f4140 100644 --- a/docs/src/site/twiki/EntitySpecification.twiki +++ b/docs/src/site/twiki/EntitySpecification.twiki @@ -256,6 +256,18 @@ upto 8 hours then late-arrival's cut-off="hours(8)" *Note:* This will only apply for !FileSystem storage but not Table storage until a future time. + +---+++ Email Notification + +<verbatim> + <notification type="email" to="[email protected]"/> +</verbatim> +Specifying the notification element with "type" property allows users to receive email notification when a scheduled feed instance completes. +Multiple recipients of an email can be provided as comma separated addresses with "to" property. +To send email notification ensure that SMTP parameters are defined in Falcon startup.properties. +Refer to [[FalconEmailNotification][Falcon Email Notification]] for more details. + + ---+++ ACL A feed has ACL (Access Control List) useful for implementing permission requirements @@ -821,6 +833,16 @@ This late handling specifies that late data detection should run at feed's late *Note:* This is only supported for !FileSystem storage but not Table storage at this point. +---+++ Email Notification + +<verbatim> + <notification type="email" to="bob@@xyz.com"/> +</verbatim> +Specifying the notification element with "type" property allows users to receive email notification when a scheduled process instance completes. +Multiple recipients of an email can be provided as comma separated addresses with "to" property. +To send email notification ensure that SMTP parameters are defined in Falcon startup.properties. +Refer to [[FalconEmailNotification][Falcon Email Notification]] for more details. + ---+++ ACL A process has ACL (Access Control List) useful for implementing permission requirements http://git-wip-us.apache.org/repos/asf/falcon/blob/5e4b06b7/docs/src/site/twiki/FalconDocumentation.twiki ---------------------------------------------------------------------- diff --git a/docs/src/site/twiki/FalconDocumentation.twiki b/docs/src/site/twiki/FalconDocumentation.twiki index 68ed2e2..26a11e4 100644 --- a/docs/src/site/twiki/FalconDocumentation.twiki +++ b/docs/src/site/twiki/FalconDocumentation.twiki @@ -15,6 +15,7 @@ * <a href="#Security">Security</a> * <a href="#Recipes">Recipes</a> * <a href="#Monitoring">Monitoring</a> + * <a href="#Email_Notification">Email Notification</a> * <a href="#Backwards_Compatibility">Backwards Compatibility Instructions</a> * <a href="#Proxyuser_support">Proxyuser support</a> @@ -722,6 +723,9 @@ Recipes is detailed in [[Recipes][Recipes]]. Monitoring and Operationalizing Falcon is detailed in [[Operability][Operability]]. +---++ Email Notification +Notification for instance completion in Falcon is defined in [[FalconEmailNotification][Falcon Email Notification]]. + ---++ Backwards Compatibility Backwards compatibility instructions are [[Compatibility][detailed here.]] http://git-wip-us.apache.org/repos/asf/falcon/blob/5e4b06b7/docs/src/site/twiki/FalconEmailNotification.twiki ---------------------------------------------------------------------- diff --git a/docs/src/site/twiki/FalconEmailNotification.twiki b/docs/src/site/twiki/FalconEmailNotification.twiki new file mode 100644 index 0000000..25abdd2 --- /dev/null +++ b/docs/src/site/twiki/FalconEmailNotification.twiki @@ -0,0 +1,29 @@ +---++Falcon Email Notification + +Falcon Email notification allows sending email notifications when scheduled feed/process instances complete. +Email notification in feed/process entity can be defined as follows: +<verbatim> +<process name="[process name]"> + ... + <notification type="email" to="[email protected],[email protected]"/> + ... +</process> +</verbatim> + + * *type* - specifies about the type of notification. *Note:* Currently "email" notification type is supported. + * *to* - specifies the address to send notifications to; multiple recipients may be provided as a comma-separated list. + + +Falcon email notification requires some SMTP server configuration to be defined in startup.properties. Following are the values +it looks for: + * *falcon.email.smtp.host* - The host where the email action may find the SMTP server (localhost by default). + * *falcon.email.smtp.port* - The port to connect to for the SMTP server (25 by default). + * *falcon.email.from.address* - The from address to be used for mailing all emails (falcon@localhost by default). + * *falcon.email.smtp.auth* - Boolean property that specifies if authentication is to be done or not. (false by default). + * *falcon.email.smtp.user* - If authentication is enabled, the username to login as (empty by default). + * *falcon.email.smtp.password* - If authentication is enabled, the username's password (empty by default). + + + +Also ensure that email notification plugin is enabled in startup.properties to send email notifications: + * *monitoring.plugins* - org.apache.falcon.plugin.EmailNotificationPlugin,org.apache.falcon.plugin.DefaultMonitoringPlugin \ No newline at end of file
