Categorygithub.com/pavel1337/lxcer
repositorypackage
0.0.0-20211124124022-eba7adcababb
Repository: https://github.com/pavel1337/lxcer.git
Documentation: pkg.go.dev
Overview
Dependencies
14
Dependents
0

# README

lxcer

Backup/restore tool for LXC containers to restic with zstd compression.

Requirements

  • zstd >= 1.38
  • lxc >= 3.0.3
  • restic >= 0.10.0

Description

This is wrapper for lxc, zstd, restic CLI interfaces. Before running:

  • all listed above programs are installed and in the $PATH
  • configure the conf.yml accordingly
  • all hosts that are listed in conf.yml are indeed available for lxc cli: lxc remote list
  • all restic repos that are listed in conf.yml are created and not broken

It does simple restic check before any work starts and fatals out in case an error.

Backup

Follows logic below:

  1. Create (remote) snapshot
  2. Publish (remote) snapshot as image
  3. Export image as .tar
  4. Compress .tar to .tar.zst
  5. Push .tar.zst to listed restic repos.

If run concurrently, then for each remote host starts its own goroutine which creates and publishes snapshots. Then passes image to next goroutine which exports it, then passes to next one which compresses it and passes it further to goroutines that push compressed archives to restic repos.

Examples
  1. Backup all containers from all hosts listed in /etc/lxc/config.yml concurrently with only errors as output (if any)

lxcer -a backup --config /etc/lxcer/config.yml --concurrently

  1. Backup all containers from host host-01 concurrently with only errors as output (if any)

lxcer -a backup --remote-host host-01 --config /etc/lxcer/config.yml --concurrently

  1. Backup container container-01 from host host-01 concurrently with only errors as output (if any)

lxcer -a backup --remote-host host-01 --container contrainer-01 --config /etc/lxcer/config.yml --concurrently

Restore

Follows logic below:

  1. Download latest snapshot for container
  2. Decompress it from .tar.zst to .tar
  3. Import .tar as (remote) image
  4. Start (remote) container from (remote) image.
Examples

Restore single container with name app-01 as container app-02 on remote host with name rhost-01 with log info printed in terminal.

lxcer -config conf.yml -a restore -container app-01 --as app-02 -remote-host rhost-01 --log-level info

Restore a list of containers on remote host rhost-01 with log info printed in terminal.

lxcer -config conf.yml -a restore -restore-list restore.lst -remote-host rhost-01 -concurrently

The restore.lst should be in the format below:

container_to_restore:name_of_restored_container

So the command above will restore the container container_to_restore as name_of_restored_container on remote host rhost-01