diff --git a/config.md b/config.md index 7823e162b..42a4701e6 100644 --- a/config.md +++ b/config.md @@ -321,7 +321,7 @@ Presently there are `Prestart`, `Poststart` and `Poststop`. * [`Poststart`](#poststart) is a list of hooks to be run immediately after the container process is started * [`Poststop`](#poststop) is a list of hooks to be run after the container process exits -Hooks allow one to run code before/after various lifecycle events of the container. +Hooks allow one to run programs before/after various lifecycle events of the container. Hooks MUST be called in the listed order. 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. diff --git a/runtime.md b/runtime.md index dd092c521..41a4c7246 100644 --- a/runtime.md +++ b/runtime.md @@ -15,9 +15,9 @@ This MUST be unique across all containers on this host. There is no requirement that it be unique across hosts. * **`status`**: (string) is the runtime state of the container. The value MAY be one of: - * `created`: the container has been created but the user-specified code has not yet been executed - * `running`: the container has been created and the user-specified code is running - * `stopped`: the container has been created and the user-specified code has been executed but is no longer running + * `created`: the container has been created but the user-specified program has not yet been executed + * `running`: the container has been created and the user-specified program is running + * `stopped`: the container has been created and the user-specified program has been executed but is no longer running Additional values MAY be defined by the runtime, however, they MUST be used to represent new runtime states not defined above. * **`pid`**: (int) is the ID of the container process, as seen by the host. @@ -49,12 +49,12 @@ The lifecycle describes the timeline of events that happen from when a container 1. OCI compliant runtime's [`create`](runtime.md#create) command is invoked with a reference to the location of the bundle and a unique identifier. 2. The container's runtime environment MUST be created according to the configuration in [`config.json`](config.md). If the runtime is unable to create the environment specified in the [`config.json`](config.md), it MUST generate an error. - While the resources requested in the [`config.json`](config.md) MUST be created, the user-specified code (from [`process`](config.md#process)) MUST NOT be run at this time. + While the resources requested in the [`config.json`](config.md) MUST be created, the user-specified program (from [`process`](config.md#process)) MUST NOT be run at this time. Any updates to [`config.json`](config.md) after this step MUST NOT affect the container. 3. Once the container is created additional actions MAY be performed based on the features the runtime chooses to support. However, some actions might only be available based on the current state of the container (e.g. only available while it is started). 4. Runtime's [`start`](runtime.md#start) command is invoked with the unique identifier of the container. - The runtime MUST run the user-specified code, as specified by [`process`](config.md#process). + The runtime MUST run the user-specified program, as specified by [`process`](config.md#process). 5. The container's process is stopped. This MAY happen due to them erroring out, exiting, crashing or the runtime's [`kill`](runtime.md#kill) operation being invoked. 6. Runtime's [`delete`](runtime.md#delete) command is invoked with the unique identifier of the container. @@ -86,7 +86,7 @@ This operation MUST return the state of a container as specified in the [State]( This operation MUST generate an error if it is not provided a path to the bundle and the container ID to associate with the container. If the ID provided is not unique across all containers within the scope of the runtime, or is not valid in any other way, the implementation MUST generate an error and a new container MUST NOT be created. Using the data in [`config.json`](config.md), this operation MUST create a new container. -This means that all of the resources associated with the container MUST be created, however, the user-specified code MUST NOT be run at this time. +This means that all of the resources associated with the container MUST be created, however, the user-specified program MUST NOT be run at this time. If the runtime cannot create the container as specified in [`config.md`](config.md), it MUST generate an error and a new container MUST NOT be created. Upon successful completion of this operation the `status` property of this container MUST be `created`. @@ -102,7 +102,7 @@ Any changes made to the [`config.json`](config.md) file after this operation wil This operation MUST generate an error if it is not provided the container ID. Attempting to start a container that does not exist MUST generate an error. Attempting to start an already started container MUST have no effect on the container and MUST generate an error. -This operation MUST run the user-specified code as specified by [`process`](config.md#process). +This operation MUST run the user-specified program as specified by [`process`](config.md#process). Upon successful completion of this operation the `status` property of this container MUST be `running`.