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, @soltysh
• Responsible SIGs: sig-cli
• Enhancement target (which target equals to which milestone):
  • Alpha release target 1.18
  • Beta release target 1.20
  • Stable release target (?)

[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]

Hi @kikisdeliveryservice,

There's been a change of plans. After chatting with sig-cli in the last meeting we've decided to pursue graduation to beta in 1.20. (cc @soltysh).

Thanks!

[soltysh]

That is correct!

[soltysh]

/milestone v1.20

[soltysh]

/stage beta

[kikisdeliveryservice]

Thank you for the update!

[MorrisLaw]

Hey @soltysh -- 1.20 Enhancements Shadow here 👋

Friendly reminder that the Enhancements Freeze deadline is October 6th and I've noticed that the KEP is following the old format. Time permitting, can we please update the KEP to be in the new directory format and include a kep.yaml. That would be extremely helpful! The new format is detailed here: https://github.com/kubernetes/enhancements/tree/master/keps/NNNN-kep-template

Regards,
Jeremy

[verb]

Hi @MorrisLaw,

#2007 updates the KEP to the new format, and @soltysh and I plan on merging before October 6.

Thanks,

[MorrisLaw]

Hi @verb ,

Since your Enhancement is scheduled to be in 1.20, please keep in mind the important upcoming dates:
Friday, Nov 6th: Week 8 - Docs Placeholder PR deadline
Thursday, Nov 12th: Week 9 - Code Freeze

As a reminder, please link all of your k/k PR as well as docs PR to this issue so we can track them.

Best,
Jeremy

[SomtochiAma]

Hello @soltysh @verb, 1.20 Docs shadow here 👋🏽.
Does this enhancement work planned for 1.20 require any new docs or modification to existing docs?

If so, please follows the steps here to open a PR against dev-1.20 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Nov 6th

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

[verb]

@SomtochiAma ack, will open PR against dev-1.20 branch by Nov 6.

[SomtochiAma]

Hi @verb
The docs placeholder deadline is almost here. Please make sure to create a placeholder PR against the dev-1.20 branch in the k/website before the deadline

Also, please keep in mind the important upcoming dates:

• Friday, Nov 6th: Week 8 - Docs Placeholder PR deadline
• Thursday, Nov 12th: Week 9 - Code Freeze
• Monday, Nov 23rd: Week 11 - Docs PR Ready for Review
  As a reminder, please link all of your k/k PR as well as docs PR to this issue for the release team to track.

Thank you!

[verb]

Pending PRs for 1.20:

• kubernetes/kubernetes#96058: Tests + Changing images of existing containers in pod copies
• kubernetes/kubernetes#96138: PR to change kubectl alpha debug to kubectl debug
• kubernetes/kubernetes#96264: Bugfix for --set-image
• kubernetes/website#24847: Docs for 1.20

[MorrisLaw]

Thank you for the PR links @verb !

[verb]

Opened remaining 1.20 PR and updated list.

[MorrisLaw]

Hey @verb is this the last PR that had to be merged? k/k #96264: Bugfix for --set-image

Are there any other k/k PRs?

Just a reminder regarding upcoming dates:

• Thursday, Nov 12th: Week 9 - Code Freeze
• Monday, Nov 23rd: Week 11 - Docs PR Ready for Review

[verb]

Hi @MorrisLaw,

That was the last. We have no more k/k PRs planned for 1.20.

[verb]

We have some minor improvements to kubectl debug in the works for 1.21, namely kubernetes/kubernetes#97887 to support configurable capabilities and supporting #1690 if it merges, but nothing major.

@soltysh shall we plan for stable release in 1.22 if nothing else comes up?

[soltysh]

@soltysh shall we plan for stable release in 1.22 if nothing else comes up?

Yeah, that sounds good to me.