Skip to content

Commit

Permalink
Add some description of update existing policy to state it works in a…
Browse files Browse the repository at this point in the history
… best-effort way. (#6856)

Signed-off-by: Xun Jiang <[email protected]>
  • Loading branch information
blackpiglet authored Sep 22, 2023
1 parent d3e5bb7 commit 4bf87c0
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 3 deletions.
4 changes: 3 additions & 1 deletion site/content/docs/main/restore-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 4 additions & 0 deletions site/content/docs/v1.10/restore-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 3 additions & 1 deletion site/content/docs/v1.11/restore-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion site/content/docs/v1.12/restore-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 4 additions & 0 deletions site/content/docs/v1.9/restore-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 4bf87c0

Please sign in to comment.