-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
* Stop shipping grafana-based image Fixes #6045 #7358 With this change we stop building a Grafana-based image preloaded with the Linkerd Grafana dashboards. Instead, we'll recommend users to install Grafana by themselves, and we provide a file `grafana/values.yaml` with a default config that points to all the same Grafana dashboards we had, which are now hosted in https://grafana.com/orgs/linkerd/dashboards . The new file `grafana/README.md` contains instructions for installing the official Grafana Helm chart, and mentions other available methods. The `grafana.enabled` flag has been removed, and `grafanaUrl` has been moved to `grafana.url`. This will help consolidating other grafana settings that might emerge, in particular when #7429 gets addressed. ## Dashboards definitions changes The dashboard definitions under `grafana/dashboards` (which should be kept in sync with what's published in https://grafana.com/orgs/linkerd/dashboards), got updated, adding the `__inputs`, `__elements` and `__requires` entries at the beginning, that were required in order to be published.
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,7 +24,6 @@ jobs: | |
- cni-plugin | ||
- controller | ||
- debug | ||
- grafana | ||
- jaeger-webhook | ||
- metrics-api | ||
- proxy | ||
|
This file was deleted.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Using Grafana with Linkerd | ||
|
||
You can install Grafana in various ways, like using the [Grafana official Helm | ||
chart](https://github.com/grafana/helm-charts/tree/main/charts/grafana), or the | ||
[Grafana Operator](https://github.com/grafana-operator/grafana-operator). Hosted | ||
solutions are also available, like [Grafana | ||
Cloud](https://grafana.com/products/cloud/). | ||
|
||
The file `grafana/values.yaml` provides a default Helm config for the [Grafana | ||
official Helm | ||
chart](https://github.com/grafana/helm-charts/tree/main/charts/grafana), which | ||
pulls the Linkerd dashboards published at | ||
<https://grafana.com/orgs/linkerd/dashboards>. | ||
|
||
You can install the chart like this: | ||
|
||
```shell | ||
helm repo add grafana https://grafana.github.io/helm-charts | ||
helm install grafana -n grafana --create-namespace grafana/grafana \ | ||
-f https://raw.githubusercontent.com/linkerd/linkerd2/main/grafana/values.yaml | ||
``` | ||
|
||
Please make sure to update the entries in `grafana/values.yaml` before using the | ||
file; in particular: | ||
|
||
- auth and log settings under `grafana.ini` | ||
- `datasources.datasources.yaml.datasources[0].url` should point to your | ||
Prometheus service | ||
|
||
The other installation methods can easily import those same dashboards using | ||
their IDs, as listed in `grafana/values.yaml`. | ||
|
||
In order to have the Linkerd Viz Dashboard show the Grafana icon there where | ||
relevant, and have it link to the appropriate Grafana dashboard, make sure you | ||
have a proper location set up in the `grafana.url` setting in Linkerd Viz's | ||
`values.yaml`. | ||
|
||
## Note to developers | ||
|
||
The `grafana/dashboards` directory contains the same dashboard definitions | ||
published under <https://grafana.com/orgs/linkerd>. Please keep them in sync when | ||
making any changes. After logging into grafana.com (using the linkerd account), | ||
the dashboards can be managed under Org Settings -> My Dashboards. |