Skip to content

Commit bebdd29

Browse files
committed
config: Make 'process.args' optional
Since be59415 (Split create and start, 2016-04-01, opencontainers#384), it's possible for a container process to never execute user-specified code (e.g. you can call 'create', 'kill', 'delete' without calling 'start'). For folks who expect to do that, there's no reason to define process.args. The only other process property required for all platforms is 'cwd', but the runtime's idler code isn't specified in sufficient detail for the configuration author to have an opinion about what its working directory should be. On Linux and Solaris, 'user' is also required for 'uid' and 'gid'. My preferred approach here is to make those optional and define defaults [1,2]: If unset, the runtime will not attempt to manipulate the user ID (e.g. not calling setuid(2) or similar). But the maintainer consensus is that they want those to be explicitly required properties [3,4,5]. With the current spec, one option could be to make process optional (with the idler's working directory unspecified) for OSes besides Linux and Solaris. On Windows, username is optional, but it's not clear how intentional that was [6]. [1]: opencontainers#417 (comment) [2]: https://groups.google.com/a/opencontainers.org/forum/#!topic/dev/DWdystx5X3A Subject: Exposing platform defaults Date: Thu, 14 Jan 2016 15:36:26 -0800 Message-ID: <20160114233625.GN6362@odin.tremily.us> [3]: http://ircbot.wl.linuxfoundation.org/meetings/opencontainers/2016/opencontainers.2016-05-04-17.00.log.html#l-44 [4]: opencontainers#417 (comment) [5]: opencontainers#417 (comment) [6]: opencontainers#618 Signed-off-by: W. Trevor King <wking@tremily.us>
1 parent 4b42ec4 commit bebdd29

File tree

4 files changed

+5
-4
lines changed

4 files changed

+5
-4
lines changed

config.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,9 @@ See links for details about [mountvol](http://ss64.com/nt/mountvol.html) and [Se
126126
* **`cwd`** (string, REQUIRED) is the working directory that will be set for the executable.
127127
This value MUST be an absolute path.
128128
* **`env`** (array of strings, OPTIONAL) with the same semantics as [IEEE Std 1003.1-2001's `environ`][ieee-1003.1-2001-xbd-c8.1].
129-
* **`args`** (array of strings, REQUIRED) with similar semantics to [IEEE Std 1003.1-2001 `execvp`'s *argv*][ieee-1003.1-2001-xsh-exec].
129+
* **`args`** (array of strings, OPTIONAL) with similar semantics to [IEEE Std 1003.1-2001 `execvp`'s *argv*][ieee-1003.1-2001-xsh-exec].
130130
This specification extends the IEEE standard in that at least one entry is REQUIRED, and that entry is used with the same semantics as `execvp`'s *file*.
131+
This property is REQUIRED when [`start`](runtime.md#start) is called.
131132

132133
For Linux-based systems the process structure supports the following process specific fields:
133134

runtime.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ This operation MUST generate an error if it is not provided the container ID.
103103
Attempting to start a container that does not exist MUST generate an error.
104104
Attempting to start an already started container MUST have no effect on the container and MUST generate an error.
105105
This operation MUST run the user-specified program as specified by [`process`](config.md#process).
106+
This operation MUST generate an error if `process.args` was not set.
106107

107108
Upon successful completion of this operation the `status` property of this container MUST be `running`.
108109

schema/config-schema.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,7 @@
7474
"id": "https://opencontainers.org/schema/bundle/process",
7575
"type": "object",
7676
"required": [
77-
"cwd",
78-
"args"
77+
"cwd"
7978
],
8079
"properties": {
8180
"args": {

specs-go/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ type Process struct {
3838
// User specifies user information for the process.
3939
User User `json:"user"`
4040
// Args specifies the binary and arguments for the application to execute.
41-
Args []string `json:"args"`
41+
Args []string `json:"args,omitempty"`
4242
// Env populates the process environment for the process.
4343
Env []string `json:"env,omitempty"`
4444
// Cwd is the current working directory for the process and must be

0 commit comments

Comments
 (0)