-
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.
[DOCS] Move preconfigured Tines connector details (#166217)
Co-authored-by: Ying Mao <[email protected]>
- Loading branch information
Showing
9 changed files
with
165 additions
and
45 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
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 |
|---|---|---|
|
|
@@ -3,6 +3,10 @@ | |
| ++++ | ||
| <titleabbrev>Tines</titleabbrev> | ||
| ++++ | ||
| :frontmatter-description: Add a connector that can use Tines to send events. | ||
| :frontmatter-tags-products: [kibana] | ||
| :frontmatter-tags-content-type: [how-to] | ||
| :frontmatter-tags-user-goals: [configure] | ||
|
|
||
| The Tines connector uses Tines's https://www.tines.com/docs/actions/types/webhook[Webhook actions] to send events via POST request. | ||
|
|
||
|
|
@@ -26,37 +30,6 @@ URL:: The Tines tenant URL. If you are using the <<action-settings,`xpack | |
| Email:: The email used to sign in to Tines. | ||
| API Token:: A Tines API token created by the user. For more information, refer to the https://www.tines.com/api/authentication#generate-api-token[Tines documentation]. | ||
|
|
||
|
|
||
| [float] | ||
| [[preconfigured-tines-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-tines: | ||
| name: preconfigured-tines-connector-type | ||
| actionTypeId: .tines | ||
| config: | ||
| url: https://some-tenant-2345.tines.com | ||
| secrets: | ||
| email: [email protected] | ||
| token: ausergeneratedapitoken | ||
| -- | ||
|
|
||
| Config defines information for the connector type. | ||
|
|
||
| `url`:: A Tines tenant URL string that corresponds to *URL*. | ||
|
|
||
| Secrets defines sensitive information for the connector type. | ||
|
|
||
| `email`:: A string that corresponds to *Email*. | ||
| `token`:: A string that corresponds to *API Token*. | ||
|
|
||
| [float] | ||
| [[tines-action-parameters]] | ||
| === Test connectors | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -120,6 +120,7 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre | |
| * <<preconfigured-slack-configuration>> | ||
| * <<preconfigured-swimlane-configuration>> | ||
| * <<preconfigured-torq-configuration>> | ||
| * <<preconfigured-tines-configuration>> | ||
| * <<preconfigured-webhook-configuration>> | ||
| * <<preconfigured-cases-webhook-configuration>> | ||
| * <<preconfigured-xmatters-configuration>> | ||
|
|
@@ -530,6 +531,28 @@ xpack.actions.preconfigured: | |
| <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] | ||
| [[preconfigured-tines-configuration]] | ||
| ==== Tines connectors | ||
|
|
||
| The following example creates a <<tines-action-type,Tines connector>>: | ||
|
|
||
| [source,text] | ||
| -- | ||
| xpack.actions.preconfigured: | ||
| my-tines: | ||
| name: preconfigured-tines-connector-type | ||
| actionTypeId: .tines | ||
| config: | ||
| url: https://some-tenant-2345.tines.com <1> | ||
| secrets: | ||
| email: [email protected] <2> | ||
| token: ausergeneratedapitoken <3> | ||
| -- | ||
| <1> The Tines tenant URL. | ||
| <2> The email used to sign in to Tines. | ||
| <3> The Tines API token. | ||
|
|
||
| [float] | ||
| [[preconfigured-torq-configuration]] | ||
| ==== Torq connectors | ||
|
|
||
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
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
10 changes: 8 additions & 2 deletions
10
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_tines.yaml
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 |
|---|---|---|
| @@ -1,5 +1,11 @@ | ||
| title: Connector request properties for a Tines connector | ||
| description: Defines properties for connectors when type is `.tines`. | ||
| type: object | ||
| additionalProperties: true | ||
| # TO-DO: Add the properties for this connector. | ||
| required: | ||
| - url | ||
| properties: | ||
| url: | ||
| description: > | ||
| The Tines tenant URL. | ||
| If you are using the `xpack.actions.allowedHosts` setting, make sure this hostname is added to the allowed hosts. | ||
| type: string |
Oops, something went wrong.