Skip to content

Commit 4c69746

Browse files
authored
[DOCS] Update tech preview copy (elastic#101606)
Updates the copy for tech preview and experimental features in the Elasticsearch docs. Relates to elastic/docs#2807
1 parent 17389d2 commit 4c69746

21 files changed

+48
-51
lines changed

REST_API_COMPATIBILITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# REST API compatibility developers guide
22

3-
REST API compatibility is intended to minimize the impact for breaking changes applied to the REST API. Compatibility is implemented in a best effort to strike a balance between preserving the REST API contract across major versions while still allowing for breaking changes. URL paths, parameters, HTTP verbs, request bodies and response bodies are all covered by REST API compatibility.
3+
REST API compatibility is intended to minimize the impact for breaking changes applied to the REST API. Compatibility is implemented to strike a balance between preserving the REST API contract across major versions while still allowing for breaking changes. URL paths, parameters, HTTP verbs, request bodies and response bodies are all covered by REST API compatibility.
44

55
### Example use case
66

@@ -10,7 +10,7 @@ For example, assume a REST request requires a consumer to send a "limit" paramet
1010

1111
### Workflow
1212

13-
REST API compatibility is opt-in per request using a specialized value for the `Accept` or `Content-Type` HTTP header. The intent is that this header may be sent prior to a major version upgrade resulting in no differences with the standard header values when the client and server match versions. For example, assume the consumer/client using the REST API for Elasticsearch version 7. If the client sends the specialized header value(s) for compatibility with version 7, then it will have no effect when talking with Elasticsearch version 7. However, once Elasticsearch is upgraded to version 8, and the compatibility with version 7 headers are sent, then Elasticsearch version 8 will do a best effort honor the version 7 REST API contract. This allows Elasticsearch to be upgraded to version 8 while the clients can generally remain on version 7. Since compatibility is best effort, it is not always guaranteed to fix all upgrade issues but should provide an additional level of confidence during/post upgrade.
13+
REST API compatibility is opt-in per request using a specialized value for the `Accept` or `Content-Type` HTTP header. The intent is that this header may be sent prior to a major version upgrade resulting in no differences with the standard header values when the client and server match versions. For example, assume the consumer/client using the REST API for Elasticsearch version 7. If the client sends the specialized header value(s) for compatibility with version 7, then it will have no effect when talking with Elasticsearch version 7. However, once Elasticsearch is upgraded to version 8, and the compatibility with version 7 headers are sent, then Elasticsearch version 8 attempts to honor the version 7 REST API contract. This allows Elasticsearch to be upgraded to version 8 while the clients can generally remain on version 7. It is not always guaranteed to fix all upgrade issues but should provide an additional level of confidence during/post upgrade.
1414

1515
Breaking changes always follow a life-cycle of deprecation (documentation and warnings) in the current version before implementing the breaking change in the next major version. This give users an opportunity to adopt the non-deprecated variants in the current version. It is the still recommended approach to stop the usage of all deprecated functionality prior to a major version upgrade. However, in practice this can be a difficult, error prone, and a time consuming task. So it also recommended that consumers/clients send the specialized header to enable REST API compatibility before an upgrade to help catch any missed usages of deprecated functionality.
1616

docs/reference/data-management.asciidoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ The data you store in {es} generally falls into one of two categories:
99
* Content: a collection of items you want to search, such as a catalog of products
1010
* Time series data: a stream of continuously-generated timestamped data, such as log entries
1111

12-
Content might be frequently updated,
13-
but the value of the content remains relatively constant over time.
14-
You want to be able to retrieve items quickly regardless of how old they are.
15-
16-
Time series data keeps accumulating over time, so you need strategies for
17-
balancing the value of the data against the cost of storing it.
18-
As it ages, it tends to become less important and less-frequently accessed,
19-
so you can move it to less expensive, less performant hardware.
20-
For your oldest data, what matters is that you have access to the data.
12+
Content might be frequently updated,
13+
but the value of the content remains relatively constant over time.
14+
You want to be able to retrieve items quickly regardless of how old they are.
15+
16+
Time series data keeps accumulating over time, so you need strategies for
17+
balancing the value of the data against the cost of storing it.
18+
As it ages, it tends to become less important and less-frequently accessed,
19+
so you can move it to less expensive, less performant hardware.
20+
For your oldest data, what matters is that you have access to the data.
2121
It's ok if queries take longer to complete.
2222

2323
To help you manage your data, {es} offers you:
@@ -26,16 +26,16 @@ To help you manage your data, {es} offers you:
2626
* <<data-stream-lifecycle, Data stream lifecycle>> which is the built-in lifecycle of data streams and addresses the most
2727
common lifecycle management needs.
2828

29-
preview::["The built-in data stream lifecycle is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but this feature is not subject to the support SLA of official GA features."]
29+
preview::["The built-in data stream lifecycle is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but this feature is not subject to the support SLA of official GA features."]
3030

3131
**{ilm-init}** can be used to manage both indices and data streams and it allows you to:
3232

3333
* Define the retention period of your data. The retention period is the minimum time your data will be stored in {es}.
3434
Data older than this period can be deleted by {es}.
3535
* Define <<data-tiers, multiple tiers>> of data nodes with different performance characteristics.
3636
* Automatically transition indices through the data tiers according to your performance needs and retention policies.
37-
* Leverage <<searchable-snapshots, searchable snapshots>> stored in a remote repository to provide resiliency
38-
for your older indices while reducing operating costs and maintaining search performance.
37+
* Leverage <<searchable-snapshots, searchable snapshots>> stored in a remote repository to provide resiliency
38+
for your older indices while reducing operating costs and maintaining search performance.
3939
* Perform <<async-search-intro, asynchronous searches>> of data stored on less-performant hardware.
4040

4141
**Data stream lifecycle** is less feature rich but is focused on simplicity, so it allows you to easily:

docs/reference/ilm/actions/ilm-forcemerge.asciidoc

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,32 @@
44

55
Phases allowed: hot, warm.
66

7-
<<indices-forcemerge,Force merges>> the index into
7+
<<indices-forcemerge,Force merges>> the index into
88
the specified maximum number of <<indices-segments,segments>>.
99

1010
[NOTE]
11-
The `forcemerge` action is best effort. It might happen that some of the
12-
shards are relocating, in which case they will not be merged.
11+
Shards that are relocating during a `forcemerge` will not be merged.
1312

1413
To use the `forcemerge` action in the `hot` phase, the `rollover` action *must* be present.
15-
If no rollover action is configured, {ilm-init} will reject the policy.
14+
If no rollover action is configured, {ilm-init} will reject the policy.
1615

1716
[[ilm-forcemerge-performance]]
1817
.Performance considerations
1918
****
20-
Force merge is a resource-intensive operation.
21-
If too many force merges are triggered at once, it can negatively impact your cluster.
22-
This can happen when you apply an {ilm-init} policy that includes a force merge action
19+
Force merge is a resource-intensive operation.
20+
If too many force merges are triggered at once, it can negatively impact your cluster.
21+
This can happen when you apply an {ilm-init} policy that includes a force merge action
2322
to existing indices.
24-
If they meet the `min_age` criteria, they can immediately proceed through multiple phases.
25-
You can prevent this by increasing the `min_age` or setting `index.lifecycle.origination_date`
26-
to change how the index age is calculated.
23+
If they meet the `min_age` criteria, they can immediately proceed through multiple phases.
24+
You can prevent this by increasing the `min_age` or setting `index.lifecycle.origination_date`
25+
to change how the index age is calculated.
2726
2827
If you experience a force merge task queue backlog,
29-
you might need to increase the size of the force merge threadpool so
30-
indices can be force merged in parallel.
28+
you might need to increase the size of the force merge threadpool so
29+
indices can be force merged in parallel.
3130
To do this, configure the `thread_pool.force_merge.size` <<cluster-get-settings,cluster setting>>.
3231
33-
IMPORTANT: This can have cascading performance impacts.
32+
IMPORTANT: This can have cascading performance impacts.
3433
Monitor cluster performance and increment the size of the thread pool slowly to reduce the backlog.
3534
3635
Force merging will be performed by the nodes within the current phase of the index. A forcemerge in
@@ -44,7 +43,7 @@ without impacting ingestion in the `hot` tier.
4443
==== Options
4544

4645
`max_num_segments`::
47-
(Required, integer)
46+
(Required, integer)
4847
Number of segments to merge to. To fully merge the index, set to `1`.
4948

5049
`index_codec`::

docs/reference/ilm/actions/ilm-searchable-snapshot.asciidoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ indices. These costs are typically lower but, in some environments, may be
4545
higher. See <<searchable-snapshots-costs>> for more details.
4646

4747
By default, this snapshot is deleted by the <<ilm-delete, delete action>> in the delete phase.
48-
To keep the snapshot, set `delete_searchable_snapshot` to `false` in the delete action. This
48+
To keep the snapshot, set `delete_searchable_snapshot` to `false` in the delete action. This
4949
snapshot retention runs off the index lifecycle management (ILM) policies and is not effected by snapshot lifecycle management (SLM) policies.
5050

5151
[[ilm-searchable-snapshot-options]]
@@ -64,8 +64,7 @@ If the managed index was already force merged using the
6464
the `searchable snapshot` action force merge step will be a no-op.
6565

6666
[NOTE]
67-
The `forcemerge` action is best effort. It might happen that some of
68-
the shards are relocating, in which case they will not be merged.
67+
Shards that are relocating during a `forcemerge` will not be merged.
6968
The `searchable_snapshot` action will continue executing even if not all shards
7069
are force merged.
7170

docs/reference/indices/data-stream-stats.asciidoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -160,9 +160,8 @@ the {wikipedia}/Unix_time[Unix epoch].
160160
+
161161
[NOTE]
162162
=====
163-
This timestamp is provided as a best effort. The data stream may contain
164-
`@timestamp` values higher than this if one or more of the following conditions
165-
are met:
163+
The data stream may contain `@timestamp` values higher than this if one or more
164+
of the following conditions are met:
166165

167166
* The stream contains <<indices-open-close,closed>> backing indices.
168167
* Backing indices with a <<data-streams-generation,lower generation>> contain

docs/reference/indices/diskusage.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,6 @@ files are ignored and some parts of data files might not be scanned by the API.
185185
<3> The stored size of the `_id` field
186186

187187
<4> The stored size of the `_source` field. As stored fields are stored
188-
together in a compressed format, the estimated sizes of stored fields are
189-
best efforts and can be inaccurate. The stored size of the `_id` field
188+
together in a compressed format, the sizes of stored fields are
189+
estimates and can be inaccurate. The stored size of the `_id` field
190190
is likely underestimated while the `_source` field is overestimated.

docs/reference/mapping/fields/synthetic-source.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
55
(indices that have `index.mode` set to `time_series`). For other indices
66
synthetic `_source` is in technical preview. Features in technical preview may
7-
be changed or removed in a future release. Elastic will apply best effort to fix
7+
be changed or removed in a future release. Elastic will work to fix
88
any issues, but features in technical preview are not subject to the support SLA
99
of official GA features.
1010

docs/reference/mapping/types/aggregate-metric-double.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ The search returns the following hit. The value of the `default_metric` field,
255255
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
256256
(indices that have `index.mode` set to `time_series`). For other indices
257257
synthetic `_source` is in technical preview. Features in technical preview may
258-
be changed or removed in a future release. Elastic will apply best effort to fix
258+
be changed or removed in a future release. Elastic will work to fix
259259
any issues, but features in technical preview are not subject to the support SLA
260260
of official GA features.
261261

docs/reference/mapping/types/boolean.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ The following parameters are accepted by `boolean` fields:
229229
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
230230
(indices that have `index.mode` set to `time_series`). For other indices
231231
synthetic `_source` is in technical preview. Features in technical preview may
232-
be changed or removed in a future release. Elastic will apply best effort to fix
232+
be changed or removed in a future release. Elastic will work to fix
233233
any issues, but features in technical preview are not subject to the support SLA
234234
of official GA features.
235235

docs/reference/mapping/types/date.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ Which will reply with a date like:
236236
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
237237
(indices that have `index.mode` set to `time_series`). For other indices
238238
synthetic `_source` is in technical preview. Features in technical preview may
239-
be changed or removed in a future release. Elastic will apply best effort to fix
239+
be changed or removed in a future release. Elastic will work to fix
240240
any issues, but features in technical preview are not subject to the support SLA
241241
of official GA features.
242242

0 commit comments

Comments
 (0)