Add v1.10 velero upgrade doc #5468

qiuming-best · 2022-10-20T07:45:35Z

Signed-off-by: Ming mqiu@vmware.com

Thank you for contributing to Velero!

Please add a summary of your change

Does your change fix a particular issue?

Fixes #(issue)

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.

reasonerjt · 2022-10-20T08:10:53Z

site/content/docs/main/upgrade-to-1.10.md

@@ -17,12 +17,15 @@ If you're not yet running at least Velero v1.6, see the following:
 - [Upgrading to v1.6][6]
 - [Upgrading to v1.7][7]
 - [Upgrading to v1.8][8]
+- [Upgrading to v1.9][9]


Prerequisite is wrong.

I'm not sure if it's necessary to list all the previous minor versions upgrade instructions.

What about we just keep 3 or 5 items on the list?

Prerequisite modified

I've just keep 5 items

@OrlinVasilev Do you think how many items should we keep for upgrading instructions?

reasonerjt · 2022-10-20T08:17:15Z

site/content/docs/main/upgrade-to-1.10.md

+    # uploader_type value cloud be restic or kopia    
+    kubectl get deploy -n velero -ojson \
+    | sed "s#\"image\"\: \"velero\/velero\:v[0-9]*.[0-9]*.[0-9]\"#\"image\"\: \"velero\/velero\:v1.10.0\"#g" \
+    | sed "s#\"--default-volumes-to-restic=true\"#\"--default-volumes-to-fs-backup=true\",\"--uploader-type=$uploader_type\"#g" \


If the user explicitly set --default-volumes-to-restic=false and it will remain, will it cause any problem?

yes, I'll modify it

I've changed

reasonerjt · 2022-10-20T08:19:37Z

site/content/docs/main/upgrade-to-1.10.md

+    dsjson=$(kubectl get ds -n velero -ojson)
+    kubectl delete ds -n velero --all --force --grace-period 0
+    echo $dsjson | sed "s#\"image\"\: \"velero\/velero\:v[0-9]*.[0-9]*.[0-9]\"#\"image\"\: \"velero\/velero\:v1.10.0\"#g" \
+    | sed "s#restic#node-agent#g" | kubectl apply -f -


Are you sure restic is not used in the env var or path or other places, if this is for renaming, similar to image, would it be better if we let sed replace only the name attribute?

yes, currently, restic if is used by label, name, or container start arguments should be replaced, if used by env var or path that would cause some problem, I'll restrict the replace fields.

reasonerjt · 2022-10-20T08:21:03Z

site/content/docs/main/upgrade-to-1.10.md

+    | sed "s#restic-timeout#fs-backup-timeout#g" \
+    | kubectl apply -f -
+
+    # optional, if using the velero daemon set


Is it intentional that restic was replaced by velero?

I'm still keeping restic now, older version indeed is restic daemon set

reasonerjt · 2022-10-20T08:22:08Z

site/content/docs/main/upgrade-to-1.10.md

    ```

 ## Notes
 ### Default backup storage location
-We have deprecated the way to indicate the default backup storage location. Previously, that was indicated according to the backup storage location name set on the velero server-side via the flag `velero server --default-backup-storage-location`. Now we configure the default backup storage location on the velero client-side. Please refer to the [About locations][9] on how to indicate which backup storage location is the default one.
+We have deprecated the way to indicate the default backup storage location. Previously, that was indicated according to the backup storage location name set on the velero server-side via the flag `velero server --default-backup-storage-location`. Now we configure the default backup storage location on the velero client-side. Please refer to the [About locations][10] on how to indicate which backup storage location is the default one.


Is this still needed? I don't think we need it in all future versions.

I've removed it

codecov-commenter · 2022-10-21T02:03:45Z

Codecov Report

Merging #5468 (f848f50) into main (11a7c79) will increase coverage by 0.17%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #5468      +/-   ##
==========================================
+ Coverage   40.56%   40.74%   +0.17%     
==========================================
  Files         236      238       +2     
  Lines       20484    20561      +77     
==========================================
+ Hits         8310     8377      +67     
- Misses      11565    11568       +3     
- Partials      609      616       +7

Impacted Files	Coverage Δ
pkg/uploader/provider/restic.go	`26.04% <0.00%> (-0.56%)`	⬇️
pkg/controller/backup_deletion_controller.go	`57.26% <0.00%> (-0.26%)`	⬇️
pkg/cmd/server/server.go	`6.57% <0.00%> (-0.02%)`	⬇️
pkg/builder/object_meta.go	`0.00% <0.00%> (ø)`
pkg/builder/volume_snapshot_content_builder.go	`0.00% <0.00%> (ø)`
pkg/builder/volume_snapshot_builder.go	`0.00% <0.00%> (ø)`
pkg/controller/backup_controller.go	`55.84% <0.00%> (+7.68%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Signed-off-by: Ming <mqiu@vmware.com>

OrlinVasilev · 2022-10-25T12:59:44Z

@qiuming-best why are you removing 1.9 upgrade guide?

qiuming-best · 2022-10-26T01:32:38Z

@qiuming-best why are you removing 1.9 upgrade guide?

@OrlinVasilev 1.9 upgrade guide is not been removed, In site/content/docs/main/ we should put the newest version of document, so I replace v1.9 to v1.10 doc

OrlinVasilev · 2022-10-26T08:48:03Z

@qiuming-best

And

OrlinVasilev · 2022-10-26T09:10:41Z

@qiuming-best fixed TOC for you! pleas check!

Signed-off-by: OrlinVasilev <ovasilev@vmware.com>

blackpiglet · 2022-10-26T12:50:41Z

site/content/docs/main/upgrade-to-1.10.md

+
+    # optional, if using the restic daemon set
+    dsjson=$(kubectl get ds -n velero -ojson)
+    kubectl delete ds -n velero --all --force --grace-period 0


Could we not using force deletion on DaemonSet update?
And I'm not sure Deployment can be updated without deletion, but DaemonSet needs deletion first.

@blackpiglet

I'm not sure Deployment can be updated without deletion, but DaemonSet needs deletion first.
all scripts are been tested.

for velero deployment, it's not been deleted, here just update images and fields.

but for restic is no longer exists in 1.10, so it must be deleted, So I create a new daemonset with the new name 'node-agent', using force deletion just want less time-consuming.

I was about to ask why the process is so hackie :)

