Skip to main content
Last updated on

Configure Jira for ingestion

Beta

The Jira connector is in Beta.

This page describes how to configure Jira for ingestion into Databricks.

Prerequisites​

To ingest from Jira, you must have the following:

  • A Jira cloud environment or a Jira on-premises environment with version 8.22.x or later.
  • Workspace administrator privileges or CREATE CONNECTION privilege on the Unity Catalog metastore.
  • OAuth 2.0 credentials for your Jira environment.

Configure Jira for OAuth​

Prepare your Jira instance for ingestion. You can either add the required scopes to an existing OAuth app or create a new app.

Jira Cloud​

  1. Visit https://developer.atlassian.com/console/myapps/.

  2. Optionally click Create > OAuth 2.0 integration to create a new OAuth app. If you prefer to use an existing OAuth app, add the required scopes defined in steps 5 and 6.

  3. Provide a name for the integration, then click Create.

  4. Visit Permissions > Jira API (under API scopes) > Add.

  5. Click Classic Scopes > Edit Scopes, then add the following scopes to the OAuth app:

    read:jira-work, read:jira-user

  6. Click Granular Scopes > Edit Scopes, then add the following scopes to the OAuth app.

    Not all OAuth scopes are required for all Jira tables. If your organization can't grant certain scopes (such as admin-level scopes), you can still ingest the tables that don't depend on them. See Supported Jira source tables for ingestion to check which scopes are required for each table.

    read:project-role:jira, read:project-category:jira, read:user:jira, read:avatar:jira, read:sprint:jira-software, read:workflow:jira, read:board-scope:jira-software, read:project:jira, read:audit-log:jira, read:issue-security-level:jira, read:issue-security-scheme:jira, read:board-scope.admin:jira-software, read:group:jira read:application-role:jira

  7. Go to Authorization > Add and input the redirect URI as follows:

    https://<databricks_workspace_URL>/login/oauth/lakehousefederation.html

    For example:

    https://my-databricks-account.cloud.databricks.com/login/oauth/lakehousefederation.html

  8. Go to Settings and note down the Client ID and Client Secret. You'll use these to create a connection.

Jira on-premises​

Configure OAuth​

  1. Open Jira Administration.

  2. Visit Applications from the settings icon on the top-right.

  3. Open Applications > Application Links to see a list of created application links.

  4. Optionally click Create Link to create a new application link. If you prefer to use an existing OAuth app, add the required scopes.

  5. Select External Application as the application type and Incoming as the direction. Then click Continue.

  6. Provide a name for your external application, and input the redirect URL as follows:

    https://<databricks_workspace_URL>/login/oauth/lakehousefederation.html

    For example:

    https://my-databricks-account.cloud.databricks.com/login/oauth/lakehousefederation.html

  7. Set the Application permissions as Admin. Then, click Save.

  8. Note down the Client ID and Client Secret. You'll use these to create a connection.

Enable issue deletes in on-premises audit logs​

Sometimes issue deletes aren't present in the audit logs on an on-premises instance. To increase audit log coverage in those scenarios:

  1. Go to Jira Administration > System.

  2. Open Audit logs under Troubleshooting on the left, and set these three areas to Advanced:

    • Global configuration and administration
    • Local configuration and administration
    • End user activity

Next steps​