How to execute a script when I terminate a docker container

Question

I want when I type on my console:

docker ^a docker container^ stop

To execute a script before terminating. is that possible?

Answer 1

The docker stop command attempts to stop a running container first by sending a SIGTERM signal to the root process (PID 1) in the container. If the process hasn't exited within the timeout period a SIGKILL signal will be sent.

In practice, that means that you have to define an ENTRYPOINT script, which will intercept (trap) the SIGTERM signal and execute any shutdown logic as appropriate.

A sample entrypoint script can look something like this:

#!/bin/bash

#Define cleanup procedure
cleanup() {
    echo "Container stopped, performing cleanup..."
}

#Trap SIGTERM
trap 'cleanup' SIGTERM

#Execute a command
"${@}" &

#Wait
wait $!

(shell signal handling, with respect to wait, is explained in a bit more details here)

Note, that with the entrypoint above, the cleanup logic will only be executed if container is stopped explicitly, if you wish it to also run when the underlying process/command stops by itself (or fails), you can restructure it as follows.

...

#Trap SIGTERM
trap 'true' SIGTERM

#Execute command
"${@}" &

#Wait
wait $!

#Cleanup
cleanup

Answer 2

I worked way too long on getting this to work. Here is a solution that worked for me (based on the other response given):

docker-compose.yml

version: "3.8"
services:
    your_service:
        image: alpine
        entrypoint: ["/bin/sh", "./shutdown_handler.sh"]

shutdown_handler.sh

#!/bin/bash
echo "Waiting for signal..."
echo "pid=$$"

# Sleeping in the background seems to do the job
sleep infinity &
wait $!

# ADD YOUR CODE HERE
echo "Received arbitrary signal"