Skip to main content
Last updated on

Jira

Preview

Lakewatch is in Private Preview. To request access, reach out to your 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 signs in to Jira Cloud with an account email and its API token.

Prerequisites​

Set up Jira​

  • A Jira instance reachable over HTTPS from the public internet. Lakewatch can't deliver to private networks, such as endpoints behind Private Link.
  • A Jira account that can create and update issues in the target project.
  • An API token for that account. Create it in your Atlassian account settings.

Store the API token as a Unity Catalog secret​

Store the Jira API token in a Unity Catalog secret in the __lakewatch schema of your Lakewatch environment's catalog. Select secret lists secrets from that schema, and Create secret creates one there. Lakewatch stores only the secret name, not the secret value.

You can create this secret ahead of time in <catalog>.__lakewatch, or create it 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 __lakewatch schema or both CREATE SECRET and USE SCHEMA on it. For the steps, see Create a secret.

Required permissions​

To configure Jira export, you need the following:

  • READ SECRET on 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.
  • The MANAGE privilege on your Lakewatch environment's catalog. See Configure settings.

To change the API token, update the value of the same Unity Catalog secret. Lakewatch uses the new value on the next export, with no change to the settings. To use a different secret, click Select secret or Create secret in the settings and save.

Set up Jira as an alert destination​

Configure a Jira destination for alerts in the Alerts settings section.

  1. In the Lakewatch sidebar, go to Settings, then open Alerts.
  2. Under Delivery, set Alert destination to Jira.
  3. In Jira instance URL, enter the Jira instance that issues are filed in, for example https://acme.atlassian.net.
  4. In Project key, enter the project that issues are created in.
  5. In User email, enter the account email that is paired with the API token.
  6. For API token secret, click Select secret to choose the secret that holds the API token, or click Create secret to create one from the API token without leaving the page. The field shows the secret's name, not its value.
  7. In Default issue type, enter the issue type to create, such as Task or Incident. This field is required, and Lakewatch doesn't fill in a default. If the project doesn't have that issue type, Jira rejects the export.
  8. 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, the secret is in a different catalog than your Lakewatch environment, or the instance URL doesn't use HTTPS or points to a private network. Confirm your access to the secret, its catalog, and the instance URL.
  • Your secret isn't listed in Select secret: Select secret lists only the secrets you can access in the __lakewatch schema of your environment's catalog. Store the secret there, or ask for READ SECRET on it.
  • 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.
On this page