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

Cleanup exec API docs and available params

Browse source 
Adds pertitent information about what is expected in the json payload
and comments out unsupported (exec) features in runConfig.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
This commit is contained in:
Brian Goff 2014-11-20 13:01:59 -05:00
parent 739d917d70
commit d4ba00bd42
4 changed files with 26 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
daemon/exec.go
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,

16
docs/sources/reference/api/docker_remote_api_v1.15.md
View file

@ -1560,7 +1560,6 @@ Sets up an exec instance in a running container `id`
"Cmd":[
"date"
],
"Container":"e90e34656806",
}
**Example response**:
@ -1574,7 +1573,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:
@ -1585,8 +1589,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**:
@ -1607,7 +1612,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:

16
docs/sources/reference/api/docker_remote_api_v1.16.md
View file

@ -1511,7 +1511,6 @@ Sets up an exec instance in a running container `id`
"Cmd":[
"date"
],
"Container":"e90e34656806",
}
**Example response**:
@ -1525,7 +1524,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:
@ -1536,8 +1540,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**:
@ -1558,7 +1563,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:

7
runconfig/exec.go
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"),