kubernetes / kubernetes/community
Contributor guide: document internal Kubelet API
Open
help wanted
kind/documentation
sig/node
- Dominant language
- Jupyter Notebook
- Stars
- 13k
- Forks
- 5.4k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 29
Description
The kubelet has an undocumented, unversioned API that is not intended for client use.
Its existence often catches new contributors by surprise. It would be good to add some developer documentation on the API in the community repo under the SIG Node folder: https://github.com/kubernetes/community/tree/master/contributors/devel/sig-node
See https://github.com/kubernetes/kubernetes/blob/release-1.22/pkg/kubelet/server/server.go#L331-L404 and https://github.com/kubernetes/kubernetes/blob/release-1.22/pkg/kubelet/server/server.go#L412-L498 for the corresponding endpoints in the kubelet.
/sig node
/kind documentation
/help
Contributor guide
Assessment
This issue has not been assessed yet.