open-telemetry / open-telemetry/opentelemetry-python-contrib
Provide documentation on prerequisites for AwsEksResourceDetector
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 1.1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 16
Description
Before opening a feature request against this repo, consider whether the feature should/could be implemented in the other OpenTelemetry client libraries. If so, please open an issue on opentelemetry-specification first.
Is your feature request related to a problem?
Problem: Have to read the source code for AwsEksResourceDetector to understand which permissions and resources are needed in the cluster for it to work.
Describe the solution you'd like
Solution: Provide documentation on prerequisites.
First prerequisite: permissions for service account role
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
name: otel-awseksresourcedetector-role
rules:
- apiGroups:
- ""
resources:
- configmaps
resourceNames:
- aws-auth
- cluster-info
verbs:
- get
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
name: otel-awseksresourcedetector-role-binding
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: otel-awseksresourcedetector-role
subjects:
- kind: ServiceAccount
name: {{your_service_account}}
namespace: {{namespace_of_your_service_account}}
- kind: ServiceAccount
name: {{your_service_account}}
namespace: {{namespace_of_your_service_account}}
Second prerequisite: a configmap cluster-info in amazon-cloudwatch is required with the following information:
# create configmap for cluster name and aws region for CloudWatch Logs
# need to replace the placeholders {{cluster_name}} and {{region_name}}
apiVersion: v1
data:
cluster.name: {{cluster_name}}
logs.region: {{region_name}}
kind: ConfigMap
metadata:
name: cluster-info
namespace: amazon-cloudwatch
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the AwsEksResourceDetector source to verify the required permissions and the cluster-info ConfigMap details. Add documentation covering the service account RBAC and amazon-cloudwatch ConfigMap prerequisites; done means users can understand what the detector needs without reading its source.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, kubernetes, python
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100