This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
= alertmanager-matrix
image::https://img.shields.io/badge/Version-0.1.8-informational?style=flat-square[Version: 0.1.8]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
image::https://img.shields.io/badge/AppVersion-0.4.3-informational?style=flat-square[AppVersion: 0.4.3]
== Maintainers
.Maintainers
|===
| Name | Email | Url
| WrenIX
|
| <https://wrenix.eu>
|===
== Usage
Helm must be installed and setup to your kubernetes cluster to use the charts.
Refer to Helm's https://helm.sh/docs[documentation] to get started.
Once Helm has been set up correctly, fetch the charts as follows:
[source,bash]
----
helm pull oci://codeberg.org/wrenix/helm-charts/alertmanager-matrix
----
You can install a chart release using the following command:
[source,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:
[source,bash]
----
helm uninstall alertmanager-matrix-release
----
== Values
.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 <font color=\"{{.StatusString|color}}\">\n {{.StatusString|icon}}\n <b>{{.StatusString|upper}}</b>\n {{.AlertName}}:\n </font>\n {{.Summary}}\n {{if ne .Fingerprint \"\"}}\n ({{.Fingerprint}})\n {{end}}\n {{if $.ShowLabels}}\n <br/>\n <b>Labels:</b>\n <code>{{.LabelString}}</code>\n {{end}}\n <br/>\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
| `"docker.io"`
|
| image.repository
| string
| `"silkeh/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 https://github.com/norwoodj/helm-docs[helm-docs]
