selfhosted-apps-docker/kopia_backup

Kopia

guide-by-example

WORK IN PROGRESS
WORK IN PROGRESS
WORK IN PROGRESS

Purpose & Overview

Backups.

• Official site
• Github

Kopia is a new open source backup utility with basicly all modern features.
Cross-platform, deduplication, encryption, compression, multithreaded speed, native cloud storage support, GUI versions, repository replication, snapshots mounting,...

Written in golang.

In this setup kopia cli is used to backup docker containers and the host, but general use and concepts are universal.

Some aspects of Kopia

• Kopia configuraiton uses term policies to apply to various
  • global policy, from which repos inherit settings
  • repos policy created on repo creation
• Backup configuration is stored in a repository where backups are stored.
  
• You connect to a repository before using it, and disconnect afterwards.
  Only one repository can be connected at the time(at least for cli version).
• Currently to ignore a folder - CACHEDIR.TAG file can be placed inside, with specific content and set policy: --ignore-cache-dirs true
• Maintence is automatic
• ..

Files and directory structure

/home/
│ └── ~/
│     └── docker/
│         ├── container-setup #2
│         ├── container-setup #1
│         ├── ...
│
/mnt/
│ └── mirror/
│      └── KOPIA/
│            └── arch_docker_host/
│
/opt/
  └── kopia-backup-home-etc.sh

only the script kopia-backup-home-etc.sh in /opt is created
uf, systemd unit files too, but I am not "drawing" /etc/systemd/system/ up there... even this will probably get deleted

The setup

install kopia

for arch linux, kopia is on AUR yay kopia-bin

the initial steps

use of sudo so that kopia has access everywhere

• the policy info and change

sudo kopia policy get --global
sudo kopia policy list
sudo kopia policy set --global --ignore-cache-dirs true --keep-annual 1 --keep-monthly 6 --keep-weekly 4 --keep-daily 14 --keep-hourly 0 --keep-latest 14

• repo creation

mkdir -p /mnt/mirror/KOPIA/docker_host_kopia
sudo kopia repository create filesystem --path /mnt/mirror/KOPIA/docker_host_kopia
sudo kopia repository connect filesystem --path /mnt/mirror/KOPIA/docker_host_kopia
sudo kopia repository status

• manual run

sudo kopia snapshot create /home/spravca/docker /etc
sudo kopia snapshot list

• mounting a backup

sudo kopia snapshot list
sudo kopia mount k7e2b0a503edd7604ff61c68655cd5ad7 /mnt/tmp &
sudo umount /mnt/tmp

the backup script

/opt/kopia-backup-home-etc.sh

#!/bin/bash

#sudo kopia policy set --global --ignore-cache-dirs true --keep-annual 1 --keep-monthly 6 --keep-weekly 4 --keep-daily 14 --keep-hourly 0 --keep-latest 14

REPOSITORY_PATH='/mnt/mirror/KOPIA/docker_host_kopia'
BACKUP_THIS='/home /etc'
KOPIA_PASSWORD='aaa'

kopia repository connect filesystem --path $REPOSITORY_PATH --password $KOPIA_PASSWORD
kopia snapshot create $BACKUP_THIS
kopia repository disconnect

Scheduled backups using systemd

Usually cron is used, but systemd provides better logging and control, so better get used to using it.
Heres some discussion on unit files.
ntfy is used for notifications, more info here

kopia-home-etc.service

[Unit]
Description=kopia backup
Wants=network-online.target
After=network-online.target
ConditionACPower=true
# OnFailure=ntfy@failure-%p.service
# OnSuccess=ntfy@success-%p.service

[Service]
Type=oneshot

# Lower CPU and I/O priority.
Nice=19
CPUSchedulingPolicy=batch
IOSchedulingPriority=7

IPAccounting=true
PrivateTmp=true
Environment="HOME=/root"

ExecStart=/opt/kopia-backup-home-etc.sh

kopia-home-etc.timer

[Unit]
Description=Run kopia backup

[Timer]
OnCalendar=*-*-* 02:00:00
RandomizedDelaySec=10min
Persistent=true

[Install]
WantedBy=timers.target

Mounting network storage using systemd

• files are placed in /etc/systemd/system
• the name of mount and automount files MUST correspond with the path
  replacing / with a -, but otherwise it must be the mounting path in the name
• for mounting that does not fail on boot if there are network issues, and mounts the target only on request - enable automount file, not mount file, so:
  sudo systemctl enable mnt-mirror.automount

mnt-mirror.mount

[Unit]
Description=3TB truenas mirror mount

[Mount]
What=//10.0.19.11/Mirror
Where=/mnt/mirror
Type=cifs
Options=rw,username=kopia,password=aaa,file_mode=0644,dir_mode=0755,uid=1000,gid=1000

[Install]
WantedBy=multi-user.target

mnt-mirror.automount

[Unit]
Description=3TB truenas mirror mount

[Automount]
Where=/mnt/mirror

[Install]
WantedBy=multi-user.target

Remote backup

... some day ...

Kopia in Windows

While GUI version seems like a way to go.. well its not there yet. The schedule it uses is running only under a user, theres no certainty it will run.

So here goes cli version

• download latest named kopia-X.XX.X-windows-x64.zip , ~11MB

• extract, move to C:\kopia

• download win_vss_before.ps1 and win_vss_after.ps1 from this repo, or crete them from here

• kopia-backup-home-etc.sh

• powershell as as administrator

• --enable-actions

• in tray, right click on the icon - Launch At Startup
  this creates registry entry - HKCU\Software\Microsoft\Windows\CurrentVersion\Run\KopiaUI

kopia policy set <target_dir> --before-folder-action "powershell -WindowStyle Hidden <path_to_script>\before.ps1" kopia policy set <target_dir> --after-folder-action "powershell -WindowStyle Hidden <path_to_script>\after.ps1"