From 0d12449bd8725d9c4caa85b34224667285e28cb0 Mon Sep 17 00:00:00 2001 From: WrenIX Date: Tue, 12 Nov 2024 12:24:16 +0100 Subject: [PATCH] fix(alertmanager-matrix): add README in markdown --- alertmanager-matrix/Chart.yaml | 2 +- alertmanager-matrix/README.adoc | 2 +- alertmanager-matrix/README.md | 110 ++++++++++++++++++++++++++++++++ 3 files changed, 112 insertions(+), 2 deletions(-) create mode 100644 alertmanager-matrix/README.md diff --git a/alertmanager-matrix/Chart.yaml b/alertmanager-matrix/Chart.yaml index b130833..2195783 100644 --- a/alertmanager-matrix/Chart.yaml +++ b/alertmanager-matrix/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: alertmanager-matrix description: Service for managing and receiving Alertmanager alerts on Matrix type: application -version: 0.1.10 +version: "0.1.11" # renovate: image=docker.io/silkeh/alertmanager_matrix appVersion: "0.5.0" maintainers: diff --git a/alertmanager-matrix/README.adoc b/alertmanager-matrix/README.adoc index 1c44122..55dd37b 100644 --- a/alertmanager-matrix/README.adoc +++ b/alertmanager-matrix/README.adoc @@ -2,7 +2,7 @@ = alertmanager-matrix -image::https://img.shields.io/badge/Version-0.1.10-informational?style=flat-square[Version: 0.1.10] +image::https://img.shields.io/badge/Version-0.1.11-informational?style=flat-square[Version: 0.1.11] image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application] image::https://img.shields.io/badge/AppVersion-0.5.0-informational?style=flat-square[AppVersion: 0.5.0] == Maintainers diff --git a/alertmanager-matrix/README.md b/alertmanager-matrix/README.md new file mode 100644 index 0000000..ddb4ed3 --- /dev/null +++ b/alertmanager-matrix/README.md @@ -0,0 +1,110 @@ +--- +title: "alertmanager-matrix" + +description: "Service for managing and receiving Alertmanager alerts on Matrix" + +--- + +# alertmanager-matrix + +![Version: 0.1.11](https://img.shields.io/badge/Version-0.1.11-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.5.0](https://img.shields.io/badge/AppVersion-0.5.0-informational?style=flat-square) + +Service for managing and receiving Alertmanager alerts on Matrix + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| WrenIX | | | + +## Usage + +Helm must be installed and setup to your kubernetes cluster to use the charts. +Refer to Helm's [documentation](https://helm.sh/docs) to get started. +Once Helm has been set up correctly, fetch the charts as follows: + +```bash +helm pull oci://codeberg.org/wrenix/helm-charts/alertmanager-matrix +``` + +You can install a chart release using the following command: + +```bash +helm install alertmanager-matrix-release oci://codeberg.org/wrenix/helm-charts/alertmanager-matrix --values values.yaml +``` + +To uninstall a chart release use `helm`'s delete command: + +```bash +helm uninstall alertmanager-matrix-release +``` + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| bot.alertmanager | string | `"http://localhost:9093"` | | +| bot.colors.alert | string | `"black"` | | +| bot.colors.critical | string | `"red"` | | +| bot.colors.error | string | `"red"` | | +| bot.colors.info | string | `"blue"` | | +| bot.colors.information | string | `"blue"` | | +| bot.colors.resolved | string | `"green"` | | +| bot.colors.silenced | string | `"gray"` | | +| bot.colors.warning | string | `"orange"` | | +| bot.icons.alert | string | `"🔔ī¸"` | | +| bot.icons.critical | string | `"🚨"` | | +| bot.icons.error | string | `"🚨"` | | +| bot.icons.info | string | `"ℹī¸"` | | +| bot.icons.information | string | `"ℹī¸"` | | +| bot.icons.resolved | string | `"✅"` | | +| bot.icons.silenced | string | `"🔕"` | | +| bot.icons.warning | string | `"⚠ī¸"` | | +| bot.matrix.homeserver | string | `"http://localhost:8008"` | | +| bot.matrix.rooms[0] | string | `"!not_existing:matrix.org"` | | +| bot.matrix.rooms[1] | string | `"!also_not_existing:matrix.org"` | | +| bot.matrix.token | string | `"SECRET_TOKEN"` | | +| bot.matrix.userID | string | `"bot"` | | +| bot.messageType | string | `"m.notice"` | | +| bot.showLabels | bool | `false` | | +| bot.template.html | string | `"{{ range .Alerts }}\n \n {{.StatusString|icon}}\n {{.StatusString|upper}}\n {{.AlertName}}:\n \n {{.Summary}}\n {{if ne .Fingerprint \"\"}}\n ({{.Fingerprint}})\n {{end}}\n {{if $.ShowLabels}}\n
\n Labels:\n {{.LabelString}}\n {{end}}\n
\n{{- end -}}\n"` | | +| bot.template.text | string | `"{{ range .Alerts }}\n {{- .StatusString|icon}} {{ .StatusString|upper }}{{ .AlertName }}: {{ .Summary }} {{ if ne .Fingerprint \"\" -}}\n ({{.Fingerprint}})\n {{- end}}\n {{- if $.ShowLabels -}}\n , labels:\n {{- .LabelString}}\n {{- end }}\n{{ end -}}\n"` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.registry | string | `"registry.gitlab.com"` | | +| image.repository | string | `"wrenix/alertmanager_matrix"` | | +| image.tag | string | `""` | | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| logging.additionalFilters | list | `[]` | Add other filters to Flow | +| logging.dedot | string | `nil` | if an filter (here or global) for dedot is active - for disable set `null` | +| logging.enabled | bool | `false` | Deploy Flow for logging-operator | +| logging.globalOutputRefs | list | `["default"]` | Flows globalOutputRefs for use of ClusterOutputs | +| logging.localOutputRefs | list | `[]` | Flows localOutputRefs for use of Outputs | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| podLabels | object | `{}` | | +| podSecurityContext | object | `{}` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| service.port | int | `4051` | | +| service.type | string | `"ClusterIP"` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `""` | | +| tolerations | list | `[]` | | + +Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)