Graceful delegate shutdown
Harness Delegate is designed to shut down gracefully. The process of graceful delegate shutdown is as follows:
- The delegate receives an instruction to quit.
- A grace period begins during which the delegate:
- Stops accepting new tasks.
- Works to complete running tasks.
- The grace period ends.
- Delegates that have not quit are force-terminated.
- Incomplete tasks are discarded.
Grace period
The length of the grace period is configurable.
Delegate type | Grace period | Default interval |
---|---|---|
Immutable image | Yes | Configurable (details below) |
Legacy image | No | 30 seconds |
Configure the default interval for a Kubernetes deployment
Open the delegate manifest file and locate the container spec
(spec.containers
). Change the terminationGracePeriodSeconds
as shown in the following YAML. In the example below, terminationGracePeriodSeconds
is set to 10 minutes.
spec:
terminationGracePeriodSeconds: 600
restartPolicy: Always
containers:
- image: example/org:custom-delegate
imagePullPolicy: Always
name: delegate
securityContext:
allowPrivilegeEscalation: false
runAsUser: 0
Configure the default interval for an Amazon ECS deployment
Open the delegate manifest file and locate the container containerDefinitions
. Change the stopTimeout
as shown in the following JSON. In the example below, stopTimeout
is set to 10 minutes.
note
For more information on stopTimeout
, go to Container timeouts in the Amazon ECS documentation.
{
"containerDefinitions": [
{
"portMappings": [
{
"hostPort": 8080,
"protocol": "tcp",
"containerPort": 8080
}
],
"cpu": 1,
"environment": [
{
"name": "ACCOUNT_ID",
"value": "<ACCOUNT_ID>"
},
{
"name": "DELEGATE_TOKEN",
"value": "<DELEGATE_TOKEN>"
},
{
"name": "DELEGATE_TYPE",
"value": "DOCKER"
},
{
"name": "INIT_SCRIPT",
"value": ""
},
{
"name": "DEPLOY_MODE",
"value": "KUBERNETES"
},
{
"name": "MANAGER_HOST_AND_PORT",
"value": "<MANAGER_HOST_AND_PORT>"
},
{
"name": "DELEGATE_NAME",
"value": "<DELEGATE_NAME>"
},
{
"name": "LOG_STREAMING_SERVICE_URL",
"value": "<LOG_STREAMING_SERVICE_URL>"
},
{
"name": "DELEGATE_TAGS",
"value": ""
},
{
"name": "NEXT_GEN",
"value": "true"
}
],
"memory": 2048,
"image": "harness/delegate:22.12.77802",
"essential": true,
"hostname": "<DELEGATE_HOST>",
"name": "<DELEGATE_NAME>",
"stopTimeout": 120
}
],
"memory": "2048",
"requiresCompatibilities": [
"EC2"
],
"cpu": "1024",
"family": "harness-delegate-task-spec"
}
Graceful shutdown events
The event that initiates the graceful shutdown depends on delegate type.
Delegate environment | Trigger |
---|---|
Kubernetes | Pod termination, eviction, or user-initiated scaling |
Docker | docker stop command |
Shell | ./stop.sh instruction |