Skip to content
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

Closed
wants to merge 2 commits into from

Conversation

rubenvp8510
Copy link
Contributor

@rubenvp8510 rubenvp8510 commented Mar 27, 2024

Version(s):

Issue: https://issues.redhat.com/browse/TRACING-3965

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

@openshift-ci openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 27, 2024
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Mar 27, 2024

Signed-off-by: Ruben Vargas <ruben.vp8510@gmail.com>
.Kubernetes cluster receiver service account RBAC
[source,yaml]
----
piVersion: rbac.authorization.k8s.io/v1
Copy link
Member

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.

Copy link
Contributor Author

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:
Copy link
Member

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Copy link
Contributor

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.

Copy link
Contributor

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>
@rubenvp8510
Copy link
Contributor Author

@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.
Copy link
Collaborator

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.

Copy link

openshift-ci bot commented May 7, 2024

@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.

@max-cx
Copy link
Contributor

max-cx commented May 7, 2024

@rubenvp8510, you're welcome to close this PR because I opened #75604.

@rubenvp8510 rubenvp8510 closed this May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants