Skip to content

Commit 9069053

Browse files
[Docs migration] Cleans up getting started files - Pt. 2 (#618)
Follow-up to #497, which was recently rescoped. Addresses part of #559 by doing the following: - Removes raw migrated Serverless files that are no longer being used. - Adds anchors where missing and updates anchors that start with an underscore. - Makes minor inline adjustments to the files that were labeled as "lift-and-shift" where appropriate. Affected pages: - [Elastic Security requirements](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/618/solutions/security/get-started/elastic-security-requirements)
1 parent e5f0ded commit 9069053

File tree

3 files changed

+26
-82
lines changed

3 files changed

+26
-82
lines changed

raw-migrated-files/docs-content/serverless/security-requirements-overview.md

Lines changed: 0 additions & 50 deletions
This file was deleted.

raw-migrated-files/toc.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,6 @@ toc:
229229
- file: docs-content/serverless/security-prebuilt-rules-management.md
230230
- file: docs-content/serverless/security-query-alert-indices.md
231231
- file: docs-content/serverless/security-reduce-notifications-alerts.md
232-
- file: docs-content/serverless/security-requirements-overview.md
233232
- file: docs-content/serverless/security-response-actions-config.md
234233
- file: docs-content/serverless/security-response-actions-history.md
235234
- file: docs-content/serverless/security-response-actions.md

solutions/security/get-started/elastic-security-requirements.md

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,85 +4,80 @@ mapped_urls:
44
- https://www.elastic.co/guide/en/serverless/current/security-requirements-overview.html
55
---
66

7-
# Elastic Security requirements
7+
# {{elastic-sec}} requirements [security-requirements-overview]
88

9-
% What needs to be done: Align serverless/stateful
9+
The [Support Matrix](https://www.elastic.co/support/matrix) page lists officially supported operating systems, platforms, and browsers on which components such as {{beats}}, {{agent}}, {{elastic-defend}}, and {{elastic-endpoint}} have been tested.
1010

11-
% Use migrated content from existing pages that map to this page:
11+
## {{stack}} requirements [elastic-stack-requirements]
1212

13-
% - [x] ./raw-migrated-files/security-docs/security/sec-requirements.md
14-
% - [ ] ./raw-migrated-files/docs-content/serverless/security-requirements-overview.md
13+
```yaml {applies_to}
14+
stack:
15+
```
1516
16-
{{elastic-sec}} is an inbuilt part of {{kib}}. To use {{elastic-sec}}, you only need an {{stack}} deployment (an {{es}} cluster and {{kib}}).
17+
{{elastic-sec}} is an inbuilt part of {{kib}}. To use {{elastic-sec}}, you only need an {{stack}} deployment (an {{es}} cluster and {{kib}}). Review the [Elastic Stack subscriptions](https://www.elastic.co/subscriptions) page to understand the required subscription plans for all features.
1718
1819
{{ecloud}} offers all of the features of {{es}}, {{kib}}, and {{elastic-sec}} as a hosted service available on AWS, GCP, and Azure. To get started, sign up for a [free {{ecloud}} trial](https://cloud.elastic.co/registration?page=docs&placement=docs-body).
1920
2021
For information about installing and managing the {{stack}} yourself, see [Installing the {{stack}}](/get-started/the-stack.md).
2122
22-
The [Support Matrix](https://www.elastic.co/support/matrix) page lists officially supported operating systems, platforms, and browsers on which {{es}}, {{kib}}, {{beats}}, and Elastic Endpoint have been tested.
23+
### Node role requirements [node-role-requirements]
2324
25+
```yaml {applies_to}
26+
stack:
27+
```
2428
25-
## Node role requirements [node-role-requirements]
26-
27-
To use Elastic Security, at least one node in your Elasticsearch cluster must have the [`transform` role](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/transforms-settings.md). Nodes are automatically given this role when they’re created, so changes are not required if default role settings remain the same. This applies to on-premise and cloud deployments.
29+
To use {{elastic-sec}}, at least one node in your Elasticsearch cluster must have the [`transform` role](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/transforms-settings.md). Nodes are automatically given this role when they’re created, so changes are not required if default role settings remain the same. This applies to on-premise and cloud deployments.
2830

2931
Changes might be required if your nodes have customized roles. When updating node roles, nodes are only assigned the roles you specify, and default roles are removed. If you need to reassign the `transform` role to a node, [create a dedicated transform node](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/node-settings.md#transform-node).
3032

3133

3234
## Space and index privileges [_space_and_index_privileges]
3335

36+
3437
To use {{elastic-sec}}, your role must have at least:
3538

3639
* `Read` privilege for the `Security` feature in the [space](/deploy-manage/manage-spaces.md). This grants you `Read` access to all features in {{elastic-sec}} except cases. You need additional [minimum privileges](/solutions/security/investigate/cases-requirements.md) to use cases.
3740
* `Read` and `view_index_metadata` privileges for all {{elastic-sec}} indices, such as `filebeat-*`, `packetbeat-*`, `logs-*`, and `endgame-*` indices.
3841

3942
::::{note}
40-
[*Configure advanced settings*](/solutions/security/get-started/configure-advanced-settings.md) describes how to modify {{elastic-sec}} indices.
43+
[Configure advanced settings](/solutions/security/get-started/configure-advanced-settings.md) describes how to modify {{elastic-sec}} indices.
4144
::::
4245

4346

4447
For more information about index privileges, refer to [{{es}} security privileges](/deploy-manage/users-roles/cluster-or-deployment-auth/elasticsearch-privileges.md).
4548

4649

47-
## Feature-specific requirements [_feature_specific_requirements]
50+
## Feature-specific requirements [security-requirements-overview-feature-specific-requirements]
4851

4952
There are some additional requirements for specific features:
5053

51-
* [*Detections requirements*](/solutions/security/detect-and-alert/detections-requirements.md)
54+
* [Detections requirements](/solutions/security/detect-and-alert/detections-requirements.md)
5255
* [Cases requirements](/solutions/security/investigate/cases-requirements.md)
5356
* [Entity risk scoring requirements](/solutions/security/advanced-entity-analytics/entity-risk-scoring-requirements.md)
5457
* [Machine learning job and rule requirements](/solutions/security/advanced-entity-analytics/machine-learning-job-rule-requirements.md)
55-
* [*{{elastic-defend}} requirements*](/solutions/security/configure-elastic-defend/elastic-defend-requirements.md)
58+
* [{{elastic-defend}} requirements](/solutions/security/configure-elastic-defend/elastic-defend-requirements.md)
5659
* [Configure network map data](/solutions/security/explore/configure-network-map-data.md)
5760

61+
## Advanced configuration and UI options [security-requirements-overview-advanced-configuration-and-ui-options]
5862

59-
## License requirements [_license_requirements]
60-
61-
All features are available as part of the free Basic plan **except**:
62-
63-
* [Alert notifications via external systems](/solutions/security/detect-and-alert/create-detection-rule.md#rule-notifications)
64-
* [{{ml-cap}} jobs and rules](/solutions/security/advanced-entity-analytics/anomaly-detection.md)
65-
* [Cases integration with third-party ticketing systems](/solutions/security/investigate/configure-case-settings.md#cases-ui-integrations)
66-
67-
[Elastic Stack subscriptions](https://www.elastic.co/subscriptions) lists the required subscription plans for all features.
63+
[Configure advanced settings](/solutions/security/get-started/configure-advanced-settings.md) describes how to modify advanced settings, such as the {{elastic-sec}} indices, default time intervals used in filters, and IP reputation links.
6864

6965

70-
## Advanced configuration and UI options [_advanced_configuration_and_ui_options]
71-
72-
[*Configure advanced settings*](/solutions/security/get-started/configure-advanced-settings.md) describes how to modify advanced settings, such as the {{elastic-sec}} indices, default time intervals used in filters, and IP reputation links.
73-
74-
75-
## Third-party collectors mapped to ECS [_third_party_collectors_mapped_to_ecs]
66+
## Third-party collectors mapped to ECS [security-requirements-overview-third-party-collectors-mapped-to-ecs]
7667

7768
The [Elastic Common Schema (ECS)](https://www.elastic.co/guide/en/ecs/current) defines a common set of fields to be used for storing event data in Elasticsearch. ECS helps users normalize their event data to better analyze, visualize, and correlate the data represented in their events. {{elastic-sec}} can ingest and normalize events from any ECS-compliant data source.
7869

7970
::::{important}
80-
{{elastic-sec}} requires [ECS-compliant data](https://www.elastic.co/guide/en/ecs/current). If you use third-party data collectors to ship data to {{es}}, the data must be mapped to ECS. [*Elastic Security ECS field reference*](asciidocalypse://docs/docs-content/docs/reference/security/fields-and-object-schemas/siem-field-reference.md) lists ECS fields used in {{elastic-sec}}.
71+
{{elastic-sec}} requires [ECS-compliant data](https://www.elastic.co/guide/en/ecs/current). If you use third-party data collectors to ship data to {{es}}, the data must be mapped to ECS. [{{elastic-sec}} ECS field reference](asciidocalypse://docs/docs-content/docs/reference/security/fields-and-object-schemas/siem-field-reference.md) lists ECS fields used in {{elastic-sec}}.
8172
::::
8273

8374

8475

85-
## Cross-cluster searches [_cross_cluster_searches]
76+
## Cross-cluster searches [security-cross-cluster-searches]
77+
78+
```yaml {applies_to}
79+
stack:
80+
```
8681

8782
For information on how to perform cross-cluster searches on {{elastic-sec}} indices, see:
8883

0 commit comments

Comments
 (0)