Skip to content

Commit bc4dbb5

Browse files
Merge branch 'main' into 586-siem-migration-guide
2 parents d990ad1 + f7d74e0 commit bc4dbb5

File tree

62 files changed

+638
-3301
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+638
-3301
lines changed

deploy-manage/deploy/cloud-on-k8s/configure-eck.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ mapped_pages:
1212
This page explains the various methods for configuring and applying ECK settings.
1313

1414
::::{tip}
15-
For a detailed list and description of all available settings in ECK, refer to [ECK configuration flags](asciidocalypse://docs/cloud-on-k8s/docs/reference/eck-configuration-flags.md).
15+
For a detailed list and description of all available settings in ECK, refer to [ECK configuration flags](cloud-on-k8s://reference/eck-configuration-flags.md).
1616
::::
1717

1818
By default, the ECK installation includes a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) with an `eck.yaml` key where you can add, remove, or update configuration settings. This ConfigMap is mounted into the operator’s container as a file, and provided to the application through the `--config` flag.
@@ -56,7 +56,7 @@ If you installed ECK using the manifests and the commands listed in [Deploy ECK]
5656

5757
You can update the ConfigMap directly using the command `kubectl edit configmap elastic-operator -n elastic-operator` or modify the installation manifests and reapply them with `kubectl apply -f <your-manifest-file.yaml>`.
5858

59-
The following shows the default `elastic-operator` ConfigMap, for reference purposes. Refer to [ECK configuration flags](asciidocalypse://docs/cloud-on-k8s/docs/reference/eck-configuration-flags.md) for a complete list of available settings.
59+
The following shows the default `elastic-operator` ConfigMap, for reference purposes. Refer to [ECK configuration flags](cloud-on-k8s://reference/eck-configuration-flags.md) for a complete list of available settings.
6060

6161
```yaml
6262
apiVersion: v1

deploy-manage/deploy/cloud-on-k8s/elasticsearch-deployment-quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The cluster that you deployed in this quickstart guide only allocates a persiste
4444
::::
4545

4646

47-
For a full description of each `CustomResourceDefinition` (CRD), refer to the [*API Reference*](asciidocalypse://docs/cloud-on-k8s/docs/reference/k8s-api-reference.md) or view the CRD files in the [project repository](https://github.com/elastic/cloud-on-k8s/tree/2.16/config/crds). You can also retrieve information about a CRD from the cluster. For example, describe the {{es}} CRD specification with [`describe`](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_describe/):
47+
For a full description of each `CustomResourceDefinition` (CRD), refer to the [*API Reference*](cloud-on-k8s://reference/api-docs.md) or view the CRD files in the [project repository](https://github.com/elastic/cloud-on-k8s/tree/2.16/config/crds). You can also retrieve information about a CRD from the cluster. For example, describe the {{es}} CRD specification with [`describe`](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_describe/):
4848

4949
```sh
5050
kubectl describe crd elasticsearch

deploy-manage/deploy/cloud-on-k8s/k8s-service-mesh-linkerd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ kubectl annotate namespace elastic-stack linkerd.io/inject=enabled
4343

4444
Any Elasticsearch, Kibana, or APM Server resources deployed to a namespace with the above annotation will automatically join the mesh.
4545

46-
Alternatively, if you only want specific resources to join the mesh, add the `linkerd.io/inject: enabled` annotation to the `podTemplate` (check [API documentation](asciidocalypse://docs/cloud-on-k8s/docs/reference/k8s-api-reference.md)) of the resource as follows:
46+
Alternatively, if you only want specific resources to join the mesh, add the `linkerd.io/inject: enabled` annotation to the `podTemplate` (check [API documentation](cloud-on-k8s://reference/api-docs.md)) of the resource as follows:
4747

4848
```yaml
4949
podTemplate:

deploy-manage/deploy/cloud-on-k8s/kibana-instance-quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ To deploy a simple [{{kib}}](/get-started/the-stack.md#stack-components-kibana)
6666
```
6767

6868

69-
For a full description of each `CustomResourceDefinition` (CRD), refer to the [*API Reference*](asciidocalypse://docs/cloud-on-k8s/docs/reference/k8s-api-reference.md) or view the CRD files in the [project repository](https://github.com/elastic/cloud-on-k8s/tree/2.16/config/crds). You can also retrieve information about a CRD from the instance. For example, describe the {{kib}} CRD specification with [`describe`](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_describe/):
69+
For a full description of each `CustomResourceDefinition` (CRD), refer to the [*API Reference*](cloud-on-k8s://reference/api-docs.md) or view the CRD files in the [project repository](https://github.com/elastic/cloud-on-k8s/tree/2.16/config/crds). You can also retrieve information about a CRD from the instance. For example, describe the {{kib}} CRD specification with [`describe`](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_describe/):
7070

7171
```sh
7272
kubectl describe crd kibana

deploy-manage/deploy/elastic-cloud/regions.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ A region is the geographic area where the data center of the cloud provider that
1212
Elastic Cloud Serverless handles all hosting details for you. You are unable to change the region after you create a project.
1313

1414
::::{note}
15-
Currently, a limited number of Amazon Web Services (AWS) and Microsoft Azure regions are available. More regions for AWS and Azure, as well as Google Cloud Platform (GCP), will be added in the future.
15+
Currently, a limited number of Amazon Web Services (AWS), Microsoft Azure, and Google Cloud Platform (GCP) regions are available. More regions for AWS, Azure, and GCP, will be added in the future.
1616

1717
::::
1818

@@ -39,4 +39,16 @@ The following Azure regions are currently available:
3939
4040
| Region | Name |
4141
| :--- | :--- |
42-
| eastus | East US |
42+
| eastus | East US |
43+
44+
## Google Cloud Platform (GCP) regions [regions-gcp-regions]
45+
46+
```yaml {applies_to}
47+
serverless: preview
48+
```
49+
50+
The following GCP regions are currently available:
51+
52+
| Region | Name |
53+
| :--- | :--- |
54+
| us-central1 | Iowa |

deploy-manage/security.md

Lines changed: 123 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
---
2+
applies_to:
3+
deployment: all
4+
serverless: ga
25
mapped_urls:
36
- https://www.elastic.co/guide/en/elasticsearch/reference/current/security-files.html
47
- https://www.elastic.co/guide/en/elasticsearch/reference/current/secure-cluster.html
@@ -12,8 +15,6 @@ mapped_urls:
1215
- https://www.elastic.co/guide/en/cloud/current/ec-faq-technical.html
1316
---
1417

15-
# Security
16-
1718
% SR: include this info somewhere in this section
1819
% {{ech}} doesn't support custom SSL certificates, which means that a custom CNAME for an {{ech}} endpoint such as *mycluster.mycompanyname.com* also is not supported.
1920
%
@@ -22,7 +23,7 @@ mapped_urls:
2223
% encryption at rest (EAR) is enabled in {{ech}} by default. We support EAR for both the data stored in your clusters and the snapshots we take for backup, on all cloud platforms and across all regions.
2324
% You can also bring your own key (BYOK) to encrypt your Elastic Cloud deployment data and snapshots. For more information, check [Encrypt your deployment with a customer-managed encryption key](../../../deploy-manage/security/encrypt-deployment-with-customer-managed-encryption-key.md).
2425

25-
Note that the encryption happens at the file system level.
26+
% Note that the encryption happens at the file system level.
2627

2728
% What needs to be done: Refine
2829

@@ -54,15 +55,122 @@ $$$preserving-data-integrity$$$
5455

5556
$$$maintaining-audit-trail$$$
5657

57-
**This page is a work in progress.** The documentation team is working to combine content pulled from the following pages:
58-
59-
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/security-files.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/security-files.md)
60-
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/secure-cluster.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/secure-cluster.md)
61-
* [/raw-migrated-files/kibana/kibana/xpack-security.md](/raw-migrated-files/kibana/kibana/xpack-security.md)
62-
* [/raw-migrated-files/cloud-on-k8s/cloud-on-k8s/k8s-securing-stack.md](/raw-migrated-files/cloud-on-k8s/cloud-on-k8s/k8s-securing-stack.md)
63-
* [/raw-migrated-files/cloud/cloud-enterprise/ece-securing-ece.md](/raw-migrated-files/cloud/cloud-enterprise/ece-securing-ece.md)
64-
* [/raw-migrated-files/cloud/cloud-heroku/ech-security.md](/raw-migrated-files/cloud/cloud-heroku/ech-security.md)
65-
* [/raw-migrated-files/kibana/kibana/using-kibana-with-security.md](/raw-migrated-files/kibana/kibana/using-kibana-with-security.md)
66-
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/security-limitations.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/security-limitations.md)
67-
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/es-security-principles.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/es-security-principles.md)
68-
* [/raw-migrated-files/cloud/cloud/ec-faq-technical.md](/raw-migrated-files/cloud/cloud/ec-faq-technical.md)
58+
:::{warning}
59+
**This page is a work in progress.**
60+
:::
61+
62+
63+
% The documentation team is working to combine content pulled from the following pages:
64+
65+
% * [/raw-migrated-files/elasticsearch/elasticsearch-reference/security-files.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/security-files.md)
66+
% * [/raw-migrated-files/elasticsearch/elasticsearch-reference/secure-cluster.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/secure-cluster.md)
67+
% * [/raw-migrated-files/kibana/kibana/xpack-security.md](/raw-migrated-files/kibana/kibana/xpack-security.md)
68+
% * [/raw-migrated-files/cloud-on-k8s/cloud-on-k8s/k8s-securing-stack.md](/raw-migrated-files/cloud-on-k8s/cloud-on-k8s/k8s-securing-stack.md)
69+
% * [/raw-migrated-files/cloud/cloud-enterprise/ece-securing-ece.md](/raw-migrated-files/cloud/cloud-enterprise/ece-securing-ece.md)
70+
% * [/raw-migrated-files/cloud/cloud-heroku/ech-security.md](/raw-migrated-files/cloud/cloud-heroku/ech-security.md)
71+
% * [/raw-migrated-files/kibana/kibana/using-kibana-with-security.md](/raw-migrated-files/kibana/kibana/using-kibana-with-security.md)
72+
% * [/raw-migrated-files/elasticsearch/elasticsearch-reference/security-limitations.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/security-limitations.md)
73+
% * [/raw-migrated-files/elasticsearch/elasticsearch-reference/es-security-principles.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/es-security-principles.md)
74+
% * [/raw-migrated-files/cloud/cloud/ec-faq-technical.md](/raw-migrated-files/cloud/cloud/ec-faq-technical.md)
75+
76+
# Security
77+
78+
This section covers how to secure your Elastic environment. Learn how to implement TLS encryption, network security controls, and data protection measures.
79+
80+
## Security overview
81+
82+
An Elastic implementation comprises many moving parts: {es} nodes forming the cluster, {kib} instances, additional stack components such as Logstash and Beats, and various clients and integrations communicating with your deployment.
83+
84+
To keep your data secured, Elastic offers comprehensive security features that:
85+
- Prevent unauthorized access to your deployment
86+
- Encrypt communications between components
87+
- Protect data at rest
88+
- Secure sensitive settings and saved objects
89+
90+
Security requirements and capabilities vary by deployment. Features may be managed automatically by Elastic, require configuration, or must be fully self-managed. Refer to [Security by deployment type](#security-by-deployment-type) for details.
91+
92+
::::{tip}
93+
See the [Deployment overview](/deploy-manage/deploy.md) to understand your options for deploying Elastic.
94+
::::
95+
96+
### Security by deployment type
97+
98+
Security features have one of these statuses across deployment types:
99+
100+
| Status | Description |
101+
|--------|-------------|
102+
| **Managed** | Handled automatically by Elastic with no user configuration needed |
103+
| **Configurable** | Built-in feature that needs your configuration (like IP filters or passwords) |
104+
| **Self-managed** | Infrastructure-level security you implement and maintain |
105+
| **N/A** | Not available for this deployment type |
106+
107+
#### Communication security
108+
109+
| **Security feature** | Serverless | Elastic Cloud Hosted | ECE | ECK | Self-managed |
110+
|------------------|------------|--------------|-----|-----|--------------|
111+
| **TLS (HTTP Layer)** | Managed | Managed | Configurable | Configurable | Self-managed |
112+
| **TLS (Transport Layer)** | Managed | Managed | Managed | Managed | Self-managed |
113+
114+
#### Network security
115+
116+
| **Security feature** | Serverless | Elastic Cloud Hosted | ECE | ECK | Self-managed |
117+
|------------------|------------|--------------|-----|-----|--------------|
118+
| **IP traffic filtering** | Configurable | Configurable | Configurable | Configurable | Configurable |
119+
| **Private link** | N/A | Configurable | N/A | N/A | N/A |
120+
| **Static IPs** | Configurable | Configurable | N/A | N/A | N/A |
121+
122+
#### Data security
123+
124+
| **Security feature** | Serverless | Elastic Cloud Hosted | ECE | ECK | Self-managed |
125+
|------------------|------------|--------------|-----|-----|--------------|
126+
| **Encryption at rest** | Managed | Managed | Self-managed | Self-managed | Self-managed |
127+
| **Bring your own encryption key** | N/A | Configurable | N/A | N/A | N/A |
128+
| **Keystore security** | Managed | Managed | Configurable | Configurable | Configurable |
129+
| **Saved object encryption** | Managed | Managed | Configurable | Configurable | Configurable |
130+
131+
#### User session security
132+
133+
| **Security feature** | Serverless | Elastic Cloud Hosted | ECE | ECK | Self-managed |
134+
|------------------|------------|--------------|-----|-----|--------------|
135+
| **Kibana Sessions** | Managed | Configurable | Configurable | Configurable | Configurable |
136+
137+
### Using this documentation
138+
139+
Throughout this security documentation, you'll see deployment type indicators that show which content applies to specific deployment types. Each section clearly identifies which deployment types it applies to, and deployment-specific details are separated within each topic.
140+
141+
To get the most relevant information for your environment, focus on sections tagged with your deployment type and look for subsections specifically addressing your deployment model.
142+
143+
## Security topics
144+
145+
This security documentation is organized into four main areas:
146+
147+
% TODO: Add links to the sections below
148+
149+
### 1. Secure your hosting environment
150+
151+
The security of your hosting environment forms the foundation of your overall security posture. This section covers environment-specific security controls:
152+
153+
- **Elastic Cloud Hosted and Serverless**: Organization-level SSO, role-based access control, and cloud API keys
154+
- **Elastic Cloud Enterprise**: TLS certificates, role-based access control, and cloud API keys
155+
- **Self-managed environments**: TLS certificates, HTTPS configuration
156+
157+
### 2. Secure your deployments and clusters
158+
159+
Protect your deployments with features available across all deployment types:
160+
161+
- **Authentication and access controls**: User management, API keys, authentication protocols, and traffic filtering
162+
- **Data protection**: Encryption, sensitive settings, and document-level security
163+
- **Monitoring and compliance**: Audit logging and security best practices
164+
165+
### 3. Secure your user accounts
166+
167+
Individual user security helps prevent unauthorized access:
168+
169+
- **Multi-factor authentication**: Add an extra layer of security to your login process
170+
171+
### 4. Secure your clients and integrations
172+
173+
Ensure secure communication between your applications and Elastic:
174+
175+
- **Client security**: Best practices for securely connecting applications to {es}
176+
- **Integration security**: Secure configuration for Beats, Logstash, and other integrations
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Secure your data
2+
3+
:::{warning}
4+
**This page is a work in progress.**
5+
:::

deploy-manage/security/fips-140-2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ mapped_urls:
44
- https://www.elastic.co/guide/en/kibana/current/xpack-security-fips-140-2.html
55
---
66

7-
# FIPS 140-2
7+
# FIPS 140-2 compliance
88

99
% What needs to be done: Refine
1010

0 commit comments

Comments
 (0)