Clarify index settings & APIs that are not available in serverless #1728
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
[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, 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
Index settings
cc @ppf2 @jakommo @maggieghamry as we discussed together
cc @dbrimley @leemthompo