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

Helm: add NOTES.txt #2189

merged 3 commits into from Jun 23, 2022

Conversation

krajorama
Copy link
Contributor

@krajorama krajorama commented Jun 23, 2022

What this PR does

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

Which issue(s) this PR fixes or relates to

N/A

Checklist

  • [N/A] Tests updated - not possible at the moment
  • [N/A] Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

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>
Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
Actually /prometheus is configurable, use its template

Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
@krajorama krajorama added the helm label Jun 23, 2022
@krajorama
Copy link
Contributor Author

Rendered output for my gem install:

$ helm -n dev upgrade krajogem ~/go/github.com/grafana/mimir/operations/helm/charts/mimir-distributed -f gem.yaml
[cut]
NOTES:
Welcome to Grafana Enterprise Metrics!

Remote write endpoints for Prometheus or Grafana Agent:
From outside the cluster via ingress:
  http://enterprise-metrics.krajo/api/v1/push

From inside the cluster:
  http://krajogem-enterprise-metrics-gateway.dev.svc:80/api/v1/push

Read address, Grafana data source (Prometheus) URL:
From outside the cluster via ingress:
  http://enterprise-metrics.krajo/prometheus

From inside the cluster:
  http://krajogem-enterprise-metrics-gateway.dev.svc:80/prometheus

Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@krajorama
Copy link
Contributor Author

From the CI test:

2022-06-23T08:58:48.4538001Z Welcome to Grafana Mimir!
2022-06-23T08:58:48.4538225Z 
2022-06-23T08:58:48.4538446Z Remote write endpoints for Prometheus or Grafana Agent:
2022-06-23T08:58:48.4538831Z Ingress is not enabled, see nginx.ingress values.
2022-06-23T08:58:48.4539173Z From inside the cluster:
2022-06-23T08:58:48.4539800Z   http://mimir-distributed-mvlsf1jk2z-nginx.mimir-distributed-mvlsf1jk2z.svc:80/api/v1/push
2022-06-23T08:58:48.4540226Z 
2022-06-23T08:58:48.4540558Z Read address, Grafana data source (Prometheus) URL:
2022-06-23T08:58:48.4540951Z Ingress is not enabled, see nginx.ingress values.
2022-06-23T08:58:48.4541291Z From inside the cluster:
2022-06-23T08:58:48.4596656Z   http://mimir-distributed-mvlsf1jk2z-nginx.mimir-distributed-mvlsf1jk2z.svc:80/prometheus

@krajorama krajorama merged commit b45d2c1 into main Jun 23, 2022
@krajorama krajorama deleted the krajo/20220623-helm-notes branch June 23, 2022 09:57
@osg-grafana
Copy link
Contributor

osg-grafana commented Jun 23, 2022

Small nit, add "the" in from of "values".

masonmei pushed a commit to udmire/mimir that referenced this pull request Jul 11, 2022
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants