Dokploy/dokploy
1
0
Fork 0
mirror of https://github.com/Dokploy/dokploy.git synced 2026-06-19 14:15:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix: improve error handling during volume restoration process

Browse Source 
- Simplified error handling in the volume restoration logic by removing detailed error messages and stack traces.
- Updated user feedback to provide clearer instructions when a volume is in use, enhancing the user experience during restoration attempts.
- Ensured that the restoration process aborts gracefully with informative messages when prerequisites are not met.
This commit is contained in:
Mauricio Siu
2025-07-01 01:21:54 -06:00
parent c6d760a904
commit 934ec9b16a
2 changed files with 22 additions and 251 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
apps/dokploy/server/api/routers/volume-backups.ts
View File

@@ -155,19 +155,9 @@ export const volumeBackupsRouter = createTRPCRouter({
emit.next(
"🎉 All containers/services have been restarted with the restored volume.",
);
} catch (error) {
} catch {
emit.next("");
emit.next("❌ Volume restore failed!");
emit.next(
`💥 Error: ${error instanceof Error ? error.message : "Unknown error"}`,
);
if (error instanceof Error && error.stack) {
emit.next("📋 Stack trace:");
for (const line of error.stack.split("\n")) {
if (line.trim()) emit.next(` ${line}`);
}
}
} finally {
emit.complete();
}

261
packages/server/src/utils/volume-backups/utils.ts
View File

@@ -181,257 +181,38 @@ export const restoreVolume = async (
docker volume rm ${volumeName} --force
${baseRestoreCommand}
else
echo "Found containers using the volume:"
echo "$CONTAINERS_USING_VOLUME"
# Collect unique services and containers to stop
echo "=== PHASE 1: Stopping all containers/services using the volume ==="
SERVICES_TO_RESTORE=""
CONTAINERS_TO_RESTORE=""
echo ""
echo "⚠️ WARNING: Cannot restore volume as it is currently in use!"
echo ""
echo "📋 The following containers are using volume '${volumeName}':"
echo ""
echo "$CONTAINERS_USING_VOLUME" | while IFS='|' read container_id container_name container_state labels; do
echo "Analyzing container: $container_id ($container_name) - State: $container_state"
echo " 🐳 Container: $container_name ($container_id)"
echo " Status: $container_state"
# Check if it's a swarm service
# Determine container type
if echo "$labels" | grep -q "com.docker.swarm.service.name="; then
SERVICE_NAME=$(echo "$labels" | grep -o "com.docker.swarm.service.name=[^,]*" | cut -d'=' -f2)
# Check if we already processed this service
if ! echo "$SERVICES_TO_RESTORE" | grep -q "SWARM:$SERVICE_NAME"; then
echo "SWARM:$SERVICE_NAME" >> /tmp/dokploy_services_to_stop
echo "Will stop swarm service: $SERVICE_NAME"
fi
# Check if it's a compose container
echo " Type: Docker Swarm Service ($SERVICE_NAME)"
elif echo "$labels" | grep -q "com.docker.compose.project="; then
PROJECT_NAME=$(echo "$labels" | grep -o "com.docker.compose.project=[^,]*" | cut -d'=' -f2)
SERVICE_NAME_COMPOSE=$(echo "$labels" | grep -o "com.docker.compose.service=[^,]*" | cut -d'=' -f2 || echo "")
# Check if it's a compose stack (swarm mode) or regular compose
if echo "$labels" | grep -q "com.docker.stack.namespace="; then
STACK_SERVICE_NAME="$PROJECT_NAME"_"$SERVICE_NAME_COMPOSE"
# Check if we already processed this stack service
if ! echo "$SERVICES_TO_RESTORE" | grep -q "STACK:$STACK_SERVICE_NAME"; then
echo "STACK:$STACK_SERVICE_NAME" >> /tmp/dokploy_services_to_stop
echo "Will stop compose stack service: $STACK_SERVICE_NAME"
fi
else
echo "COMPOSE:$container_id|$container_name|$container_state" >> /tmp/dokploy_services_to_stop
echo "Will stop compose container: $container_id ($container_name)"
fi
echo " Type: Docker Compose ($PROJECT_NAME)"
else
echo "REGULAR:$container_id|$container_name|$container_state" >> /tmp/dokploy_services_to_stop
echo "Will stop regular container: $container_id ($container_name)"
echo " Type: Regular Container"
fi
echo ""
done
# Now stop all services and containers
if [ -f /tmp/dokploy_services_to_stop ]; then
echo ""
echo "=== STOPPING ALL SERVICES/CONTAINERS ==="
while read line; do
TYPE=$(echo "$line" | cut -d':' -f1)
DATA=$(echo "$line" | cut -d':' -f2-)
if [ "$TYPE" = "SWARM" ]; then
SERVICE_NAME="$DATA"
echo "Stopping swarm service: $SERVICE_NAME"
# Get current replicas and store for later
ACTUAL_REPLICAS=$(docker service inspect "$SERVICE_NAME" --format "{{.Spec.Mode.Replicated.Replicas}}" 2>/dev/null || echo "0")
echo "SWARM:$SERVICE_NAME:$ACTUAL_REPLICAS" >> /tmp/dokploy_services_to_restore
# Scale down to 0 if not already
if [ "$ACTUAL_REPLICAS" != "0" ]; then
echo "Scaling service $SERVICE_NAME to 0 replicas (was $ACTUAL_REPLICAS)"
docker service scale "$SERVICE_NAME=0"
else
echo "Service $SERVICE_NAME is already scaled to 0"
fi
elif [ "$TYPE" = "STACK" ]; then
STACK_SERVICE_NAME="$DATA"
echo "Stopping compose stack service: $STACK_SERVICE_NAME"
# Get current replicas and store for later
ACTUAL_REPLICAS=$(docker service inspect "$STACK_SERVICE_NAME" --format "{{.Spec.Mode.Replicated.Replicas}}" 2>/dev/null || echo "0")
echo "STACK:$STACK_SERVICE_NAME:$ACTUAL_REPLICAS" >> /tmp/dokploy_services_to_restore
# Scale down to 0 if not already
if [ "$ACTUAL_REPLICAS" != "0" ]; then
echo "Scaling stack service $STACK_SERVICE_NAME to 0 replicas (was $ACTUAL_REPLICAS)"
docker service scale "$STACK_SERVICE_NAME=0"
else
echo "Stack service $STACK_SERVICE_NAME is already scaled to 0"
fi
elif [ "$TYPE" = "COMPOSE" ]; then
container_id=$(echo "$DATA" | cut -d'|' -f1)
container_name=$(echo "$DATA" | cut -d'|' -f2)
container_state=$(echo "$DATA" | cut -d'|' -f3)
echo "COMPOSE:$container_id|$container_name|$container_state" >> /tmp/dokploy_services_to_restore
# Stop the container if running
if [ "$container_state" = "running" ]; then
echo "Stopping compose container: $container_id ($container_name)"
docker stop "$container_id"
else
echo "Compose container $container_id is already stopped"
fi
elif [ "$TYPE" = "REGULAR" ]; then
container_id=$(echo "$DATA" | cut -d'|' -f1)
container_name=$(echo "$DATA" | cut -d'|' -f2)
container_state=$(echo "$DATA" | cut -d'|' -f3)
echo "REGULAR:$container_id|$container_name|$container_state" >> /tmp/dokploy_services_to_restore
# Stop the container if running
if [ "$container_state" = "running" ]; then
echo "Stopping regular container: $container_id ($container_name)"
docker stop "$container_id"
else
echo "Regular container $container_id is already stopped"
fi
fi
done < /tmp/dokploy_services_to_stop
# Wait for all services to scale down
echo ""
echo "=== WAITING FOR ALL SERVICES TO STOP ==="
echo "Waiting for all containers to be fully removed..."
sleep 10
# Verify all swarm services are scaled down
if grep -q "SWARM:" /tmp/dokploy_services_to_restore 2>/dev/null; then
echo "Verifying swarm services are scaled down..."
grep "SWARM:" /tmp/dokploy_services_to_restore | while read line; do
SERVICE_NAME=$(echo "$line" | cut -d':' -f2)
while [ $(docker service ps "$SERVICE_NAME" --filter "desired-state=running" -q 2>/dev/null | wc -l) -gt 0 ]; do
echo "Still waiting for swarm service $SERVICE_NAME to scale down..."
sleep 3
done
echo "Swarm service $SERVICE_NAME is fully scaled down"
done
fi
# Verify all stack services are scaled down
if grep -q "STACK:" /tmp/dokploy_services_to_restore 2>/dev/null; then
echo "Verifying stack services are scaled down..."
grep "STACK:" /tmp/dokploy_services_to_restore | while read line; do
STACK_SERVICE_NAME=$(echo "$line" | cut -d':' -f2)
while [ $(docker service ps "$STACK_SERVICE_NAME" --filter "desired-state=running" -q 2>/dev/null | wc -l) -gt 0 ]; do
echo "Still waiting for stack service $STACK_SERVICE_NAME to scale down..."
sleep 3
done
echo "Stack service $STACK_SERVICE_NAME is fully scaled down"
done
fi
echo ""
echo "=== REMOVING STOPPED SWARM CONTAINERS USING THE VOLUME ==="
# Only remove stopped containers that belong to Swarm services
# Regular containers and compose containers should NOT be removed since they can't be recreated automatically
SWARM_STOPPED_CONTAINERS=$(docker ps -a --filter "status=exited" --format "{{.ID}} {{.Names}} {{.Labels}}" | while read line; do
container_id=$(echo "$line" | awk '{print $1}')
container_name=$(echo "$line" | awk '{print $2}')
labels=$(echo "$line" | cut -d' ' -f3-)
# Check if this container uses the volume
volume_used=$(docker inspect "$container_id" --format '{{range .Mounts}}{{.Name}} {{end}}' 2>/dev/null | grep -w "${volumeName}" || true)
# Only include if it uses the volume AND belongs to a Swarm service
if [ -n "$volume_used" ] && echo "$labels" | grep -q "com.docker.swarm.service.name="; then
echo "$container_id"
fi
done)
if [ -n "$SWARM_STOPPED_CONTAINERS" ]; then
echo "Found stopped Swarm containers using the volume that need to be removed:"
echo "$SWARM_STOPPED_CONTAINERS"
echo "$SWARM_STOPPED_CONTAINERS" | while read container_id; do
if [ -n "$container_id" ]; then
echo "Removing stopped Swarm container: $container_id"
docker rm "$container_id" --force
fi
done
echo "All stopped Swarm containers using the volume have been removed"
else
echo "No stopped Swarm containers using the volume found"
fi
echo "Note: Regular containers and compose containers are preserved and will be restarted later"
echo ""
echo "=== PHASE 2: All containers/services stopped - Proceeding with volume restore ==="
# Remove volume and restore - ONLY ONCE!
echo "Removing existing volume: ${volumeName}"
docker volume rm ${volumeName} --force
${baseRestoreCommand}
echo ""
echo "=== PHASE 3: Restarting all services/containers ==="
# Restore all services and containers
while read line; do
TYPE=$(echo "$line" | cut -d':' -f1)
DATA=$(echo "$line" | cut -d':' -f2-)
if [ "$TYPE" = "SWARM" ]; then
SERVICE_NAME=$(echo "$DATA" | cut -d':' -f1)
REPLICAS=$(echo "$DATA" | cut -d':' -f2)
if [ "$REPLICAS" != "0" ]; then
echo "Scaling swarm service $SERVICE_NAME back to $REPLICAS replicas"
docker service scale "$SERVICE_NAME=$REPLICAS"
else
echo "Leaving swarm service $SERVICE_NAME at 0 replicas (was already 0)"
fi
elif [ "$TYPE" = "STACK" ]; then
STACK_SERVICE_NAME=$(echo "$DATA" | cut -d':' -f1)
REPLICAS=$(echo "$DATA" | cut -d':' -f2)
if [ "$REPLICAS" != "0" ]; then
echo "Scaling stack service $STACK_SERVICE_NAME back to $REPLICAS replicas"
docker service scale "$STACK_SERVICE_NAME=$REPLICAS"
else
echo "Leaving stack service $STACK_SERVICE_NAME at 0 replicas (was already 0)"
fi
elif [ "$TYPE" = "COMPOSE" ]; then
container_id=$(echo "$DATA" | cut -d'|' -f1)
container_name=$(echo "$DATA" | cut -d'|' -f2)
echo "Starting compose container: $container_id ($container_name)"
docker start "$container_id"
elif [ "$TYPE" = "REGULAR" ]; then
container_id=$(echo "$DATA" | cut -d'|' -f1)
container_name=$(echo "$DATA" | cut -d'|' -f2)
echo "Starting regular container: $container_id ($container_name)"
docker start "$container_id"
fi
done < /tmp/dokploy_services_to_restore
echo ""
echo "✅ Volume restore completed successfully!"
echo "✅ All services and containers have been restarted!"
# Clean up temp files
rm -f /tmp/dokploy_services_to_stop
rm -f /tmp/dokploy_services_to_restore
fi
echo ""
echo "🔧 To restore this volume, please:"
echo " 1. Stop all containers/services using this volume"
echo " 2. Remove the existing volume: docker volume rm ${volumeName}"
echo " 3. Run the restore operation again"
echo ""
echo "❌ Volume restore aborted - volume is in use"
exit 1
fi
fi
`;