Skip to content

Commit c8eacd1

Browse files
authored
Merge branch 'main' into AI-Assistant-9.0-updates
2 parents f10dea0 + 20595c1 commit c8eacd1

File tree

4,794 files changed

+10743
-23436
lines changed

Some content is hidden

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

4,794 files changed

+10743
-23436
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: "Docs issue"
2+
description: Report documentation issues such as inaccuracies, broken links, typos, or missing information.
3+
title: "[Issue]: "
4+
labels: ["triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Hi 👋. Thanks for taking the time to fill out this issue report!
10+
This form will create an issue that Elastic's docs team will triage and prioritize.
11+
You can also open a PR instead.
12+
- type: dropdown
13+
attributes:
14+
label: Type of issue
15+
description: What type of issue are you reporting?
16+
multiple: false
17+
options:
18+
- Inaccurate
19+
- Missing information
20+
- I can't find what I'm looking for
21+
- Other
22+
- type: input
23+
id: link
24+
attributes:
25+
label: What documentation page is affected
26+
description: Include a link to the page where you're seeing the problem.
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: related
31+
attributes:
32+
label: What happened?
33+
description: Describe the issue you're experiencing. Screenshots are valuable too!
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: moreinfo
38+
attributes:
39+
label: Additional info
40+
description: Anything else we should know?
41+
validations:
42+
required: false

deploy-manage/_snippets/field-doc-sec-limitations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ When a user’s role enables [document level security](/deploy-manage/users-role
66

77
* Document level security doesn’t affect global index statistics that relevancy scoring uses. This means that scores are computed without taking the role query into account. Documents that don’t match the role query are never returned.
88
* The `has_child` and `has_parent` queries aren’t supported as query parameters in the role definition. The `has_child` and `has_parent` queries can be used in the search API with document level security enabled.
9-
* [Date math](elasticsearch://reference/elasticsearch/rest-apis/common-options.md#date-math) expressions cannot contain `now` in [range queries with date fields](elasticsearch://reference/query-languages/query-dsl-range-query.md#ranges-on-dates).
9+
* [Date math](elasticsearch://reference/elasticsearch/rest-apis/common-options.md#date-math) expressions cannot contain `now` in [range queries with date fields](elasticsearch://reference/query-languages/query-dsl/query-dsl-range-query.md#ranges-on-dates).
1010
* Any query that makes remote calls to fetch query data isn’t supported, including the following queries:
1111

1212
* `terms` query with terms lookup
@@ -16,7 +16,7 @@ When a user’s role enables [document level security](/deploy-manage/users-role
1616
* If suggesters are specified and document level security is enabled, the specified suggesters are ignored.
1717
* A search request cannot be profiled if document level security is enabled.
1818
* The [terms enum API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-terms-enum) does not return terms if document level security is enabled.
19-
* The [`multi_match`](elasticsearch://reference/query-languages/query-dsl-multi-match-query.md) query does not support specifying fields using wildcards.
19+
* The [`multi_match`](elasticsearch://reference/query-languages/query-dsl/query-dsl-multi-match-query.md) query does not support specifying fields using wildcards.
2020

2121
:::{note}
2222
While document-level security prevents users from viewing restricted documents, it’s still possible to write search requests that return aggregate information about the entire index. A user whose access is restricted to specific documents in an index could still learn about field names and terms that only exist in inaccessible documents, and count how many inaccessible documents contain a given term.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Several types of {{es}} API keys exist:
1515

1616
To manage API keys in {{kib}}, 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).
1717

18-
![API Keys UI](../../images/kibana-api-keys.png "")
18+
![API Keys UI](/deploy-manage/images/kibana-api-keys.png "")
1919

2020

2121
## Security privileges [api-keys-security-privileges]
@@ -33,7 +33,7 @@ To manage roles, go to the **Roles** management page using the navigation menu o
3333

3434
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**.
3535

36-
![Create API Key UI](../../images/kibana-create-ccr-api-key.png "")
36+
![Create API Key UI](/deploy-manage/images/kibana-create-ccr-api-key.png "")
3737

3838
Refer to the [Create API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) documentation to learn more about creating user API keys.
3939

deploy-manage/api-keys/serverless-project-api-keys.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In serverless projects, the following types of API keys exist:
1414

1515
You can manage your keys in **{{project-settings}} → {{manage-app}} → {{api-keys-app}}**:
1616

17-
:::{image} ../../images/serverless-api-key-management.png
17+
:::{image} /deploy-manage/images/serverless-api-key-management.png
1818
:alt: API keys UI
1919
:screenshot:
2020
:::
@@ -24,7 +24,7 @@ You can manage your keys in **{{project-settings}} → {{manage-app}} → {{api-
2424

2525
In **{{api-keys-app}}**, click **Create API key**:
2626

27-
:::{image} ../../images/serverless-create-personal-api-key.png
27+
:::{image} /deploy-manage/images/serverless-create-personal-api-key.png
2828
:alt: Create API key UI
2929
:screenshot:
3030
:width: 50%

deploy-manage/autoscaling/autoscaling-deciders.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ applies_to:
1818

1919
[Autoscaling](/deploy-manage/autoscaling.md) in Elasticsearch enables dynamic resource allocation based on predefined policies. A key component of this mechanism is autoscaling deciders, which independently assess resource requirements and determine when scaling actions are necessary. Deciders analyze various factors, such as storage usage, indexing rates, and machine learning workloads, to ensure clusters maintain optimal performance without manual intervention.
2020

21-
::::{admonition} Indirect use only
21+
::::{admonition} Indirect use only
2222
This feature is designed for indirect use by {{ech}}, {{ece}}, and {{eck}}. Direct use is not supported.
2323
::::
2424

@@ -49,7 +49,7 @@ The [autoscaling](../../deploy-manage/autoscaling.md) reactive storage decider (
4949

5050
The reactive storage decider is enabled for all policies governing data nodes and has no configuration options.
5151

52-
The decider relies partially on using [data tier preference](../../manage-data/lifecycle/data-tiers.md#data-tier-allocation) allocation rather than node attributes. In particular, scaling a data tier into existence (starting the first node in a tier) will result in starting a node in any data tier that is empty if not using allocation based on data tier preference. Using the [ILM migrate](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/index-lifecycle-actions/ilm-migrate.md) action to migrate between tiers is the preferred way of allocating to tiers and fully supports scaling a tier into existence.
52+
The decider relies partially on using [data tier preference](../../manage-data/lifecycle/data-tiers.md#data-tier-allocation) allocation rather than node attributes. In particular, scaling a data tier into existence (starting the first node in a tier) will result in starting a node in any data tier that is empty if not using allocation based on data tier preference. Using the [ILM migrate](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-migrate.md) action to migrate between tiers is the preferred way of allocating to tiers and fully supports scaling a tier into existence.
5353

5454
## Proactive storage decider [autoscaling-proactive-storage-decider]
5555

@@ -62,7 +62,7 @@ The estimation of expected additional data is based on past indexing that occurr
6262
### Configuration settings [autoscaling-proactive-storage-decider-settings]
6363

6464
`forecast_window`
65-
: (Optional, [time value](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/rest-apis/api-conventions.md#time-units)) The window of time to use for forecasting. Defaults to 30 minutes.
65+
: (Optional, [time value](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#time-units)) The window of time to use for forecasting. Defaults to 30 minutes.
6666

6767

6868
### {{api-examples-title}} [autoscaling-proactive-storage-decider-examples]
@@ -96,7 +96,7 @@ The [autoscaling](../../deploy-manage/autoscaling.md) frozen shards decider (`fr
9696
### Configuration settings [autoscaling-frozen-shards-decider-settings]
9797

9898
`memory_per_shard`
99-
: (Optional, [byte value](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/rest-apis/api-conventions.md#byte-units)) The memory needed per shard, in bytes. Defaults to 2000 shards per 64 GB node (roughly 32 MB per shard). Notice that this is total memory, not heap, assuming that the Elasticsearch default heap sizing mechanism is used and that nodes are not bigger than 64 GB.
99+
: (Optional, [byte value](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#byte-units)) The memory needed per shard, in bytes. Defaults to 2000 shards per 64 GB node (roughly 32 MB per shard). Notice that this is total memory, not heap, assuming that the Elasticsearch default heap sizing mechanism is used and that nodes are not bigger than 64 GB.
100100

101101
## Frozen storage decider [autoscaling-frozen-storage-decider]
102102

@@ -121,8 +121,8 @@ The [autoscaling](../../deploy-manage/autoscaling.md) {{ml}} decider (`ml`) calc
121121

122122
The {{ml}} decider is enabled for policies governing `ml` nodes.
123123

124-
::::{note}
125-
For {{ml}} jobs to open when the cluster is not appropriately scaled, set `xpack.ml.max_lazy_ml_nodes` to the largest number of possible {{ml}} nodes (refer to [Advanced machine learning settings](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/machine-learning-settings.md#advanced-ml-settings) for more information). In {{ess}}, this is automatically set.
124+
::::{note}
125+
For {{ml}} jobs to open when the cluster is not appropriately scaled, set `xpack.ml.max_lazy_ml_nodes` to the largest number of possible {{ml}} nodes (refer to [Advanced machine learning settings](elasticsearch://reference/elasticsearch/configuration-reference/machine-learning-settings.md#advanced-ml-settings) for more information). In {{ech}}, this is automatically set.
126126
::::
127127

128128

@@ -137,7 +137,7 @@ Both `num_anomaly_jobs_in_queue` and `num_analytics_jobs_in_queue` are designed
137137
: (Optional, integer) Specifies the number of queued {{dfanalytics-jobs}} to allow. Defaults to `0`.
138138

139139
`down_scale_delay`
140-
: (Optional, [time value](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/rest-apis/api-conventions.md#time-units)) Specifies the time to delay before scaling down. Defaults to 1 hour. If a scale down is possible for the entire time window, then a scale down is requested. If the cluster requires a scale up during the window, the window is reset.
140+
: (Optional, [time value](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#time-units)) Specifies the time to delay before scaling down. Defaults to 1 hour. If a scale down is possible for the entire time window, then a scale down is requested. If the cluster requires a scale up during the window, the window is reset.
141141

142142

143143
### {{api-examples-title}} [autoscaling-machine-learning-decider-examples]
@@ -168,12 +168,12 @@ The API returns the following result:
168168

169169
## Fixed decider [autoscaling-fixed-decider]
170170

171-
::::{warning}
171+
::::{warning}
172172
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
173173
::::
174174

175175

176-
::::{warning}
176+
::::{warning}
177177
The fixed decider is intended for testing only. Do not use this decider in production.
178178
::::
179179

@@ -183,10 +183,10 @@ The [autoscaling](../../deploy-manage/autoscaling.md) `fixed` decider responds w
183183
### Configuration settings [_configuration_settings]
184184

185185
`storage`
186-
: (Optional, [byte value](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/rest-apis/api-conventions.md#byte-units)) Required amount of node-level storage. Defaults to `-1` (disabled).
186+
: (Optional, [byte value](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#byte-units)) Required amount of node-level storage. Defaults to `-1` (disabled).
187187

188188
`memory`
189-
: (Optional, [byte value](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/rest-apis/api-conventions.md#byte-units)) Required amount of node-level memory. Defaults to `-1` (disabled).
189+
: (Optional, [byte value](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#byte-units)) Required amount of node-level memory. Defaults to `-1` (disabled).
190190

191191
`processors`
192192
: (Optional, float) Required number of processors. Defaults to disabled.

deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ To help you better understand the available autoscaling settings, this example d
163163

164164
The fault tolerance for the data tier is set to 2 availability zones.
165165

166-
:::{image} ../../images/cloud-enterprise-ec-ce-autoscaling-data-summary2.png
166+
:::{image} /deploy-manage/images/cloud-enterprise-ec-ce-autoscaling-data-summary2.png
167167
:alt: A screenshot showing sizing information for the autoscaled data tier
168168
:::
169169

@@ -181,7 +181,7 @@ To help you better understand the available autoscaling settings, this example d
181181

182182
The fault tolerance for the machine learning instance is set to 1 availability zone.
183183

184-
:::{image} ../../images/cloud-enterprise-ec-ce-autoscaling-ml-summary2.png
184+
:::{image} /deploy-manage/images/cloud-enterprise-ec-ce-autoscaling-ml-summary2.png
185185
:alt: A screenshot showing sizing information for the autoscaled machine learning node
186186
:::
187187

@@ -220,9 +220,8 @@ Note the following requirements when you run this API request:
220220

221221
$$$ece-autoscaling-api-example-requirements-table$$$
222222

223-
| | | | |
224-
| --- | --- | --- | --- |
225223
| | `size` | `autoscaling_min` | `autoscaling_max` |
224+
| --- | --- | --- | --- |
226225
| data tier ||||
227226
| machine learning node ||||
228227
| coordinating and master nodes ||||

deploy-manage/autoscaling/trained-model-autoscaling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ You can choose from three levels of resource usage for your trained model deploy
7070

7171
Refer to the tables in the [Model deployment resource matrix](#model-deployment-resource-matrix) section to find out the setings for the level you selected.
7272

73-
:::{image} ../../images/machine-learning-ml-nlp-deployment-id-elser-v2.png
73+
:::{image} /deploy-manage/images/machine-learning-ml-nlp-deployment-id-elser-v2.png
7474
:alt: ELSER deployment with adaptive resources enabled.
7575
:screenshot:
7676
:width: 500px

deploy-manage/cloud-organization/billing/billing-faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ $$$faq-cost$$$Is there a way for me to estimate how much {{ecloud}} will cost?
5454
$$$faq-consumption$$$Where can I find a detailed view of my consumption?
5555
: To make it easy to track the ongoing cost of {{ecloud}}, we’ve added line items to the downloadable [invoices](https://cloud.elastic.co/billing/overview?page=docs&placement=docs-body).
5656

57-
![Example invoice](../../../images/cloud-ec-bill-example-new.png)
57+
![Example invoice](/deploy-manage/images/cloud-ec-bill-example-new.png)
5858

5959
Additionally, on the {{ecloud}} [Usage](https://cloud.elastic.co/billing/usage?page=docs&placement=docs-body) page, the **Month-to-date usage** tile shows accrued costs and can help you to better estimate the next charge amount.
6060

deploy-manage/cloud-organization/billing/cloud-hosted-deployment-billing-dimensions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Data transfer out of deployments and between nodes of the cluster is hard to con
6060

6161
The largest contributor to inter-node data transfer is usually shard movement between nodes in a cluster. The only way to prevent shard movement is by having a single node in a single availability zone. This solution is only possible for clusters up to 64GB RAM and is not recommended as it creates a risk of data loss. [Oversharding](/deploy-manage/production-guidance/optimize-performance/size-shards.md) can cause excessive shard movement. Avoiding oversharding can also help control costs and improve performance. Note that creating snapshots generates inter-node data transfer. The *storage* cost of snapshots is detailed later in this document.
6262

63-
The exact root cause of unusual data transfer is not always something we can identify as it can have many causes, some of which are out of our control and not associated with Cloud configuration changes. It may help to [enable monitoring](../../monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) and examine index and shard activity on your cluster.
63+
The exact root cause of unusual data transfer is not always something we can identify as it can have many causes, some of which are out of our control and not associated with Cloud configuration changes. It may help to [enable monitoring](../../monitor/stack-monitoring/ece-ech-stack-monitoring.md) and examine index and shard activity on your cluster.
6464

6565

6666
## Storage [storage]

deploy-manage/cloud-organization/billing/manage-subscription.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ mapped_urls:
44
- https://www.elastic.co/guide/en/cloud/current/ec-subscription-overview.html
55
- https://www.elastic.co/guide/en/cloud/current/ec-select-subscription-level.html
66
- https://www.elastic.co/guide/en/cloud/current/ec-licensing.html
7+
- https://www.elastic.co/guide/en/cloud-heroku/current/ech-licensing.html
78
applies_to:
89
deployment:
910
ess: all

0 commit comments

Comments
 (0)