diff --git a/.changeset/tame-rivers-dress.md b/.changeset/tame-rivers-dress.md new file mode 100644 index 000000000..134b37638 --- /dev/null +++ b/.changeset/tame-rivers-dress.md @@ -0,0 +1,5 @@ +--- +"@cloudoperators/juno-app-supernova": patch +--- + +chore(supernova): add screenshots to readme diff --git a/apps/supernova/README.md b/apps/supernova/README.md index 4baad0d53..b8e473615 100644 --- a/apps/supernova/README.md +++ b/apps/supernova/README.md @@ -3,7 +3,11 @@ [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE) [![Built with Juno](https://cloudoperators.github.io/juno/built-with-juno.svg)](https://github.com/cloudoperators/juno) -Supernova is an enhanced UI for Prometheus Alertmanager, offering several quality-of-life improvements: +Supernova is an enhanced UI for Prometheus Alertmanager. + +![supernova_alerts](https://github.com/user-attachments/assets/5e3b4272-d12a-4524-9c6e-669d1dd32ffb) + +Supernova offers several quality-of-life improvements: - Predefined filter categories for quick, one-click filtering of the alerts list using label and regex combinations. - Configurable labels for flexible alert filtering. @@ -21,6 +25,30 @@ Supernova is an enhanced UI for Prometheus Alertmanager, offering several qualit - Aggregation by customizable labels, replacing the current hardcoded region label. - Configurable URL patterns for automatic linking in labels (replacing the current hardcoded patterns). +## Screenshots + +Alert detail: +![supernova_alerts_details](https://github.com/user-attachments/assets/232059cd-61e6-4140-8d07-775c5145caaf) + +Silence information per alert: + +![supernova_alerts_details_silences](https://github.com/user-attachments/assets/33e192dd-759b-441c-8fd2-2b94164d7b74) + +## Getting Started + +### Docker image + +We publish a self-hostable docker image [in our registry](https://github.com/cloudoperators/juno/pkgs/container/juno-app-supernova). The README for it can be found [here in the docker folder](https://github.com/cloudoperators/juno/tree/main/apps/supernova/docker) + +### Dev mode + +To start Supernova in dev mode, make a copy of the included `secretProps_sample.js` file, rename it `secretProps.js` and enter your configuration options (see below). Then: + +```shell +npm i +npm run dev +``` + ## Concepts ### Alerts