Skip to content

Commit

Permalink
Helm: add NOTES.txt (grafana#2189)
Browse files Browse the repository at this point in the history
* Helm: add NOTES.txt

Add a NOTES.txt that prints the endpoints that will be usable by the user
for interacting with mimir/gem.

Currently helm does not support rendering the NOTES for testing.
Rage/vote here: helm/helm#6901

Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
  • Loading branch information
krajorama authored and mason committed Jul 11, 2022
1 parent 1b39cbe commit 6bd4bab
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
1 change: 1 addition & 0 deletions operations/helm/charts/mimir-distributed/CHANGELOG.md
Expand Up @@ -41,6 +41,7 @@ Entries should include a reference to the Pull Request that introduced the chang
* [ENHANCEMENT] Enable `-config.expand-env=true` option in all Mimir services to be able to take secrets/settings from the environment and inject them into the Mimir configuration file. #2017
* [ENHANCEMENT] Add a simple test for enterprise installation #2027
* [ENHANCEMENT] Check for the containerSecurityContext in values file. #2112
* [ENHANCEMENT] Add `NOTES.txt` to show endpoints URLs for the user at install/upgrade. #2189


## 2.1.0-beta.7
Expand Down
33 changes: 33 additions & 0 deletions operations/helm/charts/mimir-distributed/templates/NOTES.txt
@@ -0,0 +1,33 @@
{{- $gateway := .Values.nginx }}
{{- if .Values.enterprise.enabled }}
{{- $gateway = .Values.gateway }}
Welcome to Grafana Enterprise Metrics!
{{- else }}
Welcome to Grafana Mimir!
{{- end }}

Remote write endpoints for Prometheus or Grafana Agent:
{{ with $gateway.ingress -}}
{{- if .enabled -}}
From outside the cluster via ingress:
{{ range .hosts }} http{{ if .tls }}s{{ end }}://{{ .host }}/api/v1/push
{{ end }}
{{- else -}}
Ingress is not enabled, see {{ if $.Values.enterprise.enabled }}gateway{{ else }}nginx{{ end }}.ingress values.
{{- end -}}
{{- end }}
From inside the cluster:
http://{{ include "mimir.fullname" $ }}-{{ if .Values.enterprise.enabled }}gateway{{ else }}nginx{{ end }}.{{ .Release.Namespace }}.svc:{{ $gateway.service.port | default "80" }}/api/v1/push

Read address, Grafana data source (Prometheus) URL:
{{ with $gateway.ingress -}}
{{- if .enabled -}}
From outside the cluster via ingress:
{{ range .hosts }} http{{ if .tls }}s{{ end }}://{{ .host }}{{ template "mimir.prometheusHttpPrefix" $ }}
{{ end }}
{{- else -}}
Ingress is not enabled, see {{ if $.Values.enterprise.enabled }}gateway{{ else }}nginx{{ end }}.ingress values.
{{- end -}}
{{- end }}
From inside the cluster:
http://{{ include "mimir.fullname" $ }}-{{ if .Values.enterprise.enabled }}gateway{{ else }}nginx{{ end }}.{{ .Release.Namespace }}.svc:{{ $gateway.service.port | default "80" }}{{ template "mimir.prometheusHttpPrefix" $ }}

0 comments on commit 6bd4bab

Please sign in to comment.