From 011567a8891c9285dc296cd299a2aa1786815052 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Thu, 27 Apr 2023 07:26:19 -0700 Subject: [PATCH] [DOCS] Edits Kibana alerting settings (#155318) (cherry picked from commit 7efe3d53c6e8dfeec7da7815d2d4c7a2a965c40e) --- docs/settings/alert-action-settings.asciidoc | 35 ++++++++++---------- docs/setup/settings.asciidoc | 2 +- 2 files changed, 18 insertions(+), 19 deletions(-) diff --git a/docs/settings/alert-action-settings.asciidoc b/docs/settings/alert-action-settings.asciidoc index 5dc559d4fd389..ff7b25f5be655 100644 --- a/docs/settings/alert-action-settings.asciidoc +++ b/docs/settings/alert-action-settings.asciidoc @@ -1,10 +1,14 @@ -[role="xpack"] [[alert-action-settings-kb]] -=== Alerting and action settings in {kib} +== Alerting and action settings in {kib} ++++ Alerting and action settings ++++ +:description: Learn about the settings that affect {kib} {alert-features}. +:tags-products: [kibana, alerting] +:tags-content-type: [reference] +:tags-user-goals: [configure] + Alerting and actions are enabled by default in {kib}, but require you to configure the following: . <>. @@ -15,7 +19,7 @@ You can configure the following settings in the `kibana.yml` file. [float] [[general-alert-action-settings]] -==== General settings +=== General settings `xpack.encryptedSavedObjects.encryptionKey`:: A string of 32 or more characters used to encrypt sensitive properties on alerting rules and actions before they're stored in {es}. Third party credentials — such as the username and password used to connect to an SMTP service — are an example of encrypted properties. @@ -29,7 +33,7 @@ Be sure to back up the encryption key value somewhere safe, as your alerting rul [float] [[action-settings]] -==== Action settings +=== Action settings `xpack.actions.allowedHosts` {ess-icon}:: A list of hostnames that {kib} is allowed to connect to when built-in actions are triggered. It defaults to `[*]`, allowing any host, but keep in mind the potential for SSRF attacks when hosts are not explicitly added to the allowed hosts. An empty list `[]` can be used to block built-in actions from making any external connections. @@ -71,7 +75,7 @@ xpack.actions.customHostSettings: ssl: verificationMode: 'none' -- - ++ The settings in `xpack.actions.customHostSettings` can be used to override the global option `xpack.actions.ssl.verificationMode` and provide customized TLS settings on a per-server basis. Set `xpack.actions.ssl.verificationMode` to the @@ -107,7 +111,7 @@ The options `smtp.ignoreTLS` and `smtp.requireTLS` can not both be set to true. Default: `false`. `xpack.actions.customHostSettings[n].ssl.rejectUnauthorized`:: -Deprecated. Use <> instead. A boolean value indicating whether to bypass server certificate validation. +deprecated:[8.0.0] Use <> instead. A boolean value indicating whether to bypass server certificate validation. Overrides the general `xpack.actions.rejectUnauthorized` configuration for requests made for this hostname/port. @@ -127,7 +131,7 @@ the files cannot be made available. [[action-config-email-domain-allowlist]] `xpack.actions.email.domain_allowlist` {ess-icon}:: A list of allowed email domains which can be used with the email connector. When this setting is not used, all email domains are allowed. When this setting is used, if any email is attempted to be sent that (a) includes an addressee with an email domain that is not in the allowlist, or (b) includes a from address domain that is not in the allowlist, it will fail with a message indicating the email is not allowed. - ++ WARNING: This feature is available in {kib} 7.17.4 and 8.3.0 onwards but is not supported in {kib} 8.0, 8.1 or 8.2. As such, this setting should be removed before upgrading from 7.17 to 8.0, 8.1 or 8.2. It is possible to configure the settings in 7.17.4 and then upgrade to 8.3.0 directly. `xpack.actions.enabledActionTypes` {ess-icon}:: @@ -157,8 +161,6 @@ proxy in tunneling mode, and display some of the interaction between the client -- curl --verbose --proxytunnel --proxy http://localhost:8080 http://example.com -- -+ - `xpack.actions.proxyBypassHosts` {ess-icon}:: Specifies hostnames which should not use the proxy, if using a proxy for actions. The value is an array of hostnames as strings. By default, all hosts will use the proxy, but if an action's hostname is in this list, the proxy will not be used. The settings `xpack.actions.proxyBypassHosts` and `xpack.actions.proxyOnlyHosts` cannot be used at the same time. @@ -170,14 +172,14 @@ Specifies hostnames which should only use the proxy, if using a proxy for action Specifies HTTP headers for the proxy, if using a proxy for actions. Default: {}. `xpack.actions.proxyRejectUnauthorizedCertificates` {ess-icon}:: -Deprecated. Use <> instead. Set to `false` to bypass certificate validation for the proxy, if using a proxy for actions. Default: `true`. +deprecated:[8.0.0] Use <> instead. Set to `false` to bypass certificate validation for the proxy, if using a proxy for actions. Default: `true`. [[action-config-proxy-verification-mode]]`xpack.actions.ssl.proxyVerificationMode` {ess-icon}:: Controls the verification for the proxy server certificate that Kibana receives when making an outbound SSL/TLS connection to the proxy server. Valid values are `full`, `certificate`, and `none`. Use `full` to perform hostname verification, `certificate` to skip hostname verification, and `none` to skip verification. Default: `full`. <>. `xpack.actions.rejectUnauthorized` {ess-icon}:: -Deprecated. Use <> instead. Set to `false` to bypass certificate validation for actions. Default: `true`. +deprecated:[8.0.0] Use <> instead. Set to `false` to bypass certificate validation for actions. Default: `true`. + As an alternative to setting `xpack.actions.rejectUnauthorized`, you can use the setting `xpack.actions.customHostSettings` to set SSL options for specific servers. @@ -203,9 +205,8 @@ For example, `20m`, `24h`, `7d`, `1w`. Default: `60s`. Specifies the maximum number of times an action can be attempted to run. Can be minimum 1 and maximum 10. `xpack.actions.run.connectorTypeOverrides` {ess-icon}:: -Overrides the configs under `xpack.actions.run` for the connector type with the given ID. List the connector type identifier and its settings in an array of objects. +Overrides the configs under `xpack.actions.run` for the connector type with the given ID. List the connector type identifier and its settings in an array of objects. For example: + -For example: [source,yaml] -- xpack.actions.run: @@ -217,7 +218,7 @@ xpack.actions.run: [float] [[alert-settings]] -==== Alerting settings +=== Alerting settings `xpack.alerting.maxEphemeralActionsPerAlert` {ess-icon}:: Sets the number of actions that will run ephemerally. To use this, enable @@ -253,9 +254,8 @@ Specifies the default timeout for tasks associated with all types of rules. The For example, `20m`, `24h`, `7d`, `1w`. Default: `5m`. `xpack.alerting.rules.run.ruleTypeOverrides` {ess-icon}:: -Overrides the configs under `xpack.alerting.rules.run` for the rule type with the given ID. List the rule identifier and its settings in an array of objects. +Overrides the configs under `xpack.alerting.rules.run` for the rule type with the given ID. List the rule identifier and its settings in an array of objects. For example: + -For example: [source,yaml] -- xpack.alerting.rules.run: @@ -266,9 +266,8 @@ xpack.alerting.rules.run: -- `xpack.alerting.rules.run.actions.connectorTypeOverrides` {ess-icon}:: -Overrides the configs under `xpack.alerting.rules.run.actions` for the connector type with the given ID. List the connector type identifier and its settings in an array of objects. +Overrides the configs under `xpack.alerting.rules.run.actions` for the connector type with the given ID. List the connector type identifier and its settings in an array of objects. For example: + -For example: [source,yaml] -- xpack.alerting.rules.run: diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc index 3c45338c4da90..99f336696cc93 100644 --- a/docs/setup/settings.asciidoc +++ b/docs/setup/settings.asciidoc @@ -619,7 +619,7 @@ Set this value to false to disable the Upgrade Assistant UI. *Default: true* Set this value to change the {kib} interface language. Valid locales are: `en`, `zh-CN`, `ja-JP`. *Default: `en`* -include::{kib-repo-dir}/settings/alert-action-settings.asciidoc[] +include::{kib-repo-dir}/settings/alert-action-settings.asciidoc[leveloffset=+1] include::{kib-repo-dir}/settings/apm-settings.asciidoc[] include::{kib-repo-dir}/settings/banners-settings.asciidoc[] include::{kib-repo-dir}/settings/enterprise-search-settings.asciidoc[]