From ad819575dff9afdcdb43c632a47526b3fec5b022 Mon Sep 17 00:00:00 2001 From: Karsten Kraus Date: Tue, 12 Dec 2023 16:33:00 +0100 Subject: [PATCH] Update README.md Added links and explanation on how to restore a snapshot --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b0b47f0..dd6048e 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,10 @@ Vault Raft Snapshot Agent is a Go binary that takes periodic snapshots of a [Vau cluster using the [integrated raft storage backend](https://developer.hashicorp.com/vault/docs/concepts/integrated-storage). It can store the snapshots locally or upload them to a remote storage backend like AWS S3 as backup in case of system failure -or user errors. +or user errors. This agent basically automates [vault's standard backup procedure](https://developer.hashicorp.com/vault/tutorials/standard-procedures/sop-backup#manual-backup-procedures) for a single vault cluster or clusters with disaster recovery. + +# Restoring a backup +In case of failure just follow the [standard restore procedure](https://developer.hashicorp.com/vault/tutorials/standard-procedures/sop-restore#procedures) for your cluster's type using the last snapshot created by the agent from your backup storage. ## Running