Skip to content
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

[DOCS] Move preconfigured Tines connector details #166217

Merged
merged 6 commits into from
Sep 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 30 additions & 3 deletions docs/api-generated/connectors/connector-apis-passthru.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -1015,6 +1015,7 @@ Any modifications made to this file will be overwritten.
<li><a href="#config_properties_servicenow"><code>config_properties_servicenow</code> - Connector request properties for a ServiceNow ITSM connector</a></li>
<li><a href="#config_properties_servicenow_itom"><code>config_properties_servicenow_itom</code> - Connector request properties for a ServiceNow ITSM connector</a></li>
<li><a href="#config_properties_swimlane"><code>config_properties_swimlane</code> - Connector request properties for a Swimlane connector</a></li>
<li><a href="#config_properties_tines"><code>config_properties_tines</code> - Connector request properties for a Tines connector</a></li>
<li><a href="#config_properties_torq"><code>config_properties_torq</code> - Connector request properties for a Torq connector</a></li>
<li><a href="#config_properties_webhook"><code>config_properties_webhook</code> - Connector request properties for a Webhook connector</a></li>
<li><a href="#config_properties_xmatters"><code>config_properties_xmatters</code> - Connector request properties for an xMatters connector</a></li>
Expand Down Expand Up @@ -1109,6 +1110,7 @@ Any modifications made to this file will be overwritten.
<li><a href="#secrets_properties_slack_webhook"><code>secrets_properties_slack_webhook</code> - Connector secrets properties for a Webhook Slack connector</a></li>
<li><a href="#secrets_properties_swimlane"><code>secrets_properties_swimlane</code> - Connector secrets properties for a Swimlane connector</a></li>
<li><a href="#secrets_properties_teams"><code>secrets_properties_teams</code> - Connector secrets properties for a Microsoft Teams connector</a></li>
<li><a href="#secrets_properties_tines"><code>secrets_properties_tines</code> - Connector secrets properties for a Tines connector</a></li>
<li><a href="#secrets_properties_torq"><code>secrets_properties_torq</code> - Connector secrets properties for a Torq connector</a></li>
<li><a href="#secrets_properties_webhook"><code>secrets_properties_webhook</code> - Connector secrets properties for a Webhook connector</a></li>
<li><a href="#secrets_properties_xmatters"><code>secrets_properties_xmatters</code> - Connector secrets properties for an xMatters connector</a></li>
Expand All @@ -1128,6 +1130,7 @@ Any modifications made to this file will be overwritten.
<li><a href="#update_connector_request_slack_webhook"><code>update_connector_request_slack_webhook</code> - Update Slack connector request</a></li>
<li><a href="#update_connector_request_swimlane"><code>update_connector_request_swimlane</code> - Update Swimlane connector request</a></li>
<li><a href="#update_connector_request_teams"><code>update_connector_request_teams</code> - Update Microsoft Teams connector request</a></li>
<li><a href="#update_connector_request_tines"><code>update_connector_request_tines</code> - Update Tines connector request</a></li>
<li><a href="#update_connector_request_torq"><code>update_connector_request_torq</code> - Update Torq connector request</a></li>
<li><a href="#update_connector_request_webhook"><code>update_connector_request_webhook</code> - Update Webhook connector request</a></li>
<li><a href="#update_connector_request_xmatters"><code>update_connector_request_xmatters</code> - Update xMatters connector request</a></li>
Expand Down Expand Up @@ -1534,6 +1537,13 @@ Any modifications made to this file will be overwritten.
<div class="param">mappings (optional)</div><div class="param-desc"><span class="param-type"><a href="#Connector_mappings_properties_for_a_Swimlane_connector">Connector_mappings_properties_for_a_Swimlane_connector</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="config_properties_tines"><code>config_properties_tines</code> - Connector request properties for a Tines connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Defines properties for connectors when type is <code>.tines</code>.</div>
<div class="field-items">
<div class="param">url </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Tines tenant URL. If you are using the <code>xpack.actions.allowedHosts</code> setting, make sure this hostname is added to the allowed hosts. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="config_properties_torq"><code>config_properties_torq</code> - Connector request properties for a Torq connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Defines properties for connectors when type is <code>.torq</code>.</div>
Expand Down Expand Up @@ -1845,7 +1855,7 @@ Any modifications made to this file will be overwritten.
<h3><a name="connector_response_properties_tines"><code>connector_response_properties_tines</code> - Connector response properties for a Tines connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> Defines properties for connectors when type is <code>.tines</code>. </div>
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_tines">config_properties_tines</a></span> </div>
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">.tines</div>
Expand Down Expand Up @@ -2113,12 +2123,12 @@ Any modifications made to this file will be overwritten.
<h3><a name="create_connector_request_tines"><code>create_connector_request_tines</code> - Create Tines connector request</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The Tines connector uses Tines Webhook actions to send events via POST request.</div>
<div class="field-items">
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> Defines properties for connectors when type is <code>.tines</code>. </div>
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_tines">config_properties_tines</a></span> </div>
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">.tines</div>
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the connector. </div>
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> Defines secrets for connectors when type is <code>.tines</code>. </div>
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_tines">secrets_properties_tines</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
Expand Down Expand Up @@ -2600,6 +2610,14 @@ Any modifications made to this file will be overwritten.
<div class="param">webhookUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The URL of the incoming webhook. If you are using the <code>xpack.actions.allowedHosts</code> setting, add the hostname to the allowed hosts. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="secrets_properties_tines"><code>secrets_properties_tines</code> - Connector secrets properties for a Tines connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Defines secrets for connectors when type is <code>.tines</code>.</div>
<div class="field-items">
<div class="param">email </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The email used to sign in to Tines. </div>
<div class="param">token </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Tines API token. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="secrets_properties_torq"><code>secrets_properties_torq</code> - Connector secrets properties for a Torq connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Defines secrets for connectors when type is <code>.torq</code>.</div>
Expand Down Expand Up @@ -2765,6 +2783,15 @@ Any modifications made to this file will be overwritten.
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_teams">secrets_properties_teams</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="update_connector_request_tines"><code>update_connector_request_tines</code> - Update Tines connector request</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_tines">config_properties_tines</a></span> </div>
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the connector. </div>
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_tines">secrets_properties_tines</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="update_connector_request_torq"><code>update_connector_request_torq</code> - Update Torq connector request</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
Expand Down
35 changes: 4 additions & 31 deletions docs/management/connectors/action-types/tines.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down
23 changes: 23 additions & 0 deletions docs/management/connectors/pre-configured-connectors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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>>
Expand Down Expand Up @@ -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
Expand Down
11 changes: 9 additions & 2 deletions docs/settings/alert-action-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,8 @@ NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the h
A configuration URL that varies by connector:
+
--
* For a <<d3security-action-type,D3 Security conector>>, specifies the D3 Security API request URL.
* For a <<d3security-action-type,D3 Security connector>>, specifies the D3 Security API request URL.
* For a <<tines-action-type,Tines connector>>, specifies the Tines tenant URL.
* For a <<webhook-action-type,webhook connector>>, specifies the web service request URL.

NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure this hostname is added to the allowed hosts.
Expand Down Expand Up @@ -470,7 +471,12 @@ NOTE: The client secret must be URL-encoded.
--

`xpack.actions.preconfigured.<connector-id>.secrets.email`::
For a <<jira-action-type,Jira connector>>, specifies the account email for HTTP basic authentication.
An email address that varies by connector:
+
--
* For a <<jira-action-type,Jira connector>>, specifies the account email for HTTP basic authentication.
* For a <<tines-action-type,Tines connector>>, specifies the email used to sign in to Tines.
--

`xpack.actions.preconfigured.<connector-id>.secrets.password`::
A password secret that varies by connector:
Expand All @@ -495,6 +501,7 @@ A token secret that varies by connector:
--
* For a <<d3security-action-type,D3 Security conector>>, specifies the D3 Security token.
* For a <<slack-action-type,Slack connector>>, specifies the Slack bot user OAuth token.
* For a <<tines-action-type,Tines connector>>, specifies the Tines API token.
* For a <<torq-action-type,Torq connector>>, specifies the secret of the webhook authentication header.
--

Expand Down
49 changes: 47 additions & 2 deletions x-pack/plugins/actions/docs/openapi/bundled.json
Original file line number Diff line number Diff line change
Expand Up @@ -514,6 +514,9 @@
{
"$ref": "#/components/schemas/update_connector_request_teams"
},
{
"$ref": "#/components/schemas/update_connector_request_tines"
},
{
"$ref": "#/components/schemas/update_connector_request_torq"
},
Expand Down Expand Up @@ -2798,13 +2801,34 @@
"title": "Connector request properties for a Tines connector",
"description": "Defines properties for connectors when type is `.tines`.",
"type": "object",
"additionalProperties": true
"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.\n",
"type": "string"
}
}
},
"secrets_properties_tines": {
"title": "Connector secrets properties for a Tines connector",
"description": "Defines secrets for connectors when type is `.tines`.",
"type": "object",
"additionalProperties": true
"required": [
"email",
"token"
],
"properties": {
"email": {
"description": "The email used to sign in to Tines.",
"type": "string"
},
"token": {
"description": "The Tines API token.",
"type": "string"
}
}
},
"create_connector_request_tines": {
"title": "Create Tines connector request",
Expand Down Expand Up @@ -4337,6 +4361,27 @@
}
}
},
"update_connector_request_tines": {
"title": "Update Tines connector request",
"type": "object",
"required": [
"config",
"name",
"secrets"
],
"properties": {
"config": {
"$ref": "#/components/schemas/config_properties_tines"
},
"name": {
"type": "string",
"description": "The display name for the connector."
},
"secrets": {
"$ref": "#/components/schemas/secrets_properties_tines"
}
}
},
"update_connector_request_torq": {
"title": "Update Torq connector request",
"type": "object",
Expand Down
35 changes: 33 additions & 2 deletions x-pack/plugins/actions/docs/openapi/bundled.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,7 @@ paths:
- $ref: '#/components/schemas/update_connector_request_slack_webhook'
- $ref: '#/components/schemas/update_connector_request_swimlane'
- $ref: '#/components/schemas/update_connector_request_teams'
- $ref: '#/components/schemas/update_connector_request_tines'
- $ref: '#/components/schemas/update_connector_request_torq'
- $ref: '#/components/schemas/update_connector_request_webhook'
- $ref: '#/components/schemas/update_connector_request_xmatters'
Expand Down Expand Up @@ -1888,12 +1889,27 @@ components:
title: Connector request properties for a Tines connector
description: Defines properties for connectors when type is `.tines`.
type: object
additionalProperties: true
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
secrets_properties_tines:
title: Connector secrets properties for a Tines connector
description: Defines secrets for connectors when type is `.tines`.
type: object
additionalProperties: true
required:
- email
- token
properties:
email:
description: The email used to sign in to Tines.
type: string
token:
description: The Tines API token.
type: string
create_connector_request_tines:
title: Create Tines connector request
description: |
Expand Down Expand Up @@ -3003,6 +3019,21 @@ components:
description: The display name for the connector.
secrets:
$ref: '#/components/schemas/secrets_properties_teams'
update_connector_request_tines:
title: Update Tines connector request
type: object
required:
- config
- name
- secrets
properties:
config:
$ref: '#/components/schemas/config_properties_tines'
name:
type: string
description: The display name for the connector.
secrets:
$ref: '#/components/schemas/secrets_properties_tines'
update_connector_request_torq:
title: Update Torq connector request
type: object
Expand Down
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
Loading
Loading