self-hosted/teleport
self-hosted/teleport
1
0
Fork 0
mirror of https://github.com/gravitational/teleport synced 2024-10-20 17:23:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

[buddy] Add an optional PodMonitor to the teleport-kube-agent chart (#31169)

Browse source 
* feat: add in podmonitor to teleport-kube-agent helmchart

* fix: backport fixes to linting and tests to teleport-cluster chart

* docs: document the `podMonitor` field in chart references

* Apply suggestions from code review

* Lint

---------

Co-authored-by: ThameezBo <thameezbo@double.cloud>
This commit is contained in:
Hugo Shaka 2023-08-30 14:57:37 -04:00 committed by GitHub
parent 56b7c9a043
commit 313323704f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 211 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
docs/pages/reference/helm-reference/teleport-cluster.mdx
View file

@ -804,6 +804,45 @@ recommended to use one of the other modes and rely on
to inject your custom configuration.
</Admonition>
## `podMonitor`
`podMonitor` controls [the PodMonitor CR (from monitoring.coreos.com/v1)
](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.PodMonitor)
that monitors the workload (Auth and Proxy Services) deployed by the chart.
This custom resource configures Prometheus and makes it scrape Teleport metrics.
The CRD is deployed by the prometheus-operator and allows workload to
get monitored. You need to deploy the `prometheus-operator`
in the cluster prior to configuring the `podMonitor` section of the chart. See
[the prometheus-operator documentation](https://prometheus-operator.dev/docs/prologue/introduction/)
for setup instructions.
### `podMonitor.enabled`
| Type | Default value |
|--------|---------------|
| `bool` | `false` |
Whether the chart should deploy a `PodMonitor` resource. This is disabled by
default as it requires the `PodMonitor` CRD to be installed in the cluster.
### `podMonitor.additionalLabels`
| Type | Default value |
|------------------------|----------------------------|
| `object[string]string` | `{"prometheus":"default"}` |
Additional labels to put on the created PodMonitor Resource.
Those labels are used to be selected by a specific Prometheus instance.
### `podMonitor.interval`
| Type | Default value |
|----------|---------------|
| `string` | `30s` |
`interval` is the interval between two metrics scrapes by Prometheus.
## `persistence`
<Details title="Read this if using Kubernetes 1.23+ on EKS">

39
docs/pages/reference/helm-reference/teleport-kube-agent.mdx
View file

@ -1080,6 +1080,45 @@ Ensures that this number of replicas is available during voluntary disruptions,
minAvailable: 1
```
## `podMonitor`
`podMonitor` controls [the PodMonitor CR (from monitoring.coreos.com/v1)
](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.PodMonitor)
that monitors the workload (Auth and Proxy Services) deployed by the chart.
This custom resource configures Prometheus and makes it scrape Teleport metrics.
The CRD is deployed by the prometheus-operator and allows workload to
get monitored. You need to deploy the `prometheus-operator`
in the cluster prior to configuring the `podMonitor` section of the chart. See
[the prometheus-operator documentation](https://prometheus-operator.dev/docs/prologue/introduction/)
for setup instructions.
### `podMonitor.enabled`
| Type | Default value |
|--------|---------------|
| `bool` | `false` |
Whether the chart should deploy a `PodMonitor` resource. This is disabled by
default as it requires the `PodMonitor` CRD to be installed in the cluster.
### `podMonitor.additionalLabels`
| Type | Default value |
|------------------------|----------------------------|
| `object[string]string` | `{"prometheus":"default"}` |
Additional labels to put on the created PodMonitor Resource.
Those labels are used to be selected by a specific Prometheus instance.
### `podMonitor.interval`
| Type | Default value |
|----------|---------------|
| `string` | `30s` |
`interval` is the interval between two metrics scrapes by Prometheus.
## `clusterRoleName`
| Type | Default value |

6
examples/chart/teleport-cluster/.lint/podmonitor.yaml Normal file
View file

@ -0,0 +1,6 @@
clusterName: test-kube-cluster-name
podMonitor:
enabled: true
additionalLabels:
prometheus: default
interval: 30s

13
examples/chart/teleport-cluster/tests/podmonitor_test.yaml
View file

@ -3,12 +3,15 @@ templates:
- podmonitor.yaml
tests:
- it: does not create a PodMonitor by default
set:
clusterName: test-kube-cluster-name
asserts:
- hasDocuments:
count: 0
- it: creates a PodMonitor when enabled
set:
clusterName: test-kube-cluster-name
podMonitor:
enabled: true
asserts:
@ -19,6 +22,7 @@ tests:
- it: configures scrape interval if provided
set:
clusterName: test-kube-cluster-name
podMonitor:
enabled: true
interval: 2m
@ -28,12 +32,9 @@ tests:
value: 2m
- it: wears additional labels if provided
set:
podMonitor:
enabled: true
additionalLabels:
prometheus: teleport-only
asserts:
- equal:
path: metadata.labels.prometheus
value: teleport-only
value: default
values:
- ../.lint/podmonitor.yaml

7
examples/chart/teleport-kube-agent/.lint/podmonitor.yaml Normal file
View file

@ -0,0 +1,7 @@
proxyAddr: proxy.example.com:3080
kubeClusterName: test-kube-cluster-name
podMonitor:
enabled: true
additionalLabels:
prometheus: default
interval: 30s

31
examples/chart/teleport-kube-agent/templates/podmonitor.yaml Normal file
View file

@ -0,0 +1,31 @@
{{- if.Values.podMonitor.enabled -}}
apiVersion: monitoring.coreos.com/v1
kind: PodMonitor
metadata:
name: {{ .Release.Name }}
namespace: {{ .Release.Namespace }}
labels:
{{- with .Values.podMonitor.additionalLabels }}
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
jobLabel: {{ .Release.Name }}
namespaceSelector:
matchNames:
- {{ .Release.Namespace }}
selector:
matchLabels:
app: {{ .Release.Name }}
podMetricsEndpoints:
- port: diag
path: /metrics
{{- with .Values.podMonitor.interval }}
interval: {{ . | quote }}
{{- end }}
podTargetLabels:
- "app.kubernetes.io/name"
- "app.kubernetes.io/instance"
- "app.kubernetes.io/component"
- "app.kubernetes.io/version"
- "teleport.dev/majorVersion"
{{- end }}

43
examples/chart/teleport-kube-agent/tests/podmonitor_test.yaml Normal file
View file

@ -0,0 +1,43 @@
suite: PodMonitor
templates:
- podmonitor.yaml
tests:
- it: does not create a PodMonitor by default
set:
proxyAddr: proxy.example.com:3080
kubeClusterName: test-kube-cluster-name
asserts:
- hasDocuments:
count: 0
- it: creates a PodMonitor when enabled
set:
proxyAddr: proxy.example.com:3080
kubeClusterName: test-kube-cluster-name
podMonitor:
enabled: true
asserts:
- hasDocuments:
count: 1
- isKind:
of: PodMonitor
- it: configures scrape interval if provided
set:
proxyAddr: proxy.example.com:3080
kubeClusterName: test-kube-cluster-name
podMonitor:
enabled: true
interval: 2m
asserts:
- equal:
path: spec.podMetricsEndpoints[0].interval
value: 2m
- it: wears additional labels if provided
asserts:
- equal:
path: metadata.labels.prometheus
value: default
values:
- ../.lint/podmonitor.yaml

24
examples/chart/teleport-kube-agent/values.schema.json
View file

@ -23,6 +23,7 @@
"clusterRoleBindingName",
"roleName",
"roleBindingName",
"podMonitor",
"serviceAccountName",
"secretName",
"log",
@ -368,6 +369,29 @@
}
}
},
"podMonitor": {
"$id": "#/properties/podMonitor",
"type": "object",
"required": ["enabled"],
"properties": {
"enabled": {
"$id": "#/properties/podMonitor/enabled",
"type": "boolean",
"default": false
},
"additionalLabels": {
"$id": "#/properties/podMonitor/additionalLabels",
"type": "object",
"default": {"prometheus": "default"},
"additionalProperties": {"type": "string"}
},
"interval": {
"$id": "#/properties/podMonitor/interval",
"type": "string",
"default": "30s"
}
}
},
"priorityClassName": {
"$id": "#/properties/priorityClassName",
"type": "string",

15
examples/chart/teleport-kube-agent/values.yaml
View file

@ -198,6 +198,21 @@ highAvailability:
enabled: false
minAvailable: 1
# podMonitor controls the PodMonitor CR (from monitoring.coreos.com/v1)
# This CRD is managed by the prometheus-operator and allows workload to
# get monitored. To use this value, you need to run a `prometheus-operator`
# in the cluster for this value to take effect.
# See https://prometheus-operator.dev/docs/prologue/introduction/
podMonitor:
# Whether the chart should deploy a PodMonitor.
# Disabled by default as it requires the PodMonitor CRD to be installed.
enabled: false
# additionalLabels to put on the PodMonitor.
# This is used to be selected by a specific prometheus instance.
additionalLabels: {}
# interval is the interval between two metrics scrapes. Defaults to 30s
interval: 30s
################################################################
# Values that must be provided if using persistent storage for Teleport.
#