diff --git a/charts/karma/.helmignore b/charts/karma/.helmignore new file mode 100644 index 0000000..f0c1319 --- /dev/null +++ b/charts/karma/.helmignore @@ -0,0 +1,21 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj diff --git a/charts/karma/Chart.yaml b/charts/karma/Chart.yaml new file mode 100644 index 0000000..2084a4b --- /dev/null +++ b/charts/karma/Chart.yaml @@ -0,0 +1,16 @@ +apiVersion: v2 +description: A Helm chart for Karma - an UI for Prometheus Alertmanager +name: karma +home: https://github.com/prymitive/karma +sources: + - https://github.com/wiremind/wiremind-helm-charts/tree/main/charts/karma + - https://github.com/prymitive/karma +version: 1.8.1 +appVersion: "0.85" +maintainers: + - name: desaintmartin + email: cdesaintmartin@wiremind.io + - name: machine424 + email: amrini@wiremind.io + - name: francoisminaud + email: fminaud@wiremind.io diff --git a/charts/karma/README.md b/charts/karma/README.md new file mode 100644 index 0000000..4e83739 --- /dev/null +++ b/charts/karma/README.md @@ -0,0 +1,102 @@ +# Karma + +Karma is an ASL2 licensed alert dashboard for Prometheus Alertmanager. + +## Introduction + +This chart deploys karma to your cluster via a Deployment and Service. +Optionally you can also enable ingress. + +# Prerequisites + +- Kubernetes 1.9+ + +## Installing the Chart + +To install the chart with the release name `my-release`, run: + +```bash +$ helm repo add wiremind https://wiremind.github.io/wiremind-helm-charts +$ helm install --name my-release wiremind/karma +``` + +After a few seconds, you should see service statuses being written to the configured output. + +> **Tip**: List all releases using `helm list` + +## Uninstalling the Chart + +To uninstall/delete the `my-release` deployment: + +```bash +$ helm delete my-release +``` + +The command removes all the Kubernetes components associated with the chart and deletes the release. + +## Configuration + +The values.yaml lists the configurable parameters of the karma chart and their default values. + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, + +```bash +$ helm install --name my-release \ + stable/karma +``` + +Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example, + +```bash +$ helm install --name my-release -f values.yaml stable/karma +``` + +> **Tip**: You will have to define the URL to alertmanager in env-settings in [values.yaml](values.yaml), under key ALERTMANAGER_URI . + +### Secure configuration + +If you have sensitive information in your Karma config you can wrap it in a Kubernetes Secret and then just point to the name of the Secret. + +The structure of the Secret must follow the same pattern defined in `configMap.rawConfig`, here's an example on how to generate this Secret +with your Karma configuration: + +```sh +# create a temporary file that contains your Karma configuration +cat > karma.conf <` in the karma container. +## These secrets can be used to configure TLS for Karma's Alertmanagers by passing their paths to +## the appropriate Karma configuration parameters. For example, secret `foo` containing a `ca.crt` +## will yield a file at `/etc/certs/foo/ca.crt`. That path can then be provided as the value to +# `configMap.rawConfig.alertmanager.servers[].tls.ca`. +## Ref: . +certSecretNames: []