Skip to content

Commit e5d8774

Browse files
authored
Merge branch 'main' into leemthompo/new-branch
2 parents 0c46bf1 + 88f2959 commit e5d8774

File tree

568 files changed

+2334
-1995
lines changed

Some content is hidden

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

568 files changed

+2334
-1995
lines changed

.github/workflows/docs-build.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on:
44
push:
55
branches:
66
- main
7-
pull_request: ~
7+
pull_request_target: ~
88

99
jobs:
1010
preview:
@@ -13,5 +13,7 @@ jobs:
1313
continue-on-error: false
1414
strict: false
1515
permissions:
16+
deployments: write
17+
id-token: write
1618
contents: read
1719
pull-requests: read

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Elastic Docs Content
22

3-
![GitHub deployments](https://img.shields.io/github/deployments/elastic/docs-content/docs-preview)
3+
![GitHub deployments](https://img.shields.io/github/deployments/elastic/docs-content/docs-preview?logo=elastic&label=docs-preview&link=https%3A%2F%2Fdocs-v3-preview.elastic.dev%2Felastic%2Fdocs-content%2Ftree%2Fmain)
44

55
This repo contains source files for Elastic documentation.
66

deploy-manage/api-keys/elasticsearch-api-keys.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You can use {{kib}} to manage your different API keys:
1515
* Cross-cluster API key: allows other clusters to connect to this cluster.
1616
* Managed API key: created and managed by Kibana to run background tasks.
1717

18-
To manage API keys, go to the **API Keys** management page using the navigation menu or the [global search field](../../get-started/the-stack.md#kibana-navigation-search).
18+
To manage API keys, go to the **API Keys** management page using the navigation menu or the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md).
1919

2020
![API Keys UI](../../images/kibana-api-keys.png "")
2121

@@ -28,12 +28,12 @@ To manage API keys, go to the **API Keys** management page using the navigation
2828
* To create or update a **cross-cluster API key**, you must have the `manage_security` privilege and an Enterprise license.
2929
* To have a read-only view on the API keys, you must have access to the page and the `read_security` cluster privilege.
3030

31-
To manage roles, go to the **Roles** management page using the navigation menu or the [global search field](../../get-started/the-stack.md#kibana-navigation-search), or use the [role APIs](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-roles).
31+
To manage roles, go to the **Roles** management page using the navigation menu or the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md), or use the [role APIs](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-roles).
3232

3333

3434
## Create an API key [create-api-key]
3535

36-
To create an API key, go to the **API Keys** management page using the navigation menu or the [global search field](../../get-started/the-stack.md#kibana-navigation-search), and select **Create API key**.
36+
To create an API key, go to the **API Keys** management page using the navigation menu or the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md), and select **Create API key**.
3737

3838
![Create API Key UI](../../images/kibana-create-ccr-api-key.png "")
3939

@@ -44,7 +44,7 @@ Refer to the [create cross-cluster API key](https://www.elastic.co/guide/en/elas
4444

4545
## Update an API key [udpate-api-key]
4646

47-
To update an API key, go to the **API Keys** management page using the navigation menu or the [global search field](../../get-started/the-stack.md#kibana-navigation-search), and then click on the name of the key. You cannot update the name or the type of API key.
47+
To update an API key, go to the **API Keys** management page using the navigation menu or the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md), and then click on the name of the key. You cannot update the name or the type of API key.
4848

4949
Refer to the [update API key](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html) documentation to learn more about updating user API keys.
5050

deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Once you are on the **Create deployment** page, you can create the deployment wi
4848
::::
4949

5050
3. Select **Create deployment**. It takes a few minutes before your deployment gets created. While waiting, you are prompted to save the admin credentials for your deployment which provides you with superuser access to Elasticsearch. Keep these credentials safe as they are shown only once. These credentials also help you [add data using Kibana](../../../manage-data/ingest.md). If you need to refresh these credentials, you can [reset the password](../../users-roles/cluster-or-deployment-auth/built-in-users.md).
51-
4. Once the deployment is ready, select **Continue** to open the deployment’s main page. From here, you can start [ingesting data](../../../manage-data/ingest.md) or simply [try a sample data](../../../explore-analyze/overview/kibana-quickstart.md#gs-get-data-into-kibana) set to get started.
51+
4. Once the deployment is ready, select **Continue** to open the deployment’s main page. From here, you can start [ingesting data](../../../manage-data/ingest.md) or simply [try a sample data](../../../explore-analyze/index.md#gs-get-data-into-kibana) set to get started.
5252

5353
At any time, you can manage and [adjust the configuration](configure.md) of your deployment to your needs, add extra layers of [security](../../users-roles/cluster-or-deployment-auth.md), or (highly recommended) set up [health monitoring](../../monitor/stack-monitoring.md).
5454

deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@ Watcher encryption Key Setup is not supported.
7575

7676
Changing the default throttle period is not possible. You can specify a throttle period per watch, however.
7777

78-
Watcher comes preconfigured with a directly usable email account provided by Elastic. However, this account can’t be reconfigured and is subject to some limitations. For more information on the limits of the Elastic mail server, check the [cloud email service limits](../../../explore-analyze/alerts-cases/watcher.md#ec-cloud-email-service-limits)
78+
Watcher comes preconfigured with a directly usable email account provided by Elastic. However, this account can’t be reconfigured and is subject to some limitations. For more information on the limits of the Elastic mail server, check the [cloud email service limits](../../../explore-analyze/alerts-cases/watcher/enable-watcher.md#cloud-email-service-limits)
7979

80-
Alternatively, a custom mail server can be configured as described in [Configuring a custom mail server](../../../explore-analyze/alerts-cases/watcher.md#ec-watcher-custom-mail-server)
80+
Alternatively, a custom mail server can be configured as described in [Configuring a custom mail server](../../../explore-analyze/alerts-cases/watcher/enable-watcher.md#watcher-custom-mail-server)
8181

8282

8383
## Private Link and SSO to Kibana URLs [ec-restrictions-traffic-filters-kibana-sso]

deploy-manage/license/manage-your-license-in-self-managed-cluster.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ By default, new installations have a Basic license that never expires. For the f
99

1010
To explore all of the available solutions and features, start a 30-day free trial. You can activate a trial subscription once per major product version. If you need more than 30 days to complete your evaluation, request an extended trial at {{extendtrial}}.
1111

12-
To view the status of your license, start a trial, or install a new license, go to the **License Management** page using the navigation menu or the [global search field](../../get-started/the-stack.md#kibana-navigation-search).
12+
To view the status of your license, start a trial, or install a new license, go to the **License Management** page using the navigation menu or the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md).
1313

1414

1515
## Required permissions [_required_permissions_3]
1616

1717
The `manage` cluster privilege is required to access **License Management**.
1818

19-
To add the privilege, go to the **Roles** management page using the navigation menu or the [global search field](../../get-started/the-stack.md#kibana-navigation-search).
19+
To add the privilege, go to the **Roles** management page using the navigation menu or the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md).
2020

2121

2222
## License expiration [license-expiration]

deploy-manage/monitor/stack-monitoring/kibana-monitoring-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ If you use a separate monitoring cluster to store the monitoring data, it is str
5959

6060
If the Elastic {{security-features}} are enabled, log in.
6161

62-
7. Go to the **Stack Monitoring** page using the [global search field](../../../get-started/the-stack.md#kibana-navigation-search).
62+
7. Go to the **Stack Monitoring** page using the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
6363

6464
If data collection is disabled, you are prompted to turn on data collection. If {{es}} {security-features} are enabled, you must have `manage` cluster privileges to turn on data collection.
6565

deploy-manage/monitor/stack-monitoring/kibana-monitoring-legacy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ To learn about monitoring in general, see [Monitor a cluster](../../monitor.md).
4242

4343
If {{security-features}} are enabled, log in.
4444

45-
2. Go to the **Stack Monitoring** page using the [global search field](../../../get-started/the-stack.md#kibana-navigation-search). If data collection is disabled, you are prompted to turn it on.
45+
2. Go to the **Stack Monitoring** page using the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). If data collection is disabled, you are prompted to turn it on.
4646

4747
* From the Console or command line, set `xpack.monitoring.collection.enabled` to `true` on the production cluster.<br>
4848

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/reference-architectures/current/reference-architectures-overview.html
4+
applies:
5+
stack: all
6+
hosted: all
7+
ece: all
8+
eck: all
49
---
510

611
# Reference architectures [reference-architectures-overview]
@@ -9,19 +14,20 @@ Elasticsearch reference architectures are blueprints for deploying Elasticsearch
914

1015
These architectures are designed by architects and engineers to provide standardized, proven solutions that help you to follow best practices when deploying {{es}}.
1116

12-
::::{tip}
13-
These architectures are specific to running your deployment on-premises or on cloud. If you are using Elastic serverless your {{es}} clusters are autoscaled and fully managed by Elastic. For all the deployment options, refer to [Run Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-deploy.html).
17+
::::{tip}
18+
These architectures are specific to deploying Elastic on {{ech}}, {{eck}}, {{ece}}, or deploying a self-managed instance. If you are using {{serverless-full}}, your {{es}} clusters are autoscaled and fully managed by Elastic. To learn about all of the deployment options, refer to the [Deploy and manage overview](/deploy-manage/index.md).
1419
::::
1520

1621

17-
These reference architectures are recommendations and should be adapted to fit your specific environment and needs. Each solution can vary based on the unique requirements and conditions of your deployment. In these architectures we discuss about how to deploy cluster components. For information about designing ingest architectures to feed content into your cluster, refer to [Ingest architectures](https://www.elastic.co/guide/en/ingest/current/use-case-arch.html)
22+
These reference architectures are recommendations and should be adapted to fit your specific environment and needs. Each solution can vary based on the unique requirements and conditions of your deployment. In these architectures we discuss about how to deploy cluster components. For information about designing ingest architectures to feed content into your cluster, refer to [Ingest architectures](../manage-data/ingest/ingest-reference-architectures/use-case-arch.md)
1823

19-
20-
## Architectures [reference-architectures-time-series-2]
24+
## Architectures [reference-architectures-time-series]
2125

2226
| | |
2327
| --- | --- |
2428
| **Architecture** | **When to use** |
25-
| [*Hot/Frozen - High Availability*](https://www.elastic.co/guide/en/reference-architectures/current/hot-frozen-architecture.html)<br>A high availability architecture that is cost optimized for large time-series datasets. | * Have a requirement for cost effective long term data storage (many months or years).<br>* Provide insights and alerts using logs, metrics, traces, or various event types to ensure optimal performance and quick issue resolution for applications.<br>* Apply Machine Learning and Search AI to assist in dealing with the large amount of data.<br>* Deploy an architecture model that allows for maximum flexibility between storage cost and performance.<br> |
29+
| [*Hot/Frozen - High Availability*](/deploy-manage/reference-architectures/hotfrozen-high-availability.md)<br>A high availability architecture that is cost optimized for large time-series datasets. | * Have a requirement for cost effective long term data storage (many months or years).<br>* Provide insights and alerts using logs, metrics, traces, or various event types to ensure optimal performance and quick issue resolution for applications.<br>* Apply Machine Learning and Search AI to assist in dealing with the large amount of data.<br>* Deploy an architecture model that allows for maximum flexibility between storage cost and performance.<br> |
2630
| Additional architectures are on the way.<br>Stay tuned for updates. | |
2731

32+
33+

deploy-manage/reference-architectures/hotfrozen-high-availability.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/reference-architectures/current/hot-frozen-architecture.html
4+
applies:
5+
stack: all
6+
hosted: all
7+
ece: all
8+
eck: all
49
---
510

611
# Hot/Frozen - High Availability [hot-frozen-architecture]
@@ -50,15 +55,15 @@ Machine learning nodes are optional but highly recommended for large scale time
5055

5156
## Recommended hardware specifications [hot-frozen-hardware]
5257

53-
With {{ecloud}} you can deploy clusters in AWS, Azure, and Google Cloud. Available hardware types and configurations vary across all three cloud providers but each provides instance types that meet our recommendations for the node types used in this architecture. For more details on these instance types, see our documentation on {{ecloud}} hardware for [AWS](https://www.elastic.co/guide/en/cloud/current/ec-default-aws-configurations.html), [Azure](https://www.elastic.co/guide/en/cloud/current/ec-default-azure-configurations.html), and [GCP](https://www.elastic.co/guide/en/cloud/current/ec-default-gcp-configurations.html). The **Physical** column below is guidance, based on the cloud node types, when self-deploying {{es}} in your own data center.
58+
With {{ech}}, you can deploy clusters in AWS, Azure, and Google Cloud. Available hardware types and configurations vary across all three cloud providers but each provides instance types that meet our recommendations for the node types used in this architecture. For more details on these instance types, see our documentation on {{ech}} hardware for [AWS](https://www.elastic.co/guide/en/cloud/current/ec-default-aws-configurations.html), [Azure](https://www.elastic.co/guide/en/cloud/current/ec-default-azure-configurations.html), and [GCP](https://www.elastic.co/guide/en/cloud/current/ec-default-gcp-configurations.html). The **Physical** column below is guidance, based on the cloud node types, when self-deploying {{es}} in your own data center.
5459

55-
In the links provided above, Elastic has performance tested hardware for each of the cloud providers to find the optimal hardware for each node type. We use ratios to represent the best mix of CPU, RAM, and disk for each type. In some cases the CPU to RAM ratio is key, in others the disk to memory ratio and type of disk is critical. Significantly deviating from these ratios may seem like a way to save on hardware costs, but may result in an {{es}} cluster that does not scale and perform well.
60+
In the links provided above, Elastic has performance tested hardware for each of the cloud providers to find the optimal hardware for each node type. We use ratios to represent the best mix of CPU, RAM, and disk for each type. In some cases the CPU to RAM ratio is key, in others the disk to memory ratio and type of disk is critical. Significantly deviating from these ratios may seem like a way to save on hardware costs, but may result in an {{es}} cluster that does not scale and perform well.
5661

5762
This table shows our specific recommendations for nodes in a Hot/Frozen architecture.
5863

5964
| | | | | |
6065
| --- | --- | --- | --- | --- |
61-
| **Type** | **AWS*** | ***Azure*** | ***GCP** | **Physical** |
66+
| **Type** | **AWS** | **Azure** | **GCP** | **Physical** |
6267
| ![Hot data node](../../images/reference-architectures-hot.png "") | c6gd | f32sv2 | N2 | 16-32 vCPU<br>64 GB RAM<br>2-6 TB NVMe SSD |
6368
| ![Frozen data node](../../images/reference-architectures-frozen.png "") | i3en | e8dsv4 | N2 | 8 vCPU<br>64 GB RAM<br>6-20+ TB NVMe SSD<br>Depending on days cached |
6469
| ![Machine learning node](../../images/reference-architectures-machine-learning.png "") | m6gd | f16sv2 | N2 | 16 vCPU<br>64 GB RAM<br>256 GB SSD |
@@ -82,7 +87,7 @@ This table shows our specific recommendations for nodes in a Hot/Frozen architec
8287

8388
**Snapshots:**
8489

85-
* If auditable or business critical events are being logged, a backup is necessary. The choice to back up data will depend on each individual business’s needs and requirements. Refer to our [snapshot repository](https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html) documentation to learn more.
90+
* If auditable or business critical events are being logged, a backup is necessary. The choice to back up data will depend on each individual business’s needs and requirements. Refer to our [snapshot repository](https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html) documentation to learn more.
8691
* To automate snapshots and attach to Index lifecycle management policies, refer to [SLM (Snapshot lifecycle management)](https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html#automate-snapshots-slm).
8792

8893
**Kibana:**

0 commit comments

Comments
 (0)