Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Important
Lakewatch is in Private Preview. To request access, reach out to your Azure Databricks account team.
Export Lakewatch alerts to Jira as issues. When an alert is created, Lakewatch creates a Jira issue and updates it as the alert changes. For how export behaves across destinations, see Alert destinations.
Export to Jira is one-way, from Lakewatch to Jira. Lakewatch authenticates to Jira Cloud with a user email and API token as the basic-auth credential.
Prerequisites
Set up Jira
- A Jira account that can create and update issues in the target project.
- An API token for that account, paired with the account email as the Jira Cloud basic-auth credential. Create API tokens in your Atlassian account settings.
Store the API token as a Unity Catalog secret
Lakewatch reads the Jira API token from a Unity Catalog secret, a securable with a three-level name in the form catalog.schema.secret, each time it exports an alert. Lakewatch stores only the secret name, not the secret value.
You can create this secret ahead of time, or create it inline while configuring Jira export with the Create secret button. Either way, creating a secret requires USE CATALOG on the catalog and either ownership of the schema or both CREATE SECRET and USE SCHEMA on the schema. For the steps, see Create a secret.
Required permissions
To configure Jira export, you need the following:
READ SECRETon the Unity Catalog secret that holds the API token, or on its parent schema or catalog. Lakewatch checks that you can read the secret when you save the configuration. To grant it, see Manage permissions on secrets.- Permission to edit the alert export configuration in workspace settings.
At export time, Lakewatch reads the API token itself, as its service principal. Because Lakewatch reads the secret by name each time it exports, rotating the secret is zero-touch: update the Unity Catalog secret and Lakewatch uses the new value on the next export, with no change to the export configuration.
Configure Jira export
Configure a Jira destination for alerts in the Alerts settings section.
- In the Lakewatch sidebar, go to Settings, then open Alerts.
- Find the Export setting under Alerts.
- Set the export destination to Jira.
- For Workspace, keep the current workspace unless the destination is behind a specific workspace's network, such as a PrivateLink endpoint or a region-restricted service. This workspace's network delivers the export.
- In Instance URL, enter the Jira instance that issues are filed in, for example
https://acme.atlassian.net. - In Project key, enter the project that issues are created in.
- In User email, enter the account email that is paired with the API token.
- Set API token to the Unity Catalog secret that holds the Jira API token. Type or paste its three-level name (
catalog.schema.secret), click Select secret to pick an existing secret, or click Create secret to create one from the API token without leaving the page. After you save, the secret field becomes read-only; to update it, rotate the secret in Unity Catalog. - In Default issue type, optionally set the issue type to create, for example
Task. - Save your changes.
For the full alert settings reference, see Configure settings.
Troubleshooting
- Issues aren't created in Jira: the instance URL or project key is wrong, or the account can't create issues in the project. Confirm the instance URL, the project key, and that the account and API token can create issues in the project.
- The configuration doesn't save: you don't have permission to read the Unity Catalog secret, or the secret name isn't in the
catalog.schema.secretform. Confirm your access to the secret and the secret name. - Authentication fails: the user email or API token is wrong. Confirm the email is the account paired with the token, and that the token stored in the secret is valid.
- You rotated the API token: update the Unity Catalog secret with the new value. No change to the export configuration is needed.