community icon indicating copy to clipboard operation
community copied to clipboard
verified publisher icon kubernetes

Contributor guide: document internal Kubelet API

Open ehashman opened this issue 4 years ago • 15 comments

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

ehashman avatar Sep 15 '21 19:09 ehashman

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

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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-ci-robot avatar Sep 15 '21 19:09 k8s-ci-robot

Interested.

catblade avatar Sep 16 '21 14:09 catblade

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:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue or PR as fresh with /remove-lifecycle stale
  • Mark this issue or PR as rotten with /lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

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

/lifecycle stale

k8s-triage-robot avatar Dec 15 '21 15:12 k8s-triage-robot

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:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue or PR as fresh with /remove-lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

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

/lifecycle rotten

k8s-triage-robot avatar Jan 14 '22 15:01 k8s-triage-robot

/remove-lifecycle rotten

vaibhav2107 avatar Feb 07 '22 19:02 vaibhav2107

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:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue or PR as fresh with /remove-lifecycle stale
  • Mark this issue or PR as rotten with /lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

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

/lifecycle stale

k8s-triage-robot avatar May 08 '22 20:05 k8s-triage-robot

/remove-lifecycle stale

vaibhav2107 avatar Jun 05 '22 18:06 vaibhav2107

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

AbuTuraab avatar Jul 11 '22 13:07 AbuTuraab

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

kundan2707 avatar Aug 20 '22 14:08 kundan2707

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

catblade avatar Aug 20 '22 14:08 catblade

@catblade thanks started working on it

kundan2707 avatar Aug 21 '22 03:08 kundan2707

/assign

kundan2707 avatar Aug 21 '22 03:08 kundan2707

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

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

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

/lifecycle stale

k8s-triage-robot avatar Feb 07 '23 23:02 k8s-triage-robot