Page History

...

1. Stop the Windows services and/or Linux processes for each Web and Exec server.

2. Perform backups of the following:

   • Your Azkaban metadata repository

   • azkaban.local.properties for each Web and Exec server

   • Any other configuration files if you have customized them

3. Run the installer targeting the existing Azkaban install locations:

   • Step 1 - upgrade the Azkaban metadata
   • Step 2 - upgrade the Azkaban Web Server
   • Step 3 - upgrade each Azkaban Executor

4. Merge any customizations back in from your earlier backups.

5. Start the Azkaban Web and Executor services and/or Linux processes.

6. Upgrade or merge changes to the Scheduler Integration Scripts as required.
7. Create scheduler authentication profiles as required. See Scheduler Profile Maintenance for details.

Backup of your Azkaban Properties and Configuration files

The installer for Azkaban overwrites the properties and configuration files during the upgrade process. The first step is to When you choose to upgrade either the Scheduler or the Executor, the installer will make a copy of any properties and configuration files to merge your custom settings back in after the upgrade.Backup these files (or the entire folder) for each Web Server and Executor Server being upgradedthat could have custom settings. These copies are stored on a folder called 'Backup-<timestamp>' in the ‘WEB_SERVER’ and ‘EXEC_SERVER’ folders. The backup includes these files:

• azkaban.local.properties
• azkaban-users.xml
• log4j.properties
• Response.xml
• users.xml

You can also manually backup these files for each Web Server and Executor Server being upgraded.

The backup of the azkaban.local.properties file will be useful to open while you run the installer so you can apply the correct settings to the installer fields.

Anchor
azkaban_upgrade_wizard azkaban_upgrade_wizard

Upgrade on Windows

1. Run On the RED installation folder, run RedSchedulerInstaller.exeexe to start the upgrade process, follow the interactive installer wizard. Please note the RedSchedulerInstaller.exe must be run using the same user that the Azkaban services are run under. 

   Tip
   title Tip
   Hold down Shift and right click on RedSchedulerInstaller.exe and select “run as different user” then enter the Azkaban service user credentials if you are currently logged in as another user.

   Note
   title Note
   For scripted upgrades, the Linux upgrade method described later can also be used on Windows.

   
   

2. To upgrade the Azkaban metadata and Web Server on this machine, select Install Scheduler Upgrade and un- check Add scheduler configuration to RED as this configuration has already been added to RED during the original install. If the components you want to upgrade an Executor on this machine, select Install Executor, as required.
   Image RemovedChoose the existing Azkaban installation location . 
   Image Added
3. Select the location of the scheduler you want to upgrade.
   
Image Removed
4. Provide the existing RED and Azkaban metadata databases. If you are unsure of the ports and users of your existing servers you can open the azkaban.local.properties file you backed up earlier and extract those details from it.
   Image Removed
5. Enter your existing server details into the Web Server Configuration and Exec Server Configuration screens ensure you have unchecked the options Install as Windows service as these were already put in place in the original installation.
   Image Removed
   

   1. Tip
      title Service User vs Local System
      When you uncheck the 'Install as Windows Service' then entering Service User and Password becomes optional, this is to support backwards compatibility with services created prior to RED 10.2, but is considered less secure. If you already have a service user for your existing service then you should enter those credentials here to ensure the passwords stored in the Azkaban properties files are more secure. If you omit Service User and Password then the DPAPI encryption of passwords in Azkaban properties files will be machine wide, allowing for any authenticated user on the machine or services running under the Local System account to decrypt. This is less secure than having a specific user for the service where only that user can decrypt the passwords. WhereScape recommends using a specific user for running your services for the additional level of security.

6. Image Added
   1. If you are upgrading from a version lower than RED 10.2, you will be required to specify the profile encryption secret and Windows service credentials.
7. The Upgrade wizard will collect all the required connection information from azkaban.local.properties and will show it on the summary window.
   Image Added
8.  To proceed Proceed through the rest of the installation wizard and click Install at the end to complete the upgrade of the Azkaban metadata and the Web and Exec Servers.
9. Post install you need to manually merge any customizations to the azkaban.local.properties and users file as required before starting up your services again.

...