1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00

Merge pull request #9263 from cpuguy83/docs_cleanup_exec_api

Cleanup exec API docs and available params
This commit is contained in:
Jessie Frazelle 2014-11-24 13:35:45 -08:00
commit 39284be960
4 changed files with 26 additions and 15 deletions

View file

@ -122,8 +122,6 @@ func (d *Daemon) ContainerExecCreate(job *engine.Job) engine.Status {
entrypoint, args := d.getEntrypointAndArgs(nil, config.Cmd)
processConfig := execdriver.ProcessConfig{
Privileged: config.Privileged,
User: config.User,
Tty: config.Tty,
Entrypoint: entrypoint,
Arguments: args,

View file

@ -1561,7 +1561,6 @@ Sets up an exec instance in a running container `id`
"Cmd":[
"date"
],
"Container":"e90e34656806",
}
**Example response**:
@ -1575,7 +1574,12 @@ Sets up an exec instance in a running container `id`
Json Parameters:
- **execConfig** ? exec configuration.
- **AttachStdin** - Boolean value, attaches to stdin of the exec command.
- **AttachStdout** - Boolean value, attaches to stdout of the exec command.
- **AttachStderr** - Boolean value, attaches to stderr of the exec command.
- **Tty** - Boolean value to allocate a pseudo-TTY
- **Cmd** - Command to run specified as a string or an array of strings.
Status Codes:
@ -1586,8 +1590,9 @@ Status Codes:
`POST /exec/(id)/start`
Starts a previously set up exec instance `id`. If `detach` is true, this API returns after
starting the `exec` command. Otherwise, this API sets up an interactive session with the `exec` command.
Starts a previously set up exec instance `id`. If `detach` is true, this API
returns after starting the `exec` command. Otherwise, this API sets up an
interactive session with the `exec` command.
**Example request**:
@ -1608,7 +1613,8 @@ starting the `exec` command. Otherwise, this API sets up an interactive session
Json Parameters:
- **execConfig** ? exec configuration.
- **Detach** - Detach from the exec command
- **Tty** - Boolean value to allocate a pseudo-TTY
Status Codes:

View file

@ -1515,7 +1515,6 @@ Sets up an exec instance in a running container `id`
"Cmd":[
"date"
],
"Container":"e90e34656806",
}
**Example response**:
@ -1529,7 +1528,12 @@ Sets up an exec instance in a running container `id`
Json Parameters:
- **execConfig** ? exec configuration.
- **AttachStdin** - Boolean value, attaches to stdin of the exec command.
- **AttachStdout** - Boolean value, attaches to stdout of the exec command.
- **AttachStderr** - Boolean value, attaches to stderr of the exec command.
- **Tty** - Boolean value to allocate a pseudo-TTY
- **Cmd** - Command to run specified as a string or an array of strings.
Status Codes:
@ -1540,8 +1544,9 @@ Status Codes:
`POST /exec/(id)/start`
Starts a previously set up exec instance `id`. If `detach` is true, this API returns after
starting the `exec` command. Otherwise, this API sets up an interactive session with the `exec` command.
Starts a previously set up exec instance `id`. If `detach` is true, this API
returns after starting the `exec` command. Otherwise, this API sets up an
interactive session with the `exec` command.
**Example request**:
@ -1562,7 +1567,8 @@ starting the `exec` command. Otherwise, this API sets up an interactive session
Json Parameters:
- **execConfig** ? exec configuration.
- **Detach** - Detach from the exec command
- **Tty** - Boolean value to allocate a pseudo-TTY
Status Codes:

View file

@ -19,10 +19,11 @@ type ExecConfig struct {
func ExecConfigFromJob(job *engine.Job) *ExecConfig {
execConfig := &ExecConfig{
User: job.Getenv("User"),
Privileged: job.GetenvBool("Privileged"),
// TODO(vishh): Expose 'User' once it is supported.
//User: job.Getenv("User"),
// TODO(vishh): Expose 'Privileged' once it is supported.
//Privileged: job.GetenvBool("Privileged"),
Tty: job.GetenvBool("Tty"),
Container: job.Getenv("Container"),
AttachStdin: job.GetenvBool("AttachStdin"),
AttachStderr: job.GetenvBool("AttachStderr"),
AttachStdout: job.GetenvBool("AttachStdout"),