Skip to content

Commit

Permalink
[DOCS] Move preconfigured Opsgenie connector details (#165258)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored Sep 5, 2023
1 parent 0fe614f commit 6b6dcdb
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 28 deletions.
28 changes: 0 additions & 28 deletions docs/management/connectors/action-types/opsgenie.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
21 changes: 21 additions & 0 deletions docs/management/connectors/pre-configured-connectors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
22 changes: 22 additions & 0 deletions docs/settings/alert-action-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 6b6dcdb

Please sign in to comment.