Clarify snapshot retention option

This commit is contained in:
Catherine Luse
2020-04-15 00:19:59 -07:00
parent 69cb414010
commit 8947fe9afb
@@ -31,7 +31,7 @@ time="2018-05-04T18:43:16Z" level=info msg="Created backup" name="2018-05-04T18:
|Option|Description| S3 Specific |
|---|---| --- |
|**interval_hours**| The duration in hours between recurring backups. This supercedes the `creation` option (which was used in RKE prior to v0.2.0) and will override it if both are specified.| |
|**retention**| The number of snapshots to retain before rotation. This supercedes the `retention` option and will override it if both are specified.| |
|**retention**| The number of snapshots to retain before rotation. If the `retention` is configured in both `etcd.retention`, which was required in RKE prior to v0.2.0, and at `etcd.backup_config.retention`, the latter will be used. | |
|**bucket_name**| S3 bucket name where backups will be stored| * |
|**folder**| Folder inside S3 bucket where backups will be stored. This is optional. _Available as of v0.3.0_ | * |
|**access_key**| S3 access key with permission to access the backup bucket.| * |