[DOCS] Move preconfigured Opsgenie connector details (#165258)

This commit is contained in:
Lisa Cawley 2023-09-05 08:15:22 -07:00 committed by GitHub
parent 0fe614f189
commit 6b6dcdb7c3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 43 additions and 28 deletions

View file

@ -28,34 +28,6 @@ URL:: The Opsgenie URL. For example, https://api.opsgenie.com or https://api.eu.
NOTE: If you are using the <<action-settings, `xpack.actions.allowedHosts`>> setting, make sure the hostname is added to the allowed hosts.
API Key:: The Opsgenie API authentication key for HTTP Basic authentication. For more details about generating Opsgenie API keys, refer to https://support.atlassian.com/opsgenie/docs/create-a-default-api-integration/[Opsgenie documentation].
[float]
[[preconfigured-opsgenie-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-opsgenie:
name: preconfigured-opsgenie-connector-type
actionTypeId: .opsgenie
config:
apiUrl: https://api.opsgenie.com
secrets:
apiKey: apikey
--
Config defines information for the connector type.
`apiUrl`:: A string that corresponds to *URL*.
Secrets defines sensitive information for the connector type.
`apiKey`:: A string that corresponds to *API Key*.
[float]
[[opsgenie-action-configuration]]
=== Test connectors

View file

@ -83,9 +83,30 @@ configuration.
[float]
=== Examples
* <<preconfigured-opsgenie-configuration>>
* <<preconfigured-server-log-configuration>>
* <<preconfigured-webhook-configuration>>
[float]
[[preconfigured-opsgenie-configuration]]
==== {opsgenie} connectors
The following example creates an <<opsgenie-action-type,{opsgenie} connector>>:
[source,text]
--
xpack.actions.preconfigured:
my-opsgenie:
name: preconfigured-opsgenie-connector-type
actionTypeId: .opsgenie
config:
apiUrl: https://api.opsgenie.com <1>
secrets:
apiKey: apikey <2>
--
<1> The {opsgenie} URL.
<2> The {opsgenie} API authentication key for HTTP basic authentication.
[float]
[[preconfigured-server-log-configuration]]
==== Server log connectors

View file

@ -252,9 +252,31 @@ Specifies configuration details that are specific to the type of preconfigured c
The type of preconfigured connector.
For example: `.email`, `.index`, `.opsgenie`, `.server-log`, `.resilient`, `.slack`, and `.webhook`.
`xpack.actions.preconfigured.<connector-id>.config.apiUrl`::
A configuration URL that varies by connector:
+
--
* For an <<opsgenie-action-type,{opsgenie} connector>>, specifies the {opsgenie} URL. For example, `https://api.opsgenie.com` or `https://api.eu.opsgenie.com`.
NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the hostname in the URL is added to the allowed hosts.
--
`xpack.actions.preconfigured.<connector-id>.name`::
The name of the preconfigured connector.
`xpack.actions.preconfigured.<connector-id>.secrets`::
Sensitive configuration details, such as username, password, and keys, which are specific to the connector type.
+
TIP: Sensitive properties, such as passwords, should be stored in the <<creating-keystore,{kib} keystore>>.
`xpack.actions.preconfigured.<connector-id>.secrets.apikey`::
An API key secret that varies by connector:
+
--
* For an <<opsgenie-action-type,{opsgenie} connector>>, specifies the {opsgenie} API authentication key for HTTP basic authentication.
--
[float]
[[alert-settings]]
=== Alerting settings