From dd42da343f11c0c46a67e568b645c5d951a9d90d Mon Sep 17 00:00:00 2001 From: Tarun Pothulapati Date: Wed, 28 Oct 2020 07:30:40 +0530 Subject: [PATCH] docs: Update external prom and grafana readme (#5142) * docs: Update external prom and grafana readme Update `Values.yaml` to make it more clear about reverse proxy configuration with external grafana instances. Also, adds `global.prometheusUrl` and `global.grafanaUrl` into charts `README` Signed-off-by: Tarun Pothulapati --- charts/linkerd2/README.md | 2 ++ charts/linkerd2/values.yaml | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/charts/linkerd2/README.md b/charts/linkerd2/README.md index 6044554c7..2e2e8f145 100644 --- a/charts/linkerd2/README.md +++ b/charts/linkerd2/README.md @@ -104,6 +104,7 @@ their default values. | `global.controllerImageVersion` | Tag for the controller container docker image | latest version | | `global.controllerLogLevel` | Log level for the control plane components | `info` | | `global.controllerNamespaceLabel` | Control plane label. Do not edit | `linkerd.io/control-plane-ns` | +| `global.grafanaUrl` | URL of external grafana instance configured with reverse proxy, used by the dashboard | | | `global.podLabels` | Additional labels to add to all pods | `{}` | | `global.podAnnotations` | Additional annotations to add to all pods | `{}` | | `global.createdByAnnotation` | Annotation label for the proxy create. Do not edit. | `linkerd.io/created-by` | @@ -113,6 +114,7 @@ their default values. | `global.linkerdNamespaceLabel` | Control plane label. Do not edit | `linkerd.io/is-control-plane` | | `global.linkerdVersion` | Control plane version | latest version | | `global.namespace` | Control plane namespace | `linkerd` | +| `global.prometheusUrl` | URL of external prometheus instance to perform queries, used by the `public-api` | | | `global.proxy.enableExternalProfiles` | Enable service profiles for non-Kubernetes services | `false` | | `global.proxy.image.name` | Docker image for the proxy | `ghcr.io/linkerd/proxy` | | `global.proxy.image.pullPolicy` | Pull policy for the proxy container Docker image | `IfNotPresent` | diff --git a/charts/linkerd2/values.yaml b/charts/linkerd2/values.yaml index 65fe05a77..7eeb7bb7a 100644 --- a/charts/linkerd2/values.yaml +++ b/charts/linkerd2/values.yaml @@ -41,7 +41,7 @@ global: # url of existing prometheus prometheusUrl: "" - # url of external grafana instance. + # url of external grafana instance with reverse proxy configured grafanaUrl: "" # Additional annotations to add to all pods