Skip to content

Commit

Permalink
[receiver/kubeletstats] Add clarifications on serviceAccount auth type (
Browse files Browse the repository at this point in the history
open-telemetry#31280)

**Description:** <Describe what has changed.>
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->

This PR adds some clarifications in the documentation of the
`serviceAccount` auth type of the `kubeletstats` receiver.
This is an outcome of the discussions at
open-telemetry/opentelemetry-helm-charts#1034 (comment).

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
  • Loading branch information
ChrsMark authored and XinRanZhAWS committed Mar 13, 2024
1 parent 7ea4e27 commit 203f1be
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion receiver/kubeletstatsreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ endpoint will be used if `auth_type` set to any of the following values:
- `tls` tells the receiver to use TLS for auth and requires that the fields
`ca_file`, `key_file`, and `cert_file` also be set.
- `serviceAccount` tells this receiver to use the default service account token
to authenticate to the kubelet API.
to authenticate to the kubelet API along with the default certificate which is signed by the cluster's root CA cert:
- `/var/run/secrets/kubernetes.io/serviceaccount/token`
- `/var/run/secrets/kubernetes.io/serviceaccount/ca.crt`
- `kubeConfig` tells this receiver to use the kubeconfig file (KUBECONFIG env variable or ~/.kube/config)
to authenticate and use API server proxy to access the kubelet API.
- `initial_delay` (default = `1s`): defines how long this receiver waits before starting.
Expand Down

0 comments on commit 203f1be

Please sign in to comment.