qiuming-best · 2022-10-27T02:49:30Z

fix main TOC for 1.10

@OrlinVasilev thanks a lot !!!

Lyndon-Li · 2022-11-01T03:00:52Z

site/content/docs/main/upgrade-to-1.10.md

+    Server:
+        Version: v1.10.0
+    ```
+


We also need to tell users that some left over resources need to be deleted manually:
resticrepository CRs
velero-restic-credentials secret

There is no problem to leave these unused resources there, but if users want to delete them, they need to do it manually through kubectl

Signed-off-by: Ming <mqiu@vmware.com>

github-actions bot requested review from a-mccarthy and Lyndon-Li October 20, 2022 07:45

github-actions bot assigned qiuming-best Oct 20, 2022

github-actions bot added the Documentation label Oct 20, 2022

qiuming-best force-pushed the upgrade-doc branch from 39f499d to 0071f22 Compare October 20, 2022 07:47

github-actions bot added the has-changelog label Oct 20, 2022

qiuming-best force-pushed the upgrade-doc branch from 0071f22 to 4bba952 Compare October 20, 2022 07:55

qiuming-best requested review from ywk253100, blackpiglet and reasonerjt and removed request for a-mccarthy October 20, 2022 08:02

reasonerjt reviewed Oct 20, 2022

View reviewed changes

qiuming-best force-pushed the upgrade-doc branch 3 times, most recently from bd04630 to 6de4c46 Compare October 21, 2022 02:02

Add v1.10 velero upgrade doc

a0bf266

Signed-off-by: Ming <mqiu@vmware.com>

qiuming-best force-pushed the upgrade-doc branch from 6de4c46 to a0bf266 Compare October 25, 2022 09:41

qiuming-best requested a review from OrlinVasilev October 25, 2022 10:01

qiuming-best added the Website non-docs changes for the website label Oct 25, 2022

fix main TOC for 1.10

5bd786a

Signed-off-by: OrlinVasilev <ovasilev@vmware.com>

blackpiglet reviewed Oct 26, 2022

View reviewed changes

Lyndon-Li reviewed Nov 1, 2022

View reviewed changes

add note for left over resources

f848f50

Signed-off-by: Ming <mqiu@vmware.com>

Lyndon-Li approved these changes Nov 4, 2022

View reviewed changes

Lyndon-Li added this to the 1.10 milestone Nov 4, 2022

blackpiglet approved these changes Nov 7, 2022

View reviewed changes

blackpiglet merged commit c4c5f01 into vmware-tanzu:main Nov 7, 2022

Lyndon-Li mentioned this pull request Nov 7, 2022

Velero Kopia Integration - Upgrade Verification & Guide #5083

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add v1.10 velero upgrade doc #5468

Add v1.10 velero upgrade doc #5468

qiuming-best commented Oct 20, 2022

reasonerjt Oct 20, 2022

qiuming-best Oct 20, 2022

qiuming-best Oct 21, 2022

qiuming-best Oct 26, 2022

reasonerjt Oct 20, 2022

qiuming-best Oct 20, 2022

qiuming-best Oct 21, 2022 •

edited

reasonerjt Oct 20, 2022

qiuming-best Oct 20, 2022

reasonerjt Oct 20, 2022

qiuming-best Oct 21, 2022

reasonerjt Oct 20, 2022

qiuming-best Oct 21, 2022

codecov-commenter commented Oct 21, 2022 •

edited

OrlinVasilev commented Oct 25, 2022

qiuming-best commented Oct 26, 2022

OrlinVasilev commented Oct 26, 2022

OrlinVasilev commented Oct 26, 2022 •

edited

blackpiglet Oct 26, 2022

qiuming-best Oct 27, 2022 •

edited

OrlinVasilev Oct 28, 2022

qiuming-best commented Oct 27, 2022

Lyndon-Li Nov 1, 2022

qiuming-best Nov 1, 2022

Add v1.10 velero upgrade doc #5468

Add v1.10 velero upgrade doc #5468

Conversation

qiuming-best commented Oct 20, 2022

Please add a summary of your change

Does your change fix a particular issue?

Please indicate you've done the following:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qiuming-best Oct 21, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Oct 21, 2022 • edited

Codecov Report

OrlinVasilev commented Oct 25, 2022

qiuming-best commented Oct 26, 2022

OrlinVasilev commented Oct 26, 2022

OrlinVasilev commented Oct 26, 2022 • edited

Choose a reason for hiding this comment

qiuming-best Oct 27, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qiuming-best commented Oct 27, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qiuming-best Oct 21, 2022 •

edited

codecov-commenter commented Oct 21, 2022 •

edited

OrlinVasilev commented Oct 26, 2022 •

edited

qiuming-best Oct 27, 2022 •

edited