Skip to content

runtime: Document args[0] and the no-usable-args fallback #118

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

runtime: Document args[0] and the no-usable-args fallback #118

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
16 changes: 9 additions & 7 deletions runtime.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,22 +75,24 @@ If a hook returns a non-zero exit code, then an error is logged and the remainin
"hooks" : {
"prestart": [
{
"path": "/usr/bin/fix-mounts",
"args": ["arg1", "arg2"],
"args": ["/usr/bin/fix-mounts", "arg1", "arg2"],
"env": [ "key1=value1"]
},
{
"path": "/usr/bin/setup-network"
"path": "/usr/bin/setup-network",
"args": ["net.eth1", "start"],
}
],
"poststop": [
{
"path": "/usr/sbin/cleanup.sh",
"args": ["-f"]
"args": ["/usr/sbin/cleanup.sh", "-f"]
}
]
}
```

`path` is required for a hook.
`args` and `env` are optional.
`args` is passed to the executable, and includes the command as `args[0]` (which MUST be an absolute path).
`path` is optional, but if set it MUST be an absolute path.
When set, it takes precedence over `args[0]` when selecting for the executable, but it does not effect the arguments passed to that executable.
For example, the `setup-network` script above will still have `net.eth1` as `args[0]`.
`env` is optional.