Skip to content

Define hook structure clearly and explicitly #631

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
wants to merge 1 commit into from
Closed

Define hook structure clearly and explicitly #631

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
14 changes: 8 additions & 6 deletions config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,14 @@ Hooks allow one to run programs before/after various lifecycle events of the con
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.

Hook paths are absolute and are executed from the host's filesystem in the [runtime namespace][runtime-namespace].
The hook structure supports the following fields:

* **`path`** (string, REQUIRED) is absolute path of the command to run from the host's filesystem in the [runtime namespace][runtime-namespace]
* **`args`** (array of string, OPTIONAL) holds command line arguments, including the command as Args[0]
* **`env`** (array of string, OPTIONAL) is the environment of the process
* **`timeout`** (int, OPTIONAL) is the number of seconds before aborting the hook

The semantics of `path`, `args` and `env` are the same as in [golang Cmd](https://golang.org/pkg/os/exec/#Cmd).

### Prestart

Expand Down Expand Up @@ -377,11 +384,6 @@ If a hook returns a non-zero exit code, then an error is logged and the remainin
}
```

`path` is REQUIRED for a hook.
`args` and `env` are OPTIONAL.
`timeout` is the number of seconds before aborting the hook.
The semantics are the same as `Path`, `Args` and `Env` in [golang Cmd](https://golang.org/pkg/os/exec/#Cmd).

## Annotations

**`annotations`** (object, OPTIONAL) contains arbitrary metadata for the container.
Expand Down