SchedulerX:Graceful shutdown for scheduled jobs

Method 1: Send SIGTERM with kill -15

SchedulerX registers a JVM shutdown hook that intercepts SIGTERM. Send the signal to the application process:

kill -15 <PID>

The process completes running jobs according to the configured shutdown mode, then exits.

Method 2: Use the Spring Boot actuator shutdown endpoint

For Spring Boot applications, use the built-in actuator to trigger a shutdown event. SchedulerX responds to Spring container shutdown events and completes running jobs before the application exits.

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

management.endpoint.shutdown.enabled=true
management.endpoints.web.exposure.include=shutdown

curl -X GET http://<node-ip>:<port>/actuator/shutdown

Method 3: Use the SchedulerX HTTP endpoint

Enable the built-in SchedulerX HTTP endpoint:

spring.schedulerx2.httpServerEnable=true
spring.schedulerx2.httpServerPort=51886

Trigger the shutdown:

curl -X GET http://<node-ip>:51886/schedulerx/worker/shutdown

Self-managed continuous delivery (CD) pipeline

Include the graceful shutdown logic in the stop script of your CD pipeline. The following example sends SIGTERM, polls for process exit, and falls back to SIGKILL after a timeout:

# After starting the application, write the PID to app.pid.
PID="{Application deployment path}/app.pid"
FORCE=1
if [ -f ${PID} ]; then
  TARGET_PID=`cat ${PID}`
  kill -15 ${TARGET_PID}
  loop=1
  while(( $loop<=5 ))
  do
    # health: Check whether the application process is still running.
    # Replace with your own health check command.
    health
    if [ $? == 0 ]; then
      echo "check $loop times, current app has not stop yet."
      sleep 5s
      let "loop++"
    else
      FORCE=0
      break
    fi
  done
  if [ $FORCE -eq 1 ]; then
  	echo "App(pid:${TARGET_PID}) stop timeout, forced termination."
    kill -9 ${TARGET_PID}
  fi
  rm -rf ${PID}
  echo "App(pid:${TARGET_PID}) stopped successful."
fi

Kubernetes PreStop hook

Use the Kubernetes Pod preStop lifecycle hook to trigger graceful shutdown before a Pod is terminated.

Option A: Exec script

Run a script or send SIGTERM directly:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-app
spec:
  replicas: 3
  selector:
    matchLabels:
      app: my-app
  template:
    metadata:
      labels:
        app: my-app
    spec:
      containers:
      - name: my-app-container
        image: my-app-image:latest
        lifecycle:
          preStop:
            exec:
              # command: ["/bin/sh", "-c", "kill -15 PID && sleep 30"]
              command: ["/bin/sh", "-c", "Script path /stop.sh"] 

Option B: HTTP request

Call the appropriate HTTP endpoint based on your application type:

• Spring Boot applications: Set path to /actuator/shutdown.

• Non-Spring applications: Set path to /schedulerx/worker/shutdown after enabling the SchedulerX HTTP endpoint.

apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-app
spec:
  replicas: 3
  selector:
    matchLabels:
      app: my-app
  template:
    metadata:
      labels:
        app: my-app
    spec:
      containers:
      - name: my-app-container
        image: my-app-image:latest
        lifecycle:
          preStop:
            httpGet:
              path: /schedulerx/worker/shutdown
              port: 51886
              scheme: HTTP

Alibaba Cloud platform integration

If you deploy through Enterprise Distributed Application Service (EDAS) or through Microservices Engine (MSE) with Container Service for Kubernetes (ACK), SchedulerX graceful shutdown integrates automatically after you enable graceful shutdown on the platform. For details, see:

• Gracefully shut down Spring Cloud applications (EDAS)

• Graceful shutdown (MSE)