Skip to content

Commit 3298396

Browse files
committed
lifecycle: no hypens
Signed-off-by: Vincent Batts <[email protected]>
1 parent 0936a9c commit 3298396

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

runtime-config.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,32 +5,32 @@
55
Lifecycle hooks allow custom events for different points in a container's runtime.
66
Presently there are `Prestart`, `Poststart` and `Poststop`.
77

8-
* [`Prestart`](#pre-start) is a list of hooks to be run before the container process is executed
9-
* [`Poststart`](#post-start) is a list of hooks to be run immediately after the container process is started
10-
* [`Poststop`](#post-stop) is a list of hooks to be run after the container process exits
8+
* [`Prestart`](#prestart) is a list of hooks to be run before the container process is executed
9+
* [`Poststart`](#poststart) is a list of hooks to be run immediately after the container process is started
10+
* [`Poststop`](#poststop) is a list of hooks to be run after the container process exits
1111

1212
Hooks allow one to run code before/after various lifecycle events of the container.
1313
Hooks MUST be called in the listed order.
1414
The state of the container is passed to the hooks over stdin, so the hooks could get the information they need to do their work.
1515

1616
Hook paths are absolute and are executed from the host's filesystem.
1717

18-
### Pre-start
18+
### Prestart
1919

2020
The pre-start hooks are called after the container process is spawned, but before the user supplied command is executed.
2121
They are called after the container namespaces are created on Linux, so they provide an opportunity to customize the container.
2222
In Linux, for e.g., the network namespace could be configured in this hook.
2323

2424
If a hook returns a non-zero exit code, then an error including the exit code and the stderr is returned to the caller and the container is torn down.
2525

26-
### Post-start
26+
### Poststart
2727

2828
The post-start hooks are called after the user process is started.
2929
For example this hook can notify user that real process is spawned.
3030

3131
If a hook returns a non-zero exit code, then an error is logged and the remaining hooks are executed.
3232

33-
### Post-stop
33+
### Poststop
3434

3535
The post-stop hooks are called after the container process is stopped.
3636
Cleanup or debugging could be performed in such a hook.

0 commit comments

Comments
 (0)