Jira
The Jira Alert Method automatically opens a Jira issue to notify you whenever an incident is triggered.
Authentication
Setting up the Jira integration requires an API token. You can obtain this by logging into your Jira account and clicking on your profile. See the Atlassian account documentation for more details.
Configuring the Jira Alert Method
You can configure your Jira Alert Method directly in the Nobl9 UI, or by applying a YAML file in sloctl
.
For this Alert Method to function correctly, the following prerequisites must be met:
The user must have access and permission to create an issue in a project. Otherwise, the Nobl9 backend will receive an error from the Jira API, and the ticket will not be created.
All fields designated as mandatory by Nobl9 project settings must be included in the Nobl9 Jira message, or ticket creation will fail. For example, you may need to include values for the Due date or Fix versions fields.
By default, the Nobl9 Jira message contains the following fields:
Summary
Description
Issue Type (always set to
Bug
)
Caution: In order for a Jira alert to be sent, all of the above-mentioned fields need to exist in your Jira project. Otherwise, you will see the following error message:
Nobl9 UI
- Navigate to Integrations > Alert Methods.
- Click the
button.
- Click the relevant Alert Method icon.
Then, in the Jira Configuration Wizard:
Enter the URL.
The URL must start withhttps://
.Enter a Username.
Typically, the Username is the email address of the person that owns the API token.Enter an API Token.
For more information, refer to the Authentication section.Enter a Jira Project Key.
The code of the project, for example: PC, AT, PM.
- Select a Project.
Specifying a Project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank then object is assigned to projectdefault
. - Enter a Display Name.
You can enter a friendly name with spaces in this field. - Enter a Name.
The name is mandatory and can only contain lowercase, alphanumeric characters and dashes (for example,my-alert-method-name
). This field is populated automatically when you enter a display name, but you can edit the result. - Enter a Description.
Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it. - Click the Add Alert Method
YAML Configuration for Jira Alerts
- YAML
- Example
Here’s a general specification for adding a Jira Alert Method through YAML:
apiVersion: n9/v1alpha
kind: AlertMethod
metadata:
name: # string
displayName: # string, optional
spec:
jira:
url: # string, requires https://
username: # string
apiToken: # string, kept secret
projectKey: # string
Here's an example of Jira configuration through YAML:
apiVersion: n9/v1alpha
kind: AlertMethod
metadata:
name: jira-notification
spec:
jira:
url: <https://mycompany.atlassian.net/>
username: jira-alerts@mycompany.com
apiToken: "<secret key>"
projectKey: "AT"
Here’s a description of the fields:
url
is the Jira instance URL. Thehttps://
prefix is required.username
is the email address of the owner of your API token.apiToken
is your API token, which you create by logging into your Jira account and clicking on your profile. Note: TheapiToken
is kept secret and is not returned with theget
command insloctl
. When you create the Alert Method, theapiToken
field is required; it’s optional when you’re updating the Alert Method. The updated Alert Method uses the behavior from the existing object.projectKey
is the code of the Jira project:AT
(alert test),PM
(project management), etc.
Testing the Jira Alert Method in the UI
- Navigate to Integrations > Alert Methods.
- Follow the process outlined above to add the Alert Method in the Nobl9 UI: complete the steps in the Create Alert Method wizard, and Click the Add Alert Method
- On the Details screen, click the Test button in the upper-right corner. If the configuration is correct, Nobl9 will display the following message next to the button:
Test completed successfully!
If the configuration is incorrect, Nobl9 will provide an error message with relevant details. The content of the error differs depending on the Alert Method channel.
- Navigate to Integrations > Alert Methods.
- Find the Alert Method you want to test in the list, and click it.
- On the Details screen, click the Test button in the upper-right corner.