feat: update readme

snapp-incubator · Sep 2, 2024 · 14ea0f0 · 14ea0f0
1 parent 32cc573
commit 14ea0f0
Showing 1 changed file with 19 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,6 @@
 # Event Exporter
 
-A prometheus exporter for exporting k8s events.
-
-
+A Prometheus exporter for exporting k8s events.
 
 ## Build
 
@@ -12,7 +10,6 @@ A prometheus exporter for exporting k8s events.
 docker build -t event-exporter .
 ```
 
-
 ### Binary
 
 ```bash
@@ -25,21 +22,13 @@ go build
 
 ### Docker
 
-
 ```bash
 docker run -p 8080:8080 ghcr.io/snapp-incubator/event-exporter:main
 ```
 
 ### Helm chart
 
-* Prerequisites
-  * **Helm 3.0+** (Helm 2 is not supported)
-  * **Kubernetes 1.10+** - This is the earliest version of Kubernetes tested.
-    It is possible that this chart works with earlier versions but it is
-    untested.
-
-
-1. Add the HashiCorp Helm Repository:
+1. Add the Event Exporter Helm Repository:
 
 ```bash
 helm repo add snapp-cab https://snapp-cab.github.io/event-exporter/charts
@@ -62,31 +51,31 @@ tar xvzf event-exporter-${VERSION}.linux-amd64.tar.gz event-exporter-${VERSION}.
 
 ## Metrics and events
 
-
-| Metric                                          | Notes
-|-------------------------------------------------|------------------------------------
-| event_normal_k8s   | Normal k8s events. Labels: kind, namespace, reason, source_components
-| event_warning_k8s  | Warning k8s events. Labels: kind, namespace, reason, source_components
-
+|       Metric        | Notes               | Labels                                             |
+| :-----------------: | :------------------ | :------------------------------------------------- |
+| `event_normal_k8s`  | Normal k8s events.  | `kind`, `namespace`, `reason`, `source_components` |
+| `event_warning_k8s` | Warning k8s events. | `kind`, `namespace`, `reason`, `source_components` |
 
 ### Event reasons
 
-| Kind                                            | Reason
-|-------------------------------------------------|------------------------------------
-| Pod (Normal)            | Scheduled, Pulling, Pulled, Created, Started
-| Pod (Warning)           | BackOff, Unhealthy, FailedMount
-| ReplicationController   | SuccessfulCreate
-| DeploymentConfig        | DeploymentCreated
-| DaemonSet               | FailedCreate
-| StatefulSet             | FailedCreate
-| HorizontalPodAutoscaler | FailedGetResourceMetric
-| Node                    | Rebooted, NodeNotReady, HostPortConflict
+| Kind                    | Reason                                       |
+| ----------------------- | -------------------------------------------- |
+| Pod (Normal)            | Scheduled, Pulling, Pulled, Created, Started |
+| Pod (Warning)           | BackOff, Unhealthy, FailedMount              |
+| ReplicationController   | SuccessfulCreate                             |
+| DeploymentConfig        | DeploymentCreated                            |
+| DaemonSet               | FailedCreate                                 |
+| StatefulSet             | FailedCreate                                 |
+| HorizontalPodAutoscaler | FailedGetResourceMetric                      |
+| Node                    | Rebooted, NodeNotReady, HostPortConflict     |
 
 ## Security
 
 ### Reporting security vulnerabilities
 
-If you find a security vulnerability or any security related issues, please DO NOT file a public issue, instead send your report privately to cloud@snapp.cab. Security reports are greatly appreciated and we will publicly thank you for it.
+If you find a security vulnerability or any security related issues, please DO NOT file a public issue,
+instead send your report privately to cloud@snapp.cab.
+Security reports are greatly appreciated, and we will publicly thank you for it.
 
 ## License