-
Notifications
You must be signed in to change notification settings - Fork 8.5k
[Docs][Actions] Add docs for Jira and IBM Resilient #78316
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,77 @@ | ||
| [role="xpack"] | ||
| [[jira-action-type]] | ||
| === Jira action | ||
|
|
||
| The Jira action type 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 action type | ||
|
|
||
| [source,text] | ||
| -- | ||
| my-jira: | ||
| name: preconfigured-jira-action-type | ||
| actionTypeId: .jira | ||
| config: | ||
| apiUrl: https://elastic.atlassian.net | ||
| projectKey: ES | ||
| secrets: | ||
| email: testuser | ||
| apiToken: tokenkeystorevalue | ||
| -- | ||
|
|
||
| `config` defines the action type specific to the configuration and contains the following properties: | ||
|
|
||
| [cols="2*<"] | ||
| |=== | ||
|
|
||
| | `apiUrl` | ||
| | An address that corresponds to *URL*. | ||
|
|
||
| | `projectKey` | ||
| | A key that corresponds to *Project Key*. | ||
|
|
||
| |=== | ||
|
|
||
| `secrets` defines sensitive information for the action type: | ||
|
|
||
| [cols="2*<"] | ||
| |=== | ||
|
|
||
| | `email` | ||
| | A string that corresponds to *Email*. | ||
|
|
||
| | `apiToken` | ||
| | A string that corresponds to *API Token*. Should be stored in the <<creating-keystore, {kib} keystore>>. | ||
|
|
||
| |=== | ||
|
|
||
| [[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 of the incident. | ||
| Title:: A title for the issue, used for searching the contents of the knowledge base. | ||
| Description:: The details about the incident. | ||
| Additional comments:: Additional information for the client, such as how to troubleshoot the issue. | ||
|
|
||
| [[configuring-jira]] | ||
| ==== Configuring and testing Jira | ||
|
|
||
| Jira offers free https://www.atlassian.com/software/jira/free[Instances], which you can use to test incidents. | ||
This file contains hidden or 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 hidden or 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,76 @@ | ||
| [role="xpack"] | ||
| [[resilient-action-type]] | ||
| === IBM Resilient action | ||
|
|
||
| The IBM Resilient action type uses the https://developer.ibm.com/security/resilient/rest/[RESILIENT REST v2] to create IBM Resilient incidents. | ||
|
|
||
| [float] | ||
| [[resilient-connector-configuration]] | ||
| ==== Connector configuration | ||
|
|
||
| IBM Resilient 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:: IBM Resilient instance URL. | ||
| 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]] | ||
| ==== Preconfigured action type | ||
|
|
||
| [source,text] | ||
| -- | ||
| my-resilient: | ||
| name: preconfigured-resilient-action-type | ||
| actionTypeId: .resilient | ||
| config: | ||
| apiUrl: https://elastic.resilient.net | ||
| orgId: ES | ||
| secrets: | ||
| apiKeyId: testuser | ||
| apiKeySecret: tokenkeystorevalue | ||
| -- | ||
|
|
||
| `config` defines the action type specific to the configuration and contains the following properties: | ||
|
|
||
| [cols="2*<"] | ||
| |=== | ||
|
|
||
| | `apiUrl` | ||
| | An address that corresponds to *URL*. | ||
|
|
||
| | `orgId` | ||
| | An ID that corresponds to *Organization ID*. | ||
|
|
||
| |=== | ||
|
|
||
| `secrets` defines sensitive information for the action type: | ||
|
|
||
| [cols="2*<"] | ||
| |=== | ||
|
|
||
| | `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>>. | ||
|
|
||
| |=== | ||
|
|
||
| [[resilient-action-configuration]] | ||
| ==== Action configuration | ||
|
|
||
| IBM Resilient actions have the following configuration properties: | ||
|
|
||
| Incident types:: The incident types of the incident. | ||
cnasikas marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Severity code:: The severity of the incident. | ||
| Name:: A name for the issue, used for searching the contents of the knowledge base. | ||
| Description:: The details about the incident. | ||
| Additional comments:: Additional information for the client, such as how to troubleshoot the issue. | ||
|
|
||
| [[configuring-resilient]] | ||
| ==== Configuring and testing IBM Resilient | ||
|
|
||
| IBM Resilient offers https://www.ibm.com/security/intelligent-orchestration/resilient[Instances], which you can use to test incidents. | ||
This file contains hidden or 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 hidden or 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 hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.