search

kubernetes / community

Kubernetes community content
Apache License 2.0
11.91k stars 5.16k forks source link

Contributor guide: document internal Kubelet API #6016

Open ehashman opened 3 years ago

ehashman commented 3 years ago

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

k8s-ci-robot commented 3 years ago

@ehashman: This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-help command.

In response to [this](https://github.com/kubernetes/community/issues/6016): >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 Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
catblade commented 3 years ago

Interested.

k8s-triage-robot commented 2 years ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot commented 2 years ago

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

vaibhav2107 commented 2 years ago

/remove-lifecycle rotten

k8s-triage-robot commented 2 years ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

vaibhav2107 commented 2 years ago

/remove-lifecycle stale

AbuTuraab commented 2 years ago

Is the documentation available already? if no I wish to contribute.

kundan2707 commented 2 years ago

IF no one is working. I am interested to contribute.

catblade commented 2 years ago

@kundan2707 please do. We haven't managed to get the time to do so.

kundan2707 commented 2 years ago

@catblade thanks started working on it

kundan2707 commented 2 years ago

/assign

k8s-triage-robot commented 1 year ago

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

SergeyKanzhelev commented 1 month ago

/remove-lifecycle stale

kundan2707 commented 1 month ago

@ehashman can you list down all unversioned api for confirmation?