Merge pull request #33 from portefaix/feat/annotations-a8r.io

Annotations a8r
portefaix · Apr 27, 2021 · 5625753 · 5625753
2 parents f5158bc + e322e2d
commit 5625753
Show file tree

Hide file tree

Showing 32 changed files with 203 additions and 14 deletions.
diff --git a/charts/grafana-mixin/Chart.yaml b/charts/grafana-mixin/Chart.yaml
@@ -28,7 +28,7 @@ keywords:
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.2.0
+version: 0.3.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/charts/grafana-mixin/README.md b/charts/grafana-mixin/README.md
@@ -1,6 +1,6 @@
 # grafana-mixin
 
-![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 7.4.3](https://img.shields.io/badge/AppVersion-7.4.3-informational?style=flat-square)
+![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 7.4.3](https://img.shields.io/badge/AppVersion-7.4.3-informational?style=flat-square)
 
 A Helm chart for Grafana Mixin
 

diff --git a/charts/grafana-mixin/templates/_helpers.tpl b/charts/grafana-mixin/templates/_helpers.tpl
@@ -54,6 +54,27 @@ app.kubernetes.io/part-of: {{ include "grafana-mixin.name" . }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{- end }}
 
+{{/* See: https://ambassadorlabs.github.io/k8s-for-humans/ */}}
+{{/*
+Common annotations 
+*/}}
+{{- define "grafana-mixin.annotations" -}}
+a8r.io/description: Monitoring Mixin for Grafana
+a8r.io/owner: portefaix
+a8r.io/bugs: https://github.com/portefaix/portefaix-hub/issues
+a8r.io/documentation: https://artifacthub.io/packages/helm/portefaix-hub/grafana-mixin
+a8r.io/repository: https://github.com/portefaix/portefaix-hub
+a8r.io/support: https://github.com/portefaix/portefaix-hub/issues
+{{- end }}
+
+{{/* a8r.io/logs: */}}
+{{/* a8r.io/runbook: */}}
+{{/* a8r.io/incidents:  */}}
+{{/* a8r.io/uptime */}}
+{{/* a8r.io/performance */}}
+{{/* a8r.io/dependencies */}}
+
+
 {{/*
 Allow the release namespace to be overridden
 */}}

diff --git a/charts/grafana-mixin/templates/alerts.yaml b/charts/grafana-mixin/templates/alerts.yaml
@@ -3,6 +3,11 @@ apiVersion: monitoring.coreos.com/v1
 kind: PrometheusRule
 metadata:
   name: {{ printf "%s-%s" (include "grafana-mixin.fullname" .) "alerts" | trunc 63 | trimSuffix "-" }}
+  annotations:
+{{ include "grafana-mixin.annotations" . | indent 4 }}
+{{- if .Values.additionalAnnotations }}
+{{ toYaml .Values.additionalAnnotations | indent 4 }}
+{{- end }}
   labels:
     app: {{ include "grafana-mixin.name" . }}
 {{ include "grafana-mixin.labels" . | indent 4 }}

diff --git a/charts/grafana-mixin/templates/rules.yaml b/charts/grafana-mixin/templates/rules.yaml
@@ -3,6 +3,11 @@ apiVersion: monitoring.coreos.com/v1
 kind: PrometheusRule
 metadata:
   name: {{ printf "%s-%s" (include "grafana-mixin.fullname" .) "rules" | trunc 63 | trimSuffix "-" }}
+  annotations:
+{{ include "grafana-mixin.annotations" . | indent 4 }}
+{{- if .Values.additionalAnnotations }}
+{{ toYaml .Values.additionalAnnotations | indent 4 }}
+{{- end }}
   labels:
     app: {{ include "grafana-mixin.name" . }}
 {{ include "grafana-mixin.labels" . | indent 4 }}

diff --git a/charts/kube-state-metrics-mixin/Chart.yaml b/charts/kube-state-metrics-mixin/Chart.yaml
@@ -28,7 +28,7 @@ keywords:
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.2.0
+version: 0.3.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/charts/kube-state-metrics-mixin/README.md b/charts/kube-state-metrics-mixin/README.md
@@ -1,6 +1,6 @@
 # kube-state-metrics-mixin
 
-![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.0.0-rc0](https://img.shields.io/badge/AppVersion-2.0.0--rc0-informational?style=flat-square)
+![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.0.0-rc0](https://img.shields.io/badge/AppVersion-2.0.0--rc0-informational?style=flat-square)
 
 A Helm chart for Kube-State-Metrics Mixin
 

diff --git a/charts/kube-state-metrics-mixin/templates/_helpers.tpl b/charts/kube-state-metrics-mixin/templates/_helpers.tpl
@@ -54,6 +54,26 @@ app.kubernetes.io/part-of: {{ include "kube-state-metrics-mixin.name" . }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{- end }}
 
+{{/* See: https://ambassadorlabs.github.io/k8s-for-humans/ */}}
+{{/*
+Common annotations 
+*/}}
+{{- define "kube-state-metrics-mixin.annotations" -}}
+a8r.io/description: Monitoring Mixin for kube-state-metrics
+a8r.io/owner: portefaix
+a8r.io/bugs: https://github.com/portefaix/portefaix-hub/issues
+a8r.io/documentation: https://artifacthub.io/packages/helm/portefaix-hub/kube-state-metrics-mixin
+a8r.io/repository: https://github.com/portefaix/portefaix-hub
+a8r.io/support: https://github.com/portefaix/portefaix-hub/issues
+{{- end }}
+
+{{/* a8r.io/logs: */}}
+{{/* a8r.io/runbook: */}}
+{{/* a8r.io/incidents:  */}}
+{{/* a8r.io/uptime */}}
+{{/* a8r.io/performance */}}
+{{/* a8r.io/dependencies */}}
+
 {{/*
 Allow the release namespace to be overridden
 */}}

diff --git a/charts/kube-state-metrics-mixin/templates/alerts.yaml b/charts/kube-state-metrics-mixin/templates/alerts.yaml
@@ -3,6 +3,11 @@ apiVersion: monitoring.coreos.com/v1
 kind: PrometheusRule
 metadata:
   name: {{ printf "%s-%s" (include "kube-state-metrics-mixin.fullname" .) "alerts" | trunc 63 | trimSuffix "-" }}
+  annotations:
+{{ include "kube-state-metrics-mixin.annotations" . | indent 4 }}
+{{- if .Values.additionalAnnotations }}
+{{ toYaml .Values.additionalAnnotations | indent 4 }}
+{{- end }}
   labels:
     app: {{ include "kube-state-metrics-mixin.name" . }}
 {{ include "kube-state-metrics-mixin.labels" . | indent 4 }}

diff --git a/charts/loki-mixin/Chart.yaml b/charts/loki-mixin/Chart.yaml
@@ -28,7 +28,7 @@ keywords:
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.3.0
+version: 0.4.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/charts/loki-mixin/README.md b/charts/loki-mixin/README.md
@@ -1,6 +1,6 @@
 # loki-mixin
 
-![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.2.0](https://img.shields.io/badge/AppVersion-2.2.0-informational?style=flat-square)
+![Version: 0.4.0](https://img.shields.io/badge/Version-0.4.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.2.0](https://img.shields.io/badge/AppVersion-2.2.0-informational?style=flat-square)
 
 A Helm chart for loki Mixin
 

diff --git a/charts/loki-mixin/templates/_helpers.tpl b/charts/loki-mixin/templates/_helpers.tpl
@@ -54,6 +54,26 @@ app.kubernetes.io/part-of: {{ include "loki-mixin.name" . }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{- end }}
 
+{{/* See: https://ambassadorlabs.github.io/k8s-for-humans/ */}}
+{{/*
+Common annotations 
+*/}}
+{{- define "loki-mixin.annotations" -}}
+a8r.io/description: Monitoring Mixin for Loki
+a8r.io/owner: portefaix
+a8r.io/bugs: https://github.com/portefaix/portefaix-hub/issues
+a8r.io/documentation: https://artifacthub.io/packages/helm/portefaix-hub/loki-mixin
+a8r.io/repository: https://github.com/portefaix/portefaix-hub
+a8r.io/support: https://github.com/portefaix/portefaix-hub/issues
+{{- end }}
+
+{{/* a8r.io/logs: */}}
+{{/* a8r.io/runbook: */}}
+{{/* a8r.io/incidents:  */}}
+{{/* a8r.io/uptime */}}
+{{/* a8r.io/performance */}}
+{{/* a8r.io/dependencies */}}
+
 {{/*
 Allow the release namespace to be overridden
 */}}

diff --git a/charts/loki-mixin/templates/alerts.yaml b/charts/loki-mixin/templates/alerts.yaml
@@ -3,6 +3,11 @@ apiVersion: monitoring.coreos.com/v1
 kind: PrometheusRule
 metadata:
   name: {{ printf "%s-%s" (include "loki-mixin.fullname" .) "alerts" | trunc 63 | trimSuffix "-" }}
+  annotations:
+{{ include "loki-mixin.annotations" . | indent 4 }}
+{{- if .Values.additionalAnnotations }}
+{{ toYaml .Values.additionalAnnotations | indent 4 }}
+{{- end }}
   labels:
     app: {{ include "loki-mixin.name" . }}
 {{ include "loki-mixin.labels" . | indent 4 }}

diff --git a/charts/loki-mixin/templates/rules.yaml b/charts/loki-mixin/templates/rules.yaml
@@ -3,6 +3,11 @@ apiVersion: monitoring.coreos.com/v1
 kind: PrometheusRule
 metadata:
   name: {{ printf "%s-%s" (include "loki-mixin.fullname" .) "rules" | trunc 63 | trimSuffix "-" }}
+  annotations:
+{{ include "loki-mixin.annotations" . | indent 4 }}
+{{- if .Values.additionalAnnotations }}
+{{ toYaml .Values.additionalAnnotations | indent 4 }}
+{{- end }}
   labels:
     app: {{ include "loki-mixin.name" . }}
 {{ include "loki-mixin.labels" . | indent 4 }}

diff --git a/charts/prometheus-mixin/Chart.yaml b/charts/prometheus-mixin/Chart.yaml
@@ -28,7 +28,7 @@ keywords:
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.2.0
+version: 0.3.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/charts/prometheus-mixin/README.md b/charts/prometheus-mixin/README.md
@@ -1,6 +1,6 @@
 # prometheus-mixin
 
-![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.46.0](https://img.shields.io/badge/AppVersion-0.46.0-informational?style=flat-square)
+![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.46.0](https://img.shields.io/badge/AppVersion-0.46.0-informational?style=flat-square)
 
 A Helm chart for Prometheus Mixin
 

diff --git a/charts/prometheus-mixin/templates/_helpers.tpl b/charts/prometheus-mixin/templates/_helpers.tpl
@@ -54,6 +54,26 @@ app.kubernetes.io/part-of: {{ include "prometheus-mixin.name" . }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{- end }}
 
+{{/* See: https://ambassadorlabs.github.io/k8s-for-humans/ */}}
+{{/*
+Common annotations 
+*/}}
+{{- define "prometheus-mixin.annotations" -}}
+a8r.io/description: Monitoring Mixin for Prometheus
+a8r.io/owner: portefaix
+a8r.io/bugs: https://github.com/portefaix/portefaix-hub/issues
+a8r.io/documentation: https://artifacthub.io/packages/helm/portefaix-hub/prometheus-mixin
+a8r.io/repository: https://github.com/portefaix/portefaix-hub
+a8r.io/support: https://github.com/portefaix/portefaix-hub/issues
+{{- end }}
+
+{{/* a8r.io/logs: */}}
+{{/* a8r.io/runbook: */}}
+{{/* a8r.io/incidents:  */}}
+{{/* a8r.io/uptime */}}
+{{/* a8r.io/performance */}}
+{{/* a8r.io/dependencies */}}
+
 {{/*
 Allow the release namespace to be overridden
 */}}

diff --git a/charts/prometheus-mixin/templates/alerts.yaml b/charts/prometheus-mixin/templates/alerts.yaml
@@ -3,6 +3,11 @@ apiVersion: monitoring.coreos.com/v1
 kind: PrometheusRule
 metadata:
   name: {{ printf "%s-%s" (include "prometheus-mixin.fullname" .) "alerts" | trunc 63 | trimSuffix "-" }}
+  annotations:
+{{ include "prometheus-mixin.annotations" . | indent 4 }}
+{{- if .Values.additionalAnnotations }}
+{{ toYaml .Values.additionalAnnotations | indent 4 }}
+{{- end }}
   labels:
     app: {{ include "prometheus-mixin.name" . }}
 {{ include "prometheus-mixin.labels" . | indent 4 }}

diff --git a/charts/prometheus-operator-mixin/Chart.yaml b/charts/prometheus-operator-mixin/Chart.yaml
@@ -28,7 +28,7 @@ keywords:
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.2.0
+version: 0.3.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/charts/prometheus-operator-mixin/README.md b/charts/prometheus-operator-mixin/README.md
@@ -1,6 +1,6 @@
 # prometheus-operator-mixin
 
-![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.46.0](https://img.shields.io/badge/AppVersion-0.46.0-informational?style=flat-square)
+![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.46.0](https://img.shields.io/badge/AppVersion-0.46.0-informational?style=flat-square)
 
 A Helm chart for Prometheus Operator Mixin
 

diff --git a/charts/prometheus-operator-mixin/templates/_helpers.tpl b/charts/prometheus-operator-mixin/templates/_helpers.tpl
@@ -54,6 +54,19 @@ app.kubernetes.io/part-of: {{ include "prometheus-operator-mixin.name" . }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{- end }}
 
+{{/* See: https://ambassadorlabs.github.io/k8s-for-humans/ */}}
+{{/*
+Common annotations 
+*/}}
+{{- define "prometheus-operator-mixin.annotations" -}}
+a8r.io/description: Monitoring Mixin for Prometheus Operator
+a8r.io/owner: portefaix
+a8r.io/bugs: https://github.com/portefaix/portefaix-hub/issues
+a8r.io/documentation: https://artifacthub.io/packages/helm/portefaix-hub/prometheus-operator-mixin
+a8r.io/repository: https://github.com/portefaix/portefaix-hub
+a8r.io/support: https://github.com/portefaix/portefaix-hub/issues
+{{- end }}
+
 {{/*
 Allow the release namespace to be overridden
 */}}

diff --git a/charts/prometheus-operator-mixin/templates/alerts.yaml b/charts/prometheus-operator-mixin/templates/alerts.yaml
@@ -3,6 +3,11 @@ apiVersion: monitoring.coreos.com/v1
 kind: PrometheusRule
 metadata:
   name: {{ printf "%s-%s" (include "prometheus-operator-mixin.fullname" .) "alerts" | trunc 63 | trimSuffix "-" }}
+  annotations:
+{{ include "prometheus-operator-mixin.annotations" . | indent 4 }}
+{{- if .Values.additionalAnnotations }}
+{{ toYaml .Values.additionalAnnotations | indent 4 }}
+{{- end }}
   labels:
     app: {{ include "prometheus-operator-mixin.name" . }}
 {{ include "prometheus-operator-mixin.labels" . | indent 4 }}

diff --git a/charts/promtail-mixin/Chart.yaml b/charts/promtail-mixin/Chart.yaml
@@ -28,7 +28,7 @@ keywords:
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.3.0
+version: 0.4.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/charts/promtail-mixin/README.md b/charts/promtail-mixin/README.md
@@ -1,6 +1,6 @@
 # promtail-mixin
 
-![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.2.0](https://img.shields.io/badge/AppVersion-2.2.0-informational?style=flat-square)
+![Version: 0.4.0](https://img.shields.io/badge/Version-0.4.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.2.0](https://img.shields.io/badge/AppVersion-2.2.0-informational?style=flat-square)
 
 A Helm chart for Promtail Mixin
 

diff --git a/charts/promtail-mixin/templates/_helpers.tpl b/charts/promtail-mixin/templates/_helpers.tpl
@@ -54,6 +54,26 @@ app.kubernetes.io/part-of: {{ include "promtail-mixin.name" . }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{- end }}
 
+{{/* See: https://ambassadorlabs.github.io/k8s-for-humans/ */}}
+{{/*
+Common annotations 
+*/}}
+{{- define "promtail-mixin.annotations" -}}
+a8r.io/description: Monitoring Mixin for Promtail
+a8r.io/owner: portefaix
+a8r.io/bugs: https://github.com/portefaix/portefaix-hub/issues
+a8r.io/documentation: https://artifacthub.io/packages/helm/portefaix-hub/promtail-mixin
+a8r.io/repository: https://github.com/portefaix/portefaix-hub
+a8r.io/support: https://github.com/portefaix/portefaix-hub/issues
+{{- end }}
+
+{{/* a8r.io/logs: */}}
+{{/* a8r.io/runbook: */}}
+{{/* a8r.io/incidents:  */}}
+{{/* a8r.io/uptime */}}
+{{/* a8r.io/performance */}}
+{{/* a8r.io/dependencies */}}
+
 {{/*
 Allow the release namespace to be overridden
 */}}

diff --git a/charts/promtail-mixin/templates/alerts.yaml b/charts/promtail-mixin/templates/alerts.yaml
@@ -3,6 +3,11 @@ apiVersion: monitoring.coreos.com/v1
 kind: PrometheusRule
 metadata:
   name: {{ printf "%s-%s" (include "promtail-mixin.fullname" .) "alerts" | trunc 63 | trimSuffix "-" }}
+  annotations:
+{{ include "promtail-mixin.annotations" . | indent 4 }}
+{{- if .Values.additionalAnnotations }}
+{{ toYaml .Values.additionalAnnotations | indent 4 }}
+{{- end }}
   labels:
     app: {{ include "promtail-mixin.name" . }}
 {{ include "promtail-mixin.labels" . | indent 4 }}

diff --git a/charts/promtail-mixin/templates/rules.yaml b/charts/promtail-mixin/templates/rules.yaml
@@ -3,6 +3,11 @@ apiVersion: monitoring.coreos.com/v1
 kind: PrometheusRule
 metadata:
   name: {{ printf "%s-%s" (include "promtail-mixin.fullname" .) "rules" | trunc 63 | trimSuffix "-" }}
+  annotations:
+{{ include "promtail-mixin.annotations" . | indent 4 }}
+{{- if .Values.additionalAnnotations }}
+{{ toYaml .Values.additionalAnnotations | indent 4 }}
+{{- end }}
   labels:
     app: {{ include "promtail-mixin.name" . }}
 {{ include "promtail-mixin.labels" . | indent 4 }}

diff --git a/charts/thanos-mixin/Chart.yaml b/charts/thanos-mixin/Chart.yaml
@@ -28,7 +28,7 @@ keywords:
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.10.0
+version: 0.11.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/charts/thanos-mixin/README.md b/charts/thanos-mixin/README.md
@@ -1,6 +1,6 @@
 # thanos-mixin
 
-![Version: 0.10.0](https://img.shields.io/badge/Version-0.10.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.18.0](https://img.shields.io/badge/AppVersion-0.18.0-informational?style=flat-square)
+![Version: 0.11.0](https://img.shields.io/badge/Version-0.11.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.18.0](https://img.shields.io/badge/AppVersion-0.18.0-informational?style=flat-square)
 
 A Helm chart for Thanos Mixin