Fix docs for update security index settings API #110126
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
n1v0lg
added
>docs
|
Documentation preview: |
n1v0lg
changed the title
|
@elasticmachine update branch |
n1v0lg
commented
Jun 28, 2024
| <<security-api-get-token,tokens>>. | ||
|
|
||
| `security`:: | ||
| (Optional, object) Settings to be used for the index used to store | ||
| `security-profile`:: |
There was a problem hiding this comment.
Truly, the most pernicious class of error: the copy/paste error.
🤦🏼♀️ thanks
elasticsearchmachine
added
Team:Docs
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-security (Team:Security) |
n1v0lg
commented
Jun 28, 2024
| be modified. This includes: | ||
|
|
||
| - `index.auto_expand_replicas` | ||
| - `index.number_of_replicas` | ||
|
|
||
| NOTE: If `index.auto_expand_replicas` is set, `index.number_of_replicas` will be ignored during updates. |
There was a problem hiding this comment.
This is change 2: I think it's as simple as that. Basically, if you have e.g., 0-1 for auto expand, and a 1 node cluster, trying to set number of replicates to say 2 won't have any effect (#27871)
There was a problem hiding this comment.
Matches my understanding, and this API just plumbs through to the normal settings infra so it should behave the same as the same setting on any other index.
|
@elasticmachine update branch |
n1v0lg
added
the
auto-merge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Docs tweak with a typo fix and a clarification on how the two available settings interact (essentially #27871). I'm also open to including this info in the more generic settings API but feels like a simple enough callout to add to the security API.