Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The RED scheduler can send email notifications when jobs fail or complete successfully. This section provides instructions on how to add the required configurations. 

Table of Contents

Configuring email settings on Scheduler Installation

Windows

The Windows Scheduler installation wizard provides a configuration screen for adding all the required settings.

  1. On the Email Configuration screen, select Enable email notifications. On this section add the following information.
    Email Server
    In this field enter the mail host.
    Email Server Port
    Enter the port your email server is using.
    Sender Email 
    This will be the email address displayed as From: on the email client.
  2. Select Enable authentication and fill the required fields.
    Email Server User
    Enter the username for the account that will send notifications.
    Email Server Password
    Enter the password for the account that will send notifications. 
    Encryption
    Select a type of encryption
    Note
    titleNote

    If you don't want to use an authenticated user for sending email notifications, deselect the Enable authentication option.

  3. Verify your settings and click Next to continue with the Scheduler installation.
  4. On the Summary screen, verify your settings are correct and continue with the installation.

Anchor
email_linux
email_linux
Linux

To add email notifications when installing the scheduler on Linux, you need to add the required settings on both the web response file andexecutor response files

Edit both response files, find the <emailConfig> element, and modify its child elements adding the required information.

...

Set to true if you want to authenticate the user that will send notifications. Set to false to send notifications without authentication.

Configuring email settings manually

Windows and Linux

If you didn't provide email settings during the scheduler installation, you can add them manually. You need to edit the azkaban.local.properties configuration file in the WEB_SERVER and EXEC_SERVER folders, these folders are located in the Scheduler installation folder, for example c:\pathtoscheduler\WEB_SERVER in Windows and /path/to/scheduler/WEB_SERVER in Linux.

...

In Linux, set this parameter to the string that represents the email password in the WALLET. To learn more about WALLET passwords refer to the RED Scheduler Configuration section.

...

Note
titleImportant

Once you add your configurations to azkaban.local.properties in both WEB_SERVER and EXEC_SERVER, you need to restart the Azkaban Webserver and Executor.

Setting up the notification recipient

Once you have configured your email settings you also need to set up the recipient email address in RED. 

...