Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note about non-destrutive restore #4885

Closed
wants to merge 1 commit into from

Conversation

a-mccarthy
Copy link
Contributor

Signed-off-by: Abigail McCarthy [email protected]

Thank you for contributing to Velero!

Please add a summary of your change

Adds a note to the How Velero Works page about non-destructive nature of restores.

Also fixes some minor formatting issues on the restore reference page.

Does your change fix a particular issue?

Fixes ##4571

Please indicate you've done the following:

  • Accepted the DCO. Commits without the DCO will delay acceptance.
  • Created a changelog file or added /kind changelog-not-required as a comment on this pull request.
  • Updated the corresponding documentation in site/content/docs/main.

Signed-off-by: Abigail McCarthy <[email protected]>
@codecov-commenter
Copy link

Codecov Report

Merging #4885 (5b3c62d) into main (5b49fa0) will decrease coverage by 0.04%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #4885      +/-   ##
==========================================
- Coverage   41.25%   41.20%   -0.05%     
==========================================
  Files         204      204              
  Lines       18041    18041              
==========================================
- Hits         7442     7434       -8     
- Misses      10047    10054       +7     
- Partials      552      553       +1     
Impacted Files Coverage Δ
pkg/restore/restore.go 66.04% <0.00%> (-0.65%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5b49fa0...5b3c62d. Read the comment docs.

@a-mccarthy a-mccarthy added the kind/changelog-not-required PR does not require a user changelog. Often for docs, website, or build changes label May 9, 2022
@@ -38,6 +38,8 @@ By default, backup storage locations are created in read-write mode. However, du

You can optionally specify restore hooks to be executed during a restore or after resources are restored. For example, you might need to perform a custom database restore operation before the database application containers start. [More about restore hooks][11].

During a restore, Velero is non-destructive. That means that Velero will never overwrite a pre-existing resource which has the same name as a resource in the backup it is restoring. Similarly, if a persistent volume exists, Velero will not overwrite the data in it. This behavior is by design, so that you don't have to worry about accidentally overwriting your cluster's state when using Velero.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not exactly true for v1.9+

A contributor from redhat recently added an option so that some resources can be overwritten:
#4851 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for bringing this up, I'll close this PR and address this with the changes in PR #4928

@a-mccarthy
Copy link
Contributor Author

#4885 (comment)

@a-mccarthy a-mccarthy closed this May 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation kind/changelog-not-required PR does not require a user changelog. Often for docs, website, or build changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants