[DOCS] Move preconfigured IBM Resilient connector details (#166020)

This commit is contained in:
Lisa Cawley 2023-09-12 08:22:35 -07:00 committed by GitHub
parent ddf1db09f9
commit 982b2c86bd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 41 additions and 34 deletions

View file

@ -1,8 +1,12 @@
[[resilient-action-type]]
== IBM Resilient connector and action
== {ibm-r} connector and action
++++
<titleabbrev>IBM Resilient</titleabbrev>
<titleabbrev>{ibm-r}</titleabbrev>
++++
:frontmatter-description: Add a connector that can create {ibm-r} incidents.
:frontmatter-tags-products: [kibana]
:frontmatter-tags-content-type: [how-to]
:frontmatter-tags-user-goals: [configure]
The IBM Resilient connector uses the https://developer.ibm.com/security/resilient/rest/[RESILIENT REST v2] to create IBM Resilient incidents.
@ -28,38 +32,6 @@ Organization ID:: IBM Resilient organization ID.
API key ID:: The authentication key ID for HTTP Basic authentication.
API key secret:: The authentication key secret for HTTP Basic authentication.
[float]
[[preconfigured-resilient-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-resilient:
name: preconfigured-resilient-connector-type
actionTypeId: .resilient
config:
apiUrl: https://elastic.resilient.net
orgId: ES
secrets:
apiKeyId: testuser
apiKeySecret: tokenkeystorevalue
--
Config defines information for the connector type.
`apiUrl`:: An address that corresponds to *URL*.
`orgId`:: An ID that corresponds to *Organization ID*.
Secrets defines sensitive information for the connector type.
`apiKeyId`:: A string that corresponds to *API key ID*.
`apiKeySecret`:: A string that corresponds to *API Key secret*. Should be stored in the <<creating-keystore, {kib} keystore>>.
[float]
[[resilient-action-configuration]]
=== Test connectors

View file

@ -106,6 +106,7 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre
[float]
=== Examples
* <<preconfigured-resilient-configuration>>
* <<preconfigured-index-configuration>>
* <<preconfigured-jira-configuration>>
* <<preconfigured-opsgenie-configuration>>
@ -116,6 +117,30 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre
* <<preconfigured-cases-webhook-configuration>>
* <<preconfigured-xmatters-configuration>>
[float]
[[preconfigured-resilient-configuration]]
==== {ibm-r} connectors
The following example creates a <<resilient-action-type,{ibm-r} connector>>:
[source,text]
--
xpack.actions.preconfigured:
my-resilient:
name: preconfigured-resilient-connector-type
actionTypeId: .resilient
config:
apiUrl: https://elastic.resilient.net <1>
orgId: ES <2>
secrets:
apiKeyId: testuser <3>
apiKeySecret: tokenkeystorevalue <4>
--
<1> The {ibm-r} instance URL.
<2> The {ibm-r} organization identifier.
<3> The authentication key ID for HTTP basic authentication.
<4> The authentication key secret for HTTP basic authentication. NOTE: This value should be stored in the <<creating-keystore,{kib} keystore>>.
[float]
[[preconfigured-index-configuration]]
==== Index 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 <<resilient-action-type,{ibm-r} connector>>, specifies the {ibm-r} instance URL.
* 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`.
@ -322,6 +323,9 @@ For a <<cases-webhook-action-type,{webhook-cm} connector>>, specifies a set of k
`xpack.actions.preconfigured.<connector-id>.config.index`::
For an <<index-action-type,index connector>>, specifies the {es} index.
`xpack.actions.preconfigured.<connector-id>.config.orgId`::
For an <<resilient-action-type,{ibm-r} connector>>, specifies the {ibm-r} organization identifier.
`xpack.actions.preconfigured.<connector-id>.config.projectKey`::
For a <<jira-action-type,Jira connector>>, specifies the Jira project key.
@ -360,6 +364,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.apiKeyId`::
For an <<resilient-action-type,{ibm-r} connector>>, specifies the authentication key ID for HTTP basic authentication.
`xpack.actions.preconfigured.<connector-id>.secrets.apiKeySecret`::
For an <<resilient-action-type,{ibm-r} connector>>, specifies the authentication key secret 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.