Hooks to linux,solaris and doc clarification #855
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: John Howard <jhoward@microsoft.com>
wking
reviewed
May 24, 2017
| @@ -356,7 +356,8 @@ Runtime implementations MAY support any valid values for platform-specific field | |||
|
|
|||
| ## <a name="configHooks" />Hooks | |||
|
|
|||
| Hooks allow for the configuration of custom actions related to the [lifecycle](runtime.md#lifecycle) of the container. | |||
| Hooks allow for the configuration of custom actions related to the [lifecycle](runtime.md#lifecycle) of the container if supported by the platform. | |||
| On Linux, they are run after the container namespaces are created. | |||
There was a problem hiding this comment.
Not all hooks are run after creation. In fact, there are currently no postcreate hooks (prestart hooks are called “after the start operation is called but before the user-specified program command is executed”. I suggest not adding this line (and removing it from the Go comment).
| @@ -356,7 +356,8 @@ Runtime implementations MAY support any valid values for platform-specific field | |||
|
|
|||
| ## <a name="configHooks" />Hooks | |||
|
|
|||
| Hooks allow for the configuration of custom actions related to the [lifecycle](runtime.md#lifecycle) of the container. | |||
| Hooks allow for the configuration of custom actions related to the [lifecycle](runtime.md#lifecycle) of the container if supported by the platform. | |||
There was a problem hiding this comment.
I'd rather follow the example set for process.user.uid and friends and make this:
## Linux and Solaris Hooks
For Linux- and Solaris-based systems, the configuration structure supports `hooks` for configuring custom actions related to the [lifecycle](runtime.md#lifecycle) of the container.Although I'd rather have this ABNF so we could say:
hooks(object, OPTIONAL, linux solaris) …
to protect readers who skipped over this lead-in paragraph and went straight to the hooks list entry.
There was a problem hiding this comment.
If we don't clearly say which platforms can rely on hooks, we're back to the rejected #472.
|
SGTM |
|
LGTM |
1 similar comment
|
LGTM |
|
On Wed, May 31, 2017 at 03:44:08PM -0700, Tianon Gravi wrote:
Hmm. I'll file follow-up PRs for at least this point and something about this one. |
wking
added a commit
to wking/opencontainer-runtime-spec
that referenced
this pull request
May 31, 2017
Not all hooks are run after creation. In fact, there are currently no postcreate hooks (prestart hooks are called "after the start operation is called but before the user-specified program command is executed". Fixing 28e8f68 (Hooks to linux,solaris and doc clarification, 2017-05-24, opencontainers#855), which pulled the broken line in from a Go comment [1]. [1]: opencontainers#855 (comment) Signed-off-by: W. Trevor King <wking@tremily.us>
wking
added a commit
to wking/opencontainer-runtime-spec
that referenced
this pull request
May 31, 2017
Clarifying the language from 28e8f68 (Hooks to linux,solaris and doc clarification, 2017-05-24, opencontainers#855), which did not say which platforms support hooks and which don't. Without something like this commit, there's no clear way for config authors to know if their runtime will support hooks or not, and there was previous agreement that that sort of ambiguity was not helpful [1]. This also gives normative Markdown grounding for the Go platform tag added in 28e8f68. [1]: opencontainers#472 (comment) Signed-off-by: W. Trevor King <wking@tremily.us>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: John Howard jhoward@microsoft.com
Made
hooksLinux and solaris. Windows does not currently support hooks. While we might at a later date, have clarified that in the .go and .md file.Also, as I mentioned in the description of #854, platform-specific things are generally in the
.mdfile, not the.gofile. Hence moved the Linux comment.