github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Add settings for Enterprise Search (#126711)

Browse source 
* [DOCS] Add settings for Enterprise Search

* Update docs/settings/enterprise-search-settings.asciidoc

Co-authored-by: Rich Kuzsma <62522248+richkuz@users.noreply.github.com>

Co-authored-by: Rich Kuzsma <62522248+richkuz@users.noreply.github.com>
This commit is contained in:
gchaps 2022-03-02 12:58:15 -08:00 • committed by GitHub
parent 0bd772432a
commit 2fc7ad44a8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/settings/enterprise-search-settings.asciidoc Normal file
View file

@ -0,0 +1,26 @@
[role="xpack"]
[[enterprise-search-settings-kb]]
=== Enterprise Search settings in {kib}
++++
<titleabbrev>Enterprise Search settings</titleabbrev>
++++
On Elastic Cloud, you do not need to configure any settings to use Enterprise Search in {kib}. It is enabled by default. On self-managed installations, you must configure `enterpriseSearch.host`.
`enterpriseSearch.host`::
The http(s) URL of your Enterprise Search instance. For example, in a local self-managed setup,
set this to `http://localhost:3002`. Authentication between {kib} and the Enterprise Search host URL,
such as via OAuth, is not supported. You can also
{enterprise-search-ref}/configure-ssl-tls.html#configure-ssl-tls-in-kibana[configure {kib} to trust
your Enterprise Search TLS certificate authority].
`enterpriseSearch.accessCheckTimeout`::
When launching the Enterprise Search UI, the maximum number of milliseconds for {kib} to wait
for a response from Enterprise Search
before considering the attempt failed and logging a warning.
Default: 5000.
`enterpriseSearch.accessCheckTimeoutWarning`::
When launching the Enterprise Search UI, the maximum number of milliseconds for {kib} to wait for a response from
Enterprise Search before logging a warning. Default: 300.

6
docs/setup/settings.asciidoc
View file

@ -282,9 +282,6 @@ on the {kib} index at startup. {kib} users still need to authenticate with
that the {kib} server uses to perform maintenance on the {kib} index at startup. This setting that the {kib} server uses to perform maintenance on the {kib} index at startup. This setting
is an alternative to `elasticsearch.username` and `elasticsearch.password`. is an alternative to `elasticsearch.username` and `elasticsearch.password`.
| `enterpriseSearch.host`
| The http(s) URL of your Enterprise Search instance. For example, in a local self-managed setup, set this to `http://localhost:3002`. Authentication between Kibana and the Enterprise Search host URL, such as via OAuth, is not supported. You can also {enterprise-search-ref}/configure-ssl-tls.html#configure-ssl-tls-in-kibana[configure Kibana to trust your Enterprise Search TLS certificate authority].
| `interpreter.enableInVisualize` | `interpreter.enableInVisualize`
| Enables use of interpreter in Visualize. *Default: `true`* | Enables use of interpreter in Visualize. *Default: `true`*
@ -719,6 +716,7 @@ 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[]
include::{kib-repo-dir}/settings/apm-settings.asciidoc[] include::{kib-repo-dir}/settings/apm-settings.asciidoc[]
include::{kib-repo-dir}/settings/banners-settings.asciidoc[] include::{kib-repo-dir}/settings/banners-settings.asciidoc[]
include::{kib-repo-dir}/settings/enterprise-search-settings.asciidoc[]
include::{kib-repo-dir}/settings/fleet-settings.asciidoc[] include::{kib-repo-dir}/settings/fleet-settings.asciidoc[]
include::{kib-repo-dir}/settings/i18n-settings.asciidoc[] include::{kib-repo-dir}/settings/i18n-settings.asciidoc[]
include::{kib-repo-dir}/settings/logging-settings.asciidoc[] include::{kib-repo-dir}/settings/logging-settings.asciidoc[]
@ -726,8 +724,8 @@ include::{kib-repo-dir}/settings/logs-ui-settings.asciidoc[]
include::{kib-repo-dir}/settings/infrastructure-ui-settings.asciidoc[] include::{kib-repo-dir}/settings/infrastructure-ui-settings.asciidoc[]
include::{kib-repo-dir}/settings/monitoring-settings.asciidoc[] include::{kib-repo-dir}/settings/monitoring-settings.asciidoc[]
include::{kib-repo-dir}/settings/reporting-settings.asciidoc[] include::{kib-repo-dir}/settings/reporting-settings.asciidoc[]
include::secure-settings.asciidoc[]
include::{kib-repo-dir}/settings/search-sessions-settings.asciidoc[] include::{kib-repo-dir}/settings/search-sessions-settings.asciidoc[]
include::secure-settings.asciidoc[]
include::{kib-repo-dir}/settings/security-settings.asciidoc[] include::{kib-repo-dir}/settings/security-settings.asciidoc[]
include::{kib-repo-dir}/settings/spaces-settings.asciidoc[] include::{kib-repo-dir}/settings/spaces-settings.asciidoc[]
include::{kib-repo-dir}/settings/task-manager-settings.asciidoc[] include::{kib-repo-dir}/settings/task-manager-settings.asciidoc[]