github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[7.17] [DOCS] Add examples for proxyBypassHosts and proxyOnlyHosts settings (#164981) (#165162)

Browse source 
# Backport

This will backport the following commits from `main` to `7.17`:
- [[DOCS] Add examples for `proxyBypassHosts` and `proxyOnlyHosts`
settings (#164981)](https://github.com/elastic/kibana/pull/164981)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"James
Rodewig","email":"james.rodewig@elastic.co"},"sourceCommit":{"committedDate":"2023-08-29T20:13:27Z","message":"[DOCS]
Add examples for `proxyBypassHosts` and `proxyOnlyHosts` settings
(#164981)\n\nAdds example values for the
`xpack.actions.proxyBypassHosts` and `xpack.actions.proxyOnlyHosts`
settings.\r\n\r\nCloses
https://github.com/elastic/kibana/issues/139560","sha":"00853534c8be36feebb4eac05039a73074268025","branchLabelMapping":{"^v8.11.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","Team:ResponseOps","docs","Feature:Actions/ConnectorsManagement","v8.10.0","v7.17.13","v8.11.0","v8.9.2"],"number":164981,"url":"https://github.com/elastic/kibana/pull/164981","mergeCommit":{"message":"[DOCS]
Add examples for `proxyBypassHosts` and `proxyOnlyHosts` settings
(#164981)\n\nAdds example values for the
`xpack.actions.proxyBypassHosts` and `xpack.actions.proxyOnlyHosts`
settings.\r\n\r\nCloses
https://github.com/elastic/kibana/issues/139560","sha":"00853534c8be36feebb4eac05039a73074268025"}},"sourceBranch":"main","suggestedTargetBranches":["8.10","7.17","8.9"],"targetPullRequestStates":[{"branch":"8.10","label":"v8.10.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"7.17","label":"v7.17.13","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.11.0","labelRegex":"^v8.11.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/164981","number":164981,"mergeCommit":{"message":"[DOCS]
Add examples for `proxyBypassHosts` and `proxyOnlyHosts` settings
(#164981)\n\nAdds example values for the
`xpack.actions.proxyBypassHosts` and `xpack.actions.proxyOnlyHosts`
settings.\r\n\r\nCloses
https://github.com/elastic/kibana/issues/139560","sha":"00853534c8be36feebb4eac05039a73074268025"}},{"branch":"8.9","label":"v8.9.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
This commit is contained in:
Kibana Machine 2023-08-29 16:35:55 -04:00 • committed by GitHub
parent fca642d65a
commit da898a338e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/settings/alert-action-settings.asciidoc
View file

@ -166,10 +166,26 @@ 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.
Specifies hostnames which should not use the proxy, if using a proxy for actions. The value is an array of hostnames as strings. Example:
+
[source,yaml]
----
# If applicable, include the subdomain in the hostname
xpack.actions.proxyBypassHosts: [ "events.pagerduty.com" ]
----
+
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.
`xpack.actions.proxyOnlyHosts` {ess-icon}::
Specifies hostnames which should only use the proxy, if using a proxy for actions. The value is an array of hostnames as strings. By default, no hosts will use the proxy, but if an action's hostname is in this list, the proxy will be used. The settings `xpack.actions.proxyBypassHosts` and `xpack.actions.proxyOnlyHosts` cannot be used at the same time.
Specifies hostnames which should only use the proxy, if using a proxy for actions. The value is an array of hostnames as strings. Example:
+
[source,yaml]
----
# If applicable, include the subdomain in the hostname
xpack.actions.proxyOnlyHosts: [ "events.pagerduty.com" ]
----
+
By default, no hosts will use the proxy, but if an action's hostname is in this list, the proxy will be used. The settings `xpack.actions.proxyBypassHosts` and `xpack.actions.proxyOnlyHosts` cannot be used at the same time.
`xpack.actions.proxyHeaders` {ess-icon}::
Specifies HTTP headers for the proxy, if using a proxy for actions. Default: {}.