Skip to content

start: Add a --state option #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wking wants to merge 1 commit into from
Closed

start: Add a --state option #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion runtime.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ Start a container from a bundle directory.
* *`--id <ID>`* Set the container ID when creating or joining a container.
If not set, the runtime is free to pick any ID that is not already in use.
* *`--bundle <PATH>`* Override the path to the bundle directory (defaults to the current working directory).
* *`--state <PATH>`* The runtime MUST write the state JSON to this path (creating a new file or truncating a previous file as necessary).
The path may not support seeking (e.g. `/dev/fd/3`).
* *Standard streams:* The runtime MUST attach its standard streams directly to the application process without inspection.
* *Environment variables*
* *`LISTEN_FDS`:* The number of file descriptors passed.
Expand All @@ -61,11 +63,18 @@ Start a container from a bundle directory.
Example:
```sh
# in a bundle directory with a process that echos "hello" and exits 42
$ funC start --id hello-1
$ funC start --id hello-1 --state hello.json
hello

$ echo $?
42
$ cat hello.json
{
"version": "0.1.0",
"id": "hello-1",
"pid": 4422,
"root": "/var/lib/oci/hello"
}
```

[posix-encoding]: http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap06.html#tag_06_02
Expand Down