Skip to content
This repository has been archived by the owner on Dec 21, 2023. It is now read-only.

Keptn Bridge: UI support for remediation actions #2299

Closed
jetzlstorfer opened this issue Sep 7, 2020 · 9 comments
Closed

Keptn Bridge: UI support for remediation actions #2299

jetzlstorfer opened this issue Sep 7, 2020 · 9 comments
Labels
bridge.2.0 Bridge Version 2 type:feature New feature or request that provides value to the stakeholders/end-users

Comments

@jetzlstorfer
Copy link
Member

jetzlstorfer commented Sep 7, 2020

Problem statement:
Keptn supports the automatic execution of so-called "remediation actions" in response to alerts (aka. problem events) from external sources (e.g., Prometheus). Remediation actions are linked to these alerts via a dedicated remediation.yaml file. A remediation.yaml file is mapped to a service running in a stage:

remediation action --- many to one mapping to -- remediation.yaml file --- one to one mapping to --- service/stage

Please find the specification of a remediation.yaml here: https://github.com/keptn/spec/blob/master/remediation.md

The problem is that right now there is no way in the Keptn Bridge to visualize which actions will be triggered by Keptn in response to alerts. As the remediation.yaml file can hold multiple actions and is attached to one service, the need for visualization of this file is given.

Potential solution:
Re-use the environment screen in the Keptn Bridge that displays all stages and services. When clicking on a stage and then on a service, I see the remediation file from the service (please see mock below). When clicking on the remediation file, all remediation actions should be shown and customizable.

Screenshots:

  • In this mockup, the service carts in stage prod-cluster-A is selected.

image

  • When clicking on Show: Remediation (as highlighted in yellow), the remediation is displayed by its problem type and the remediation actions. For an initial MVP, a representation of the plain yaml file works too.
  • As a user, I would like to add/delete/update a remediation action
  • As a user, I would like to add a remediation

Support: UI components are provided by the open-source framework Barista.

Optional

  • If the feature of editing remediation for a service is implemented, the SLI/SLO file could be customizable too; at least the plain yaml file.
@johannes-b johannes-b added the bridge.2.0 Bridge Version 2 label Sep 7, 2020
@johannes-b johannes-b changed the title UI support for remediation actions Keptn Bridge: UI support for remediation actions Sep 8, 2020
@Mayank4git
Copy link

I am interested in this projects.i am good enough in working with js framework like in this one i.e. angular.so please assign this task to me

@jetzlstorfer jetzlstorfer self-assigned this Oct 12, 2020
@jetzlstorfer
Copy link
Member Author

Thanks all for your interest (either here or in Slack). The issue has been proposed to the CNCF Community Bridge program and the selected mentee will be assigned to the issue.
You can still contribute to Keptn, e.g., by taking a look at our good first issues here: https://github.com/keptn/keptn/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22

@ayushnawal
Copy link

I have been selected as a mentee under the CNCF community bridge program and I would like to take this up.
@jetzlstorfer could you please assign it to me?

@johannes-b
Copy link
Member

Hi @ayushnawal and @jetzlstorfer,

I slightly updated the content of the issue by providing a new wireframe. As you can see in the new wireframe, the remediation of a file should be editable through the Environment screen (before we thought to introduce a new screen).

@jetzlstorfer
Copy link
Member Author

FYI @ayushnawal

resources like the remediation.yaml and the sli.yaml/slo.yaml can be fetched via this endpoint from the configuration-service (can be found in the Swagger UI of your Keptn installation)

image

@ayushnawal
Copy link

ON IT

@stale
Copy link

stale bot commented Dec 20, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@christian-kreuzberger-dtx
Copy link
Member

This issue is available again!

@christian-kreuzberger-dtx christian-kreuzberger-dtx added help wanted Extra attention is needed type:feature New feature or request that provides value to the stakeholders/end-users labels Dec 21, 2020
@johannes-b johannes-b removed the help wanted Extra attention is needed label Apr 9, 2021
@johannes-b
Copy link
Member

I closed this issue because this is not the way we envision displaying remediations in the future. Please see here: keptn/enhancement-proposals#40 for more details.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bridge.2.0 Bridge Version 2 type:feature New feature or request that provides value to the stakeholders/end-users
Projects
None yet
Development

No branches or pull requests

5 participants