Add documentation for file format versioning

Signed-off-by: Nolan Brubaker <brubakern@vmware.com>
pull/2436/head
Nolan Brubaker 2020-04-14 17:26:17 -04:00
parent fdba6a6c55
commit 07fa6da0d6
1 changed files with 13 additions and 0 deletions

View File

@ -97,3 +97,16 @@ resources/
...
...
```
## Output File Format Versioning
The Velero output file format is intended to be relatively stable, but may change over time in order to support new features.
In order to accomodate this, Velero follows [Semantic Versioning](http://semver.org/) for the file format version.
Minor and patch versions will indicate backwards-compatible changes that previous versions of Velero can restore, including new directories or files.
A major version would indicate that a version Velero older than the version that created the backup could restore it.
Major versions of the file format are tied to major versions of Velero, though they are not necessarily in sync - Velero 3.0 may still use backup file format 2.0, as an example.