Documentation

Tout ce dont vous avez besoin pour démarrer avec RestoreProof

Installation du Runner

app.restoreproof.io
Assistant de déploiement d'un runner RestoreProof affichant la commande docker run générée
L'application génère cette commande pour vous, avec votre clé.

Docker

docker run -d \
  --name restoreproof-runner \
  --restart unless-stopped \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v restoreproof-work:/var/lib/restoreproof \
  -e RESTOREPROOF_API_KEY="<your-api-key>" \
  -e RESTOREPROOF_URL="https://api.restoreproof.io" \
  -e RESTOREPROOF_RUNNER_NAME="my-runner" \
  ghcr.io/kolapsis/restoreproof/runner:main

Kubernetes À venir

Chart Helm en préparation.

Intéressé ? Écrivez-nous : hello@restoreproof.io

Binary À venir

Binaire Linux en préparation.

Intéressé ? Écrivez-nous : hello@restoreproof.io

Configuration

Les variables d'environnement suffisent pour démarrer (voir la commande Docker ci-dessus). Pour les cas avancés, vous pouvez aussi utiliser un fichier config.yaml :

control_plane:
  url: "https://api.restoreproof.io"
  api_key: "rp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

runner:
  name: "prod-runner-01"
  labels:
    - "env:production"
    - "region:us-east-1"
    - "tier:database"

docker:
  socket: "unix:///var/run/docker.sock"

secrets:
  postgres_password:
    source: "env://PGPASSWORD"

Exemple de plan de restauration

Définissez un plan de restauration en JSON :

{
  "name": "daily-postgres-verify",
  "runner_labels": ["tier:database"],
  "steps": [
    {
      "type": "fetch",
      "source": "s3://backups/postgres/latest.sql.gz"
    },
    {
      "type": "unpack",
      "format": "gzip"
    },
    {
      "type": "start_sandbox",
      "image": "postgres:15"
    },
    {
      "type": "restore_postgres"
    }
  ],
  "probes": [
    {
      "type": "postgres",
      "config": {
        "tables": ["users", "orders"],
        "sample_rows": 1000
      }
    }
  ]
}