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

Document the kubelet's HTTP API #48757

Open
adriancuadrado opened this issue Nov 18, 2024 · 4 comments
Open

Document the kubelet's HTTP API #48757

adriancuadrado opened this issue Nov 18, 2024 · 4 comments
Assignees
Labels
kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/node Categorizes an issue or PR as relevant to SIG Node.

Comments

@adriancuadrado
Copy link

This is a Bug Report

Problem: The Kubelet API is not documented. The only thing documented about it is that you can enable the server setting the enableServer kubelet configuration to true.

Proposed Solution: Create the documentation and add a reference to it in the enableServer kubelet configuration documentation.

Page to Update:
https://kubernetes.io/docs/reference/config-api/kubelet-config.v1beta1/#kubelet-config-k8s-io-v1beta1-KubeletConfiguration

Additional Information:
https://stackoverflow.com/a/35076156/5744858

@adriancuadrado adriancuadrado added the kind/bug Categorizes issue or PR as related to a bug. label Nov 18, 2024
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Nov 18, 2024
@sftim
Copy link
Contributor

sftim commented Nov 18, 2024

Adding documentation for the kubelet's HTTP API would be a feature
/remove-kind bug
/kind feature
/retitle Document the kubelet's HTTP API
/language en
/priority backlog
/sig node

@k8s-ci-robot k8s-ci-robot changed the title The kubelet rest api is not documented Document the kubelet's HTTP API Nov 18, 2024
@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language priority/backlog Higher priority than priority/awaiting-more-evidence. sig/node Categorizes an issue or PR as relevant to SIG Node. and removed kind/bug Categorizes issue or PR as related to a bug. labels Nov 18, 2024
@adriancuadrado
Copy link
Author

Also, now that we are on it, can we remove the [Required] label? The description says "Default: true". If it has a default value, then the field shouldn't be required in the configuration.

image

@ayushpatil2122
Copy link
Contributor

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/node Categorizes an issue or PR as relevant to SIG Node.
Projects
None yet
Development

No branches or pull requests

4 participants