sauvegardes/Plan Borg/README.md

| Plan Borg |
| --------- |

# Introduction

Le plan Borg est une solution de sauvegarde basée sur Borgmatic.

[[_TOC_]]

# Installation d'un serveur de sauvegarde

Ajouter les backports bullseye dans `/etc/apt/source.list` :
```
deb http://ftp.fr.debian.org/debian/ bullseye-backports main
```

Installer les paquets nécessaires :
```
apt install -t bullseye-backports borgmatic borgbackup
```

Créer un utilisateur dédié `borg` :
```
adduser --disabled-password --system --group --home /srv/borg/ --shell /bin/bash borg
```

Créer des clés `ssh` pour l'utilisateur `root` :
```
sudo ssh-keygen -t ed25519
```

Récupérer les scripts et modèles :
```
cd ~borg/
mkdir bin models
URL=https://git.a-lec.org/a-lec/commissions/infrastructure/sauvegardes/-/raw/main/Plan%20Borg/
cd bin
wget -nv $URL/bin/dobackup-server
wget -nv $URL/bin/dobackup-remote
wget -nv $URL/bin/dobackup-rsync
wget -nv $URL/bin/dobackups
wget -nv $URL/bin/dochecks
wget -nv $URL/bin/dochecksb
wget -nv $URL/bin/doinit
wget -nv $URL/bin/doprunes
wget -nv $URL/bin/doprunesb
wget -nv $URL/bin/lastbackups
cd ../models
wget -nv $URL/models/cron
wget -nv $URL/models/excludes
wget -nv $URL/models/model-conf-local.yaml
wget -nv $URL/models/model-conf-remote.yaml
#wget -nv $URL/models/model-conf-remote-client.yaml
#wget -nv $URL/models/model-conf-rsync.yaml
wget -nv $URL/models/retention.yaml
cd .. ; find
```

Déployer la configuration générique de Borgmatic :
```
mkdir -p /etc/borgmatic/ /etc/borgmatic.d/
cp /srv/borg/models/retention.yaml /etc/borgmatic/
cp /srv/borg/models/excludes /etc/borgmatic/
```
Définir une passphrase générique : 
```
echo "XXXXXXXXXXXXXXXXXXXXXXXXXXX" > ~borg/.borg-passphrase
```

Ajouter la ligne suivante dans `/root/.bashrc` (facilite la commande `borg` directe même si normalement on fait tout avec la commande `borgmatic`) :
```
export BORG_PASSCOMMAND="cat /srv/borg/.borg-passphrase"
```

Créer un dossier dédié aux sauvegardes du plan Borg :
```
mkdir -p /var/backups/borg
chown borg /var/backups/borg
```

Configurer le `cron` dans `/etc/cron.d/backups` :
```
cp /srv/borg/models/cron /etc/cron.d/backups
cd /srv/borg/
ln -s /etc/cron.d/backups cron
```

# Configurer la sauvegarde du serveur de sauvegarde

Initialiser le contexte Borgmatic :
```
/srv/borg/bin/doinit-local
```

