Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Helm: add NOTES.txt #2189

Merged
merged 3 commits into from
Jun 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions operations/helm/charts/mimir-distributed/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,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
Original file line number Diff line number Diff line change
@@ -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" $ }}