-
Notifications
You must be signed in to change notification settings - Fork 526
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
docs: Change API key docs to Kibana UI #5953
Conversation
"{beat_default_index_prefix}_writer": { | ||
"cluster": ["monitor", "read_ilm"], <1> | ||
"index": [ <2> | ||
{ | ||
"names": ["{beat_default_index_prefix}-*"], | ||
"privileges": ["view_index_metadata", "create_doc"] | ||
} |
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.
Question for reviewers. Are these permissions correct for a publishing user? I didn't change anything here, but I did notice that our Grant privileges and roles needed for writing events documentation shows different req'd privs.
These docs | Privilege docs |
---|---|
Cluster: monitor + read_ilm |
Cluster: none |
Index (apm-* ): view_index_metadata + create_doc |
Index (apm-* ): create_index + create_doc |
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.
Good catch! The linked docs have a NOTE at the beginning that the setup
role is separated from the writer
role to minimize the privileges required during writing. That's why the dedicated writer role has less privileges. But even with that, there are still discrepancies.
I'd only put a minimal example here, using the same privileges as documented for the writer role, and add a note that this assumes previous setup and link to the privileges docs for more details on that. Otherwise I am certain we will diverge again.
I did not explicitly test the privileges again, but remember that we did extensive testing when overhauling the privileges docs, so I think we can rely on them.
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.
I'd only put a minimal example here, using the same privileges as documented for the writer role, and add a note that this assumes previous setup and link to the privileges docs for more details on that. Otherwise I am certain we will diverge again.
Makes sense! I'll get that fixed.
but remember that we did extensive testing when overhauling the privileges docs, so I think we can rely on them.
💯
Thanks!
"{beat_default_index_prefix}_monitoring": { | ||
"cluster": ["monitor"], <1> | ||
"index": [ <2> | ||
{ | ||
"names": [".monitoring-beats-*"], | ||
"privileges": ["create_index", "create"] | ||
} |
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.
Same question here. What we had is different from what we show in Grant privileges and roles needed for monitoring.
These docs | Privilege docs |
---|---|
Cluster: monitor |
Cluster: none |
Index (.monitoring-beats-* ): create_index + create_doc |
Index (.monitoring-beats-* ): create_index + create_doc |
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.
Same as above, let's rely on the privilege docs.
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
Trends 🧪 |
|
||
NOTE: API Keys are not applicable for the RUM Agent, | ||
as there is no way to prevent them from being publicly exposed. | ||
NOTE: API Keys |
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.
leftover?
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.
leftover 😬
"{beat_default_index_prefix}_writer": { | ||
"cluster": ["monitor", "read_ilm"], <1> | ||
"index": [ <2> | ||
{ | ||
"names": ["{beat_default_index_prefix}-*"], | ||
"privileges": ["view_index_metadata", "create_doc"] | ||
} |
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.
Good catch! The linked docs have a NOTE at the beginning that the setup
role is separated from the writer
role to minimize the privileges required during writing. That's why the dedicated writer role has less privileges. But even with that, there are still discrepancies.
I'd only put a minimal example here, using the same privileges as documented for the writer role, and add a note that this assumes previous setup and link to the privileges docs for more details on that. Otherwise I am certain we will diverge again.
I did not explicitly test the privileges again, but remember that we did extensive testing when overhauling the privileges docs, so I think we can rely on them.
"{beat_default_index_prefix}_monitoring": { | ||
"cluster": ["monitor"], <1> | ||
"index": [ <2> | ||
{ | ||
"names": [".monitoring-beats-*"], | ||
"privileges": ["create_index", "create"] | ||
} |
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.
Same as above, let's rely on the privilege docs.
Motivation/summary
This PR updates API key documentation to use the Kibana UI instead of ES APIs or APM Server tools.
Let me see it
Related issues
Closes elastic/observability-docs#965.