lifecycle hooks by ndeloof · Pull Request #21061 · docker/docs

ndeloof · 2024-10-04T12:57:51Z

Description

Related issues or tickets

Reviews

Technical review
Editorial review
Product review

netlify · 2024-10-04T12:58:07Z

✅ Deploy Preview for docsdocker ready!

Name	Link
🔨 Latest commit	`8b96dfb`
🔍 Latest deploy log	https://app.netlify.com/sites/docsdocker/deploys/670e8c225939b10009f69518
😎 Deploy Preview	https://deploy-preview-21061--docsdocker.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

aevesdocker

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 · 2024-10-11T08:58:47Z

+
+## Services lifecycle hooks
+
+As Docker Compose run a service container, the actual command being ran is managed


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

jhrotko · 2024-10-11T08:59:26Z

+## 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


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

jhrotko · 2024-10-11T09:03:06Z

+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


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?

jhrotko · 2024-10-11T09:10:39Z

+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


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...

jhrotko · 2024-10-11T09:14:42Z

+
+### Post-Start hooks
+
+Post-Start lifecycle hooks are ran after container has been started. There's no


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.

jhrotko · 2024-10-11T09:16:09Z

+
+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.


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.

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>

aevesdocker

LGTM. Want this to be published now or with the compose release?

ndeloof · 2024-10-15T15:45:42Z

better get this published with the compose release

ndeloof requested a review from aevesdocker as a code owner October 4, 2024 12:57

github-actionsBot added the area/compose Relates to docker-compose.yml spec or docker-compose binary label Oct 4, 2024

ndeloof force-pushed the hooks branch 2 times, most recently from f8514f6 to ca7443dCompare October 7, 2024 09:34

ndeloof requested review from glours and jhrotko October 7, 2024 09:34

aevesdocker reviewed Oct 9, 2024
View reviewed changes

jhrotko suggested changes Oct 11, 2024
View reviewed changes

ndeloof force-pushed the hooks branch from ca7443d to 631949bCompare October 15, 2024 14:29

ndeloof requested a review from aevesdocker October 15, 2024 14:58

aevesdocker reviewed Oct 15, 2024
View reviewed changes

Comment threadcontent/manuals/compose/how-tos/lifecycle.md

lifecycle hooks
8b96dfb
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>

ndeloof force-pushed the hooks branch from 631949b to 8b96dfbCompare October 15, 2024 15:37

aevesdocker approved these changes Oct 15, 2024
View reviewed changes

aevesdocker merged commit 9fed920 into docker:mainOct 29, 2024


		## Services lifecycle hooks

		As Docker Compose run a service container, the actual command being ran is managed

	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

	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


		### Post-Start hooks

		Post-Start lifecycle hooks are ran after container has been started. There's no

	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.

Uh oh!

Conversation

ndeloof commented Oct 4, 2024

Description

Related issues or tickets

Reviews

Uh oh!

netlifyBot commented Oct 4, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docsdocker ready!

Uh oh!

aevesdocker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jhrotkoOct 11, 2024

Choose a reason for hiding this comment

Uh oh!

jhrotkoOct 11, 2024

Choose a reason for hiding this comment

Uh oh!

jhrotkoOct 11, 2024

Choose a reason for hiding this comment

Uh oh!

jhrotkoOct 11, 2024

Choose a reason for hiding this comment

Uh oh!

jhrotkoOct 11, 2024

Choose a reason for hiding this comment

Uh oh!

jhrotkoOct 11, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aevesdocker left a comment

Choose a reason for hiding this comment

Uh oh!

ndeloof commented Oct 15, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

netlifyBot commented Oct 4, 2024•
edited
Loading

jhrotkoOct 11, 2024•
edited
Loading