tquin/pirouette

A log and backup rotation tool.

⚠️ alpha software under active development - may break your stuff! ⚠️

Installation

Docker Compose

The recommended installation method is with Docker Compose. You need to edit the volume mappings for the source (what you want to take snapshots of), target (where should pirouette store those snapshots), and config (where the pirouette.toml file can be found). Then, run docker compose up -d to start pirouette.

services:
  pirouette:
    image: tquin/pirouette:latest
    container_name: pirouette
    environment:
      PIROUETTE_CONFIG_FILE: /config/pirouette.toml
    volumes:
      - "/your/path/to/source:/source"
      - "/your/path/to/target:/target"
      - "/your/path/to/pirouette.toml:/config/pirouette.toml"

Binary from Cargo

Alternatively, if you can't run a container, pirouette is also available as a binary Rust crate.

cargo install pirouette

Configuration

Configuration for pirouette is done through a pirouette.toml file. By default, pirouette will look for this in the current working directory, or /config for a container. You can override this by specifying a full path in the environment variable PIROUETTE_CONFIG_FILE.

Source

Specifies the source data you want to take snapshots of. If using Docker, you can leave this as /source and map it to the corresponding host path in your Compose file.

The path must already exist, or pirouette will return an error.

Target

Specifies the destination where you want your snapshots stored. If using Docker, you can leave this as /target and map it to the corresponding host path in your Compose file.

If the target.path doesn't already exist, pirouette will try to create it for you.

Retention

This section defines how many copies of the source data pirouette should keep at different age intervals. While each key is optional and can be excluded, at least one key in total must be provided.

Options

All options listed below are optional, and if excluded will have a default value.

Example

[source]
path = "/source"

[target]
path = "/target"

[retention]
days = 7
weeks = 4
months = 12

[options]
output_format = "tarball"
log_level = "warn"

Local Development

You can test changes in a Docker container:

./docker-dev.sh

Todo

• src: deep copy? shallow? latest file only?
• glob include/exclude patterns would be nice at some point too.
• custom-defined retention periods would be nice
• dry-run option?
• one-shot or background daemon mode?