FR: New kubectl command `kubectl debug` #45922

verb · 2017-05-17T00:12:56Z

Is this a BUG REPORT or FEATURE REQUEST? (choose one): FEATURE REQUEST

SIG Node is working on new functionality (feature: kubernetes/enhancements#277 , proposal: #35584) to execute a "Debug Container" in the context of a running pod for the purposes of troubleshooting. This issue is to discuss changes needed to kubectl to surface this feature.

We're aiming for an alpha release in 1.7 that includes basic functionality. As written, the proposal in #35584 calls for a new command, kubectl debug, that resembles kubectl exec. An example run is:

% kubectl debug -it --image alpine $POD -c $DEBUG_CONTAINER_NAME -- sh
/ # ps x
PID   USER     TIME   COMMAND
    1 root       0:00 /pause
   13 root       0:00 /app
   26 root       0:00 sh
   32 root       0:00 ps x
/ #

Ideally we could have reasonable defaults so that the minimum command would be something like:

% kubectl debug -it
Defaulting container name to debug.
/ #

One departure from kubectl exec is that kubectl debug supports reattaching to a running Debug Container with a command like kubectl debug --reattach $POD $CONTAINER_NAME

Options for the command would resemble:

Execute a Debug Container in a Pod.

Options:
  -c, --container='': Name of container to create. If omitted, the default "debug" will be used.
  -i, --stdin=false: Pass stdin to the container
  -m, --image='': Container Image to use when creating debug container. If omitted, the cluster default is used.
  -t, --tty=false: Stdin is a TTY

Usage:
  kubectl debug POD [-m IMAGE ] [-c CONTAINER] -- COMMAND [args...] [options]

Since this is an alpha feature it might be nice to be able to hide it in kubectl unless alpha features are enabled. It will return an error on clusters with alpha features disabled (the default).

/cc @pwittrock

The text was updated successfully, but these errors were encountered:

pwittrock · 2017-05-17T16:13:19Z

How are we going to hide this? I can think of a couple ways:

put it under and alpha subcommand as is done in gcloud
only expose it if a --alpha flag is provided

FYI, code freeze for 1.7 is a week from tomorrow, so this will need to be fully reviewed, approved and have all checks passing by then to make it into 1.7.

You probably want to send an MVP for review ASAP, so follow up later with anything that is non-trivial to implement and not part of the MVP.

verb · 2017-05-17T18:02:49Z

ack, thanks. Will dig into which is easier and create an MVP ASAP.

verb · 2017-05-20T20:02:22Z

Thinking about this a little bit more, it would be nice to integrate the same feature gates used with the rest of kubernetes into kubectl. I was going to add a flag to set feature gates, but this has a couple of downsides:

As a flag the feature gates wouldn't be able to influence behavior of other flags, and kubectl has plenty of complexity prior to flag parsing.
It would be nice if enabling alpha features was more persistent than a flag (which isn't a concern for the other long running daemons).

I settled on an environment variable as a decent way to do this and opened #46151. Using this, kubectl debug would be hidden and inaccessible without the alpha feature enabled by an environment variable.

@pwittrock

Automatic merge from submit-queue Add alpha command to kubectl Also allow new commands to disable themselves by returning a nil value. This can be used to disable commands based on feature gates. **What this PR does / why we need it**: Method of enabling alpha functionality in kubectl **Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: ref kubernetes#45922 **Special notes for your reviewer**: Part of a discussion in kubernetes#45922 with @pwittrock **Release note**: ```release-note NONE ```

k8s-ci-robot · 2017-09-13T15:30:59Z

@verb: GitHub didn't allow me to assign the following users: aaron-prindle.

Note that only kubernetes members can be assigned.

In response to this:

/assign @aaron-prindle

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.

verb · 2017-09-13T15:32:18Z

@aaron-prindle is interested in working on this.

/assign @verb

fejta-bot · 2018-01-05T15:12:38Z

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

Prevent issues from auto-closing with an /lifecycle frozen comment.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or @fejta.
/lifecycle stale

verb · 2018-01-06T19:14:11Z

/remove-lifecycle stale

t3hmrman · 2018-02-22T07:44:35Z

Hey I just ran into this, I'm running cri-containerd(+containerd), and the direct docker exec hack of course doesn't work for me. I'm on k8s v1.9.2 actually but instead of enabling the experimental debug option, I just went with adding my own little alpine container:

      - name: debug
        image: alpine
        command: ["/bin/sh"]
        args: ["-c", "sleep 100000000"]

And then kubectl apply -f pod.yaml and watch get spun up then go in. This helped in my case since I was trying to be "amongst" the other containers to observe them, but obviously wouldn't help you if you absolutely needed to get into the one specific container as root...

fejta-bot · 2018-05-23T08:04:06Z

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

t3hmrman · 2018-05-23T08:44:33Z

Seems like this would be a good fit for a kubectl plugin

verb · 2018-05-23T16:19:36Z

@t3hmrman oh that's neat, I didn't know about the plugins, I don't think they were around when I first added kubectl alpha to support this sort of thing. Thanks for the heads up, I'll dig into the plugins docs.

/remove-lifecycle stale

t3hmrman · 2018-05-24T03:41:49Z

@verb I'm also think they weren't -- I'm not sure when kubectl plugins became a thing, but I'm really hoping other operators will use them instead of building their own CLI tools. Not sure if it completely satisfies the needs of this ticket, but thought it was worth a mention!

Currently I avoid operators that introduce their own CLI tools to manage resources (so for a concrete example, zalando/patroni over CrunchyData/postgres-operator)

fejta-bot · 2018-08-22T04:42:36Z

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

fejta-bot · 2018-09-21T05:36:08Z

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

fejta-bot · 2018-10-21T05:52:05Z

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

k8s-ci-robot · 2018-10-21T05:52:12Z

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/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.

verb · 2019-07-25T11:04:52Z

Reopening now that #59416 has merged.

/reopen

k8s-ci-robot · 2019-07-25T11:04:54Z

@verb: Reopened this issue.

In response to this:

Reopening now that #59416 has merged.

/reopen

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.

verb · 2019-07-25T11:05:36Z

/remove-lifecycle rotten

fejta-bot · 2019-10-23T11:05:51Z

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

verb · 2019-10-23T11:15:12Z

/remove-lifecycle stale

verb · 2019-10-25T11:16:47Z

/kind feature
/priority important-longterm

fejta-bot · 2020-01-23T12:03:00Z

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

verb · 2020-01-23T14:56:00Z

Working on this for 1.18.

/remove-lifecycle stale

pwittrock added area/kubectl sig/cli Categorizes an issue or PR as relevant to SIG CLI. labels May 17, 2017

verb mentioned this issue May 20, 2017

Add alpha command to kubectl #46151

Merged

verb mentioned this issue May 22, 2017

WIP: Create a new kubectl command to attach debug container to a running pod #46256

Closed

2 tasks

k8s-ci-robot assigned verb Sep 13, 2017

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 5, 2018

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 6, 2018

whereisaaron mentioned this issue Jan 11, 2018

Support the user flag from docker exec in kubectl exec #30656

Closed

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 23, 2018

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 23, 2018

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 22, 2018

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Sep 21, 2018

k8s-ci-robot closed this as completed Oct 21, 2018

ahmetb mentioned this issue Apr 13, 2019

Add debug plugin kubernetes-sigs/krew-index#135

Closed

2 tasks

k8s-ci-robot reopened this Jul 25, 2019

k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Jul 25, 2019

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 23, 2019

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 23, 2019

verb mentioned this issue Oct 25, 2019

Ephemeral Containers kubernetes/enhancements#277

Closed

23 tasks

k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. labels Oct 25, 2019

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 23, 2020

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 23, 2020

verb mentioned this issue Feb 10, 2020

Add kubectl debug alpha command #88004

Merged

k8s-ci-robot closed this as completed in #88004 Mar 5, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FR: New kubectl command `kubectl debug` #45922

FR: New kubectl command `kubectl debug` #45922

verb commented May 17, 2017

pwittrock commented May 17, 2017

verb commented May 17, 2017

verb commented May 20, 2017 •

edited

Loading

k8s-ci-robot commented Sep 13, 2017

verb commented Sep 13, 2017

fejta-bot commented Jan 5, 2018

verb commented Jan 6, 2018

t3hmrman commented Feb 22, 2018

fejta-bot commented May 23, 2018

t3hmrman commented May 23, 2018

verb commented May 23, 2018

t3hmrman commented May 24, 2018 •

edited

Loading

fejta-bot commented Aug 22, 2018

fejta-bot commented Sep 21, 2018

fejta-bot commented Oct 21, 2018

k8s-ci-robot commented Oct 21, 2018

verb commented Jul 25, 2019

k8s-ci-robot commented Jul 25, 2019

verb commented Jul 25, 2019

fejta-bot commented Oct 23, 2019

verb commented Oct 23, 2019

verb commented Oct 25, 2019

fejta-bot commented Jan 23, 2020

verb commented Jan 23, 2020

FR: New kubectl command kubectl debug #45922

FR: New kubectl command kubectl debug #45922

Comments

verb commented May 17, 2017

pwittrock commented May 17, 2017

verb commented May 17, 2017

verb commented May 20, 2017 • edited Loading

k8s-ci-robot commented Sep 13, 2017

verb commented Sep 13, 2017

fejta-bot commented Jan 5, 2018

verb commented Jan 6, 2018

t3hmrman commented Feb 22, 2018

fejta-bot commented May 23, 2018

t3hmrman commented May 23, 2018

verb commented May 23, 2018

t3hmrman commented May 24, 2018 • edited Loading

fejta-bot commented Aug 22, 2018

fejta-bot commented Sep 21, 2018

fejta-bot commented Oct 21, 2018

k8s-ci-robot commented Oct 21, 2018

verb commented Jul 25, 2019

k8s-ci-robot commented Jul 25, 2019

verb commented Jul 25, 2019

fejta-bot commented Oct 23, 2019

verb commented Oct 23, 2019

verb commented Oct 25, 2019

fejta-bot commented Jan 23, 2020

verb commented Jan 23, 2020

FR: New kubectl command `kubectl debug` #45922

FR: New kubectl command `kubectl debug` #45922

verb commented May 20, 2017 •

edited

Loading

t3hmrman commented May 24, 2018 •

edited

Loading