Skip to content

Commit

Permalink
Enable Slack notification customization
Browse files Browse the repository at this point in the history
  • Loading branch information
@robertvolkmann
robertvolkmann committed Aug 1, 2023
1 parent aa454a9 commit 765693e
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 39 deletions.
71 changes: 37 additions & 34 deletions control-plane/roles/monitoring/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,40 +18,43 @@ The following variables can be set to configure the role:

### General

| Name | Mandatory | Description |
|-----------------------------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| rethinkdb_exporter_name | yes | rethinkdb exporter image name |
| rethinkdb_exporter_tag | yes | rethinkdb exporter image tag |
| event_exporter_name | yes | event exporter image name |
| event_exporter_tag | yes | event exporter image tag |
| gardener_metrics_exporter_image_name | yes | gardener metrics exporter image name |
| gardener_metrics_exporter_image_tag | yes | gardener metrics exporter image tag |
| prometheus_chart_version | yes | version of the prometheus stack chart |
| prometheus_stack_repo | yes | chart of the prometheus stack |
| monitoring_namespace | | Name of the monitoring namespace |
| monitoring_ingress_grafana_tls | | If enabled, exposes Grafana through HTTPS on the ingress |
| monitoring_grafana_ingress_dns | | The dns name used for exposing Grafana via ingress |
| monitoring_prometheus_ingress_dns | | If enabled, exposes Prometheus through HTTPS on the ingress |
| monitoring_prometheus_image_tag | | Prometheus container image tag, defaults to chart's default |
| monitoring_prometheus_ingress_enabled | | Enables ingress for prometheus |
| monitoring_prometheus_storage_spec | | Prometheus storage spec, see [Storage Configuration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/storage.md) |
| monitoring_additional_ingress_annotations | | Annotations that will be attached to the ingress resource |
| monitoring_grafana_admin_password | | Sets the admin password for Grafana |
| monitoring_grafana_dashboard_timezone | | Sets the default's dashboard timezone for Grafana |
| monitoring_grafana_additional_datasources | | Configures additional datasources for Grafana |
| monitoring_grafana_github_oauth | | [Configure GitHub OAuth2 authentication](https://grafana.com/docs/grafana/latest/setup-grafana/configure-security/configure-authentication/github/) |
| monitoring_grafana_extra_secret_mounts | | Extra secret mounts |
| monitoring_slack_channel_url | | Slack channel url to add on alertmanager |
| monitoring_slack_channel | | Slack channel to add on alertmanager |
| monitoring_metal_api_url | | The URL where to reach metal-api |
| monitoring_metal_api_hmac | | The hmac to authenticate against metal-api |
| monitoring_thanos_object_store_config | | Object storage used by Thanos, see [Official Documentation](https://thanos.io/tip/thanos/storage.md/#supported-clients) |
| monitoring_thanos_receive_enabled | | Enable Thanos Receive component |
| monitoring_thanos_receive_ingress_enabled | | Enable Ingress for Thanos Receive |
| monitoring_thanos_receive_ingress_annotations | | Annotations that will be attached to the ingress resource for the Thanos Receive component |
| monitoring_thanos_receive_ingress_basic_auth | | Set basic authentication on the Ingress for Thanos Receive |
| monitoring_thanos_receive_ingress_dns | | The DNS name used for exposing Thanos Receive via Ingress |
| monitoring_thanos_receive_ingress_tls | | If enabled, exposes Thanos Receive through HTTPS on the Ingress |
| Name | Mandatory | Description |
|-----------------------------------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| rethinkdb_exporter_name | yes | rethinkdb exporter image name |
| rethinkdb_exporter_tag | yes | rethinkdb exporter image tag |
| event_exporter_name | yes | event exporter image name |
| event_exporter_tag | yes | event exporter image tag |
| gardener_metrics_exporter_image_name | yes | gardener metrics exporter image name |
| gardener_metrics_exporter_image_tag | yes | gardener metrics exporter image tag |
| prometheus_chart_version | yes | version of the prometheus stack chart |
| prometheus_stack_repo | yes | chart of the prometheus stack |
| monitoring_namespace | | Name of the monitoring namespace |
| monitoring_ingress_grafana_tls | | If enabled, exposes Grafana through HTTPS on the ingress |
| monitoring_grafana_ingress_dns | | The dns name used for exposing Grafana via ingress |
| monitoring_prometheus_ingress_dns | | If enabled, exposes Prometheus through HTTPS on the ingress |
| monitoring_prometheus_image_tag | | Prometheus container image tag, defaults to chart's default |
| monitoring_prometheus_ingress_enabled | | Enables ingress for prometheus |
| monitoring_prometheus_storage_spec | | Prometheus storage spec, see [Storage Configuration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/storage.md) |
| monitoring_additional_ingress_annotations | | Annotations that will be attached to the ingress resource |
| monitoring_grafana_admin_password | | Sets the admin password for Grafana |
| monitoring_grafana_dashboard_timezone | | Sets the default's dashboard timezone for Grafana |
| monitoring_grafana_additional_datasources | | Configures additional datasources for Grafana |
| monitoring_grafana_github_oauth | | [Configure GitHub OAuth2 authentication](https://grafana.com/docs/grafana/latest/setup-grafana/configure-security/configure-authentication/github/) |
| monitoring_grafana_extra_secret_mounts | | Extra secret mounts |
| monitoring_slack_api_url | | The URL for the Slack API, required to send alerts. This must be a valid and accessible Slack webhook URL specific to the channel where alerts will be sent. |
| monitoring_slack_notification_channel | | The name or ID of the Slack channel where the alerts will be posted. This must correspond to an existing Slack channel within the workspace defined by the `monitoring_slack_api_url`. |
| monitoring_slack_notification_icon_url | | The URL of an image that will be used as the icon for notifications in Slack. This is optional, and if not provided, the default icon will be used. The URL must be accessible by Slack and should point to a valid image file. |
| monitoring_slack_notification_title | | The title of the Slack notification. This will be used as the headline or subject of the alert and can be a static text or include dynamic content based on the alert data. |
| monitoring_slack_notification_text | | The main text body of the Slack notification. This should include the detailed information about the alert and can support Slack's formatting and templating for more structured and readable notifications. |
| monitoring_metal_api_url | | The URL where to reach metal-api |
| monitoring_metal_api_hmac | | The hmac to authenticate against metal-api |
| monitoring_thanos_object_store_config | | Object storage used by Thanos, see [Official Documentation](https://thanos.io/tip/thanos/storage.md/#supported-clients) |
| monitoring_thanos_receive_enabled | | Enable Thanos Receive component |
| monitoring_thanos_receive_ingress_enabled | | Enable Ingress for Thanos Receive |
| monitoring_thanos_receive_ingress_annotations | | Annotations that will be attached to the ingress resource for the Thanos Receive component |
| monitoring_thanos_receive_ingress_basic_auth | | Set basic authentication on the Ingress for Thanos Receive |
| monitoring_thanos_receive_ingress_dns | | The DNS name used for exposing Thanos Receive via Ingress |
| monitoring_thanos_receive_ingress_tls | | If enabled, exposes Thanos Receive through HTTPS on the Ingress |

### Gardener

Expand Down
19 changes: 14 additions & 5 deletions control-plane/roles/monitoring/templates/prometheus-stack-values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,8 @@ alertmanager:
config:
global:
resolve_timeout: 5m
{% if monitoring_slack_channel_url is defined %}
slack_api_url: "{{ monitoring_slack_channel_url }}"
{% if monitoring_slack_api_url is defined %}
slack_api_url: "{{ monitoring_slack_api_url }}"
{% endif %}
inhibit_rules: []
route:
Expand All @@ -108,7 +108,7 @@ alertmanager:
- receiver: 'null'
matchers:
- alertname=~"Watchdog|InfoInhibitor"
{% if monitoring_slack_channel_url is defined %}
{% if monitoring_slack_api_url is defined && monitoring_slack_notification_channel is defined %}
- receiver: slack
continue: true
{% endif %}
Expand All @@ -119,11 +119,20 @@ alertmanager:
send_resolved: true
max_alerts: 0 # 0=all alerts
- name: 'null'
{% if monitoring_slack_channel is defined %}
{% if monitoring_slack_api_url is defined && monitoring_slack_notification_channel is defined %}
- name: slack
slack_configs:
- channel: "{{ monitoring_slack_channel }}"
- channel: "{{ monitoring_slack_notification_channel }}"
send_resolved: true
{% if monitoring_slack_notification_icon_url %}
icon_url: "{% monitoring_slack_icon_url %}"
{% endif %}
{% if monitoring_slack_notification_title %}
title: "{% monitoring_slack_notification_title %}"
{% endif %}
{% if monitoring_slack_notification_text }
text: "{% monitoring_slack_notification_text %}"
{% endif %}
{% endif %}
templates:
- '/etc/alertmanager/config/*.tmpl'
Expand Down

0 comments on commit 765693e

Please sign in to comment.