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.
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adds documentation for permission that provides access to system indexes #4849
Adds documentation for permission that provides access to system indexes #4849
Changes from 13 commits
c77bac7
f37d69e
abc33d3
f2b57de
13b0589
f75599c
887ff13
8cad753
4b1494a
548c739
4953ef5
7662f64
ec6972d
72e2cc1
063c27c
c76426a
c959b64
ba37dc1
771a8b0
3e96bd9
bcaee4f
798eecb
35268a2
e7e7208
0caa394
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using
*
is allowed, there is no requirement for a special case with.*
. The following index pattern is the shortest way to give a user full access to all - including system indices - on the cluster.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@peternied Thanks for pointing this out. I've reworded the points above to bring guidance in line with this clarification. Is the additional wildcard necessary under
allowed_actions
only when you want to specify all system indexes underindex_patterns
?One other nitpick. Are values for this configuration wrapped in single quotes or double quotes? Or doesn't it matter? I've seen both.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Quotes Single vs Double]
Just looked this up from from the spec. Generally we shouldn't use quotes, however, special characters like
*
and:
should be quoted.Generally single quote style is what we should use in our docs as double quotes are used for interpolation eg
\n
becomes the newline character inside double quotes.Don't want to think about it, you can interactively use yaml-formatter, or we can look at added a formatter as part of this project.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@DarshitChanpura can you confirm?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@peternied "YAML formatter": a thing of beauty. Thanks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
extreme caution, this feels a little dramatic, is this inline with other risky operations in the access control system?
Note; I'd rather educate users that they could test the pattern by using
GET /_cat/indices/.kibana*
which returns all the indices associated with that index pattern (in this case any index starting with .kibana), which has the resulting output of the following indices, at least on my test cluster.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@peternied Good perspective on that. I removed that caution (seemed redundant, anyhow) and replaced it with a "tip" about using the
GET /_cat/indices/<index>
operation to verify your index pattern. Thank you for that.