Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added links and explanation on how to restore a snapshot
  • Loading branch information
Argelbargel authored Dec 12, 2023
1 parent 7299605 commit ad81957
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit ad81957

Please sign in to comment.