Skip to content

Commit

Permalink
Name PodExecOptions fields as recommended by API reviewer
Browse files Browse the repository at this point in the history
  • Loading branch information
verb committed Sep 27, 2017
1 parent 8136e3d commit 473c49d
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions contributors/design-proposals/node/troubleshoot-running-pods.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Troubleshoot Running Pods

[bit.ly/k8s-pod-troubleshooting](bit.ly/k8s-pod-troubleshooting)
* Status: Pending
* Version: Alpha
* Implementation Owner: @verb

This proposal seeks to add first class support for troubleshooting by creating a
mechanism to execute a shell or other troubleshooting tools inside a running pod
Expand Down Expand Up @@ -116,20 +118,22 @@ fields required for creating a Debug Container:
// PodExecOptions is the query options to a Pod's remote exec call
type PodExecOptions struct {
...
// DebugName is the name of the Debug Container. Its presence will cause
// exec to create a Debug Container rather than performing a runtime exec.
DebugName string `json:"debugName,omitempty" ...`
// Image is an optional container image name that will be used to for the Debug
// Container in the specified Pod with Command as ENTRYPOINT. If omitted a
// default image will be used.
Image string `json:"image,omitempty" ...`
// EphemeralContainerName is the name of an ephemeral container in which the
// command ought to be run. Either both EphemeralContainerName and
// EphemeralContainerImage fields must be set, or neither.
EphemeralContainerName *string `json:"ephemeralContainerName,omitempty" ...`
// EphemeralContainerImage is the image of an ephemeral container in which the command
// ought to be run. Either both EphemeralContainerName and EphemeralContainerImage
// fields must be set, or neither.
EphemeralContainerImage *string `json:"ephemeralContainerImage,omitempty" ...`
}
```

After creating the Debug Container, the kubelet will upgrade the connection to
streaming and perform an attach to the container's console. If disconnected, the
Debug Container can be reattached using the pod's `/attach` endpoint with
`DebugName`.
`EphemeralContainerName`.

Debug Containers cannot be removed via the API and instead the process must
terminate. While not ideal, this parallels existing behavior of `kubectl exec`.
Expand Down

0 comments on commit 473c49d

Please sign in to comment.