Page History

There are two ways to install the RED Azkaban Scheduler servers on Windows, this section covers using the recommended approach of running the RedSchedulerInstaller.exe, this wizard guides you through all the steps required to get up and running. For installation via the command line the same approach for RED Scheduler Installation on Linux can be followed. 

Windows Prerequisites

1. RED application installed 
2. RED metadata repository exists with ODBC DSN created

3. Azkaban PostgreSQL database to install the Azkaban 'white' schema and metadata tables (can be installed to the RED metadata database)

4. A Windows User for the services to run under, with: 
   1. user rights to 'Log On As A Service'
   2. write permissions on the Azkaban installation location (and work directory if not default user temp)

Windows Installation

To install the WhereScape Azkaban Scheduler on a Windows machine you must first install RED then run the RedSchedulerInstaller.exe from the installation directory.

1. Go to the installer path C:\Program Files\WhereScape\RED, run RedSchedulerInstaller.exe.

2. The Scheduler Installation screen opens. Select all the installation options: Install Scheduler, Install Executor, and Add Scheduler Configuration to RED, and click Next.

   1. Only one Scheduler can be installed per RED metadata repository
   2.  If you installed a scheduler already and only want to install another Executor then deselect the other options
      

3. In the Install Location screen, select the Installation Location. It is recommended to create a folder under the C: disk to install Azkaban. Click Next. 

   Tip
   title Azkaban Install Location
   The install location must be writeable for the Service User which the service will run under so should not be installed in a directory under Windows Users. Typically you would create a folder called Azkaban in your 'C:\Program Files\WhereScape' directory, but it can be installed anywhere on the machine that the service you has write access to.

   
   

4. The Scheduler Metadata screen shows the information of the database that contains the scheduler metadata. Fill out the Database Name, the User Name, and the Password of the database you created for Azkaban (Follow the same steps you follow to create the PostgreSQL Database). 

   Click Validate to confirm that all the entered information is correct. Click Next.

   

   Note: PostgreSQL Database Server Port is 5432 in default installations, but your database port may be different.

5. Enter the RED Metadata database information. Enter the Database Name, the User Name, and the Password. Click Validate to confirm all the information is correct and click Next.
   

6. Enter the Scheduler Metadata installation/upgrade or leave blank to use the previously entered user for Azkaban and click Next. These credentials are for an administrative database user with permission to perform DDL operations (If required).
   

7. The Web Server Configuration screen allows specifying the settings for the Web Server, make any changes necessary, populate all "required" fields and be sure that the option Install as Windows Service is selected before you move on. Note: You can uncheck Install as a Windows Service when upgrading or when you want to manage startup of the Web Server manually.

   Tip
   title Profile Pwd and Windows User
   The 'Profile Encryption Secret' will be used by RED Scheduler Jobs to decrypt the connection credentials at run-time, therefore you must remember and use this same password when generating the encrypted Scheduler Profile records for your connections. See Scheduler Profile Maintenance for more information. The 'Service User' is a windows user with the 'Log On As A Service' right, which the Azkaban service will run under. During installation the azkaban.local.properties file will be created for each Azkaban server with Windows user-based DPAPI encrypted password values and therefore only this same Service User will be able to decrypt those passwords at run-time. The 'Job Work Directory' is a location for any RED job related temporary files to be created. When left empty it will default to the Service User's temp directory at run-time. If you specify a value here it is important to make sure it will be writeable for the Server User, so typically you would not use a folder under the Windows Users directory.

   
   

8. In the Executor Configuration, click Add an Executor Tag…, enter the host name or IP address, and click OK. Click Next to continue with the installation.
   

9. Under the Email Configuration, enter the values you need to configure the email notifications. Click Next.
   

10. A window pops up to select the Data Source Name from the drop-down menu which is the RED Metadata database that you created previously, its credentials, Validate the data, and click Login.

    

11. The Add Scheduler Configuration to WhereScape RED window shows the information on how the new Scheduler will be accessed. Click Next.

    Tip
    title RED Scheduler Configuration
    It is important to note that the credentials for the Azkaban Dashboard User and API User are not applied to RED since these now reside only in the RED Profile file. Therefore after installing the Azkaban Web Server you will need to log in to RED and set these values in you Scheduler Configuration and then right click on 'Connections' node in the object tree to 'Save Profile' and 'include passwords'. The default credentials used in this screen are: wsdashboarduser, wsdashboardpass and wsapiuser, wsapipass

    
    
    
    

12. In the Summary window, review all the information about your installation and click Install.

13. When the installation is complete, click Finish to close the confirmation window.
    

Starting and stopping the Azkaban Servers

Windows

Each Azkaban Server service starts after installation and is set to auto-start at Windows startup.

Open Services.msc in Windows to find your Azkaban services to Start/Stop/Restart them manually or change the login user.

Troubleshooting

If either of your services fail to install

This issue is usually due to user rights to 'Log On As A Service' are not granted for the user you tried to install the service as.

In most cases you can simply go to Services.msc in Windows to find your Azkaban services and go to Properties of that service and renter the password for the service user, which will prompt Windows to detect the lack of rights issue and set the required rights for the user. In some systems only an Administrator user will be able to assign these rights so it is best to either have an admin do this or have the user created with the required rights by and admin prior to installation.

Another reason this could happen is if the services already exist, such as in an upgrade scenario. For upgrades it is best to either remove the service manually prior to upgrading or uncheck the 'Install as a Service' option during the install. In many cases the application upgrade will have been successful so you would just need to start up the service again.