Skip to content

Commit 4fd9e07

Browse files
mdbirnstiehlmdbirnstiehl
authored
Merge branch 'main' into update-ai-functions
2 parents 74f8a16 + a1d6244 commit 4fd9e07

File tree

6 files changed

+194
-6
lines changed

6 files changed

+194
-6
lines changed

‎deploy-manage/deploy/cloud-enterprise/edit-stack-settings-elasticsearch.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
navigation_title: Elasticsearch user settings
33
mapped_pages:
44
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-add-user-settings.html
5+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-change-user-settings-examples.html
56
applies_to:
67
deployment:
78
ece: all
@@ -17,9 +18,11 @@ Change how {{es}} runs by providing your own user settings. User settings are ap
1718
If a feature requires both standard `elasticsearch.yml` settings and [secure settings](/deploy-manage/security/secure-settings.md), configure the secure settings first. Updating standard user settings can trigger a cluster rolling restart, and if the required secure settings are not yet in place, the nodes might fail to start. Adding secure settings does not trigger a restart.
1819
:::
1920

20-
{{ece}} automatically rejects `elasticsearch.yml` settings that could break your cluster, including some zen discovery and security settings.
21+
{{ece}} automatically rejects `elasticsearch.yml` settings that could break your cluster, including some zen discovery and security settings. For a detailed list of settings, refer to the [{{es}} configuration reference](elasticsearch://reference/elasticsearch/configuration-reference/index.md).
2122

22-
For a list of supported settings, check [Supported {{es}} settings](elasticsearch://reference/elasticsearch/configuration-reference/index.md).
23+
::::{note}
24+
Most of the user settings that are available for the {{es}} version that your cluster is running are also available on {{ece}}, regardless of being marked as "supported on {{ech}}".
25+
::::
2326

2427
To add or edit {{es}} user settings:
2528

@@ -37,6 +40,7 @@ To add or edit {{es}} user settings:
3740
If you encounter the **Edit elasticsearch.yml** carets, be sure to make your changes on all {{es}} node types.
3841
::::
3942

43+
$$$ece-change-user-settings-examples$$$
4044
## Example: enable email notifications [ece_enable_email_notifications_from_gmail]
4145

4246
To enable email notifications in your {{es}} cluster, you need to configure an email account and related settings. For complete instructions, refer to [Configuring email accounts](/explore-analyze/alerts-cases/watcher/actions-email.md#configuring-email).

‎deploy-manage/deploy/cloud-enterprise/migrate-to-podman-5.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
---
2+
mapped_pages:
3+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-podman-5-migration.html
24
applies_to:
35
deployment:
46
ece: all

‎deploy-manage/deploy/elastic-cloud/differences-from-other-elasticsearch-offerings.md‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,10 @@ These recommendations do not apply to indices using better binary quantization (
162162

163163
## Available {{es}} APIs [elasticsearch-differences-serverless-apis-availability]
164164

165-
Because {{serverless-full}} manages infrastructure automatically, certain Elasticsearch APIs are not available:
165+
In {{serverless-full}}, access is limited to a subset of {{es}} APIs, as Elastic manages the underlying infrastructure. These restrictions help maintain cluster stability, availability, and data integrity, ensuring reliable operation of Serverless projects.
166+
167+
The following {{es}} APIs are not available in {{serverless-full}}:
168+
166169

167170
Infrastructure operations
168171
: * All `_nodes/*` operations
@@ -201,7 +204,7 @@ Refer to the [{{es-serverless}} API reference](https://www.elastic.co/docs/api/d
201204

202205
## Available {{es}} settings [elasticsearch-differences-serverless-settings-availability]
203206

204-
In {{serverless-full}} Elasticsearch projects, you can only configure [index-level settings](elasticsearch://reference/elasticsearch/index-settings/index.md). Cluster-level settings and node-level settings are fully managed by Elastic.
207+
In {{serverless-full}} projects, configuration available to users is limited to certain [index-level settings](elasticsearch://reference/elasticsearch/index-settings/index.md), while Elastic manages cluster-level and node-level settings to maintain stability, availability, performance, and data integrity. These restrictions help ensure the reliability of Serverless projects.
205208

206209
Available settings
207210
: **Index-level settings**: Settings that control how documents are processed, stored, and searched are available to end users. These include:
@@ -219,6 +222,24 @@ Managed settings
219222
* Shard allocation
220223
* Resource management
221224

225+
When attempting to use an unavailable index setting, you'll receive this error:
226+
227+
```json
228+
{
229+
"error": {
230+
"root_cause": [
231+
{
232+
"type": "illegal_argument_exception",
233+
"reason": "Settings [xyz] are not available when running in serverless mode"
234+
}
235+
],
236+
"type": "illegal_argument_exception",
237+
"reason": "Settings [xyz] are not available when running in serverless mode"
238+
},
239+
"status": 400
240+
}
241+
```
242+
222243
## Learn more
223244

224245
- [{{serverless-full}} roadmap](https://www.elastic.co/cloud/serverless/roadmap): See upcoming features and development plans for the Serverless platform

‎solutions/search/full-text/create-update-synonyms-api-example.md‎

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
---
2+
mapped_pages:
3+
- https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-synonyms-set.html#put-synonyms-set-example
4+
applies_to:
5+
stack:
6+
serverless:
7+
products:
8+
- id: elasticsearch
9+
---
10+
11+
# Create or update synonyms set API examples [create-update-synonyms-set-api-examples]
12+
13+
On this page, you can find practical examples of how to create or update a synonyms set using the [Synonyms APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-synonyms). The examples below show how to create a new synonyms set, validate its rules, and explain how analyzers are reloaded automatically when the synonyms set is updated.
14+
15+
The following example creates a new synonyms set called `my-synonyms-set`:
16+
17+
```console
18+
PUT _synonyms/my-synonyms-set
19+
{
20+
"synonyms_set": [
21+
{
22+
"id": "test-1",
23+
"synonyms": "hello, hi"
24+
},
25+
{
26+
"synonyms": "bye, goodbye"
27+
},
28+
{
29+
"id": "test-2",
30+
"synonyms": "test => check"
31+
}
32+
]
33+
}
34+
```
35+
36+
If any of the synonym rules included is not valid, the API will return an error.
37+
38+
```console
39+
PUT _synonyms/my-synonyms-set
40+
{
41+
"synonyms_set": [
42+
{
43+
"synonyms": "hello => hi => howdy"
44+
}
45+
]
46+
}
47+
```
48+
% TEST[catch:bad_request]
49+
50+
```console-result
51+
{
52+
"error": {
53+
"root_cause": [
54+
{
55+
"type": "action_request_validation_exception",
56+
"reason": "Validation Failed: 1: More than one explicit mapping specified in the same synonyms rule: [hello => hi => howdy];",
57+
"stack_trace": ...
58+
}
59+
],
60+
"type": "action_request_validation_exception",
61+
"reason": "Validation Failed: 1: More than one explicit mapping specified in the same synonyms rule: [hello => hi => howdy];",
62+
"stack_trace": ...
63+
},
64+
"status": 400
65+
}
66+
```
67+
% TESTRESPONSE[s/"stack_trace": \.\.\./"stack_trace": $body.$_path/]
68+
69+
## Analyzer reloading [synonyms-set-analyzer-reloading]
70+
71+
When an existing synonyms set is updated, the [search-analyzer](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/search-analyzer) that use the synonyms set are reloaded automatically for all indices.
72+
This would be equivalent to invoking [Reload search analyzers API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers) for all indices that use the synonyms set.
73+
74+
For example, creating an index with a synonyms set and updating it:
75+
76+
```console-result
77+
PUT _synonyms/my-synonyms-set
78+
{
79+
"synonyms_set": [
80+
{
81+
"id": "test-1",
82+
"synonyms": "hello, hi"
83+
}
84+
]
85+
}
86+
87+
PUT /test-index
88+
{
89+
"settings": {
90+
"analysis": {
91+
"filter": {
92+
"synonyms_filter": {
93+
"type": "synonym_graph",
94+
"synonyms_set": "my-synonyms-set",
95+
"updateable": true
96+
}
97+
},
98+
"analyzer": {
99+
"my_index_analyzer": {
100+
"type": "custom",
101+
"tokenizer": "standard",
102+
"filter": ["lowercase"]
103+
},
104+
"my_search_analyzer": {
105+
"type": "custom",
106+
"tokenizer": "standard",
107+
"filter": ["lowercase", "synonyms_filter"]
108+
}
109+
}
110+
}
111+
},
112+
"mappings": {
113+
"properties": {
114+
"title": {
115+
"type": "text",
116+
"analyzer": "my_index_analyzer",
117+
"search_analyzer": "my_search_analyzer"
118+
}
119+
}
120+
}
121+
}
122+
123+
PUT _synonyms/my-synonyms-set
124+
{
125+
"synonyms_set": [
126+
{
127+
"id": "test-1",
128+
"synonyms": "hello, hi, howdy"
129+
}
130+
]
131+
}
132+
```
133+
134+
The reloading result is included as part of the response:
135+
136+
```console-result
137+
{
138+
"result": "updated",
139+
"reload_analyzers_details": {
140+
"_shards": {
141+
"total": 2,
142+
"successful": 1,
143+
"failed": 0
144+
},
145+
"reload_details": [
146+
{
147+
"index": "test-index",
148+
"reloaded_analyzers": [
149+
"my_search_analyzer"
150+
],
151+
"reloaded_node_ids": [
152+
"1wYFZzq8Sxeu_Jvt9mlbkg"
153+
]
154+
}
155+
]
156+
}
157+
}
158+
```
159+
% TESTRESPONSE[s/1wYFZzq8Sxeu_Jvt9mlbkg/$body.reload_analyzers_details.reload_details.0.reloaded_node_ids.0/]

‎solutions/search/full-text/search-with-synonyms.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ Your synonyms sets need to be stored in {{es}} so your analyzers can refer to th
5151

5252
### Synonyms API [synonyms-store-synonyms-api]
5353

54-
You can use the [synonyms APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-synonyms) to manage synonyms sets. This is the most flexible approach, as it allows to dynamically define and modify synonyms sets.
54+
You can use the [synonyms APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-synonyms) to manage synonyms sets. This is the most flexible approach, as it allows to dynamically define and modify synonyms sets. For examples of how to
55+
create or update a synonym set with APIs, refer to the [Create or update synonyms set API examples](/solutions/search/full-text/search-with-synonyms.md) page.
5556

5657
Changes in your synonyms sets will automatically reload the associated analyzers.
5758

58-
5959
### Synonyms File [synonyms-store-synonyms-file]
6060

6161
You can store your synonyms set in a file.

‎solutions/toc.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ toc:
2121
children:
2222
- file: search/full-text/how-full-text-works.md
2323
- file: search/full-text/search-with-synonyms.md
24+
children:
25+
- file: search/full-text/create-update-synonyms-api-example.md
2426
- file: search/full-text/text-analysis-during-search.md
2527
- file: search/full-text/search-relevance.md
2628
children:

0 commit comments

Comments
 (0)