Skip to content

Commit

Permalink
Add warning re: signal handling with string cmd (#4008)
Browse files Browse the repository at this point in the history
We've seen a couple instances where the k8s signal handling wrought a
certain amount of confusion, so let's document this for users/future us.
  • Loading branch information
nemacysts authored Feb 19, 2025
1 parent 27ae135 commit 8b441b7
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/source/yelpsoa_configs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,9 @@ instance MAY have:

* ``cmd``: The command that is executed. If a string, will be wrapped in ``/bin/sh -c``.
If a list, will be executed directly as is with no shell parsing.
WARNING: if the command registers any signal handlers (e.g., you want to gracefully shutdown upon SIGTERM), you'll
need to pass the command in as a list to ensure that Kubernetes sends signals to a process that can handle them.
For internal users, COMPINFRA-4755 has some information around ways that we'll make this automatic/unnecessary in the future.

* ``args``: An array of docker args if you use the `"entrypoint"
<https://docs.docker.com/reference/builder/#entrypoint>`_ functionality.
Expand Down

0 comments on commit 8b441b7

Please sign in to comment.