vmware-tanzu
/
velero
mirror of https://github.com/vmware-tanzu/velero.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #273 from skriss/pv-annotations-docs-fix 

remove outdated line about backups removing PV annotations
pull/249/head
Andy Goldstein 2018-01-05 15:10:16 -05:00 committed by GitHub
parent 656428d0b9 92a18f490b
commit 326eb7a4e8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/concepts.md
View File

@ -5,7 +5,7 @@
* [1. Backups][2] * [1. Backups][2]
* [2. Schedules][3] * [2. Schedules][3]
* [3. Restores][4] * [3. Restores][4]
* [API types][9] * [API types][8]
* [Expired backup deletion][5] * [Expired backup deletion][5]
* [Cloud storage sync][6] * [Cloud storage sync][6]
@ -20,11 +20,11 @@ Ark is ideal for the disaster recovery use case, as well as for snapshotting you
This section gives a quick overview of the Ark operation types. This section gives a quick overview of the Ark operation types.
### 1. Backups ### 1. Backups
The *backup* operation (1) uploads a tarball of copied Kubernetes resources into cloud object storage and (2) uses the cloud provider API to make disk snapshots of persistent volumes, if specified. [Annotations][8] are cleared for PVs but kept for all other object types. The *backup* operation (1) uploads a tarball of copied Kubernetes resources into cloud object storage and (2) uses the cloud provider API to make disk snapshots of persistent volumes, if specified.
You can optionally specify hooks that should be executed during the backup. For example, you may You can optionally specify hooks that should be executed during the backup. For example, you may
need to tell a database to flush its in-memory buffers to disk prior to taking a snapshot. You can need to tell a database to flush its in-memory buffers to disk prior to taking a snapshot. You can
find more information about hooks [here][11]. find more information about hooks [here][10].
Some things to be aware of: Some things to be aware of:
* *Cluster backups are not strictly atomic.* If API objects are being created or edited at the time of backup, they may or not be included in the backup. In practice, backups happen very quickly and so the odds of capturing inconsistent information are low, but still possible. * *Cluster backups are not strictly atomic.* If API objects are being created or edited at the time of backup, they may or not be included in the backup. In practice, backups happen very quickly and so the odds of capturing inconsistent information are low, but still possible.
@ -50,7 +50,7 @@ You can also run the Ark server in *restore-only* mode, which disables backup, s
## API types ## API types
For information about the individual API types Ark uses, please see the [API types reference][10]. For information about the individual API types Ark uses, please see the [API types reference][9].
## Expired backup deletion ## Expired backup deletion
@ -72,7 +72,6 @@ This allows *restore* functionality to work in a cluster migration scenario, whe
[5]: #expired-backup-deletion [5]: #expired-backup-deletion
[6]: #cloud-storage-sync [6]: #cloud-storage-sync
[7]: use-cases.md#cluster-migration [7]: use-cases.md#cluster-migration
[8]: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ [8]: #api-types
[9]: #api-types [9]: api-types/
[10]: api-types/ [10]: hooks.md
[11]: hooks.md