Skip to content

Commit

Permalink
runtime: Add a 'state' command
Browse files Browse the repository at this point in the history
Partially catch up with opencontainers/runtime-spec@7117ede7 (Expand
on the definition of our ops, 2015-10-13,
opencontainers/runtime-spec#225, v0.4.0).  The state example is
adapted from the current release [1], but we defer the actual
definition of that JSON to runtime-spec.  The UTF-8 requirement
extends [2] to the output state.

[1]: https://github.com/opencontainers/runtime-spec/blob/v1.0.0-rc1/runtime.md#state
[2]: https://github.com/opencontainers/runtime-spec/blob/v1.0.0-rc1/glossary.md#json
  I'd intended this restriction to cover all of our JSON [3], but I
  don't have a problem keeping the state restriction in this
  repository.
[3]: opencontainers/runtime-spec@0f9ec22b (glossary: Specify UTF-8 for all
     our JSON, 2015-09-25, opencontainers/runtime-spec#107).

Signed-off-by: W. Trevor King <wking@tremily.us>
  • Loading branch information
wking committed Jun 22, 2016
1 parent f827719 commit 77250e8
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,38 @@ $ echo $?
42
```

### state

Request the container state.

* *Arguments*
* *`<ID>`* The container whose state is being requested.
* *Standard streams:*
* *stdin:* The runtime MUST NOT attempt to read from its stdin.
* *stdout:* The runtime MUST print the UTF-8 state JSON to its stdout.
* *stderr:* The runtime MAY print diagnostic messages to stderr, and the format for those lines is not specified in this document.
* *Exit code:* Zero if the state was successfully written to stdout and non-zero on errors.

#### Example

```
# in a bundle directory with a process that sleeps for several seconds
$ funC start --id sleeper-1 &
$ funC state sleeper-1
{
"ociVersion": "1.0.0-rc1",
"id": "sleeper-1",
"status": "running",
"pid": 4422,
"bundlePath": "/containers/sleeper",
"annotations" {
"myKey": "myValue"
}
}
$ echo $?
0
```

[posix-encoding]: http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap06.html#tag_06_02
[posix-lang]: http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html#tag_08_02
[posix-locale-encoding: http://www.unicode.org/reports/tr35/#Bundle_vs_Item_Lookup
Expand Down

0 comments on commit 77250e8

Please sign in to comment.