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

[ResponseOps] do we need to display info for rules with user-managed API keys? #154581

Closed
pmuellr opened this issue Apr 6, 2023 · 4 comments · Fixed by #155699
Closed

[ResponseOps] do we need to display info for rules with user-managed API keys? #154581

pmuellr opened this issue Apr 6, 2023 · 4 comments · Fixed by #155699
Assignees
Labels
Feature:Alerting/RulesManagement Issues related to the Rules Management UX Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@pmuellr
Copy link
Member

pmuellr commented Apr 6, 2023

In PR Allow users authenticated with an API keys to manage alerting rules #154189, we will now have a combination of alerting-framework-generated APIs keys and user-generated API keys, as the API keys stored and used by rules.

We currently show a bit of API key info in the Rule details:

image

I'm thinking we'll want some additional UX around these, so users will be able to tell whether a given rule has user-managed API keys or not. I'm not sure how far we can go

  • just indicate it's user-managed with a icon/text next to the existing API key owner?
  • can we provide a link into the API key management page for this key? (doesn't look like that view supports such things now)
  • does it need to be a column in the Rule's list, or at least somehow filterable?

I think we'll have to play with it to see how much we would need, but we do probably want to at least add a visual indication of this - will be very useful for diagnostic situations in which Rule details pages are screen-shot'ed :-)

@pmuellr pmuellr added Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Alerting/RulesManagement Issues related to the Rules Management UX labels Apr 6, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

@XavierM
Copy link
Contributor

XavierM commented Apr 12, 2023

@shanisagiv1 @mdefazio
what do you guys think about that?

@mdefazio
Copy link
Contributor

just indicate it's user-managed with a icon/text next to the existing API key owner?

Seems reasonable.

can we provide a link into the API key management page for this key? (doesn't look like that view supports such things now)

Perhaps the link out should be behind a popover/click or something—thinking we would need to make it clear where the link would go

does it need to be a column in the Rule's list, or at least somehow filterable?

I would vote against this. Seems like too much detail at this level.

@shanisagiv1
Copy link

shanisagiv1 commented Apr 17, 2023

I'd say that the first option will provide the details for users to keep checking the details if they're willing to.. I'd not invest more in the other 2 for now..

@ersin-erdal ersin-erdal self-assigned this Apr 24, 2023
ersin-erdal added a commit that referenced this issue May 15, 2023
…eated by users (#155699)

Resolves: #154581

This PR adds 'user-managed' label next to the API key owner name when
the API key is created by the user.

<img width="813" alt="Screenshot 2023-05-06 at 19 02 08"
src="https://user-images.githubusercontent.com/92688503/236637767-d0c0ee00-1314-4824-b97a-b7bdf1b7f43b.png">
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue May 15, 2023
…eated by users (elastic#155699)

Resolves: elastic#154581

This PR adds 'user-managed' label next to the API key owner name when
the API key is created by the user.

<img width="813" alt="Screenshot 2023-05-06 at 19 02 08"
src="https://user-images.githubusercontent.com/92688503/236637767-d0c0ee00-1314-4824-b97a-b7bdf1b7f43b.png">

(cherry picked from commit d297a99)
kibanamachine added a commit that referenced this issue May 15, 2023
…eys created by users (#155699) (#157792)

# Backport

This will backport the following commits from `main` to `8.8`:
- [add 'user-managed' label to the rule details page for the api keys
created by users
(#155699)](#155699)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Ersin
Erdal","email":"92688503+ersin-erdal@users.noreply.github.com"},"sourceCommit":{"committedDate":"2023-05-15T19:33:48Z","message":"add
'user-managed' label to the rule details page for the api keys created
by users (#155699)\n\nResolves: #154581\r\n\r\nThis PR adds
'user-managed' label next to the API key owner name when\r\nthe API key
is created by the user.\r\n\r\n<img width=\"813\" alt=\"Screenshot
2023-05-06 at 19 02
08\"\r\nsrc=\"https://user-images.githubusercontent.com/92688503/236637767-d0c0ee00-1314-4824-b97a-b7bdf1b7f43b.png\">","sha":"d297a9949fc603a797faebc997ea92bee1001fee","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","ui-copy","v8.8.0","v8.9.0"],"number":155699,"url":"https://github.com/elastic/kibana/pull/155699","mergeCommit":{"message":"add
'user-managed' label to the rule details page for the api keys created
by users (#155699)\n\nResolves: #154581\r\n\r\nThis PR adds
'user-managed' label next to the API key owner name when\r\nthe API key
is created by the user.\r\n\r\n<img width=\"813\" alt=\"Screenshot
2023-05-06 at 19 02
08\"\r\nsrc=\"https://user-images.githubusercontent.com/92688503/236637767-d0c0ee00-1314-4824-b97a-b7bdf1b7f43b.png\">","sha":"d297a9949fc603a797faebc997ea92bee1001fee"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/155699","number":155699,"mergeCommit":{"message":"add
'user-managed' label to the rule details page for the api keys created
by users (#155699)\n\nResolves: #154581\r\n\r\nThis PR adds
'user-managed' label next to the API key owner name when\r\nthe API key
is created by the user.\r\n\r\n<img width=\"813\" alt=\"Screenshot
2023-05-06 at 19 02
08\"\r\nsrc=\"https://user-images.githubusercontent.com/92688503/236637767-d0c0ee00-1314-4824-b97a-b7bdf1b7f43b.png\">","sha":"d297a9949fc603a797faebc997ea92bee1001fee"}}]}]
BACKPORT-->

Co-authored-by: Ersin Erdal <92688503+ersin-erdal@users.noreply.github.com>
jasonrhodes pushed a commit that referenced this issue May 17, 2023
…eated by users (#155699)

Resolves: #154581

This PR adds 'user-managed' label next to the API key owner name when
the API key is created by the user.

<img width="813" alt="Screenshot 2023-05-06 at 19 02 08"
src="https://user-images.githubusercontent.com/92688503/236637767-d0c0ee00-1314-4824-b97a-b7bdf1b7f43b.png">
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Alerting/RulesManagement Issues related to the Rules Management UX Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
No open projects
6 participants