Commit 11840e9
Clarify index settings & APIs that are not available in serverless (#1728)
## Description
There are some APIs and index settings that are not available in
serverless mode. Using such API or index settings will get such
response.
Two main things:
### [1]
It's not clear in docs that explain "why" these settings are designed as
not available.
Reason per we checked internally is that, _"These are defensive settings
meant to protect the index from misuse that may lead to cluster
instability so I don't believe we can expose these in Serverless. Since
Elastic has responsibility for supporting cluster stability we have to
make decisions about what you can and can not do to destabilize a
cluster."_
We'd like to make it clear in public too.
Also, some other pointers taken into consideration:
- Avoid mentioning "misuse" since that sounds like user's fault
- Emphasize it's Elastic's responsibility to keep the cluster stability.
- Cover also cluster level and node level setting description that fully
managed by Elastic
### [2]
There's a detailed error message when using not available API. But
there's no such error message for not available index settings. It's
logically unbalanced.
Either we should remove the message from unavailable API, or we add the
error message for unavailable index settings.
IMHO, at this time point, I'd like to add the error message for
unavailable index settings, because there must have been a reason that
we decided to put "unavailable API error message" into the doc.
In the long run, I'd think we should remove both.
### Side notes
Note the difference between index settings, and node/cluster settings.
Per the [existing
doc](https://www.elastic.co/docs/deploy-manage/deploy/elastic-cloud/differences-from-other-elasticsearch-offerings),
we don't allow any node settings and cluster settings, they are fully
managed by Elastic.
We only allow limited index settings.
I tried to make this point clear in my doc PR too.
## PR Preview
API
-
https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1728/deploy-manage/deploy/elastic-cloud/differences-from-other-elasticsearch-offerings#elasticsearch-differences-serverless-apis-availability
Index settings
-
https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1728/deploy-manage/deploy/elastic-cloud/differences-from-other-elasticsearch-offerings#elasticsearch-differences-serverless-settings-availability
---
cc @ppf2 @jakommo @maggieghamry as we discussed together
cc @dbrimley @leemthompo
---------
Co-authored-by: Edu González de la Herrán <[email protected]>1 parent 49ea890 commit 11840e9
File tree
1 file changed
+23
-2
lines changed- deploy-manage/deploy/elastic-cloud
1 file changed
+23
-2
lines changedLines changed: 23 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
162 | 162 | | |
163 | 163 | | |
164 | 164 | | |
165 | | - | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
166 | 169 | | |
167 | 170 | | |
168 | 171 | | |
| |||
201 | 204 | | |
202 | 205 | | |
203 | 206 | | |
204 | | - | |
| 207 | + | |
205 | 208 | | |
206 | 209 | | |
207 | 210 | | |
| |||
219 | 222 | | |
220 | 223 | | |
221 | 224 | | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
222 | 243 | | |
223 | 244 | | |
224 | 245 | | |
| |||
0 commit comments