lifecycle hooks #21061
Merged
lifecycle hooks #21061
Conversation
This file contains hidden or 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
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
github-actions
bot
added
the
area/compose
ndeloof
force-pushed
the
hooks
branch
2 times, most recently
from
f8514f6 to
ca7443d
Compare
aevesdocker
reviewed
Oct 9, 2024
Contributor
aevesdocker
left a comment
aevesdocker
left a comment
There was a problem hiding this comment.
Hey @ndeloof, thanks for the PR
With ChatGPT helping my understanding, I've provided an iteration of your draft that expands the explanation and uses slightly simpler language. Let me know what you think.
Also I noticed the Compose spec updates https://github.com/compose-spec/compose-spec/pull/538/files. Can we get that added in here too as part of this PR?
jhrotko
suggested changes
Oct 11, 2024
|
|
||
| ## Services lifecycle hooks | ||
|
|
||
| As Docker Compose run a service container, the actual command being ran is managed |
Contributor
There was a problem hiding this comment.
Suggested change
| As Docker Compose run a service container, the actual command being ran is managed | |
| As Docker Compose runs a service container, the actual command being ran is managed |
| ## Services lifecycle hooks | ||
|
|
||
| As Docker Compose run a service container, the actual command being ran is managed | ||
| by the combination of `entrypoint` and `command` as documented [here](https://docs.docker.com/engine/containers/run/#default-entrypoint). Those ley you manage |
Contributor
There was a problem hiding this comment.
Suggested change
| by the combination of `entrypoint` and `command` as documented [here](https://docs.docker.com/engine/containers/run/#default-entrypoint). Those ley you manage | |
| by the combination of `entrypoint` and `command` as documented [here](https://docs.docker.com/engine/containers/run/#default-entrypoint). These let you manage |
| As Docker Compose run a service container, the actual command being ran is managed | ||
| by the combination of `entrypoint` and `command` as documented [here](https://docs.docker.com/engine/containers/run/#default-entrypoint). Those ley you manage | ||
| container setup and termination, catching SITERM signal to process a graceful shutdown. In some circumstances anyway it is easier to consider those a separate | ||
| command to be introduced as lifecycle hooks, to be ran just after the container |
Contributor
There was a problem hiding this comment.
I am not sure what you mean here -
In some circumstances anyway it is easier to consider those a separate
command to be introduced as lifecycle hooks, to be ran just after the container
is started, or just before Compose stop it.
Could you rephrase it?
| command to be introduced as lifecycle hooks, to be ran just after the container | ||
| is started, or just before Compose stop it. | ||
|
|
||
| Another benefit for lifecycle hooks, is that hook command can run with additional |
Contributor
There was a problem hiding this comment.
Suggestion: instead of
Another benefit for lifecycle hooks, is that hook command can run with additional privileges
->
Another advantage of lifecycle hooks is the ability to run hook commands with elevated privileges...
|
|
||
| ### Post-Start hooks | ||
|
|
||
| Post-Start lifecycle hooks are ran after container has been started. There's no |
Contributor
There was a problem hiding this comment.
There's no guarantee on the timing hook executes while the container entrypoint is ran.
to
The timing of the hook execution is not guaranteed while the container's entrypoint is running.
|
|
||
| Pre-Stop lifecycle hooks are ran before an explicit request to stop container by a | ||
| compose command, either `docker compose down` or interrupting `docker compose up` | ||
| with Ctrl+C. Hook won't execute if container stops on its own or is killed. |
Contributor
There was a problem hiding this comment.
Suggested change
| with Ctrl+C. Hook won't execute if container stops on its own or is killed. | |
| with Ctrl+C. The hook execution timing is not assured during the execution of the container's entrypoint. |
aevesdocker
reviewed
Oct 15, 2024
Signed-off-by: Nicolas De Loof <[email protected]>
aevesdocker
approved these changes
Oct 15, 2024
Contributor
aevesdocker
left a comment
aevesdocker
left a comment
There was a problem hiding this comment.
LGTM. Want this to be published now or with the compose release?
Contributor
Author
|
better get this published with the compose release |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
documentation for docker/compose#12166
Related issues or tickets
Reviews