Skip to content

Commit

Permalink
[DOCS] Documents monitoring.cluster_alerts.allowedSpaces (#114669) (#…
Browse files Browse the repository at this point in the history
…114890)

* [DOCS] Documents monitoring.cluster_alerts.allowedSpaces

* Update docs/settings/spaces-settings.asciidoc

Co-authored-by: gchaps <[email protected]>

Co-authored-by: gchaps <[email protected]>

Co-authored-by: gchaps <[email protected]>
  • Loading branch information
KOTungseth and gchaps authored Oct 13, 2021
1 parent b32d555 commit 291ea9d
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions docs/settings/spaces-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,23 @@
<titleabbrev>Spaces settings</titleabbrev>
++++

By default, Spaces is enabled in Kibana, and you can secure Spaces using
roles when Security is enabled.

[float]
[[spaces-settings]]
==== Spaces settings
By default, spaces is enabled in {kib}. To secure spaces, <<security-settings-kb,enable security>>.

`xpack.spaces.enabled`::
deprecated:[7.16.0,"In 8.0 and later, this setting will no longer be supported."]
Set to `true` (default) to enable Spaces in {kib}.
This setting is deprecated. Starting in 8.0, it will not be possible to disable this plugin.
deprecated:[7.16.0,"In 8.0 and later, this setting will no longer be supported and it will not be possible to disable this plugin."]
To enable spaces, set to `true`.
The default is `true`.

`xpack.spaces.maxSpaces`::
The maximum amount of Spaces that can be used with this instance of {kib}. Some operations
in {kib} return all spaces using a single `_search` from {es}, so this must be
set lower than the `index.max_result_window` in {es}.
Defaults to `1000`.
The maximum number of spaces that you can use with the {kib} instance. Some {kib} operations
return all spaces using a single `_search` from {es}, so you must
configure this setting lower than the `index.max_result_window` in {es}.
The default is `1000`.

`monitoring.cluster_alerts-allowedSpaces` {ess-icon}::
Specifies the spaces where cluster alerts are automatically generated.
You must specify all spaces where you want to generate alerts, including the default space.
When the default space is unspecified, {kib} is unable to generate an alert for the default space.
{es} clusters that run on {es} services are all containers. To send monitoring data
from your self-managed {es} installation to {es} services, set to `false`.
The default is `true`.

0 comments on commit 291ea9d

Please sign in to comment.