From 07fa6da0d60e1c57f741b753d7698106d8e2c991 Mon Sep 17 00:00:00 2001 From: Nolan Brubaker Date: Tue, 14 Apr 2020 17:26:17 -0400 Subject: [PATCH] Add documentation for file format versioning Signed-off-by: Nolan Brubaker --- site/docs/master/output-file-format.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/site/docs/master/output-file-format.md b/site/docs/master/output-file-format.md index a4b462614..7eac49960 100644 --- a/site/docs/master/output-file-format.md +++ b/site/docs/master/output-file-format.md @@ -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. +