github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-23 19:56:01 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #12860 from nak3/exec-help

Browse Source 
Modify kubectl exec help to set -c CONTAINER as optional
This commit is contained in:
Robert Bailey 2015-08-18 11:48:26 -07:00
commit 6e94e44d9c
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/man/man1/kubectl-exec.1
View File

@ -19,7 +19,7 @@ Execute a command in a container.
.SH OPTIONS
.PP
\fB\-c\fP, \fB\-\-container\fP=""
Container name
Container name. If omitted, the first container in the pod will be chosen
.PP
\fB\-h\fP, \fB\-\-help\fP=false

4
docs/user-guide/kubectl/kubectl_exec.md
View File

@ -41,7 +41,7 @@ Execute a command in a container.
Execute a command in a container.
```
kubectl exec POD -c CONTAINER -- COMMAND [args...]
kubectl exec POD [-c CONTAINER] -- COMMAND [args...]
```
### Examples
@ -61,7 +61,7 @@ $ kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il
### Options
```
-c, --container="": Container name
-c, --container="": Container name. If omitted, the first container in the pod will be chosen
-h, --help[=false]: help for exec
-p, --pod="": Pod name
-i, --stdin[=false]: Pass stdin to the container

4
pkg/kubectl/cmd/exec.go
View File

@ -53,7 +53,7 @@ func NewCmdExec(f *cmdutil.Factory, cmdIn io.Reader, cmdOut, cmdErr io.Writer) *
Executor: &DefaultRemoteExecutor{},
}
cmd := &cobra.Command{
Use: "exec POD -c CONTAINER -- COMMAND [args...]",
Use: "exec POD [-c CONTAINER] -- COMMAND [args...]",
Short: "Execute a command in a container.",
Long: "Execute a command in a container.",
Example: exec_example,
@ -65,7 +65,7 @@ func NewCmdExec(f *cmdutil.Factory, cmdIn io.Reader, cmdOut, cmdErr io.Writer) *
}
cmd.Flags().StringVarP(&options.PodName, "pod", "p", "", "Pod name")
// TODO support UID
cmd.Flags().StringVarP(&options.ContainerName, "container", "c", "", "Container name")
cmd.Flags().StringVarP(&options.ContainerName, "container", "c", "", "Container name. If omitted, the first container in the pod will be chosen")
cmd.Flags().BoolVarP(&options.Stdin, "stdin", "i", false, "Pass stdin to the container")
cmd.Flags().BoolVarP(&options.TTY, "tty", "t", false, "Stdin is a TTY")
return cmd