-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2f23cb4
commit b3e2ff6
Showing
6 changed files
with
109 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
102 changes: 102 additions & 0 deletions
102
docs/management/connectors/action-types/swimlane.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
[role="xpack"] | ||
[[swimlane-action-type]] | ||
=== Swimlane connector and action | ||
++++ | ||
<titleabbrev>Swimlane</titleabbrev> | ||
++++ | ||
|
||
The Swimlane connector uses the https://swimlane.com/knowledge-center/docs/developer-guide/rest-api/[REST API] to create Swimlane records. | ||
|
||
[float] | ||
[[swimlane-connector-configuration]] | ||
==== Connector configuration | ||
|
||
Swimlane 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:: Swimlane instance URL. | ||
Application ID:: Swimlane application ID. | ||
API token:: Swimlane API authentication token for HTTP Basic authentication. | ||
|
||
[float] | ||
[[Preconfigured-swimlane-configuration]] | ||
==== Preconfigured connector type | ||
|
||
[source,text] | ||
-- | ||
my-swimlane: | ||
name: preconfigured-swimlane-connector-type | ||
actionTypeId: .swimlane | ||
config: | ||
apiUrl: https://elastic.swimlaneurl.us | ||
appId: app-id | ||
mappings: | ||
alertNameConfig: | ||
fieldType: text | ||
id: a6fst | ||
key: alert-name | ||
name: Alert Name | ||
alertSourceConfig: | ||
fieldType: text | ||
id: adnls | ||
key: alert-source | ||
name: Alert Source | ||
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 | ||
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] | ||
[[define-swimlane-ui]] | ||
==== Define connector in Stack Management | ||
|
||
Define Swimlane connector properties. | ||
|
||
[role="screenshot"] | ||
image::management/connectors/images/swimlane-connector.png[Swimlane connector] | ||
|
||
Test Swimlane action parameters. | ||
|
||
[role="screenshot"] | ||
image::management/connectors/images/swimlane-params-test.png[Swimlane params test] | ||
|
||
[float] | ||
[[swimlane-action-configuration]] | ||
==== Action configuration | ||
|
||
Swimlane actions have the following configuration properties. | ||
|
||
Alert Name:: The alert name of the incident. | ||
Alert Source:: The alert source of the incident. | ||
Case ID:: The Case ID of the incident. | ||
Case Name:: The Case name of the incident. | ||
Comments:: The comments of the incident. | ||
Severity:: The severity of the incident. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters