Skip to content

viz: make prom checks dynamic by using annotations #5680

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.

Sign up for GitHub

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

Merged
Pothulapati merged 12 commits into from
Feb 12, 2021
Merged

viz: make prom checks dynamic by using annotations #5680

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
11635b8
Add new external-* annotations to linkerd-viz namespace
Pothulapati Feb 8, 2021
95938d3
update to check to use the newly added annotations
Pothulapati Feb 8, 2021
3d45307
use vizNamespace.Name everywhere
Pothulapati Feb 8, 2021
d8fd4d8
use externalPrometheus and externalGrafana fields
Pothulapati Feb 9, 2021
deb7570
remove grafana checks as they are not useful
Pothulapati Feb 11, 2021
08b8697
Merge branch 'main' into tarun/dynamic-prom-grafana-checks
Pothulapati Feb 11, 2021
190e051
update golden tests after merge
Pothulapati Feb 11, 2021
b05652c
Merge branch 'main' into tarun/dynamic-prom-grafana-checks
Pothulapati Feb 11, 2021
6f2576c
Merge branch 'main' into tarun/dynamic-prom-grafana-checks
Pothulapati Feb 11, 2021
709482f
update golden tests after merge
Pothulapati Feb 11, 2021
7ab79ed
Merge branch 'main' into tarun/dynamic-prom-grafana-checks
Pothulapati Feb 12, 2021
3ecb68d
update golden tests after merge
Pothulapati Feb 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion charts/linkerd2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,6 @@ Kubernetes: `>=1.13.0-0`
| global.controllerNamespaceLabel | string | `"linkerd.io/control-plane-ns"` | Control plane label. Do not edit |
| global.createdByAnnotation | string | `"linkerd.io/created-by"` | Annotation label for the proxy create. Do not edit. |
| global.enableEndpointSlices | bool | `false` | enables the use of EndpointSlice informers for the destination service; enableEndpointSlices should be set to true only if EndpointSlice K8s feature gate is on; the feature is still experimental. |
| global.grafanaUrl | string | `""` | url of external grafana instance with reverse proxy configured. |
| global.identityTrustAnchorsPEM | string | `""` | Trust root certificate (ECDSA). It must be provided during install. |
| global.identityTrustDomain | string | `"cluster.local"` | Trust domain used for identity |
| global.imagePullPolicy | string | `"IfNotPresent"` | Docker image pull policy |
Expand Down
3 changes: 0 additions & 3 deletions charts/linkerd2/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,6 @@ global:
# -- Trust domain used for identity
identityTrustDomain: *cluster_domain

# -- url of external grafana instance with reverse proxy configured.
grafanaUrl: ""

# -- Additional annotations to add to all pods
podAnnotations: {}

Expand Down
1 change: 1 addition & 0 deletions viz/charts/linkerd-viz/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ Kubernetes: `>=1.13.0-0`
| grafana.resources.cpu.request | string | `nil` | Amount of CPU units that the grafana container requests |
| grafana.resources.memory.limit | string | `nil` | Maximum amount of memory that grafana container can use |
| grafana.resources.memory.request | string | `nil` | Amount of memory that the grafana container requests |
| grafanaUrl | string | `""` | url of external grafana instance with reverse proxy configured. |
| identityTrustDomain | string | `"cluster.local"` | Trust domain used for identity |
| imagePullSecrets | list | `[]` | For Private docker registries, authentication is needed. Registry secrets are applied to the respective service accounts |
| installNamespace | bool | `true` | Set to false when installing in a custom namespace. |
Expand Down
6 changes: 6 additions & 0 deletions viz/charts/linkerd-viz/templates/namespace.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,11 @@ metadata:
labels:
{{.Values.extensionAnnotation}}: linkerd-viz
annotations:
{{- if .Values.prometheusUrl }}
viz.linkerd.io/external-prometheus: {{.Values.prometheusUrl}}
{{- end }}
{{- if .Values.grafanaUrl }}

@Pothulapati Pothulapati Feb 8, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This logic i.e assuming linkerd-grafana is presently based on the absence of this annotation does not really work with grafana because both being absent case is allowed here. Should we make disabled an explicit annotation then?

viz.linkerd.io/external-grafana: {{.Values.grafanaUrl}}
{{- end }}
{{.Values.proxyInjectAnnotation}}: enabled
{{ end -}}
3 changes: 3 additions & 0 deletions viz/charts/linkerd-viz/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ enablePodAntiAffinity: false
# -- url of external prometheus instance
prometheusUrl: ""

# -- url of external grafana instance with reverse proxy configured.
grafanaUrl: ""

# -- url of external jaeger instance
# Set this to `jaeger.linkerd-jaeger.svc.<clusterDomain>` if you plan to use jaeger extension
jaegerUrl: ""
Expand Down
7 changes: 7 additions & 0 deletions viz/cmd/install_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,13 @@ func TestRender(t *testing.T) {
},
"install_proxy_resources.golden",
},
{
map[string]interface{}{
"grafana": map[string]interface{}{"enabled": false},
"grafanaUrl": "external-grafana.com",
},
"install_grafana_disabled.golden",
},
}

for i, tc := range testCases {
Expand Down
Loading