mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 11:05:39 -04:00
[DOCS] Move preconfigured Swimlane connector details (#163547)
This commit is contained in:
parent
fe4c76e326
commit
a3a2f402fe
3 changed files with 111 additions and 73 deletions
|
@ -3,6 +3,10 @@
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Swimlane</titleabbrev>
|
<titleabbrev>Swimlane</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
:frontmatter-description: Add a connector that can create Swimlane records.
|
||||||
|
:frontmatter-tags-products: [kibana]
|
||||||
|
:frontmatter-tags-content-type: [how-to]
|
||||||
|
:frontmatter-tags-user-goals: [configure]
|
||||||
|
|
||||||
The Swimlane connector uses the https://swimlane.com/knowledge-center/docs/developer-guide/rest-api/[Swimlane REST API] to create Swimlane records.
|
The Swimlane connector uses the https://swimlane.com/knowledge-center/docs/developer-guide/rest-api/[Swimlane REST API] to create Swimlane records.
|
||||||
|
|
||||||
|
@ -25,74 +29,7 @@ Swimlane connectors have the following configuration properties:
|
||||||
Name:: The name of the connector.
|
Name:: The name of the connector.
|
||||||
URL:: Swimlane instance URL.
|
URL:: Swimlane instance URL.
|
||||||
Application ID:: Swimlane application ID.
|
Application ID:: Swimlane application ID.
|
||||||
API token:: Swimlane API authentication token for HTTP Basic authentication.
|
API token:: Swimlane API authentication token for HTTP basic authentication.
|
||||||
|
|
||||||
|
|
||||||
[float]
|
|
||||||
[[preconfigured-swimlane-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-swimlane:
|
|
||||||
name: preconfigured-swimlane-connector-type
|
|
||||||
actionTypeId: .swimlane
|
|
||||||
config:
|
|
||||||
apiUrl: https://elastic.swimlaneurl.us
|
|
||||||
appId: app-id
|
|
||||||
mappings:
|
|
||||||
alertIdConfig:
|
|
||||||
fieldType: text
|
|
||||||
id: agp4s
|
|
||||||
key: alert-id
|
|
||||||
name: Alert ID
|
|
||||||
caseIdConfig:
|
|
||||||
fieldType: text
|
|
||||||
id: ae1mi
|
|
||||||
key: case-id
|
|
||||||
name: Case ID
|
|
||||||
caseNameConfig:
|
|
||||||
fieldType: text
|
|
||||||
id: anxnr
|
|
||||||
key: case-name
|
|
||||||
name: Case Name
|
|
||||||
commentsConfig:
|
|
||||||
fieldType: comments
|
|
||||||
id: au18d
|
|
||||||
key: comments
|
|
||||||
name: Comments
|
|
||||||
descriptionConfig:
|
|
||||||
fieldType: text
|
|
||||||
id: ae1gd
|
|
||||||
key: description
|
|
||||||
name: Description
|
|
||||||
ruleNameConfig:
|
|
||||||
fieldType: text
|
|
||||||
id: avfsl
|
|
||||||
key: rule-name
|
|
||||||
name: Rule Name
|
|
||||||
severityConfig:
|
|
||||||
fieldType: text
|
|
||||||
id: a71ik
|
|
||||||
key: severity
|
|
||||||
name: severity
|
|
||||||
secrets:
|
|
||||||
apiToken: tokenkeystorevalue
|
|
||||||
--
|
|
||||||
|
|
||||||
Config defines information for the connector type.
|
|
||||||
|
|
||||||
`apiUrl`:: An address that corresponds to *URL*.
|
|
||||||
`appId`:: A key that corresponds to *Application ID*.
|
|
||||||
|
|
||||||
Secrets defines sensitive information for the connector type.
|
|
||||||
|
|
||||||
`apiToken`:: A string that corresponds to *API Token*. Should be stored in the <<creating-keystore, {kib} keystore>>.
|
|
||||||
|
|
||||||
[float]
|
[float]
|
||||||
[[swimlane-action-configuration]]
|
[[swimlane-action-configuration]]
|
||||||
|
|
|
@ -58,7 +58,7 @@ Sensitive properties, such as passwords, can also be stored in the
|
||||||
==============================================
|
==============================================
|
||||||
|
|
||||||
[float]
|
[float]
|
||||||
[[managing-pre-configured-connectors]]
|
[[managing-preconfigured-connectors]]
|
||||||
=== View preconfigured connectors
|
=== View preconfigured connectors
|
||||||
|
|
||||||
When you open the main menu, click *{stack-manage-app} > {connectors-ui}*.
|
When you open the main menu, click *{stack-manage-app} > {connectors-ui}*.
|
||||||
|
@ -71,7 +71,7 @@ image::images/preconfigured-connectors-managing.png[Connectors managing tab with
|
||||||
Clicking a preconfigured connector shows the description, but not the configuration.
|
Clicking a preconfigured connector shows the description, but not the configuration.
|
||||||
|
|
||||||
[float]
|
[float]
|
||||||
[[build-in-preconfigured-connectors]]
|
[[built-in-preconfigured-connectors]]
|
||||||
=== Built-in preconfigured connectors
|
=== Built-in preconfigured connectors
|
||||||
|
|
||||||
{kib} provides the following built-in preconfigured connectors:
|
{kib} provides the following built-in preconfigured connectors:
|
||||||
|
@ -104,6 +104,7 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre
|
||||||
====
|
====
|
||||||
|
|
||||||
[float]
|
[float]
|
||||||
|
[[preconfigured-connector-examples]]
|
||||||
=== Examples
|
=== Examples
|
||||||
|
|
||||||
* <<preconfigured-d3security-configuration>>
|
* <<preconfigured-d3security-configuration>>
|
||||||
|
@ -115,6 +116,7 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre
|
||||||
* <<preconfigured-pagerduty-configuration>>
|
* <<preconfigured-pagerduty-configuration>>
|
||||||
* <<preconfigured-server-log-configuration>>
|
* <<preconfigured-server-log-configuration>>
|
||||||
* <<preconfigured-slack-configuration>>
|
* <<preconfigured-slack-configuration>>
|
||||||
|
* <<preconfigured-swimlane-configuration>>
|
||||||
* <<preconfigured-webhook-configuration>>
|
* <<preconfigured-webhook-configuration>>
|
||||||
* <<preconfigured-cases-webhook-configuration>>
|
* <<preconfigured-cases-webhook-configuration>>
|
||||||
* <<preconfigured-xmatters-configuration>>
|
* <<preconfigured-xmatters-configuration>>
|
||||||
|
@ -412,7 +414,6 @@ xpack.actions.preconfigured:
|
||||||
actionTypeId: .server-log
|
actionTypeId: .server-log
|
||||||
--
|
--
|
||||||
|
|
||||||
|
|
||||||
[float]
|
[float]
|
||||||
[[preconfigured-slack-configuration]]
|
[[preconfigured-slack-configuration]]
|
||||||
==== Slack connectors
|
==== Slack connectors
|
||||||
|
@ -443,6 +444,65 @@ xpack.actions.preconfigured:
|
||||||
--
|
--
|
||||||
<1> The Slack bot user OAuth token.
|
<1> The Slack bot user OAuth token.
|
||||||
|
|
||||||
|
[float]
|
||||||
|
[[preconfigured-swimlane-configuration]]
|
||||||
|
==== Swimlane connectors
|
||||||
|
|
||||||
|
The following example creates a <<swimlane-action-type,Swimlane connector>>:
|
||||||
|
|
||||||
|
[source,text]
|
||||||
|
--
|
||||||
|
xpack.actions.preconfigured:
|
||||||
|
my-swimlane:
|
||||||
|
name: preconfigured-swimlane-connector-type
|
||||||
|
actionTypeId: .swimlane
|
||||||
|
config:
|
||||||
|
apiUrl: https://elastic.swimlaneurl.us <1>
|
||||||
|
appId: app-id <2>
|
||||||
|
mappings: <3>
|
||||||
|
alertIdConfig:
|
||||||
|
fieldType: text
|
||||||
|
id: agp4s
|
||||||
|
key: alert-id
|
||||||
|
name: Alert ID
|
||||||
|
caseIdConfig:
|
||||||
|
fieldType: text
|
||||||
|
id: ae1mi
|
||||||
|
key: case-id
|
||||||
|
name: Case ID
|
||||||
|
caseNameConfig:
|
||||||
|
fieldType: text
|
||||||
|
id: anxnr
|
||||||
|
key: case-name
|
||||||
|
name: Case Name
|
||||||
|
commentsConfig:
|
||||||
|
fieldType: comments
|
||||||
|
id: au18d
|
||||||
|
key: comments
|
||||||
|
name: Comments
|
||||||
|
descriptionConfig:
|
||||||
|
fieldType: text
|
||||||
|
id: ae1gd
|
||||||
|
key: description
|
||||||
|
name: Description
|
||||||
|
ruleNameConfig:
|
||||||
|
fieldType: text
|
||||||
|
id: avfsl
|
||||||
|
key: rule-name
|
||||||
|
name: Rule Name
|
||||||
|
severityConfig:
|
||||||
|
fieldType: text
|
||||||
|
id: a71ik
|
||||||
|
key: severity
|
||||||
|
name: severity
|
||||||
|
secrets:
|
||||||
|
apiToken: tokenkeystorevalue <4>
|
||||||
|
--
|
||||||
|
<1> The {swimlane} instance URL.
|
||||||
|
<2> The {swimlane} application identifier.
|
||||||
|
<3> Field mappings for properties such as the alert identifer, severity, and rule name.
|
||||||
|
<4> The API authentication token for HTTP basic authentication. NOTE: This value should be stored in the <<creating-keystore, {kib} keystore>>.
|
||||||
|
|
||||||
[float]
|
[float]
|
||||||
[[preconfigured-webhook-configuration]]
|
[[preconfigured-webhook-configuration]]
|
||||||
==== Webhook connectors
|
==== Webhook connectors
|
||||||
|
|
|
@ -234,7 +234,7 @@ Specifies the maximum number of actions that can be queued. Default: 1000000
|
||||||
[[preconfigured-connector-settings]]
|
[[preconfigured-connector-settings]]
|
||||||
=== Preconfigured connector settings
|
=== Preconfigured connector settings
|
||||||
|
|
||||||
These settings vary depending on which type of <<pre-configured-connectors,preconfigured connector>> you're adding.
|
These settings vary depending on which type of preconfigured connector you're adding.
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
[source,yaml]
|
[source,yaml]
|
||||||
|
@ -245,6 +245,8 @@ xpack.actions.preconfigured:
|
||||||
actionTypeId: .server-log
|
actionTypeId: .server-log
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
|
For more examples, go to <<pre-configured-connectors>>.
|
||||||
|
|
||||||
`xpack.actions.preconfiguredAlertHistoryEsIndex` {ess-icon}::
|
`xpack.actions.preconfiguredAlertHistoryEsIndex` {ess-icon}::
|
||||||
Enables a preconfigured alert history {es} <<index-action-type, Index>> connector. Default: `false`.
|
Enables a preconfigured alert history {es} <<index-action-type, Index>> connector. Default: `false`.
|
||||||
|
|
||||||
|
@ -266,10 +268,18 @@ A configuration URL that varies by connector:
|
||||||
* For a <<jira-action-type,Jira connector>>, specifies the Jira 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 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`.
|
* For a <<pagerduty-action-type,PagerDuty connector>>, specifies the PagerDuty event URL. Defaults to `https://events.pagerduty.com/v2/enqueue`.
|
||||||
|
* For a <<swimlane-action-type,{swimlane} connector>>, specifies the {swimlane} instance URL.
|
||||||
|
|
||||||
NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the hostname in the URL is added to the allowed hosts.
|
NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the hostname in the URL is added to the allowed hosts.
|
||||||
--
|
--
|
||||||
|
|
||||||
|
`xpack.actions.preconfigured.<connector-id>.config.appId`::
|
||||||
|
An application ID that varies by connector:
|
||||||
|
+
|
||||||
|
--
|
||||||
|
* For a <<swimlane-action-type,{swimlane} connector>>, specifies a {swimlane} application identifier.
|
||||||
|
--
|
||||||
|
|
||||||
`xpack.actions.preconfigured.<connector-id>.config.clientId`::
|
`xpack.actions.preconfigured.<connector-id>.config.clientId`::
|
||||||
For an <<email-action-type,email connector>>, specifies a GUID format value that corresponds to the client ID, which is a part of OAuth 2.0 client credentials authentication.
|
For an <<email-action-type,email connector>>, specifies a GUID format value that corresponds to the client ID, which is a part of OAuth 2.0 client credentials authentication.
|
||||||
|
|
||||||
|
@ -333,6 +343,37 @@ For an <<email-action-type,email connector>>, specifies the host name of the ser
|
||||||
`xpack.actions.preconfigured.<connector-id>.config.index`::
|
`xpack.actions.preconfigured.<connector-id>.config.index`::
|
||||||
For an <<index-action-type,index connector>>, specifies the {es} index.
|
For an <<index-action-type,index connector>>, specifies the {es} index.
|
||||||
|
|
||||||
|
`xpack.actions.preconfigured.<connector-id>.config.mappings`::
|
||||||
|
For a <<swimlane-action-type,Swimlane connector>>, specifies field mappings.
|
||||||
|
|
||||||
|
`xpack.actions.preconfigured.<connector-id>.config.mappings.alertIdConfig`::
|
||||||
|
For a <<swimlane-action-type,Swimlane connector>>, field mapping for the alert identifier.
|
||||||
|
You must provide `fieldtype`, `id`, `key`, and `name` values.
|
||||||
|
|
||||||
|
`xpack.actions.preconfigured.<connector-id>.config.mappings.caseIdConfig`::
|
||||||
|
For a <<swimlane-action-type,Swimlane connector>>, field mapping for the case identifier.
|
||||||
|
You must provide `fieldtype`, `id`, `key`, and `name` values.
|
||||||
|
|
||||||
|
`xpack.actions.preconfigured.<connector-id>.config.mappings.caseNameConfig`::
|
||||||
|
For a <<swimlane-action-type,Swimlane connector>>, field mapping for the case name.
|
||||||
|
You must provide `fieldtype`, `id`, `key`, and `name` values.
|
||||||
|
|
||||||
|
`xpack.actions.preconfigured.<connector-id>.config.mappings.commentsConfig`::
|
||||||
|
For a <<swimlane-action-type,Swimlane connector>>, field mapping for the case comments.
|
||||||
|
You must provide `fieldtype`, `id`, `key`, and `name` values.
|
||||||
|
|
||||||
|
`xpack.actions.preconfigured.<connector-id>.config.mappings.descriptionConfig`::
|
||||||
|
For a <<swimlane-action-type,Swimlane connector>>, field mapping for the case description.
|
||||||
|
You must provide `fieldtype`, `id`, `key`, and `name` values.
|
||||||
|
|
||||||
|
`xpack.actions.preconfigured.<connector-id>.config.mappings.ruleNameConfig`::
|
||||||
|
For a <<swimlane-action-type,Swimlane connector>>, field mapping for the rule name.
|
||||||
|
You must provide `fieldtype`, `id`, `key`, and `name` values.
|
||||||
|
|
||||||
|
`xpack.actions.preconfigured.<connector-id>.config.mappings.severityConfig`::
|
||||||
|
For a <<swimlane-action-type,Swimlane connector>>, specifies a field mapping for the severity.
|
||||||
|
You must provide `fieldtype`, `id`, `key`, and `name` values.
|
||||||
|
|
||||||
`xpack.actions.preconfigured.<connector-id>.config.method`::
|
`xpack.actions.preconfigured.<connector-id>.config.method`::
|
||||||
For a <<webhook-action-type,webhook connector>>, specifies the HTTP request method, either `post` or `put`. Defaults to `post`.
|
For a <<webhook-action-type,webhook connector>>, specifies the HTTP request method, either `post` or `put`. Defaults to `post`.
|
||||||
|
|
||||||
|
@ -406,7 +447,7 @@ For an <<resilient-action-type,{ibm-r} connector>>, specifies the authentication
|
||||||
For an <<resilient-action-type,{ibm-r} connector>>, specifies the authentication key secret for HTTP basic authentication.
|
For an <<resilient-action-type,{ibm-r} connector>>, specifies the authentication key secret for HTTP basic authentication.
|
||||||
|
|
||||||
`xpack.actions.preconfigured.<connector-id>.secrets.apiToken`::
|
`xpack.actions.preconfigured.<connector-id>.secrets.apiToken`::
|
||||||
For a <<jira-action-type,Jira connector>>, specifies the API authentication token for HTTP basic authentication.
|
For a <<jira-action-type,Jira>> or <<swimlane-action-type,{swimlane} connector>>, specifies the API authentication token for HTTP basic authentication.
|
||||||
|
|
||||||
`xpack.actions.preconfigured.<connector-id>.secrets.clientSecret`::
|
`xpack.actions.preconfigured.<connector-id>.secrets.clientSecret`::
|
||||||
A client secret that varies by connector:
|
A client secret that varies by connector:
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue