a7c9d3f1e0
* Renaming alerts to rules * Updating formatted messages * Updating i18n labels * Completed renaming in UI * Updating client routes including redirect * wip docs update * Reverting title changes for now * Fixing types check * Fixing unit tests * Fixing functional test * Fixing functional test * docs wip * wip docs update * Finished first run through docs * docs docs docs * Fixing bad merge * Fixing functional test * Docs cleanup * Cleaning up i18n labels * Fixing functional test * Updating screenshots * Updating screenshots * Updating screenshots * Updating terminology in alerting examples * Updating terminology in alerting examples Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
67 lines
2.2 KiB
Plaintext
67 lines
2.2 KiB
Plaintext
[role="xpack"]
|
|
[[jira-action-type]]
|
|
=== Jira connector and action
|
|
++++
|
|
<titleabbrev>Jira</titleabbrev>
|
|
++++
|
|
|
|
The Jira connector uses the https://developer.atlassian.com/cloud/jira/platform/rest/v2/[REST API v2] to create Jira issues.
|
|
|
|
[float]
|
|
[[jira-connector-configuration]]
|
|
==== Connector configuration
|
|
|
|
Jira connectors have the following configuration properties.
|
|
|
|
Name:: The name of the connector. The name is used to identify a connector in the **Stack Management** UI connector listing, and in the connector list when configuring an action.
|
|
URL:: Jira instance URL.
|
|
Project key:: Jira project key.
|
|
Email (or username):: The account email (or username) for HTTP Basic authentication.
|
|
API token (or password):: Jira API authentication token (or password) for HTTP Basic authentication.
|
|
|
|
[float]
|
|
[[Preconfigured-jira-configuration]]
|
|
==== Preconfigured connector type
|
|
|
|
[source,text]
|
|
--
|
|
my-jira:
|
|
name: preconfigured-jira-connector-type
|
|
actionTypeId: .jira
|
|
config:
|
|
apiUrl: https://elastic.atlassian.net
|
|
projectKey: ES
|
|
secrets:
|
|
email: testuser
|
|
apiToken: tokenkeystorevalue
|
|
--
|
|
|
|
Config defines information for the connector type.
|
|
|
|
`apiUrl`:: An address that corresponds to *URL*.
|
|
`projectKey`:: A key that corresponds to *Project Key*.
|
|
|
|
Secrets defines sensitive information for the connector type.
|
|
|
|
`email`:: A string that corresponds to *Email*.
|
|
`apiToken`:: A string that corresponds to *API Token*. Should be stored in the <<creating-keystore, {kib} keystore>>.
|
|
|
|
[float]
|
|
[[jira-action-configuration]]
|
|
==== Action configuration
|
|
|
|
Jira actions have the following configuration properties.
|
|
|
|
Issue type:: The type of the issue.
|
|
Priority:: The priority of the incident.
|
|
Labels:: The labels for the incident.
|
|
Title:: A title for the issue, used for searching the contents of the knowledge base.
|
|
Description:: The details about the incident.
|
|
Parent:: The ID or key of the parent issue. Only for `Subtask` issue types.
|
|
Additional comments:: Additional information for the client, such as how to troubleshoot the issue.
|
|
|
|
[[configuring-jira]]
|
|
==== Configure Jira
|
|
|
|
Jira offers free https://www.atlassian.com/software/jira/free[Instances], which you can use to test incidents.
|