-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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.
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
[TRACING-4077] Add documentation for kubernetes cluster receiver #73769
Conversation
🤖 Tue May 07 05:53:23 - Prow CI generated the docs preview: |
94ea659
to
f5a86cd
Compare
Signed-off-by: Ruben Vargas <ruben.vp8510@gmail.com>
.Kubernetes cluster receiver service account RBAC | ||
[source,yaml] | ||
---- | ||
piVersion: rbac.authorization.k8s.io/v1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missed the a in apiVersion. We should also add the required ClusterRoleBinding to bind the created role to the SA.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
[source,yaml] | ||
---- | ||
receivers: | ||
k8s_cluster: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Support for collecting OpenShift specific metrics is also available which needs to be documented. https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/k8sclusterreceiver#openshift
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@IshwarKanse, please ping me when you get around to verifying and approving Ruben's update.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you both.
Signed-off-by: Ruben Vargas <ruben.vp8510@gmail.com>
@IshwarKanse @max-cx I've already address the comments! |
namespace: default | ||
---- | ||
|
||
You can enable OpenShift support to collect OpenShift specific metrics in addition to the default kubernetes ones. To do this,set the distribution key to openshift. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤖 [error] RedHat.CaseSensitiveTerms: Use 'Kubernetes' rather than 'kubernetes'. For more information, see RedHat.CaseSensitiveTerms.
@rubenvp8510: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
@rubenvp8510, you're welcome to close this PR because I opened #75604. |
Version(s):
Issue: https://issues.redhat.com/browse/TRACING-3965
Link to docs preview:
QE review:
Additional information: