[DOCS] Move preconfigured Jira connector details (#165920)

Co-authored-by: Ying Mao <ying.mao@elastic.co>
This commit is contained in:
Lisa Cawley 2023-09-08 12:03:25 -07:00 committed by GitHub
parent ca677245a6
commit d589cf246a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 35 additions and 33 deletions

View file

@ -38,38 +38,6 @@ Project key:: Jira project key.
Email:: The account email for HTTP Basic authentication.
API token:: Jira API authentication token for HTTP Basic authentication.
[float]
[[preconfigured-jira-configuration]]
=== Create preconfigured connectors
If you are running {kib} on-prem, you can define connectors by
adding `xpack.actions.preconfigured` settings to your `kibana.yml` file.
For example:
[source,text]
--
xpack.actions.preconfigured:
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]]
=== Test connectors
@ -77,7 +45,6 @@ Secrets defines sensitive information for the connector type.
You can test connectors with the <<execute-connector-api,run connector API>> or
as you're creating or editing the connector in {kib}. For example:
[role="screenshot"]
image::management/connectors/images/jira-params-test.png[Jira params test]

View file

@ -107,6 +107,7 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre
=== Examples
* <<preconfigured-index-configuration>>
* <<preconfigured-jira-configuration>>
* <<preconfigured-opsgenie-configuration>>
* <<preconfigured-pagerduty-configuration>>
* <<preconfigured-server-log-configuration>>
@ -132,6 +133,30 @@ xpack.actions.preconfigured:
<1> The {es} index to be written to.
<2> A field that indicates when the document was indexed.
[float]
[[preconfigured-jira-configuration]]
==== Jira connectors
The following example creates a <<jira-action-type,Jira connector>>:
[source,text]
--
xpack.actions.preconfigured:
my-jira:
name: preconfigured-jira-connector-type
actionTypeId: .jira
config:
apiUrl: https://elastic.atlassian.net <1>
projectKey: ES <2>
secrets:
email: testuser <3>
apiToken: tokenkeystorevalue <4>
--
<1> The Jira instance URL.
<2> The Jira project key.
<3> The account email for HTTP basic authentication.
<4> The API authentication token for HTTP basic authentication. NOTE: This value should be stored in the <<creating-keystore,{kib} keystore>>.
[float]
[[preconfigured-opsgenie-configuration]]
==== {opsgenie} connectors

View file

@ -262,6 +262,7 @@ The configuration details, which are specific to the type of preconfigured conne
A configuration URL that varies by connector:
+
--
* For a <<jira-action-type,Jira connector>>, specifies the Jira instance URL.
* For an <<opsgenie-action-type,{opsgenie} connector>>, specifies the {opsgenie} URL. For example, `https://api.opsgenie.com` or `https://api.eu.opsgenie.com`.
* For a <<pagerduty-action-type,PagerDuty connector>>, specifies the PagerDuty event URL. Defaults to `https://events.pagerduty.com/v2/enqueue`.
@ -274,6 +275,9 @@ For an <<index-action-type,index connector>>, a field that indicates when the do
`xpack.actions.preconfigured.<connector-id>.config.index`::
For an <<index-action-type,index connector>>, specifies the {es} index.
`xpack.actions.preconfigured.<connector-id>.config.projectKey`::
For a <<jira-action-type,Jira connector>>, specifies the Jira project key.
`xpack.actions.preconfigured.<connector-id>.name`::
The name of the preconfigured connector.
@ -289,6 +293,12 @@ An API key secret that varies by connector:
* For an <<opsgenie-action-type,{opsgenie} connector>>, specifies the {opsgenie} API authentication key for HTTP basic authentication.
--
`xpack.actions.preconfigured.<connector-id>.secrets.apiToken`::
For a <<jira-action-type,Jira connector>>, specifies the API authentication token for HTTP basic authentication.
`xpack.actions.preconfigured.<connector-id>.secrets.email`::
For a <<jira-action-type,Jira connector>>, specifies the account email for HTTP basic authentication.
`xpack.actions.preconfigured.<connector-id>.secrets.routingKey`::
For a <<pagerduty-action-type,PagerDuty connector>>, specifies the 32 character PagerDuty Integration Key for an integration on a service, also referred to as the routing key.