Lancer la première sauvegarde locale (dure moins d'une minutes) :
```
time /srv/borg/bin/dobackup-local
```

Afficher les informations du dépôt :
```
borgmatic -c /etc/borgmatic.d/$(hostname).yaml info
```

Afficher la liste des sauvegardes du dépôt :
```
borgmatic -c /etc/borgmatic.d/$(hostname).yaml list
```

Afficher le contenu de la sauvegarde :
```
borgmatic -c /etc/borgmatic.d/$(hostname).yaml list --archive $(borgmatic -c /etc/borgmatic.d/$(hostname).yaml list --short | tail -1)
```

Ajouter le déclenchement de la sauvegarde dans `/srv/borg/bin/dobackups` :
```
/srv/borg/bin/dobackup-local
```

# Configurer la sauvegarde d'une machine en remote

C'est le cas nominal. Le principe consiste à configurer le serveur de sauvegarde pour déclencher l'action de sauvegarde sur la machine à sauvegarder.

## Côté machine à sauvegarder

Ajouter les backports bullseye dans `/etc/apt/source.list.d` :
```
echo "deb http://ftp.fr.debian.org/debian/ bullseye-backports main" > /etc/apt/sources.list.d/backports.list
```

Installer les paquets nécessaires :
```
apt install -t bullseye-backports borgmatic borgbackup
```

Créer des clés `ssh` pour l'utilisateur `root` :
```
sudo ssh-keygen -t ed25519
```

Créer et peupler le dossier de configruation de Borgmatic :
```
mkdir -p /etc/borgmatic
cd /etc/borgmatic
URL=https://git.a-lec.org/a-lec/commissions/infrastructure/sauvegardes/-/raw/main/Plan%20Borg/
wget -nv $URL/models/excludes
wget -nv $URL/models/model-conf-remote-client.yaml -O /etc/borgmatic/config.yaml
```

Vérifier que la configuration Borgmatic est valide :
```
validate-borgmatic-config
```

Configurer la passphrase dans `/etc/borgmatic/config.yaml` :
```
     encryption_passphrase: 'XXXXXXXXXXXXXX'
```

Ajouter la clé `root` du serveur de sauvegarde dans `/home/admin666/.ssh/authorized_keys` :
```
ssh-ed25519 AAAAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX root@sauvkipeu.libre-en-communs.org
```

## Côté serveur de sauvegarde

Initialiser le contexte Borgmatic :
```
/srv/borg/bin/doinit-remote foo.bar.org
```

Ajouter un accès ssh restreint dans `/srv/borg/.ssh/authorized_keys` :
```
command="export BORG_PASSCOMMAND=/srv/borg/.borg-passphrase; borg serve --restrict-to-path /var/backups/borg/foo.bar.org.repo/ --restrict-to-repository /var/backups/borg/foo.bar.org.repo --append-only",restrict ssh-rsa AAAAZZZZZ root666@foo.bar.org
```

## Tester côté marchine à sauvegarder

Lancer une première sauvegarde (prévoir 2 min) :
```
time sudo /srv/borg/bin/dobackup-remote foo.bar.org
```

## Tester côté serveur

Lancer une sauvegarde :
```
time sudo /srv/borg/bin/dobackup-remote foo.bar.org
```

Afficher les informations du dépôt :
```
borgmatic -c /etc/borgmatic.d/foo.bar.org.yaml info
```

Afficher la liste des sauvegardes du dépôt :
```
borgmatic -c /etc/borgmatic.d/foo.bar.org.yaml list
```

Afficher le contenu de la sauvegarde :
```
borgmatic -c /etc/borgmatic.d/foo.bar.org.yaml list --archive 2023-XX-XXTXX:XX
```

Ajouter le lancement de la sauvegarde dans `/srv/borg/bin/dobackups` :
```
/srv/borg/bin/dobackup-remote foo.bar.org
```

# Configurer la sauvegarde d'une machine en rsync

Le principe consiste en deux étapes :
- création d'un miroir de la machine à sauvegarder ;
- sauvegarde borgmatic du miroir.

C'est notamment adapté aux cas des routeurs où le logiciel Borgmatic n'est pas déployable.

## Côté serveur de sauvegarde
STU

## Côté machine à sauvegarder
STU

## Tester côté serveur
STU

# Sauver les bases de données
STU

# Notes pour les mises à jour futures

Actuellement :
```
root@sauvkipeu:/var/backups/borg# borgmatic --version
1.5.13.dev0
root@sauvkipeu:/var/backups/borg# borg -V
borg 1.1.16
```

Or :
- [Borgmatic releases](https://projects.torsion.org/borgmatic-collective/borgmatic/releases) : 1.7.5
- [Borg release](https://github.com/borgbackup/borg/releases) : 1.2.3

Donc des précautions sont à prévoir dans le futur. Normalement, commme l'usage fait est relativment basique, cela devrait avoir des impactes limités.

Pour Borgmatic :
- [1.7.0](https://projects.torsion.org/borgmatic-collective/borgmatic/releases/tag/1.7.0) :
  - #571: Add "--list" as alias for "--files" flag on "create" and "export-tar" actions.
- [1.6.1](https://projects.torsion.org/borgmatic-collective/borgmatic/releases/tag/1.6.1) :
  - #402: Remove the error when "archive_name_format" is specified but a retention prefix isn't.
-