Skip to content

Commit

Permalink
[Alerting] Link to action config settings from connector docs (#100358)…
Browse files Browse the repository at this point in the history
… (#100751)

* wip

* Adding section about connector networking config to all connectors

* Updating wording

* Changing header size

* Updating links

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Co-authored-by: ymao1 <ying.mao@elastic.co>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
  • Loading branch information
3 people committed May 27, 2021
1 parent df8ba92 commit 12ec99f
Show file tree
Hide file tree
Showing 9 changed files with 54 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/management/action-types.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,11 @@ image::images/connector-listing.png[Example connector listing in the Rules and C

Access to connectors is granted based on your privileges to alerting-enabled features. See <<alerting-security, Alerting Security>> for more information.

[float]
=== Connector networking configuration

Use the <<action-settings, Action configuration settings>> to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.

[float]
[[connectors-list]]
=== Connector list
Expand Down Expand Up @@ -110,7 +115,7 @@ image::images/connector-select-type.png[Connector select type]
[[importing-and-exporting-connectors]]
=== Importing and exporting connectors

To import and export rules, use the <<managing-saved-objects, Saved Objects Management UI>>.
To import and export connectors, use the <<managing-saved-objects, Saved Objects Management UI>>.
After a successful import, the proper banner is displayed:
[role="screenshot"]
image::images/coonectors-import-banner.png[Connectors import banner, width=50%]
Expand Down
6 changes: 6 additions & 0 deletions docs/management/connectors/action-types/email.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ Require authentication:: If true, a username and password for login type authent
Username:: Username for login type authentication.
Password:: Password for login type authentication.

[float]
[[email-connector-networking-configuration]]
==== Connector networking configuration

Use the <<action-settings, Action configuration settings>> to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.

[float]
[[preconfigured-email-configuration]]
==== Preconfigured connector type
Expand Down
6 changes: 6 additions & 0 deletions docs/management/connectors/action-types/jira.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ Project key:: Jira project key.
Email (or username):: The account email (or username) for HTTP Basic authentication.
API token (or password):: Jira API authentication token (or password) for HTTP Basic authentication.

[float]
[[jira-connector-networking-configuration]]
==== Connector networking configuration

Use the <<action-settings, Action configuration settings>> to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.

[float]
[[Preconfigured-jira-configuration]]
==== Preconfigured connector type
Expand Down
6 changes: 6 additions & 0 deletions docs/management/connectors/action-types/pagerduty.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ Name:: The name of the connector. The name is used to identify a connector
API URL:: An optional PagerDuty event URL. Defaults to `https://events.pagerduty.com/v2/enqueue`. If you are using the <<action-settings, `xpack.actions.allowedHosts`>> setting, make sure the hostname is added to the allowed hosts.
Integration Key:: A 32 character PagerDuty Integration Key for an integration on a service, also referred to as the routing key.

[float]
[[pagerduty-connector-networking-configuration]]
==== Connector networking configuration

Use the <<action-settings, Action configuration settings>> to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.

[float]
[[Preconfigured-pagerduty-configuration]]
==== Preconfigured connector type
Expand Down
6 changes: 6 additions & 0 deletions docs/management/connectors/action-types/resilient.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ Organization ID:: IBM Resilient organization ID.
API key ID:: The authentication key ID for HTTP Basic authentication.
API key secret:: The authentication key secret for HTTP Basic authentication.

[float]
[[resilient-connector-networking-configuration]]
==== Connector networking configuration

Use the <<action-settings, Action configuration settings>> to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.

[float]
[[Preconfigured-resilient-configuration]]
==== Preconfigured connector type
Expand Down
6 changes: 6 additions & 0 deletions docs/management/connectors/action-types/servicenow.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ URL:: ServiceNow instance URL.
Username:: Username for HTTP Basic authentication.
Password:: Password for HTTP Basic authentication.

[float]
[[servicenow-connector-networking-configuration]]
==== Connector networking configuration

Use the <<action-settings, Action configuration settings>> to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.

[float]
[[Preconfigured-servicenow-configuration]]
==== Preconfigured connector type
Expand Down
6 changes: 6 additions & 0 deletions docs/management/connectors/action-types/slack.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ Slack connectors have the following configuration properties.
Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
Webhook URL:: The URL of the incoming webhook. See https://api.slack.com/messaging/webhooks#getting_started[Slack Incoming Webhooks] for instructions on generating this URL. If you are using the <<action-settings, `xpack.actions.allowedHosts`>> setting, make sure the hostname is added to the allowed hosts.

[float]
[[slack-connector-networking-configuration]]
==== Connector networking configuration

Use the <<action-settings, Action configuration settings>> to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.

[float]
[[Preconfigured-slack-configuration]]
==== Preconfigured connector type
Expand Down
6 changes: 6 additions & 0 deletions docs/management/connectors/action-types/teams.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ Microsoft Teams connectors have the following configuration properties.
Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
Webhook URL:: The URL of the incoming webhook. See https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook#add-an-incoming-webhook-to-a-teams-channel[Add Incoming Webhooks] for instructions on generating this URL. If you are using the <<action-settings, `xpack.actions.allowedHosts`>> setting, make sure the hostname is added to the allowed hosts.

[float]
[[teams-connector-networking-configuration]]
==== Connector networking configuration

Use the <<action-settings, Action configuration settings>> to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.

[float]
[[Preconfigured-teams-configuration]]
==== Preconfigured connector type
Expand Down
6 changes: 6 additions & 0 deletions docs/management/connectors/action-types/webhook.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ Require authentication:: If true, a username and password for login type authent
Username:: Username for HTTP basic authentication.
Password:: Password for HTTP basic authentication.

[float]
[[webhook-connector-networking-configuration]]
==== Connector networking configuration

Use the <<action-settings, Action configuration settings>> to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.

[float]
[[Preconfigured-webhook-configuration]]
==== Preconfigured connector type
Expand Down

0 comments on commit 12ec99f

Please sign in to comment.