Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Backup a docker-compose project, including all images, named and unnamed volumes, container filesystems, config, logs, and databases.
#!/usr/bin/env bash
### Bash Environment Setup
# http://redsymbol.net/articles/unofficial-bash-strict-mode/
# https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html
# set -o xtrace
set -o errexit
set -o errtrace
set -o nounset
set -o pipefail
IFS=$'\n'
# Fully backup a docker-compose project, including all images, named and unnamed volumes, container filesystems, config, logs, and databases.
project_dir="${1:-$PWD}"
if [ -f "$project_dir/docker-compose.yml" ]; then
echo "[i] Found docker-compose config at $project_dir/docker-compose.yml"
else
echo "[X] Could not find a docker-compose.yml file in $project_dir"
exit 1
fi
project_name=$(basename "$project_dir")
backup_time=$(date +"%Y-%m-%d_%H-%M")
backup_dir="$project_dir/data/backups/$backup_time"
# Source any needed environment variables
[ -f "$project_dir/docker-compose.env" ] && source "$project_dir/docker-compose.env"
[ -f "$project_dir/.env" ] && source "$project_dir/.env"
echo "[+] Backing up $project_name project to $backup_dir"
mkdir -p "$backup_dir"
echo " - Saving docker-compose.yml config"
cp "$project_dir/docker-compose.yml" "$backup_dir/docker-compose.yml"
# Optional: run a command inside the contianer to dump your application's state/database to a stable file
echo " - Saving application state to ./dumps"
mkdir -p "$backup_dir/dumps"
# your database/stateful service export commands to run inside docker go here, e.g.
# docker-compose exec postgres env PGPASSWORD="$POSTGRES_PASSWORD" pg_dump -U "$POSTGRES_USER" "$POSTGRES_DB" | gzip -9 > "$backup_dir/dumps/$POSTGRES_DB.sql.gz"
# docker-compose exec redis redis-cli SAVE
# docker-compose exec redis cat /data/dump.rdb | gzip -9 > "$backup_dir/dumps/redis.rdb.gz"
# Optional: pause the containers before backing up to ensure consistency
# docker-compose pause
for service_name in $(docker-compose config --services); do
image_id=$(docker-compose images -q "$service_name")
image_name=$(docker image inspect --format '{{json .RepoTags}}' "$image_id" | jq -r '.[0]')
container_id=$(docker-compose ps -q "$service_name")
service_dir="$backup_dir/$service_name"
echo "[*] Backing up ${project_name}__${service_name} to ./$service_name..."
mkdir -p "$service_dir"
# save image
echo " - Saving $image_name image to ./$service_name/image.tar"
docker save --output "$service_dir/image.tar" "$image_id"
if [[ -z "$container_id" ]]; then
echo " - Warning: $service_name has no container yet."
echo " (has it been started at least once?)"
continue
fi
# save config
echo " - Saving container config to ./$service_name/config.json"
docker inspect "$container_id" > "$service_dir/config.json"
# save logs
echo " - Saving stdout/stderr logs to ./$service_name/docker.{out,err}"
docker logs "$container_id" > "$service_dir/docker.out" 2> "$service_dir/docker.err"
# save data volumes
mkdir -p "$service_dir/volumes"
for source in $(docker inspect -f '{{range .Mounts}}{{println .Source}}{{end}}' "$container_id"); do
volume_dir="$service_dir/volumes$source"
echo " - Saving $source volume to ./$service_name/volumes$source"
mkdir -p $(dirname "$volume_dir")
cp -a -r "$source" "$volume_dir"
done
# save container filesystem
echo " - Saving container filesystem to ./$service_name/container.tar"
docker export --output "$service_dir/container.tar" "$container_id"
# save entire container root dir
echo " - Saving container root to $service_dir/root"
cp -a -r "/var/lib/docker/containers/$container_id" "$service_dir/root"
done
echo "[*] Compressing backup folder to $backup_dir.tar.gz"
tar -zcf "$backup_dir.tar.gz" --totals "$backup_dir" && rm -Rf "$backup_dir"
echo "[√] Finished Backing up $project_name to $backup_dir.tar.gz."
# Resume the containers if paused above
# docker-compose unpause
@arifrhm
Copy link

arifrhm commented Apr 4, 2022

$ sh docker-compose-backup.sh
[i] Found docker-compose config at /g/BNS-dev-phase-2(30Mar2022)/ufe-bns/docker-compose.yml
[+] Backing up ufe-bns project to /g/BNS-dev-phase-2(30Mar2022)/ufe-bns/data/backups/2022-04-04_12-06
- Saving docker-compose.yml config
- Saving application state to ./dumps
time="2022-04-04T12:06:37+07:00" level=warning msg="The "REACT_APP_API_V1" variable is not set. Defaulting to a blank string."
time="2022-04-04T12:06:37+07:00" level=warning msg="network default: network.external.name is deprecated in favor of network.name"
time="2022-04-04T12:06:39+07:00" level=warning msg="The "REACT_APP_API_V1" variable is not set. Defaulting to a blank string."
time="2022-04-04T12:06:39+07:00" level=warning msg="network default: network.external.name is deprecated in favor of network.name"
time="2022-04-04T12:06:42+07:00" level=warning msg="The "REACT_APP_API_V1" variable is not set. Defaulting to a blank string."
time="2022-04-04T12:06:42+07:00" level=warning msg="network default: network.external.name is deprecated in favor of network.name"
[*] Backing up ufe-bns__api to ./api...
- Saving registry.gitlab.com/ihsansolusi/universal-front-end/api:latest image to ./api/image.tar
- Saving container config to ./api/config.json
- Saving stdout/stderr logs to ./api/docker.{out,err}
- Saving G:\BNS-dev-phase-2(30Mar2022)\ufe-bns\api\app volume to ./api/volumesG:\BNS-dev-phase-2(30Mar2022)\ufe-bns\api\app
- Saving container filesystem to ./api/container.tar
- Saving container root to /g/BNS-dev-phase-2(30Mar2022)/ufe-bns/data/backups/2022-04-04_12-06/api/root
cp: cannot stat '/var/lib/docker/containers/f7d4ec6770e19e07bc1cf716715bc16f60e3ffbdb4d5db3db546ee8f5800dc90': No such file or directory

@Joeshiett
Copy link

Joeshiett commented Apr 4, 2022

Don't use docker-compose installed with snap. This will result in the cp: cannot stat '/var/lib/docker/containers/f7d4e........ error. Install docker-compose the manual way.

@killmasta93
Copy link

killmasta93 commented Apr 25, 2022

Hi not sure if someone else has gotten this
bak.sh: 8: set: Illegal option -o errtrace

running on ubuntu 20 LTS server

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment