Skip to content

Commit 686800d

Browse files
authored
Spaces in serverless (#5813)
* Add previously omitted spaces page, align with ESS * Fix typo in description frontmatter * Minor edit * Update "Data views in Elastic Security" Align across platforms, and omit "feature visibility" since it's unavailable in security * Update "Timeline" * Update "Timeline templates" * Update link to general docs on spaces This link will be broken until elastic/docs-content#55 is merged * Fix links: targets from stateful to serverless
1 parent 3c6e809 commit 686800d

File tree

10 files changed

+37
-22
lines changed

10 files changed

+37
-22
lines changed

docs/events/timeline-templates.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ NOTE: You cannot delete prebuilt templates.
136136
== Export and import Timeline templates
137137

138138
You can import and export Timeline templates, which enables importing templates
139-
from one {kib} space or instance to another. Exported templates are saved in an `ndjson` file.
139+
from one space or {elastic-sec} instance to another. Exported templates are saved in an `ndjson` file.
140140

141141
. Go to *Timelines* -> *Templates*.
142142
. To export templates, do one of the following:

docs/events/timeline-ui-overview.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ then select an action from the *Bulk actions* menu.
171171
== Export and import Timelines
172172

173173
You can export and import Timelines, which enables you to share Timelines from one
174-
{kib} space or instance to another. Exported Timelines are saved as `.ndjson` files.
174+
space or {elastic-sec} instance to another. Exported Timelines are saved as `.ndjson` files.
175175

176176
To export Timelines:
177177

docs/getting-started/data-views-in-sec.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ NOTE: You cannot update the data view for the Alerts page. This includes referen
3333
[[default-data-view-security]]
3434
== The default {data-source}
3535

36-
The default {data-source} is defined by the `securitySolution:defaultIndex` setting, which you can modify in {kib}'s advanced settings (**Stack Management** > **Advanced Settings** > **Security Solution**). To learn more about this setting, including its default value, refer to {security-guide}/advanced-settings.html#update-sec-indices[Advanced settings].
36+
The default {data-source} is defined by the `securitySolution:defaultIndex` setting, which you can modify in {security-guide}/advanced-settings.html#update-sec-indices[advanced settings].
3737

3838
The first time a user visits {elastic-sec} within a given {kib} {kibana-ref}/xpack-spaces.html[space], the default {data-source} generates in that space and becomes active.
3939

docs/getting-started/security-spaces.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
= Spaces and {elastic-sec}
33

44
{elastic-sec} supports the organization of your security operations into
5-
logical instances with the {kibana-ref}/xpack-spaces.html[{kib} spaces]
5+
logical instances with the {kibana-ref}/xpack-spaces.html[spaces]
66
feature. Each space in {kib} represents a separate logical instance of
77
{elastic-sec} in which detection rules, rule exceptions, value lists,
88
alerts, Timelines, cases, and {kib} advanced settings are private to the
99
space and accessible only by users that have role privileges to
10-
access the space. For details about configuring privileges for
11-
{es} and {kib}, refer to <<detections-permissions-section>>.
10+
access the space. For details about privileges for
11+
{elastic-sec} and specific features, refer to <<sec-requirements>>.
1212

1313
For example, if you create a `SOC_prod` space in which you load and
1414
activate all the {elastic-sec} prebuilt detection rules, these rules and
@@ -22,7 +22,7 @@ the `SOC_dev` space, and they will run independently of those in the
2222
[NOTE]
2323
=====
2424
By default, alerts created by detection rules are stored in {es} indices
25-
under the `.alerts-security.alerts-<Kibana-space>` index pattern, and they may be
25+
under the `.alerts-security.alerts-<space-name>` index pattern, and they may be
2626
accessed by any user with role privileges to access those
2727
{es} indices. In our example above, any user with {es} privileges to access
2828
`.alerts-security.alerts-SOC_prod` will be able to view `SOC_prod` alerts from

docs/serverless/explore/data-views-in-sec.mdx

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,8 @@ This only allows you to add index patterns that match indices that currently con
4444

4545
## The default ((data-source))
4646

47-
The default ((data-source)) is defined by the `securitySolution:defaultIndex` setting, which you can modify in your project's advanced settings{/* path to be updated: (**Stack Management** → **Advanced Settings** → **Security Solution**) */}. To learn more about this setting, including its default value, refer to <DocLink slug="/serverless/security/advanced-settings" />).
47+
The default ((data-source)) is defined by the `securitySolution:defaultIndex` setting, which you can modify in <DocLink slug="/serverless/security/advanced-settings">advanced settings</DocLink>.
4848

49-
The first time a user visits ((elastic-sec)){/* within a given ((kib)) [space](((kibana-ref))/xpack-spaces.html)*/}, the default ((data-source)) generates{/* in that space*/} and becomes active.
49+
The first time a user visits ((elastic-sec)) within a given ((kib)) <DocLink slug="/serverless/spaces">space</DocLink>, the default ((data-source)) generates in that space and becomes active.
5050

51-
{/* TO-DO: in the first sentence of the following note, link to the Serverless page that explains spaces. */}
52-
53-
<DocCallOut title="Note">
54-
Your space must have **Data View Management**{/*{kibana-ref}/xpack-spaces.html#spaces-control-feature-visibility[feature visibility*/} feature visibility setting enabled for the default ((data-source)) to generate and become active in your space.
55-
</DocCallOut>
56-
57-
If you delete the active ((data-source)) when there are no other defined ((data-sources)), the default ((data-source)) will regenerate and become active upon refreshing any ((elastic-sec)) page{/* in the space*/}.
51+
If you delete the active ((data-source)) when there are no other defined ((data-sources)), the default ((data-source)) will regenerate and become active upon refreshing any ((elastic-sec)) page in the space.

docs/serverless/investigate/timeline-templates-ui.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ You cannot delete prebuilt templates.
135135

136136
## Export and import Timeline templates
137137

138-
You can import and export Timeline templates, which enables importing templates from one {/*space or (*/}((elastic-sec)) instance to another. Exported templates are saved in an `ndjson` file.
138+
You can import and export Timeline templates, which enables importing templates from one space or ((elastic-sec)) instance to another. Exported templates are saved in an `ndjson` file.
139139

140140
1. Go to **Investigations****Timelines****Templates**.
141141
1. To export templates, do one of the following:

docs/serverless/investigate/timelines-ui.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ then select an action from the **Bulk actions** menu.
176176

177177
## Export and import Timelines
178178

179-
You can export and import Timelines, which enables you to share Timelines from one {/* space or */} ((elastic-sec)) instance to another. Exported Timelines are saved as `.ndjson` files.
179+
You can export and import Timelines, which enables you to share Timelines from one space or ((elastic-sec)) instance to another. Exported Timelines are saved as `.ndjson` files.
180180

181181
To export Timelines:
182182

docs/serverless/sec-requirements.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Provide access to ((elastic-sec)) by assigning a user the appropriate <DocLink s
1515

1616
To use ((elastic-sec)), your role must have at least:
1717

18-
* `Read` privilege for the `Security` feature in the [space](((kibana-ref))/xpack-spaces.html). This grants you `Read` access to all features in ((elastic-sec)) except cases. You need additional <DocLink slug="/serverless/security/cases-requirements">minimum privileges</DocLink> to use cases.
19-
* `Read` and `view_index_metadata` privileges for all ((elastic-sec)) indices, such as
20-
`filebeat-*`, `packetbeat-*`, `logs-*`, and `endgame-*` indices.
18+
* `Read` privilege for the `Security` feature in the <DocLink slug="/serverless/spaces">space</DocLink>. This grants you `Read` access to all features in ((elastic-sec)) except cases. You need additional <DocLink slug="/serverless/security/cases-requirements">minimum privileges</DocLink> to use cases.
19+
* `Read` and `view_index_metadata` privileges for all ((elastic-sec)) indices, such as
20+
`filebeat-*`, `packetbeat-*`, `logs-*`, and `endgame-*` indices.
2121

2222
<DocCallOut title="Note">
2323
<DocLink slug="/serverless/security/advanced-settings" /> describes how to modify ((elastic-sec)) indices.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
slug: /serverless/security/security-spaces
3+
title: Spaces and ((elastic-sec))
4+
description: Learn how spaces work in ((elastic-sec)).
5+
tags: [ 'serverless', 'security', 'reference' ]
6+
---
7+
8+
((elastic-sec)) supports the organization of your security operations into logical instances with the <DocLink slug="/serverless/spaces">spaces</DocLink> feature. Each space in ((kib)) represents a separate logical instance of ((elastic-sec)) in which detection rules, rule exceptions, value lists, alerts, Timelines, cases, and ((kib)) advanced settings are private to the space and accessible only by users that have role privileges to access the space. For details about privileges for ((elastic-sec)) and specific features, refer to <DocLink slug="/serverless/security/requirements-overview" />.
9+
10+
For example, if you create a `SOC_prod` space in which you load and activate all the ((elastic-sec)) prebuilt detection rules, these rules and any detection alerts they generate will be accessible only when visiting the ((security-app)) in the `SOC_prod` space. If you then create a new `SOC_dev` space, you'll notice that no detection rules or alerts are present. Any rules subsequently loaded or created here will be private to the `SOC_dev` space, and they will run independently of those in the `SOC_prod` space.
11+
12+
<DocCallOut title="Note">
13+
By default, alerts created by detection rules are stored in ((es)) indices under the `.alerts-security.alerts-<space-name>` index pattern, and they may be accessed by any user with role privileges to access those ((es)) indices. In our example above, any user with ((es)) privileges to access `.alerts-security.alerts-SOC_prod` will be able to view `SOC_prod` alerts from within ((es)) and other ((kib)) apps such as Discover.
14+
15+
To ensure that detection alert data remains private to the space in which it was created, ensure that the roles assigned to your ((elastic-sec)) users include ((es)) privileges that limit their access to alerts within their space's alerts index.
16+
</DocCallOut>

docs/serverless/serverless-security.docnav.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,12 @@
2121
},
2222
{
2323
"slug": "/serverless/security/security-ui",
24-
"classic-sources": [ "enSecurityEsUiOverview" ]
24+
"classic-sources": [ "enSecurityEsUiOverview" ],
25+
"items": [
26+
{
27+
"slug": "/serverless/security/security-spaces"
28+
}
29+
]
2530
},
2631
{
2732
"label": "AI for security",

0 commit comments

Comments
 (0)