Skip to content

Commit

Permalink
[DOCS] Move preconfigured xMatters connector details (#165923)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored Sep 11, 2023
1 parent f27519a commit 7267efe
Show file tree
Hide file tree
Showing 12 changed files with 305 additions and 74 deletions.
45 changes: 37 additions & 8 deletions docs/api-generated/connectors/connector-apis-passthru.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -1012,6 +1012,7 @@ Any modifications made to this file will be overwritten.
<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_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>
<li><a href="#connector_response_properties"><code>connector_response_properties</code> - Connector response properties</a></li>
<li><a href="#connector_response_properties_cases_webhook"><code>connector_response_properties_cases_webhook</code> - Connector request properties for a Webhook - Case Management connector</a></li>
<li><a href="#connector_response_properties_email"><code>connector_response_properties_email</code> - Connector response properties for an email connector</a></li>
Expand Down Expand Up @@ -1097,6 +1098,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_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>
<li><a href="#updateConnector_400_response"><code>updateConnector_400_response</code> - </a></li>
<li><a href="#update_connector_request_cases_webhook"><code>update_connector_request_cases_webhook</code> - Update Webhook - Case Managment connector request</a></li>
<li><a href="#update_connector_request_index"><code>update_connector_request_index</code> - Update index connector request</a></li>
Expand All @@ -1110,6 +1112,7 @@ Any modifications made to this file will be overwritten.
<li><a href="#update_connector_request_slack_api"><code>update_connector_request_slack_api</code> - Update Slack connector request</a></li>
<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_xmatters"><code>update_connector_request_xmatters</code> - Update xMatters connector request</a></li>
</ol>
<div class="model">
Expand Down Expand Up @@ -1179,12 +1182,12 @@ Any modifications made to this file will be overwritten.
<h3><a name="Create_connector_request_body_properties"><code>Create_connector_request_body_properties</code> - Create connector request body properties</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The properties vary depending on the connector type.</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>.xmatters</code>. </div>
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_xmatters">config_properties_xmatters</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">.xmatters</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>.xmatters</code>. </div>
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_xmatters">secrets_properties_xmatters</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
Expand Down Expand Up @@ -1335,9 +1338,9 @@ Any modifications made to this file will be overwritten.
<h3><a name="Update_connector_request_body_properties"><code>Update_connector_request_body_properties</code> - Update connector request body properties</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The properties vary depending on the connector type.</div>
<div class="field-items">
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_swimlane">config_properties_swimlane</a></span> </div>
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_xmatters">config_properties_xmatters</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_swimlane">secrets_properties_swimlane</a></span> </div>
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_xmatters">secrets_properties_xmatters</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
Expand Down Expand Up @@ -1484,11 +1487,19 @@ Any modifications made to this file will be overwritten.
<div class="param-enum">certificate</div><div class="param-enum">full</div><div class="param-enum">none</div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="config_properties_xmatters"><code>config_properties_xmatters</code> - Connector request properties for an xMatters connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Defines properties for connectors when type is <code>.xmatters</code>.</div>
<div class="field-items">
<div class="param">configUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The request URL for the Elastic Alerts trigger in xMatters. It is applicable only when <code>usesBasic</code> is <code>true</code>. </div>
<div class="param">usesBasic (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Specifies whether the connector uses HTTP basic authentication (<code>true</code>) or URL authentication (<code>false</code>). </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="connector_response_properties"><code>connector_response_properties</code> - Connector response properties</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The properties vary depending on the connector type.</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>.xmatters</code>. </div>
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_xmatters">config_properties_xmatters</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">.xmatters</div>
Expand Down Expand Up @@ -1773,7 +1784,7 @@ Any modifications made to this file will be overwritten.
<h3><a name="connector_response_properties_xmatters"><code>connector_response_properties_xmatters</code> - Connector response properties for an xMatters 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>.xmatters</code>. </div>
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_xmatters">config_properties_xmatters</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">.xmatters</div>
Expand Down Expand Up @@ -2005,12 +2016,12 @@ Any modifications made to this file will be overwritten.
<h3><a name="create_connector_request_xmatters"><code>create_connector_request_xmatters</code> - Create xMatters connector request</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The xMatters connector uses the xMatters Workflow for Elastic to send actionable alerts to on-call xMatters resources.</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>.xmatters</code>. </div>
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_xmatters">config_properties_xmatters</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">.xmatters</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>.xmatters</code>. </div>
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_xmatters">secrets_properties_xmatters</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
Expand Down Expand Up @@ -2444,6 +2455,15 @@ Any modifications made to this file will be overwritten.
<div class="param">user (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The username for HTTP basic authentication. If <code>hasAuth</code> is set to <code>true</code> and <code>authType</code> is <code>webhook-authentication-basic</code>, this property is required. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="secrets_properties_xmatters"><code>secrets_properties_xmatters</code> - Connector secrets properties for an xMatters connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Defines secrets for connectors when type is <code>.xmatters</code>.</div>
<div class="field-items">
<div class="param">password (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A user name for HTTP basic authentication. It is applicable only when <code>usesBasic</code> is <code>true</code>. </div>
<div class="param">secretsUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The request URL for the Elastic Alerts trigger in xMatters with the API key included in the URL. It is applicable only when <code>usesBasic</code> is <code>false</code>. </div>
<div class="param">user (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A password for HTTP basic authentication. It is applicable only when <code>usesBasic</code> is <code>true</code>. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="updateConnector_400_response"><code>updateConnector_400_response</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
Expand Down Expand Up @@ -2556,5 +2576,14 @@ 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_swimlane">secrets_properties_swimlane</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="update_connector_request_xmatters"><code>update_connector_request_xmatters</code> - Update xMatters 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_xmatters">config_properties_xmatters</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_xmatters">secrets_properties_xmatters</a></span> </div>
</div> <!-- field-items -->
</div>
</div>
++++
61 changes: 7 additions & 54 deletions docs/management/connectors/action-types/xmatters.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,59 +33,12 @@ xMatters connectors have the following configuration properties:

Name:: The name of the connector.
Authentication Type:: The type of authentication used in the request made to xMatters.
URL:: The request URL for the Elastic Alerts trigger in xMatters. If you are using the <<action-settings, `xpack.actions.allowedHosts`>> setting, make sure the hostname is added to the allowed hosts.
Username:: Username for HTTP Basic Authentication.
Password:: Password for HTTP Basic Authentication.

[float]
[[preconfigured-xmatters-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:

Connector using Basic Authentication
[source,text]
--
xpack.actions.preconfigured:
my-xmatters:
name: preconfigured-xmatters-connector-type
actionTypeId: .xmatters
config:
configUrl: https://test.host
usesBasic: true
secrets:
user: testuser
password: passwordkeystorevalue
--

Connector using URL Authentication
[source,text]
--
xpack.actions.preconfigured:
my-xmatters:
name: preconfigured-xmatters-connector-type
actionTypeId: .xmatters
config:
usesBasic: false
secrets:
secretsUrl: https://test.host?apiKey=1234-abcd
--

Config defines information for the connector type:

`configUrl`:: A URL string that corresponds to *URL*. Only used if `usesBasic` is true.

`usesBasic`:: A boolean that corresponds to *Authentication Type*. If `true`, this connector will require values for `user` and `password` inside the secrets configuration. Defaults to `true`.

Secrets defines sensitive information for the connector type:

`user`:: A string that corresponds to *User*. Required if `usesBasic` is set to `true`.

`password`:: A string that corresponds to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>. Required if `usesBasic` is set to `true`.

`secretsUrl`:: A URL string that corresponds to *URL*. Only used if `usesBasic` is false, indicating the API key is included in the URL.
URL::
The request URL for the Elastic Alerts trigger in xMatters.
If you are using URL authentication, include the API key in the URL. For example, `https://example.com?apiKey=1234-abcd`.
If you are using the <<action-settings,`xpack.actions.allowedHosts`>> setting, make sure the hostname is added to the allowed hosts.
Username:: Username for HTTP basic authentication.
Password:: Password for HTTP basic authentication.

[float]
[[xmatters-action-configuration]]
Expand All @@ -100,7 +53,7 @@ image::management/connectors/images/xmatters-params-test.png[xMatters params tes

xMatters rules have the following properties:

Severity:: Severity of the rule.
Severity:: Severity of the rule.
Tags:: Comma-separated list of tags for the rule as provided by the user in Elastic.

[float]
Expand Down
41 changes: 41 additions & 0 deletions docs/management/connectors/pre-configured-connectors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre
* <<preconfigured-server-log-configuration>>
* <<preconfigured-webhook-configuration>>
* <<preconfigured-cases-webhook-configuration>>
* <<preconfigured-xmatters-configuration>>

[float]
[[preconfigured-index-configuration]]
Expand Down Expand Up @@ -292,3 +293,43 @@ xpack.actions.preconfigured:
<14> A stringified JSON payload with Mustache variables that is sent to the create comment URL to create a case comment.
<15> A user name, which is required when `hasAuth` is `true`.
<16> A password, which is required when `hasAuth` is `true`.

[float]
[[preconfigured-xmatters-configuration]]
==== xMatters connectors

The following example creates an <<xmatters-action-type,xMatters connector>> with basic authentication:

[source,text]
--
xpack.actions.preconfigured:
my-xmatters:
name: preconfigured-xmatters-connector-type
actionTypeId: .xmatters
config:
configUrl: https://test.host <1>
usesBasic: true <2>
secrets:
user: testuser <3>
password: passwordkeystorevalue <4>
--
<1> The request URL for the Elastic Alerts trigger in xMatters.
<2> Indicates whether the connector uses HTTP basic authentication. If `true`, you must provide `user` and `password` values. Defaults to `true`.
<3> A user name for authentication, which is required when `usesBasic` is `true`.
<4> A password for authentication, which is required when `usesBasic` is `true`. NOTE: This value should be stored in the <<creating-keystore,{kib} keystore>>.

The following example creates an xMatters connector with URL authentication:

[source,text]
--
xpack.actions.preconfigured:
my-xmatters:
name: preconfigured-xmatters-connector-type
actionTypeId: .xmatters
config:
usesBasic: false <1>
secrets:
secretsUrl: https://test.host?apiKey=1234-abcd <2>
--
<1> Indicates whether the connector uses HTTP basic authentication. Set to `false` to use URL authentication. Defaults to `true`.
<2> The request URL for the Elastic Alerts trigger in xMatters with the API key included in the URL.
Loading

0 comments on commit 7267efe

Please sign in to comment.