KEP 1441 - kubectl debug

[soltysh]

Enhancement Description

• One-line enhancement description (can be used as a release note): Add a new command to debug pods.
• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/tree/master/keps/sig-cli/1441-kubectl-debug
• Discussion Link: sig-cli agenda
• Primary contact (assignee): @verb, @ardaguclu, @soltysh
• Responsible SIGs: sig-cli
• Enhancement target (which target equals to which milestone):
  • Alpha release target (x.y): 1.18
  • Beta release target (x.y): 1.20
  • Stable release target (x.y): 1.30
• Stable
  • KEP (k/enhancements) update PR(s): Promote kubectl debug to GA #4408
  • Code (k/k) update PR(s):
  • Docs (k/website) update(s):

[soltysh]

/stage alpha
/kind feature
/sig cli
/milestone v1.18

[jeremyrickard]

Hey there @soltysh can you confirm that this will be in the 1.18 release? To make it into the release, the KEP will need to be merged as implementablewith a Test Plan (looks like that's a TODO) by enhancements freeze, which is going to be end of day (pacific time) on January 28th

[soltysh]

@jeremyrickard yup, I confirm. The KEP should be merged later today after SIG-CLI call, then we'll start with the implementation right away.

[jeremyrickard]

Thanks for getting the KEP in @soltysh 🎊

[palnabarun]

Updated the issue description with KEP link.

[VineethReddy02]

Hello, @soltysh, I'm 1.18 docs lead.
Does this enhancement work planned for 1.18 require any new docs (or modifications to existing docs)? If not, can you please update the 1.18 Enhancement Tracker Sheet (or let me know and I'll do so)
If so, just a friendly reminder we're looking for a PR against k/website (branch dev-1.18) due by Friday, Feb 28th, it can just be a placeholder PR at this time. Let me know if you have any questions!

[verb]

@VineethReddy02 ack, this will include doc updates and we will open a placeholder PR by Feb 28. Thanks!

[helayoty]

Hi @soltysh @verb We're only a few days out from code freeze now. It does not look like your PRs have merged yet, are you still feeling like you're on track for code freeze for this enhancement? Do you want to defer this to 1.19 based on the reviewer bandwidth? Or try and make a push?

[verb]

@helayoty I expect this to merge in time.

[3k8]

Add support for override image command & args for debug some error between container starting？
such as

kubectl run nginx --image nginx --debug
apiVersion: apps/v1
kind: Deployment
metadata:
  creationTimestamp: null
  labels:
    run: nginx
  name: nginx
spec:
  replicas: 1
  selector:
    matchLabels:
      run: nginx
  strategy: {}
  template:
    metadata:
      creationTimestamp: null
      labels:
        run: nginx
    spec:
      containers:
      - image: nginx
        name: nginx
        command: ["sleep"]
        args: ["1d"]
        resources: {}

[verb]

@cnk8s This is indeed included in the proposal. See Pod Troubleshooting by Copy

[verb]

@aylei Are you interested in working on Pod Troubleshooting by Copy for 1.19? or anything else related to debug?

[aylei]

@verb Absolutely

[aylei]

I will draft a PR this week

[zanetworker]

@verb reading the KEP, I still don't get how pod-troubleshooting by copy would work, what does copy mean in this case?

[verb]

@ardaguclu Agree about custom profiles with a new KEP. I think NET_RAW is more of a bugfix and it would reasonable to amend the existing KEP, which should be quicker than getting a new KEP reviewed.

Since we're adding a capability I think backwards compatibility won't be much of a concern. The only problem would be if there was an admission controller that was only allowing NET_ADMIN and not NET_RAW.

[mochizuki875]

@verb @ardaguclu
Hi, can I try to fix netadmin debugging profile to add NET_RAW?
If OK, I'll create an new issue and start working.

[mochizuki875]

@verb @ardaguclu
I've tried to fix it.
Could you please check it?

kubernetes/kubernetes#118647

[alculquicondor]

Have you considered adding support for runAsUser? Right now, for a securityContext: runAsNonRoot: true, I can't debug a running Pod using busybox directly. I have to create a Dockerfile just to set a different user.

[ardaguclu]

Have you considered adding support for runAsUser? Right now, for a securityContext: runAsNonRoot: true, I can't debug a running Pod using busybox directly. I have to create a Dockerfile just to set a different user.

@alculquicondor this will be handled by this KEP #4293.

I opened this #4408 to mark kubectl debug as GA and close this issue.

[soltysh]

/label lead-opted-in
/stage stable
/milestone v1.30

[AnaMMedina21]

Hello @verb, @ardaguclu, @soltysh 👋, Enhancements team here.

Just checking in as we approach enhancements freeze on 02:00 UTC Friday 9th February 2024.

This enhancement is targeting for stage stable for v1.30 (correct me, if otherwise)

Here's where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: v1.30. KEPs targeting stable will need to be marked as implemented after code PRs are merged and the feature gates are removed.
• KEP readme has up-to-date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here).

The status of this enhancement is marked as tracked for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well. Thank you!

[ardaguclu]

I think, we can close this issue as completed.

[natalisucks]

Hi @verb and @soltysh,

👋 from the v1.30 Communications Team! We'd love for you to opt in to write a feature blog about your enhancement!

We encourage blogs for features including, but not limited to: breaking changes, features and changes important to our users, and features that have been in progress for a long time and are graduating.

To opt in, you need to open a Feature Blog placeholder PR against the website repository.
The placeholder PR deadline is 27th February, 2024.

Here's the 1.30 Release Calendar

[Vyom-Yadav]

Hey, @verb and @soltysh 👋, v1.30 Docs Shadow here.

Does this enhancement work planned for v1.30 require any new docs or modification to existing docs?

If so, please follows the steps here to open a PR against dev-1.30 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday, February 22nd, 2024 18:00 PDT

Also, take a look at Documenting for a release to get yourself familiarize with the docs requirement for the release.

Thank you!

---

Does this enhancement work planned for v1.30 require any new docs or modification to existing docs?

I think we'll need a stability version bump PR at a minimum, marking it as Need Docs (Correct me, if otherwise). Thanks!

Based on Slack discussion, marking this as has docs. Thanks again!

[AnaMMedina21]

Hello again @verb, @ardaguclu, @soltysh 👋, Enhancements team here.

Just checking in as we approach code freeze at 02:00 UTC Wednesday 6th March 2024 .

Here's where this enhancement currently stands:

• All PRs to the Kubernetes repo that are related to your enhancement are linked in the above issue description (for tracking purposes).
• All PR/s are ready to be merged (they have approved and lgtm labels applied) by the code freeze deadline. This includes tests.

For this enhancement, it looks like the KEPs status on kep.yaml needs it's status changed from implementable to implemented KEPs targeting stable for the release will now need to be marked as implemented after code PRs are merged and the feature gates are removed

Also, please let me know if there are other PRs in k/k we should be tracking for this KEP.
As always, we are here to help if any questions come up. Thanks!

[salehsedghpour]

Hello @verb, @ardaguclu, @soltysh 👋 Enhancements team here,

Unfortunately, the implementation (code related) PR(s) associated with this enhancement is not in the merge-ready state by code-freeze and hence this enhancement is now removed from the v1.30 milestone.

If you still wish to progress this enhancement in v1.30, please file an exception request. Thanks!

/milestone clear

[ardaguclu]

We have promoted this to GA and can close this issue as completed;
/close

[k8s-ci-robot]

@ardaguclu: Closing this issue.

In response to this:

We have promoted this to GA and can close this issue as completed;
/close

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.