From 4bf87c01ea73a143908ca76bc845c5822c9b99a3 Mon Sep 17 00:00:00 2001 From: Xun Jiang/Bruce Jiang <59276555+blackpiglet@users.noreply.github.com> Date: Sat, 23 Sep 2023 02:18:42 +0800 Subject: [PATCH] Add some description of update existing policy to state it works in a best-effort way. (#6856) Signed-off-by: Xun Jiang --- site/content/docs/main/restore-reference.md | 4 +++- site/content/docs/v1.10/restore-reference.md | 4 ++++ site/content/docs/v1.11/restore-reference.md | 4 +++- site/content/docs/v1.12/restore-reference.md | 4 +++- site/content/docs/v1.9/restore-reference.md | 4 ++++ 5 files changed, 17 insertions(+), 3 deletions(-) diff --git a/site/content/docs/main/restore-reference.md b/site/content/docs/main/restore-reference.md index 8d646407c6..d50a12a43f 100644 --- a/site/content/docs/main/restore-reference.md +++ b/site/content/docs/main/restore-reference.md @@ -269,7 +269,9 @@ are `none` (default) and `update`. If you choose to update existing resources du You can also configure the existing resource policy in a [Restore](api-types/restore.md) object. -**NOTE:** Update of a resource only applies to the Kubernetes resource data such as its spec. It may not work as expected for certain resource types such as PVCs and Pods. In case of PVCs for example, data in the PV is not restored or overwritten in any way. +**NOTE:** +* Update of a resource only applies to the Kubernetes resource data such as its spec. It may not work as expected for certain resource types such as PVCs and Pods. In case of PVCs for example, data in the PV is not restored or overwritten in any way. +* `update` existing resource policy works in a best-effort way, which means when restore's `--existing-resource-policy` is set to `update`, Velero will try to update the resource if the resource already exists, if the update fails, Velero will fall back to the default non-destructive way in the restore, and just logs a warning without failing the restore. ## Removing a Restore object diff --git a/site/content/docs/v1.10/restore-reference.md b/site/content/docs/v1.10/restore-reference.md index 31a3e79602..19eaf539cf 100644 --- a/site/content/docs/v1.10/restore-reference.md +++ b/site/content/docs/v1.10/restore-reference.md @@ -224,6 +224,10 @@ You can change this policy for a restore by using the `--existing-resource-polic You can also configure the existing resource policy in a [Restore](api-types/restore.md) object. +**NOTE:** +* Update of a resource only applies to the Kubernetes resource data such as its spec. It may not work as expected for certain resource types such as PVCs and Pods. In case of PVCs for example, data in the PV is not restored or overwritten in any way. +* `update` existing resource policy works in a best-effort way, which means when restore's `--existing-resource-policy` is set to `update`, Velero will try to update the resource if the resource already exists, if the update fails, Velero will fall back to the default non-destructive way in the restore, and just logs a warning without failing the restore. + ## Removing a Restore object There are two ways to delete a Restore object: diff --git a/site/content/docs/v1.11/restore-reference.md b/site/content/docs/v1.11/restore-reference.md index dce9a67d76..e0bc65a1aa 100644 --- a/site/content/docs/v1.11/restore-reference.md +++ b/site/content/docs/v1.11/restore-reference.md @@ -267,7 +267,9 @@ You can change this policy for a restore by using the `--existing-resource-polic You can also configure the existing resource policy in a [Restore](api-types/restore.md) object. -**NOTE:** Update of a resource only applies to the Kubernetes resource data such as its spec. It may not work as expected for certain resource types such as PVCs and Pods. In case of PVCs for example, data in the PV is not restored or overwritten in any way. +**NOTE:** +* Update of a resource only applies to the Kubernetes resource data such as its spec. It may not work as expected for certain resource types such as PVCs and Pods. In case of PVCs for example, data in the PV is not restored or overwritten in any way. +* `update` existing resource policy works in a best-effort way, which means when restore's `--existing-resource-policy` is set to `update`, Velero will try to update the resource if the resource already exists, if the update fails, Velero will fall back to the default non-destructive way in the restore, and just logs a warning without failing the restore. ## Removing a Restore object diff --git a/site/content/docs/v1.12/restore-reference.md b/site/content/docs/v1.12/restore-reference.md index 8d646407c6..2994d72fd6 100644 --- a/site/content/docs/v1.12/restore-reference.md +++ b/site/content/docs/v1.12/restore-reference.md @@ -269,7 +269,9 @@ are `none` (default) and `update`. If you choose to update existing resources du You can also configure the existing resource policy in a [Restore](api-types/restore.md) object. -**NOTE:** Update of a resource only applies to the Kubernetes resource data such as its spec. It may not work as expected for certain resource types such as PVCs and Pods. In case of PVCs for example, data in the PV is not restored or overwritten in any way. +**NOTE:** +* Update of a resource only applies to the Kubernetes resource data such as its spec. It may not work as expected for certain resource types such as PVCs and Pods. In case of PVCs for example, data in the PV is not restored or overwritten in any way. +* `update` existing resource policy works in a best-effort way, which means when restore's `--existing-resource-policy` is set to `update`, Velero will try to update the resource if the resource already exists, if the update fails, Velero will fall back to the default non-destructive way in the restore, and just logs a warning without failing the restore. ## Removing a Restore object diff --git a/site/content/docs/v1.9/restore-reference.md b/site/content/docs/v1.9/restore-reference.md index a91ef960db..d843369db3 100644 --- a/site/content/docs/v1.9/restore-reference.md +++ b/site/content/docs/v1.9/restore-reference.md @@ -224,6 +224,10 @@ You can change this policy for a restore by using the `--existing-resource-polic You can also configure the existing resource policy in a [Restore](api-types/restore.md) object. +**NOTE:** +* Update of a resource only applies to the Kubernetes resource data such as its spec. It may not work as expected for certain resource types such as PVCs and Pods. In case of PVCs for example, data in the PV is not restored or overwritten in any way. +* `update` existing resource policy works in a best-effort way, which means when restore's `--existing-resource-policy` is set to `update`, Velero will try to update the resource if the resource already exists, if the update fails, Velero will fall back to the default non-destructive way in the restore, and just logs a warning without failing the restore. + ## Removing a Restore object There are two ways to delete a Restore object: