Thanks to visit codestin.com
Credit goes to github.com

Skip to content

📝 Add note in Docker docs about ensuring graceful shutdowns and lifespan events with CMD exec form #11960

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

Merged
tiangolo merged 7 commits into from
Aug 24, 2024
Merged

📝 Add note in Docker docs about ensuring graceful shutdowns and lifespan events with CMD exec form #11960

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d3f331b
add caution admonition for CMD command
GPla Aug 6, 2024
db17378
fix grammar
GPla Aug 6, 2024
ab00c77
Fix code formatting
GPla Aug 6, 2024
5a69f4d
added line about docker compose
GPla Aug 6, 2024
44cd326
rewording to include keyword
GPla Aug 6, 2024
705cc85
Merge branch 'master' into docs/docker-cmd-note
svlandeg Aug 19, 2024
48781e8
📝 Tweak docs about Docker CMD exec form
tiangolo Aug 24, 2024
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
32 changes: 32 additions & 0 deletions docs/en/docs/deployment/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,38 @@ Review what each line does by clicking each number bubble in the code. 👆

///

/// warning

Make sure to **always** use the **exec form** of the `CMD` instruction, as explained below.

///

#### Use `CMD` - Exec Form

The <a href="https://docs.docker.com/reference/dockerfile/#cmd" class="external-link" target="_blank">`CMD`</a> Docker instruction can be written using two forms:

✅ **Exec** form:

```Dockerfile
# ✅ Do this
CMD ["fastapi", "run", "app/main.py", "--port", "80"]
```

⛔️ **Shell** form:

```Dockerfile
# ⛔️ Don't do this
CMD fastapi run app/main.py --port 80
```

Make sure to always use the **exec** form to ensure that FastAPI can shutdown gracefully and [lifespan events](../advanced/events.md){.internal-link target=_blank} are triggered.

You can read more about it in the <a href="https://docs.docker.com/reference/dockerfile/#shell-and-exec-form" class="external-link" target="_blank">Docker docs for shell and exec form</a>.

This can be quite noticeable when using `docker compose`. See this Docker Compose FAQ section for more technical details: <a href="https://docs.docker.com/compose/faq/#why-do-my-services-take-10-seconds-to-recreate-or-stop" class="external-link" target="_blank">Why do my services take 10 seconds to recreate or stop?</a>.

#### Directory Structure

You should now have a directory structure like:

```
Expand Down