Skip to content

Commit c50d23c

Browse files
elasticsearchmachineelasticsearchmachine
authored
Add release notes for v9.1.0 release (elastic#131953)
* Update docs for v9.1.0 release
1 parent bcb0aa6 commit c50d23c

File tree

4 files changed

+2788
-0
lines changed

4 files changed

+2788
-0
lines changed

‎docs/release-notes/breaking-changes.md‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,114 @@ If you are migrating from a version prior to version 9.0, you must first upgrade
1212

1313
% ## Next version [elasticsearch-nextversion-breaking-changes]
1414

15+
```{applies_to}
16+
stack: coming 9.1.0
17+
```
18+
## 9.1.0 [elasticsearch-9.1.0-breaking-changes]
19+
20+
Discovery-Plugins:
21+
:::{dropdown} Migrates `discovery-ec2` plugin to AWS SDK v2
22+
The `discovery-ec2` plugin now uses AWS SDK v2 instead of v1, as AWS plans to deprecate SDK v1 before the end of Elasticsearch 8.19’s support period. AWS SDK v2 introduces several behavior changes that affect configuration.
23+
24+
**Impact:**
25+
If you use the `discovery-ec2` plugin, your existing settings may no longer be compatible. Notable changes include, but may not be limited to:
26+
- AWS SDK v2 does not support the EC2 IMDSv1 protocol.
27+
- AWS SDK v2 does not support the `aws.secretKey` or `com.amazonaws.sdk.ec2MetadataServiceEndpointOverride` system properties.
28+
- AWS SDK v2 does not permit specifying a choice between HTTP and HTTPS so the `discovery.ec2.protocol` setting is no longer effective.
29+
- AWS SDK v2 does not accept an access key without a secret key or vice versa.
30+
31+
**Action:**
32+
Test the upgrade in a non-production environment. Adapt your configuration to the new SDK functionality. This includes, but may not be limited to, the following items:
33+
- If you use IMDS to determine the availability zone of a node or to obtain credentials for accessing the EC2 API, ensure that it supports the IMDSv2 protocol.
34+
- If applicable, discontinue use of the `aws.secretKey` and `com.amazonaws.sdk.ec2MetadataServiceEndpointOverride` system properties.
35+
- If applicable, specify that you wish to use the insecure HTTP protocol to access the EC2 API by setting `discovery.ec2.endpoint` to a URL which starts with `http://`.
36+
- Either supply both an access key and a secret key using the `discovery.ec2.access_key` and `discovery.ec2.secret_key` keystore settings, or configure neither of these settings.
37+
38+
For more information, view [#122062](https://github.com/elastic/elasticsearch/pull/122062).
39+
:::
40+
41+
ES|QL:
42+
43+
:::{dropdown} ES|QL now returns partial results by default
44+
In previous versions, ES|QL queries failed entirely when any error occurred. As of 8.19.0, ES|QL returns partial results instead.
45+
46+
**Impact:**
47+
Callers must check the `is_partial` flag in the response to determine whether the result is complete. Relying on full results without checking this flag may lead to incorrect assumptions about the response.
48+
49+
**Action:**
50+
If partial results are not acceptable for your use case, you can disable this behavior by:
51+
* Setting `allow_partial_results=false` in the query URL per request, or
52+
* Setting the `esql.query.allow_partial_results` cluster setting to `false`.
53+
54+
For more information, view [#127351](https://github.com/elastic/elasticsearch/pull/127351) (issue: [#122802](https://github.com/elastic/elasticsearch/issues/122802))
55+
:::
56+
57+
:::{dropdown} Disallows parentheses in unquoted index patterns in ES|QL
58+
To avoid ambiguity with subquery syntax, ES|QL no longer allows the use of `(` and `)` in unquoted index patterns.
59+
60+
**Impact:**
61+
Queries that include parentheses in unquoted index names will now result in a parsing exception.
62+
63+
**Action:**
64+
Update affected queries to quote index names that contain parentheses. For example, use `FROM "("foo")"` instead of `FROM (foo)`.
65+
For more information, view [#130427](https://github.com/elastic/elasticsearch/pull/130427) (issue: [#130378](https://github.com/elastic/elasticsearch/issues/130378))
66+
:::
67+
68+
:::{dropdown} Disallows mixing quoted and unquoted components in `FROM` index patterns
69+
ES|QL no longer allows mixing quoted and unquoted parts in `FROM` index patterns (e.g. `FROM remote:"index"`). Previously, such patterns were parsed inconsistently and could result in misleading runtime errors.
70+
71+
**Impact:**
72+
Queries using partially quoted index patterns—such as quoting only the index or only the remote cluster—will now be rejected at parse time. This change simplifies grammar handling and avoids confusing validation failures.
73+
74+
**Action:**
75+
Ensure index patterns are either fully quoted or fully unquoted. For example:
76+
* Valid: `FROM "remote:index"` or `FROM remote:index`
77+
* Invalid: `FROM remote:"index"`, `FROM "remote":index`
78+
79+
For more information, view [#127636](https://github.com/elastic/elasticsearch/pull/127636) (issue: [#122651](https://github.com/elastic/elasticsearch/issues/122651))
80+
:::
81+
82+
:::{dropdown} `skip_unavailable` now catches all remote cluster runtime errors in ES|QL
83+
When `skip_unavailable` is set to `true`, ES|QL now treats all runtime errors from that cluster as non-fatal. Previously, this setting only applied to connectivity issues (i.e. when a cluster was unavailable).
84+
85+
**Impact:**
86+
Errors such as missing indices on a remote cluster will no longer cause the query to fail. Instead, the cluster will appear in the response metadata as `skipped` or `partial`.
87+
88+
**Action:**
89+
If your workflows rely on detecting remote cluster errors, review your use of `skip_unavailable` and adjust error handling as needed.
90+
91+
For more information, view [#128163](https://github.com/elastic/elasticsearch/pull/128163)
92+
:::
93+
94+
Snapshot/Restore:
95+
96+
:::{dropdown} Upgrades `repository-s3` plugin to AWS SDK v2
97+
The `repository-s3` plugin now uses AWS SDK v2 instead of v1, as AWS will deprecate SDK v1 before the end of Elasticsearch 8.19’s support period. The two SDKs differ in behavior, which may require updates to your configuration.
98+
99+
**Impact:**
100+
Existing `repository-s3` configurations may no longer be compatible. Notable differences in AWS SDK v2 include, but may not be limited to:
101+
- AWS SDK v2 requires users to specify the region to use for signing requests, or else to run in an environment in which it can determine the correct region automatically. The older SDK used to determine the region based on the endpoint URL as specified with the `s3.client.${CLIENT_NAME}.endpoint` setting, together with other data drawn from the operating environment, and fell back to `us-east-1` if no better value was found.
102+
- AWS SDK v2 does not support the EC2 IMDSv1 protocol.
103+
- AWS SDK v2 does not support the `com.amazonaws.sdk.ec2MetadataServiceEndpointOverride` system property.
104+
- AWS SDK v2 does not permit specifying a choice between HTTP and HTTPS so the `s3.client.${CLIENT_NAME}.protocol` setting is deprecated and no longer has any effect.
105+
- AWS SDK v2 does not permit control over throttling for retries, so the `s3.client.${CLIENT_NAME}.use_throttle_retries` setting is deprecated and no longer has any effect.
106+
- AWS SDK v2 requires the use of the V4 signature algorithm, therefore, the `s3.client.${CLIENT_NAME}.signer_override` setting is deprecated and no longer has any effect.
107+
- AWS SDK v2 does not support the `log-delivery-write` canned ACL.
108+
- AWS SDK v2 counts 4xx responses differently in its metrics reporting.
109+
- AWS SDK v2 always uses the regional STS endpoint, whereas AWS SDK v2 could use either a regional endpoint or the global `https://sts.amazonaws.com` one.
110+
111+
**Action:**
112+
Test the upgrade in a non-production environment. Adapt your configuration to the new SDK functionality. This includes, but may not be limited to, the following items:
113+
- Specify the correct signing region using the `s3.client.${CLIENT_NAME}.region` setting on each node. {es} will try to determine the correct region based on the endpoint URL and other data drawn from the operating environment, but might not do so correctly in all cases.
114+
- If you use IMDS to determine the availability zone of a node or to obtain credentials for accessing the EC2 API, ensure that it supports the IMDSv2 protocol.
115+
- If applicable, discontinue use of the `com.amazonaws.sdk.ec2MetadataServiceEndpointOverride` system property.
116+
- If applicable, specify that you wish to use the insecure HTTP protocol to access the S3 API by setting `s3.client.${CLIENT_NAME}.endpoint` to a URL which starts with `http://`.
117+
- If applicable, discontinue use of the `log-delivery-write` canned ACL.
118+
119+
For more information, view [#126843](https://github.com/elastic/elasticsearch/pull/126843) (issue: [#120993](https://github.com/elastic/elasticsearch/issues/120993))
120+
:::
121+
122+
15123
## 9.0.4 [elasticsearch-9.0.4-breaking-changes]
16124

17125
No breaking changes in this version.

0 commit comments

Comments
 (0)