[Docs] Include instructions for setting cluster name on Kubernetes installations of the Operator

elastic / opentelemetry

Get started with our Elastic Distros of OpenTelemetry

6 stars 8 forks source link

[Docs] Include instructions for setting cluster name on Kubernetes installations of the Operator #35

Open eedugon opened 2 days ago

eedugon commented 2 days ago

We should add details in our main document (https://github.com/elastic/opentelemetry/tree/main/docs/kubernetes/operator/README.md) details about how to customize the values.yaml before installing the operator via helm, and explain use cases where this might be needed, like:

Adding cluster name
Integrate with cert-manager for automatic certificates generation and renew.

Then we have to provide specific details for the clusterName use case.

eedugon commented 2 days ago

@gizas : would you provide some details about how exactly the k8s.cluster.name is retrieved for cloud based clusters like GKE, AKS and EKS? Are all of them supported for that?

I'd like to get a better knowledge of what systems get that field automatically populated and in what other systems the users should manually set clusterName if they are planning to monitor multiple clusters.

thanks!

gizas commented 2 days ago

Heyy @eedugon , the k8s.cluster name retrieval is based on the resourcedetectionprocessor. We configure 3 different instances of the same processor in https://github.com/elastic/opentelemetry/blob/main/resources/kubernetes/operator/helm/values.yaml#L63-L82, one per major cloud provider.

In case the auto detection does not work, user can also set the clusterName` variable