feat: implement volume backup and restore functionalities

- Added backupVolume and restoreVolume functions to handle the backup and restoration of volume data. - Introduced a new index file to streamline exports for volume backup utilities. - Updated volume backup logic to include scheduling and improved user feedback during operations. - Refactored existing volume backup utilities for better organization and clarity.
2026-11-01 09:42:16 +00:00 · 2025-07-02 00:23:27 -06:00
parent 7726c8db21
commit c5311f2a9f
7 changed files with 233 additions and 213 deletions
@@ -0,0 +1,90 @@
+import { type findVolumeBackupById, paths } from "@dokploy/server";
+import { normalizeS3Path } from "../backups/utils";
+import { getS3Credentials } from "../backups/utils";
+import path from "node:path";
+import { findComposeById } from "@dokploy/server";
+
+export const backupVolume = async (
+	volumeBackup: Awaited<ReturnType<typeof findVolumeBackupById>>,
+) => {
+	const { serviceType, volumeName, turnOff, prefix } = volumeBackup;
+	const serverId =
+		volumeBackup.application?.serverId || volumeBackup.compose?.serverId;
+	const { VOLUME_BACKUPS_PATH } = paths(!!serverId);
+	const destination = volumeBackup.destination;
+	const backupFileName = `${volumeName}-${new Date().toISOString()}.tar`;
+	const bucketDestination = `${normalizeS3Path(prefix)}${backupFileName}`;
+	const rcloneFlags = getS3Credentials(volumeBackup.destination);
+	const rcloneDestination = `:s3:${destination.bucket}/${bucketDestination}`;
+	const volumeBackupPath = path.join(VOLUME_BACKUPS_PATH, volumeBackup.appName);
+
+	const rcloneCommand = `rclone copyto ${rcloneFlags.join(" ")} "${volumeBackupPath}/${backupFileName}" "${rcloneDestination}"`;
+
+	const baseCommand = `
+	set -e
+	echo "Volume name: ${volumeName}"
+	echo "Backup file name: ${backupFileName}"
+	echo "Turning off volume backup: ${turnOff ? "Yes" : "No"}"
+	echo "Starting volume backup" 
+	echo "Dir: ${volumeBackupPath}"
+    docker run --rm \
+  -v ${volumeName}:/volume_data \
+  -v ${volumeBackupPath}:/backup \
+  ubuntu \
+  bash -c "cd /volume_data && tar cvf /backup/${backupFileName} ."
+  echo "Volume backup done ✅"
+  echo "Starting upload to S3..."
+  ${rcloneCommand}
+  echo "Upload to S3 done ✅"
+  `;
+
+	if (!turnOff) {
+		return baseCommand;
+	}
+
+	if (serviceType === "application") {
+		return `
+		echo "Stopping application to 0 replicas"
+		ACTUAL_REPLICAS=$(docker service inspect ${volumeBackup.application?.appName} --format "{{.Spec.Mode.Replicated.Replicas}}")
+		echo "Actual replicas: $ACTUAL_REPLICAS"
+		docker service scale ${volumeBackup.application?.appName}=0
+        ${baseCommand}
+		echo "Starting application to $ACTUAL_REPLICAS replicas"
+        docker service scale ${volumeBackup.application?.appName}=$ACTUAL_REPLICAS
+  `;
+	}
+	if (serviceType === "compose") {
+		const compose = await findComposeById(
+			volumeBackup.compose?.composeId || "",
+		);
+		let stopCommand = "";
+		let startCommand = "";
+
+		if (compose.composeType === "stack") {
+			stopCommand = `
+			echo "Stopping compose to 0 replicas"
+			echo "Service name: ${compose.appName}_${volumeBackup.serviceName}"
+            ACTUAL_REPLICAS=$(docker service inspect ${compose.appName}_${volumeBackup.serviceName} --format "{{.Spec.Mode.Replicated.Replicas}}")
+            echo "Actual replicas: $ACTUAL_REPLICAS"
+            docker service scale ${compose.appName}_${volumeBackup.serviceName}=0`;
+			startCommand = `
+			echo "Starting compose to $ACTUAL_REPLICAS replicas"
+			docker service scale ${compose.appName}_${volumeBackup.serviceName}=$ACTUAL_REPLICAS`;
+		} else {
+			stopCommand = `
+			echo "Stopping compose container"
+            ID=$(docker ps -q --filter "label=com.docker.compose.project=${compose.appName}" --filter "label=com.docker.compose.service=${volumeBackup.serviceName}")
+            docker stop $ID`;
+			startCommand = `
+            echo "Starting compose container"
+            docker start $ID
+			echo "Compose container started"
+			`;
+		}
+		return `
+        ${stopCommand}
+        ${baseCommand}
+        ${startCommand}
+  `;
+	}
+};