Skip to content

Commit 409bb10

Browse files
committed
Merge branch 'drop-exec-pause-resume-and-signal' into rfc-2119
* drop-exec-pause-resume-and-signal: Drop exec, pause, resume, and signal
2 parents ffdd704 + 49ccb8d commit 409bb10

File tree

1 file changed

+0
-78
lines changed

1 file changed

+0
-78
lines changed

runtime.md

Lines changed: 0 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -63,83 +63,5 @@ $ echo $?
6363
42
6464
```
6565

66-
### exec
67-
68-
Runs a secondary process in the given container.
69-
70-
* *Options*
71-
* *`--process <PATH>`* Override `process.json` with an alternative path. The path may not support seeking (e.g. `/dev/fd/3`).
72-
* *Arguments*
73-
* *`<ID>`* The container ID to join.
74-
* *Standard streams:* The runtime must attach its standard streams directly to the application process without inspection.
75-
* *Exit code:* The runtime must exit with the application process's exit code.
76-
77-
If the main application (launched by `start`) dies, all other processes in its container will be killed [TODO: link to lifecycle docs explaining this].
78-
79-
Example:
80-
```sh
81-
# in a directory with a process.json that echos "goodbye" and exits 43
82-
$ funC exec hello-1
83-
goodbye
84-
$ echo $?
85-
43
86-
```
87-
88-
### pause
89-
90-
Pause all processes in a container.
91-
92-
* *Options*
93-
* *`--wait`* Block until the process is completely paused.
94-
Otherwise return immediately after initiating the pause, which may happen before the pause is complete.
95-
* *Arguments*
96-
* *`<ID>`* The container ID to join.
97-
* *Exit code:* 0 on success, non-zero on error.
98-
99-
Example:
100-
```sh
101-
$ funC pause --wait hello-1
102-
$ echo $?
103-
0
104-
```
105-
106-
### resume
107-
108-
Unpause all processes in a container.
109-
110-
* *Options*
111-
* *`--wait`* Block until the process is completely unpaused.
112-
Otherwise return immediately after initiating the unpause, which may happen before the unpause is complete.
113-
* *Arguments*
114-
* *`<ID>`* The container ID to join.
115-
* *Exit code:* 0 on success, non-zero on error.
116-
117-
Example:
118-
```sh
119-
$ funC resume hello-1
120-
$ echo $?
121-
0
122-
```
123-
124-
### signal
125-
126-
Sends a signal to the container.
127-
128-
* *Options*
129-
* *`--signal <SIGNAL>`* The signal to send.
130-
This must be one of the valid POSIX signals, although runtimes on non-POSIX systems must translate the POSIX name to their platorm's analogous signal.
131-
Defaults to TERM.
132-
* *Arguments*
133-
* *`<ID>`* The container ID to join.
134-
* *Exit code:* 0 on success, non-zero on error.
135-
A 0 exit status does not imply the process has exited (as it may have caught the signal).
136-
137-
Example:
138-
```sh
139-
$ funC signal --signal KILL hello-1
140-
$ echo $?
141-
0
142-
```
143-
14466
[standard-streams]: https://github.com/opencontainers/specs/blob/v0.1.1/runtime-linux.md#file-descriptors
14567
[systemd-listen-fds]: http://www.freedesktop.org/software/systemd/man/sd_listen_fds.html

0 commit comments

Comments
 (0)