Setting up Azkaban Users

If you require additional users for the Azkaban dashboard or API, other than the default users, then they can be added by the following process:

Create Azkaban accounts by editing the azkaban-users.xml file in the Web Server install directory, any changes to the settings in this file will not take effect until the Azkaban Web Server is restarted.

<web_server_dir>\<server_name>\azkaban-users.xml

For example:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<azkaban-users>
  <role name="admin" permissions="ADMIN"/>
  <role name="read" permissions="READ"/>
  <role name="executor" permissions="EXECUTE"/>
  <user username="admin" password="admin" roles="admin"/>
  <user username="readonly" password="readonly" roles="read"/>
  <user username="executor" password="executor" roles="executor,read"/>
</azkaban-users>

The possible role permissions are the following:

PermissionsValues
ADMINGrants all access to everything in Azkaban.
READGives users read-only access to every project and their logs
WRITEAllows users to upload files, change job properties, or remove any project
EXECUTEAllows users to trigger the execution of any flow
SCHEDULEUsers can add or remove schedules for any flows
CREATEPROJECTSAllows users to create new projects if project creation is locked down

Adjusting Properties

The main properties file ‘azkaban.local.properties’ for Azkaban Servers is located in the root folder of the Web or Executor Server installation directory. Most changes to the settings in this file will not take effect until the Azkaban Web or Executor Server is restarted.

Work Directory

  • Property: wherescape.job.workdir
  • Description: This setting is not present by default but can be added and set to an existing directory where all the WhereScape job work files will be created. Useful in dev environments where you have multiple schedulers running on a single machine and want to avoid conflicting temporary files.
  • Defaults to the following locations if the setting is not present or empty:

    • Linux defaults to /tmp

    • Windows defaults to the defined temp directory of the user (for the system user this will be C:\Windows\Temp)

Bin Directory

  • Property: wherescape.red.bindir - this setting allows you to set the path that will be returned by the WSL_BINDIR environment variable in scripts.


  • No labels