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

Misleading description? #681

Open
qds-x opened this issue Feb 23, 2024 · 3 comments
Open

Misleading description? #681

qds-x opened this issue Feb 23, 2024 · 3 comments
Labels
type/documentation Improvements or additions to documentation

Comments

@qds-x
Copy link

qds-x commented Feb 23, 2024

- Use the Kubernetes Python client to perform read operations on K8s objects.

@gravesm
Copy link
Member

gravesm commented Feb 27, 2024

@qds-x Could you provide some more information about what you find misleading?

@gravesm gravesm added the needs_info Needs additional information from original reporter label Feb 27, 2024
@qds-x
Copy link
Author

qds-x commented Mar 4, 2024

@gravesm Yes sorry, it was misleading to me because I took it to mean that the purpose of the module is to read arbitrary objects from the API server.

If I understand correctly it actually only reads certain objects to provide information about the cluster.

For context I came to this repo to try to understand what the equivalent kubectl commands to the cluster_info module would be - it seems to go well beyond 'kubectl cluster-info' - and left none the wiser.

@gravesm gravesm added type/documentation Improvements or additions to documentation and removed needs_info Needs additional information from original reporter labels Mar 5, 2024
@yurnov
Copy link
Contributor

yurnov commented May 16, 2024

Hi @qds-x,

here Use the Kubernetes Python client means that the underlying code has import kubernetes to use kubernetes python client.

So, I don't see a misleading description, but agree that it's the description is not clear at all

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants