Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

kubectl debug: Add --rm flag to remove debug pod on exit #129046

Closed
wants to merge 2 commits into from
Closed

kubectl debug: Add --rm flag to remove debug pod on exit #129046

wants to merge 2 commits into from

Conversation

tksm
Copy link
Contributor

@tksm tksm commented Dec 1, 2024 •
edited
Loading

What type of PR is this?

/kind feature

What this PR does / why we need it:

This PR adds the --rm flag to kubectl debug, similar to the same flag in kubectl run and docker run, allowing automatic deletion of the debug pod on exit. Since ephemeral containers cannot be removed, this flag is only valid when debugging a node or a pod with --copy-to. It also requires --attach or -i/--stdin, similar to kubectl run --rm.

Which issue(s) this PR fixes:

Fixes kubernetes/kubectl#1681

Special notes for your reviewer:

I added a unit test for DebugOptions.Run() in the first commit, then I implemented the --rm flag in the second commit.

Does this PR introduce a user-facing change?

`kubectl debug` now supports the `--rm` flag to remove debug pod on exit. 
This flag is only valid when debugging a node or a pod with `--copy-to`,
as ephemeral containers cannot be deleted. It also requires `--attach` or `-i/--stdin`.

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

@k8s-ci-robot k8s-ci-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Dec 1, 2024
@k8s-ci-robot
Copy link
Contributor

Please note that we're already in Test Freeze for the release-1.32 branch. This means every merged PR will be automatically fast-forwarded via the periodic ci-fast-forward job to the release branch of the upcoming v1.32.0 release.

Fast forwards are scheduled to happen every 6 hours, whereas the most recent run was: Sun Dec 1 10:44:49 UTC 2024.

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Dec 1, 2024
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Dec 1, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @tksm. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added area/kubectl sig/cli Categorizes an issue or PR as relevant to SIG CLI. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Dec 1, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: tksm
Once this PR has been reviewed and has the lgtm label, please assign seans3 for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tksm tksm mentioned this pull request Dec 2, 2024
Open
@sftim
Copy link
Contributor

sftim commented Dec 5, 2024

Changelog suggestion

-`kubectl debug` now supports the `--rm` flag to remove debug pod on exit.
+Implemented `kubectl debug --rm`; the new flag removes the debug Pod on exit.
 This flag is only valid when debugging a node or a pod with `--copy-to`,
 as ephemeral containers cannot be deleted. It also requires `--attach` or `-i/--stdin`.

@sftim
Copy link
Contributor

sftim commented Dec 5, 2024

I would change the flag from --rm to an argument --remove=pod.

We may one day want to support --remove=all-ephemeral, --remove=container, etc.

@tksm
Copy link
Contributor Author

tksm commented Dec 10, 2024

Thank you for the review, and I apologize for the delayed response. As discussed in kubernetes/kubectl#1681, adding a new flag introduces a risk of reduced usability, so I will close this PR for now.

@tksm tksm closed this Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brianpursley brianpursley Awaiting requested review from brianpursley

@mpuckett159 mpuckett159 Awaiting requested review from mpuckett159

Assignees
No one assigned
Labels
area/kubectl cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/cli Categorizes an issue or PR as relevant to SIG CLI. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
SIG CLI
Status: Closed
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add --rm flag to kubectl debug to remove debug pod on exit
3 participants
@tksm @k8s-ci-robot @sftim