Skip to content
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

Merged
merged 6 commits into from
Aug 23, 2021

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Aug 16, 2021

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.

@bmorelli25 bmorelli25 added v7.14.0 Team:Docs Label for the Observability docs team labels Aug 16, 2021
@bmorelli25 bmorelli25 self-assigned this Aug 16, 2021
Comment on lines 35 to 41
"{beat_default_index_prefix}_writer": {
"cluster": ["monitor", "read_ilm"], <1>
"index": [ <2>
{
"names": ["{beat_default_index_prefix}-*"],
"privileges": ["view_index_metadata", "create_doc"]
}
Copy link
Member Author

@bmorelli25 bmorelli25 Aug 16, 2021

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

Copy link
Contributor

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.

Copy link
Member Author

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!

Comment on lines 81 to 87
"{beat_default_index_prefix}_monitoring": {
"cluster": ["monitor"], <1>
"index": [ <2>
{
"names": [".monitoring-beats-*"],
"privileges": ["create_index", "create"]
}
Copy link
Member Author

@bmorelli25 bmorelli25 Aug 16, 2021

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

Copy link
Contributor

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.

@bmorelli25 bmorelli25 requested a review from a team August 16, 2021 22:02
@apmmachine
Copy link
Contributor

apmmachine commented Aug 16, 2021

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2021-08-23T21:29:15.708+0000

  • Duration: 42 min 17 sec

  • Commit: bf16de4

Test stats 🧪

Test Results
Failed 0
Passed 5936
Skipped 14
Total 5950

Trends 🧪

Image of Build Times

Image of Tests


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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

leftover?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

leftover 😬

Comment on lines 35 to 41
"{beat_default_index_prefix}_writer": {
"cluster": ["monitor", "read_ilm"], <1>
"index": [ <2>
{
"names": ["{beat_default_index_prefix}-*"],
"privileges": ["view_index_metadata", "create_doc"]
}
Copy link
Contributor

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.

Comment on lines 81 to 87
"{beat_default_index_prefix}_monitoring": {
"cluster": ["monitor"], <1>
"index": [ <2>
{
"names": [".monitoring-beats-*"],
"privileges": ["create_index", "create"]
}
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Docs Label for the Observability docs team v7.14.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] Change API Key creation docs to contain the Kibana UI for API Key creation
3 participants