Skip to content

Commit f0835e9

Browse files
committed
*: Restore hook lifecycle information removed by create/start split
I expect the lifecycle information was removed accidentally in be59415 (Split create and start, 2016-04-01, opencontainers#384), because for a time it seemed like that PR would also be removing hooks. Putting the lifecycle information back in, I made some tweaks to adjust to the new environment, for example: * Put the pre-start hooks after the 'start' call, but before the meat of the start call (the container-process exec trigger). Folks who want a post-create hook can add one with that name. I'd like to have renamed poststop to post-delete to avoid confusion like [1]. But the motivation for keeping hooks was backwards compatibility [2] so I've left the name alone. * Put each "...command is invoked..." lifecycle entry in its own list entry, to match the 'create' list entry. * Move the rules about what happens on hook failure into the lifecycle. This matches pre-split entries like: If any prestart hook fails, then the container MUST be stopped and the lifecycle continues at step 7. and avoids respecifying that information in a second location (config.md). * I added the warning section to try and follow post-split's generic "generates an error" approach while respecting the pre-split desire to see what failed (we had "then an error including the exit code and the stderr is returned to the caller" and "then an error is logged"). * I left the state 'id' context out, since Michael didn't want it [3]. [1]: opencontainers#395 Subject: Run post-stop hooks before the container sandbox is deleted. [2]: opencontainers#483 (comment) Subject: *: Remove hooks [3]: opencontainers#532 (comment) Subject: Restore hook language removed by create/start split Signed-off-by: W. Trevor King <[email protected]>
1 parent 3297cd5 commit f0835e9

File tree

2 files changed

+19
-13
lines changed

2 files changed

+19
-13
lines changed

config.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -339,24 +339,19 @@ The [state](runtime.md#state) of the container is passed to the hooks over stdin
339339

340340
### Prestart
341341

342-
The pre-start hooks are called after the container process is spawned, but before the user supplied command is executed.
343-
They are called after the container namespaces are created on Linux, so they provide an opportunity to customize the container.
342+
The pre-start hooks MUST be called after the [`start`](runtime.md#start) operation is called but [before the user-specified program command is executed](runtime.md#lifecycle).
343+
They provide an opportunity to customize the container.
344344
In Linux, for e.g., the network namespace could be configured in this hook.
345345

346-
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.
347-
348346
### Poststart
349347

350-
The post-start hooks are called after the user process is started.
348+
The post-start hooks MUST be called [after the user-specified process is executed](runtime#lifecycle) but before the [`start`](runtime.md#start) operation returns.
351349
For example this hook can notify user that real process is spawned.
352350

353-
If a hook returns a non-zero exit code, then an error is logged and the remaining hooks are executed.
354-
355351
### Poststop
356352

357-
The post-stop hooks are called after the container process is stopped.
353+
The post-stop hooks MUST be called [after the container is deleted](runtime#lifecycle) but before the [`delete`](runtime.md#delete) operation returns.
358354
Cleanup or debugging could be performed in such a hook.
359-
If a hook returns a non-zero exit code, then an error is logged and the remaining hooks are executed.
360355

361356
### Example
362357

runtime.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,17 +57,28 @@ The lifecycle describes the timeline of events that happen from when a container
5757
3. Once the container is created additional actions MAY be performed based on the features the runtime chooses to support.
5858
However, some actions might only be available based on the current state of the container (e.g. only available while it is started).
5959
4. Runtime's [`start`](runtime.md#start) command is invoked with the unique identifier of the container.
60-
The runtime MUST run the user-specified program, as specified by [`process`](config.md#process).
61-
5. The container process exits.
60+
5. The [prestart hooks](config.md#prestart) MUST be invoked by the runtime.
61+
If any prestart hook fails, the runtime MUST generate an error, stop the container, and continue the lifecycle at step 10.
62+
6. The runtime MUST run the user-specified program, as specified by [`process`](config.md#process).
63+
7. The [poststart hooks](config.md#poststart) MUST be invoked by the runtime.
64+
If any poststart hook fails, the runtime MUST log a warning, but the remaining hooks and lifecycle continue as if the hook had succeeded.
65+
8. The container process exits.
6266
This MAY happen due to erroring out, exiting, crashing or the runtime's [`kill`](runtime.md#kill) operation being invoked.
63-
6. Runtime's [`delete`](runtime.md#delete) command is invoked with the unique identifier of the container.
64-
The container MUST be destroyed by undoing the steps performed during create phase (step 2).
67+
9. Runtime's [`delete`](runtime.md#delete) command is invoked with the unique identifier of the container.
68+
10. The container MUST be destroyed by undoing the steps performed during create phase (step 2).
69+
11. The [poststop hooks](config.md#poststop) MUST be invoked by the runtime.
70+
If any poststop hook fails, the runtime MUST log a warning, but the remaining hooks and lifecycle continue as if the hook had succeeded.
6571

6672
## Errors
6773

6874
In cases where the specified operation generates an error, this specification does not mandate how, or even if, that error is returned or exposed to the user of an implementation.
6975
Unless otherwise stated, generating an error MUST leave the state of the environment as if the operation were never attempted - modulo any possible trivial ancillary changes such as logging.
7076

77+
## Warnings
78+
79+
In cases where the specified operation logs a warning, this specification does not mandate how, or even if, that warning is returned or exposed to the user of an implementation.
80+
Unless otherwise stated, logging a warning does not change the flow of the operation; it MUST continue as if the warning had not been logged.
81+
7182
## Operations
7283

7384
OCI compliant runtimes MUST support the following operations, unless the operation is not supported by the base operating system.

0 commit comments

Comments
 (0)