Merge branch 'graceful-shutdown-module'

Author: patternhelloworld

.env.example

@@ -61,6 +61,8 @@ DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES=["./shared/nginx-error-logs:/var/log/ngin
 # Check if the host folder or file exists
 DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
 
+DOCKER_COMPOSE_STOP_GRACEFUL_SHUTDOWN_PERIOD=40s
+
 NGINX_CLIENT_MAX_BODY_SIZE=50M
 
 # Format : docker-compose-${project_name}-original-ready.yml

.env.example.java

@@ -44,7 +44,7 @@
 DOCKER_COMPOSE_ENVIRONMENT={"TZ":"Asia/Seoul"}
 # This goes with "docker build ... in the 'run.sh' script file", and the command always contain "HOST_IP" and "APP_ENV" above.
 # docker exec -it CONTAINER_NAME cat /var/log/env_build_args.log
-DOCKER_BUILD_ARGS={"DOCKER_BUILDKIT":"1","PROJECT_ROOT_IN_CONTAINER":"/var/www/server/spring-sample-h-auth","FILE_STORAGE_ROOT_IN_CONTAINER":"/var/www/files","APP_ENV":"production"}
+DOCKER_BUILD_ARGS={"DOCKER_BUILDKIT":"1","PROJECT_ROOT_IN_CONTAINER":"/var/www/server/spring-sample-h-auth","FILE_STORAGE_ROOT_IN_CONTAINER":"/var/www/files","APP_ENV":"production","JVM_XMS":"1024","JVM_XMX":"2048"}
 DOCKER_BUILD_LABELS=["foo=happy","bar=sad"]
 # For Mac like, EX.  DOCKER_BUILD_ADDITIONAL_RAW_PARAMS=--platform linux/amd64
 DOCKER_BUILD_ADDITIONAL_RAW_PARAMS=--platform linux/amd64
@@ -54,6 +54,8 @@
 DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES=["./shared/nginx-error-logs:/var/log/nginx"]
 DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
 
+DOCKER_COMPOSE_STOP_GRACEFUL_SHUTDOWN_PERIOD=40s
+
 NGINX_CLIENT_MAX_BODY_SIZE=50M
 
 USE_MY_OWN_APP_YML=false

.env.example.java.commercial.ssl.sample

@@ -54,6 +54,8 @@ DOCKER_COMPOSE_SELECTIVE_VOLUMES=["/var/web/files/spring-sample-h-auth:/var/www/
 DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES=["/var/web/files/nginx/spring-sample-h-auth/logs:/var/log/nginx"]
 DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
 
+DOCKER_COMPOSE_STOP_GRACEFUL_SHUTDOWN_PERIOD=40s
+
 NGINX_CLIENT_MAX_BODY_SIZE=50M
 
 USE_MY_OWN_APP_YML=false

.env.example.node

@@ -49,6 +49,8 @@ DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES=[]
 DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
 DOCKER_COMPOSE_SELECTIVE_VOLUMES=[]
 
+DOCKER_COMPOSE_STOP_GRACEFUL_SHUTDOWN_PERIOD=40s
+
 NGINX_CLIENT_MAX_BODY_SIZE=50M
 
 USE_MY_OWN_APP_YML=false

.env.example.php

@@ -55,6 +55,8 @@
 DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES=["./shared/nginx-error-logs:/var/log/nginx"]
 DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
 
+DOCKER_COMPOSE_STOP_GRACEFUL_SHUTDOWN_PERIOD=40s
+
 NGINX_CLIENT_MAX_BODY_SIZE=50M
 
 USE_MY_OWN_APP_YML=false

README.md

@@ -238,6 +238,7 @@ DOCKER_COMPOSE_SELECTIVE_VOLUMES=["/your-project-path:/var/www/app"]
 ```shell
 # First, as the sample project requires MySQL8, run it separately.
 # You can use your own MySQL8 Docker or just clone "https://github.com/patternhelloworld/docker-mysql-8"
+# The SQL file is located at './samples/spring-sample-h-auth/.mysql/schema_all.sql'.
 ```
 
 ```shell
@@ -287,6 +288,11 @@ GOOD_APP_HEALTH_CHECK_PATTERN=UP
 DOCKER_COMPOSE_SELECTIVE_VOLUMES=["/my-host/files/:/in-container/files", "/my-host/java-spring-project/src/main/resources:/in-container/java-spring-project/src/main/resources"]
 # Check if the host folder or file exists
 DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
+
+# Currently, a graceful shutdown example is only provided for the Java sample. To enable graceful termination, make sure to handle SIGTERM in both your application and the Dockerfile.
+# Refer to "docker-compose-app-original.yml" which uses this property.
+DOCKER_COMPOSE_STOP_GRACEFUL_SHUTDOWN_PERIOD=40s
+
 # If APP_ENV is set to 'local', as specified in 'docker-compose-app-original.yml', synchronize your entire project as follows: "HOST_ROOT_LOCATION:PROJECT_LOCATION".
 # [IMPORTANT] If this is set to true, Nginx will be restarted, resulting in a short downtime. 
 # This option should be used when upgrading the Runner. See the "Upgrade" section below.

docker-compose-app-original.yml

@@ -15,6 +15,11 @@ services:
     env_file:
       - .env
     volumes: []
+    # After sending SIGTERM, Docker waits for a grace period (default is 10 seconds) to allow the process to exit.
+    # If the process does not terminate within this grace period,
+    # Docker sends a SIGKILL signal to terminate the process forcibly.
+    stop_signal: SIGTERM
+    stop_grace_period: ${DOCKER_COMPOSE_STOP_GRACEFUL_SHUTDOWN_PERIOD}
   ${PROJECT_NAME}-green:
     container_name: ${PROJECT_NAME}-green
     stdin_open: true
@@ -30,6 +35,8 @@ services:
     env_file:
       - .env
     volumes: []
+    stop_signal: SIGTERM
+    stop_grace_period: ${DOCKER_COMPOSE_STOP_GRACEFUL_SHUTDOWN_PERIOD}
 networks:
   dbgr-net:
     external:

docker-stack-app-original-blue.yml

@@ -13,6 +13,8 @@ services:
       replicas: 2
     networks:
       - dbgr-net
+    stop_signal: SIGTERM
+    stop_grace_period: ${DOCKER_COMPOSE_STOP_GRACEFUL_SHUTDOWN_PERIOD}
 networks:
   dbgr-net:
     external: true

docker-stack-app-original-green.yml

@@ -13,6 +13,8 @@ services:
       replicas: 2
     networks:
       - dbgr-net
+    stop_signal: SIGTERM
+    stop_grace_period: ${DOCKER_COMPOSE_STOP_GRACEFUL_SHUTDOWN_PERIOD}
 networks:
   dbgr-net:
     external: true

samples/spring-sample-h-auth/.docker/entrypoint/run-app.sh

@@ -16,5 +16,23 @@ if [ -z "$4" ]; then
     exit 1
 fi
 
+echo "[INSIDE APP CONTAINER][NOTICE] Starting Spring Boot App with graceful shutdown..."
+
+# graceful shutdown handler
+term_handler() {
+  echo "[INSIDE APP CONTAINER][NOTICE] Caught SIGTERM, forwarding to Java process (PID $pid)..."
+  if [ "$pid" -ne 0 ]; then
+    kill -SIGTERM "$pid"
+    wait "$pid"
+  fi
+  exit 143
+}
+
+trap 'term_handler' SIGTERM
+
 echo "[INSIDE APP CONTAINER][NOTICE] Run : java -Xms${3}m -Xmx${4}m -XX:+PrintGCDetails -Xloggc:${2}/logs/auth-gc.log -Dspring.config.location=file:${1}/src/main/resources/application.properties -Dlogging.config=file:${1}/src/main/resources/logback-spring.xml -jar /app.jar > ${2}/logs/auth-start.log 2>&1 &"
 java -Xms${3}m -Xmx${4}m -XX:+PrintGCDetails -Xloggc:${2}/auth-gc.log -Dspring.config.location=file:${1}/src/main/resources/application.properties  -jar /app.jar > ${2}/auth-start.log 2>&1 &
+pid=$!
+
+# foreground wait
+wait "$pid"

samples/spring-sample-h-auth/Dockerfile

@@ -24,12 +24,19 @@ WORKDIR $PROJECT_ROOT_IN_CONTAINER
 RUN cp $PROJECT_ROOT_IN_CONTAINER/target/*.jar  /app.jar
 
 RUN ln -s $PROJECT_ROOT_IN_CONTAINER/.docker/entrypoint/run-app.sh /run-app.sh
+RUN chmod 755 /run-app.sh
 
-RUN apk --no-cache add curl bash
+# dumb-init added!
+RUN apk update && apk add --no-cache bash curl dumb-init
+
+# dumb-init : https://engineeringblog.yelp.com/2016/01/dumb-init-an-init-for-docker.html
+##ENTRYPOINT ["/usr/bin/dumb-init", "--", "/my/script"]
 
 ENV PROJECT_ROOT_IN_CONTAINER=$PROJECT_ROOT_IN_CONTAINER
 ENV FILE_STORAGE_ROOT_IN_CONTAINER=$FILE_STORAGE_ROOT_IN_CONTAINER
 ENV JVM_XMS=$JVM_XMS
 ENV JVM_XMX=$JVM_XMX
 
-ENTRYPOINT sh /run-app.sh $PROJECT_ROOT_IN_CONTAINER $FILE_STORAGE_ROOT_IN_CONTAINER $JVM_XMS $JVM_XMX && /bin/sh
+#ENTRYPOINT ["/usr/bin/dumb-init", "--", "/my/script"]
+#ENTRYPOINT sh /run-app.sh $PROJECT_ROOT_IN_CONTAINER $FILE_STORAGE_ROOT_IN_CONTAINER $JVM_XMS $JVM_XMX && /bin/sh
+ENTRYPOINT ["/usr/bin/dumb-init", "--", "sh", "-c", "/run-app.sh $PROJECT_ROOT_IN_CONTAINER $FILE_STORAGE_ROOT_IN_CONTAINER $JVM_XMS $JVM_XMX && exec /bin/sh"]

samples/spring-sample-h-auth/src/main/resources/application.properties

@@ -60,4 +60,7 @@ app.test.auth.password=ee
 spring.mail.username=aaa@dd.com
 spring.mail.password=aaa
 
-spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
+spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
+
+server.shutdown=graceful
+spring.lifecycle.timeout-per-shutdown-phase=30s

samples/spring-sample-h-auth/src/main/resources/application.properties.commerical.ssl

@@ -66,3 +66,6 @@ server.ssl.key-store-password=11111
 server.ssl.key-store=/var/www/server/spring-sample-h-auth/yourdomain.com.jks
 server.ssl.key-store-type=jks
 server.ssl.key-alias=server
+
+server.shutdown=graceful
+spring.lifecycle.timeout-per-shutdown-phase=30s

samples/spring-sample-h-auth/src/main/resources/application.properties.sample

@@ -58,4 +58,7 @@ app.test.auth.password=ee
 spring.mail.username=aaa@dd.com
 spring.mail.password=aaa
 
-spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
+spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
+
+server.shutdown=graceful
+spring.lifecycle.timeout-per-shutdown-phase=30s