Skip to content

Commit 65548a8

Browse files
CarmiWisemonCarmiWisemon
committed
OADP 2041fixes
1 parent ea40960 commit 65548a8

8 files changed

+10
-222
lines changed

‎modules/oadp-csi-snapshot-timeouts.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// * backup_and_restore/application_backup_and_restore/troubleshooting.adoc
44

55
:_content-type: PROCEDURE
6-
[id="CSIsnapshot-timeout_{context}"]
6+
[id="csisnapshot-timeout_{context}"]
77
= CSI snapshot timeout
88

99
`CSISnapshotTimeout` specifies the time during creation to wait until the `CSI VolumeSnapshot` status becomes `ReadyToUse`, before returning error as timeout. The default value is `10m`.

‎modules/oadp-datamover-timeouts.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// * backup_and_restore/application_backup_and_restore/troubleshooting.adoc
44

55
:_content-type: PROCEDURE
6-
[id="Datamover-timeout_{context}"]
6+
[id="datamover-timeout_{context}"]
77
= Data Mover timeout
88

99
`timeout` is a user-supplied timeout to complete `VolumeSnapshotBackup` and `VolumeSnapshotRestore`. The default value is `10m`.

‎modules/oadp-item-backup-timeouts.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// * backup_and_restore/application_backup_and_restore/troubleshooting.adoc
44

55
:_content-type: PROCEDURE
6-
[id="Item-operation-timeout-backup_{context}"]
6+
[id="item-operation-timeout-backup_{context}"]
77
= Item operation timeout - backup
88

99
`ItemOperationTimeout` specifies the time used to wait for asynchronous

‎modules/oadp-item-restore-timeouts.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// * backup_and_restore/application_backup_and_restore/troubleshooting.adoc
44

55
:_content-type: PROCEDURE
6-
[id="Item-operation-timeout-restore_{context}"]
6+
[id="item-operation-timeout-restore_{context}"]
77
= Item operation timeout - restore
88

99
`ItemOperationTimeout` specifies the time that is used to wait for `RestoreItemAction` operations. The default value is `1h`.

‎modules/oadp-restic-timeouts.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// * backup_and_restore/application_backup_and_restore/troubleshooting.adoc
44

55
:_content-type: PROCEDURE
6-
[id="Restic-timeout_{context}"]
6+
[id="restic-timeout_{context}"]
77
= Restic timeout
88

99
`timeout` defines the Restic timeout. The default value is `1h`.

‎modules/oadp-timeouts.adoc

Lines changed: 0 additions & 212 deletions
Original file line numberDiff line numberDiff line change
@@ -11,216 +11,4 @@ Extending a timeout allows complex or resource-intensive processes to complete s
1111
Ensure that you balance timeout extensions in a logical manner so that you do not configure excessively long timeouts that might hide underlying issues in the process. Carefully consider and monitor an appropriate timeout value that meets the needs of the process and the overall system performance.
1212

1313
The following are various OADP timeouts, with instructions of how and when to implement these parameters:
14-
////
15-
[id="Restic-timeout_{context}"]
16-
== Restic timeout
17-
18-
`timeout` defines the Restic timeout. The default value is `1h`.
19-
20-
Use the Restic `timeout` for the following scenarios:
21-
22-
* For Restic backups with total PV data usage that is greater than 500GB.
23-
* If backups are timing out with the following error:
24-
+
25-
[source,terminal]
26-
----
27-
level=error msg="Error backing up item" backup=velero/monitoring error="timed out waiting for all PodVolumeBackups to complete"
28-
----
29-
30-
.Procedure
31-
* Edit the values in the `spec.configuration.restic.timeout` block of the `DataProtectionApplication` CR manifest, as in the following example:
32-
+
33-
[source,yaml]
34-
----
35-
apiVersion: oadp.openshift.io/v1alpha1
36-
kind: DataProtectionApplication
37-
metadata:
38-
name: <dpa_name>
39-
spec:
40-
configuration:
41-
restic:
42-
timeout: 1h
43-
# ...
44-
----
45-
46-
[id="Velero-resource-timeout_{context}"]
47-
== Velereo resource timeout
48-
49-
.Description
50-
`resourceTimeout` defines how long to wait for several Velero resources before timeout occurs, such as Velero CRD availability, `volumeSnapshot` deletion, and repository availability. The default is `10m`.
51-
52-
.Implementation
53-
54-
Use the `resourceTimeout` for the following scenarios:
55-
56-
* For backups with total PV data usage that is greater than 1TB. This parameter is used as a timeout value when Velero tries to clean-up or delete the Container Storage Interface (CSI) snapshots, before marking the backup as complete.
57-
** A sub-task of this cleanup tries to patch VSC and this timeout can be used for that task.
58-
+
59-
* To create or ensure a backup repository is ready for filesystem based backups for Restic or Kopia.
60-
* To check if the Velero CRD is available in the cluster before restoring the custom resource (CR) or resource from the backup.
61-
62-
.Procedure
63-
* Edit the values in the `spec.configuration.velero.resourceTimeout` block of the `DataProtectionApplication` CR manifest, as in the following example:
64-
+
65-
[source,yaml]
66-
----
67-
apiVersion: oadp.openshift.io/v1alpha1
68-
kind: DataProtectionApplication
69-
metadata:
70-
name: <dpa_name>
71-
spec:
72-
configuration:
73-
velero:
74-
resourceTimeout: 10m
75-
# ...
76-
----
77-
78-
[id="Datamover-timeout_{context}"]
79-
== Data Mover timeout
80-
81-
.Description
82-
`timeout` is a user-supplied timeout to complete `VolumeSnapshotBackup` and `VolumeSnapshotRestore`. The default value is `10m`.
83-
84-
.Implementation
85-
86-
Use the Data Mover `timeout` for the following scenarios:
87-
88-
* If creation of `VolumeSnapshotBackups` (VSBs) and `VolumeSnapshotRestores` (VSRs), times out after 10 minutes.
89-
* For large scale environments with total PV data usage that is greater than 500GB. Set the timeout for `1h`.
90-
* With the `VolumeSnapshotMover` (VSM) plugin.
91-
* Only with OADP 1.1.x.
92-
93-
.Procedure
94-
* Edit the values in the `spec.features.dataMover.timeout` block of the `DataProtectionApplication` CR manifest, as in the following example:
95-
+
96-
[source,yaml]
97-
----
98-
apiVersion: oadp.openshift.io/v1alpha1
99-
kind: DataProtectionApplication
100-
metadata:
101-
name: <dpa_name>
102-
spec:
103-
features:
104-
dataMover:
105-
timeout: 10m
106-
# ...
107-
----
108-
109-
[id="CSIsnapshot-timeout_{context}"]
110-
== CSI snapshot timeout
111-
112-
.Description
113-
`CSISnapshotTimeout` specifies the time during creation to wait until the `CSI VolumeSnapshot` status becomes `ReadyToUse`, before returning error as timeout. The default value is `10m`.
114-
115-
.Implementation
116-
117-
Use the `CSISnapshotTimeout` for the following scenarios:
118-
119-
* With the CSI plugin.
120-
* For very large storage volumes that may take longer than 10 minutes to snapshot. Adjust this timeout if timeouts are found in the logs.
121-
122-
[NOTE]
123-
====
124-
Typically, the default value for `CSISnapshotTimeout` does not require adjustment, because the default setting can accommodate large storage volumes.
125-
====
126-
127-
.Procedure
128-
* Edit the values in the `spec.csiSnapshotTimeout` block of the `Backup` CR manifest, as in the following example:
129-
+
130-
[source,yaml]
131-
----
132-
apiVersion: velero.io/v1
133-
kind: Backup
134-
metadata:
135-
name: <backup_name>
136-
spec:
137-
csiSnapshotTimeout: 10m
138-
# ...
139-
----
140-
141-
[id="Velero-default-item-operation-timeout_{context}"]
142-
== Velereo default item operation timeout
143-
144-
.Description
145-
`defaultItemOperationTimeout` defines how long to wait on asynchronous `BackupItemActions` and `RestoreItemActions` to complete before timing out. The default value is `1h`.
146-
147-
.Implementation
148-
149-
Use the `defaultItemOperationTimeout` for the following scenarios:
150-
151-
* Only with Data Mover 1.2.x.
152-
* To specify the amount of time a particular backup or restore should wait for the Asynchronous actions to complete. In the context of OADP features, this value is used for the Asynchronous actions involved in the Container Storage Interface (CSI) Data Mover feature.
153-
* When `defaultItemOperationTimeout` is defined in the Data Protection Application (DPA) using the `defaultItemOperationTimeout`, it applies to both backup and restore operations. You can use `itemOperationTimeout` to define only the backup or only the restore of those CRs, as described in the following *Item operation timeout - restore*, and *Item operation timeout - backup* sections.
154-
155-
.Procedure
156-
* Edit the values in the `spec.configuration.velero.defaultItemOperationTimeout` block of the `DataProtectionApplication` CR manifest, as in the following example:
157-
+
158-
[source,yaml]
159-
----
160-
apiVersion: oadp.openshift.io/v1alpha1
161-
kind: DataProtectionApplication
162-
metadata:
163-
name: <dpa_name>
164-
spec:
165-
configuration:
166-
velero:
167-
defaultItemOperationTimeout: 1h
168-
# ...
169-
----
170-
171-
[id="Item-operation-timeout-restore_{context}"]
172-
== Item operation timeout - restore
173-
174-
.Description
175-
`ItemOperationTimeout` specifies the time that is used to wait for `RestoreItemAction` operations. The default value is `1h`.
176-
177-
.Implementation
178-
179-
Use the restore `ItemOperationTimeout` for the following scenarios:
180-
181-
* Only with Data Mover 1.2.x.
182-
* For Data Mover uploads and downloads to or from the `BackupStorageLocation`. If the restore action is not completed when the timeout is reached, it will be marked as failed. If Data Mover operations are failing due to timeout issues, because of large storage volume sizes, then this timeout setting may need to be increased.
183-
184-
.Procedure
185-
* Edit the values in the `Restore.spec.itemOperationTimeout` block of the `Restore` CR manifest, as in the following example:
186-
+
187-
[source,yaml]
188-
----
189-
apiVersion: velero.io/v1
190-
kind: Restore
191-
metadata:
192-
name: <restore_name>
193-
spec:
194-
itemOperationTimeout: 1h
195-
# ...
196-
----
197-
198-
[id="Item-operation-timeout-backup_{context}"]
199-
== Item operation timeout - backup
200-
201-
.Description
202-
`ItemOperationTimeout` specifies the time used to wait for asynchronous
203-
`BackupItemAction` operations. The default value is `1h`.
204-
205-
.Implementation
206-
207-
Use the backup `ItemOperationTimeout` for the following scenarios:
208-
209-
* Only with Data Mover 1.2.x.
210-
* For Data Mover uploads and downloads to or from the `BackupStorageLocation`. If the backup action is not completed when the timeout is reached, it will be marked as failed. If Data Mover operations are failing due to timeout issues, because of large storage volume sizes, then this timeout setting may need to be increased.
211-
212-
.Procedure
213-
* Edit the values in the `Backup.spec.itemOperationTimeout` block of the `Backup` CR manifest, as in the following example:
214-
+
215-
[source,yaml]
216-
----
217-
apiVersion: velero.io/v1
218-
kind: Backup
219-
metadata:
220-
name: <backup_name>
221-
spec:
222-
itemOperationTimeout: 1h
223-
# ...
224-
----
225-
////
22614

‎modules/oadp-velero-default-timeouts.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// * backup_and_restore/application_backup_and_restore/troubleshooting.adoc
44

55
:_content-type: PROCEDURE
6-
[id="Velero-default-item-operation-timeout_{context}"]
6+
[id="velero-default-item-operation-timeout_{context}"]
77
= Velereo default item operation timeout
88

99
`defaultItemOperationTimeout` defines how long to wait on asynchronous `BackupItemActions` and `RestoreItemActions` to complete before timing out. The default value is `1h`.
@@ -12,7 +12,7 @@ Use the `defaultItemOperationTimeout` for the following scenarios:
1212

1313
* Only with Data Mover 1.2.x.
1414
* To specify the amount of time a particular backup or restore should wait for the Asynchronous actions to complete. In the context of OADP features, this value is used for the Asynchronous actions involved in the Container Storage Interface (CSI) Data Mover feature.
15-
* When `defaultItemOperationTimeout` is defined in the Data Protection Application (DPA) using the `defaultItemOperationTimeout`, it applies to both backup and restore operations. You can use `itemOperationTimeout` to define only the backup or only the restore of those CRs, as described in the following *Item operation timeout - restore*, and *Item operation timeout - backup* sections.
15+
* When `defaultItemOperationTimeout` is defined in the Data Protection Application (DPA) using the `defaultItemOperationTimeout`, it applies to both backup and restore operations. You can use `itemOperationTimeout` to define only the backup or only the restore of those CRs, as described in the following "Item operation timeout - restore", and "Item operation timeout - backup" sections.
1616
1717
.Procedure
1818
* Edit the values in the `spec.configuration.velero.defaultItemOperationTimeout` block of the `DataProtectionApplication` CR manifest, as in the following example:

‎modules/oadp-velero-timeouts.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
// * backup_and_restore/application_backup_and_restore/troubleshooting.adoc
44

55
:_content-type: PROCEDURE
6-
[id="Velero-timeout_{context}"]
6+
[id="velero-timeout_{context}"]
77
= Velereo resource timeout
88

9-
`resourceTimeout` defines how long to wait for several Velero resources before timeout occurs, such as Velero CRD availability, `volumeSnapshot` deletion, and repository availability. The default is `10m`.
9+
`resourceTimeout` defines how long to wait for several Velero resources before timeout occurs, such as Velero custom resource definition (CRD) availability, `volumeSnapshot` deletion, and repository availability. The default is `10m`.
1010

1111
Use the `resourceTimeout` for the following scenarios:
1212

13-
* For backups with total PV data usage that is greater than 1TB. This parameter is used as a timeout value when Velero tries to clean-up or delete the Container Storage Interface (CSI) snapshots, before marking the backup as complete.
13+
* For backups with total PV data usage that is greater than 1TB. This parameter is used as a timeout value when Velero tries to clean up or delete the Container Storage Interface (CSI) snapshots, before marking the backup as complete.
1414
** A sub-task of this cleanup tries to patch VSC and this timeout can be used for that task.
1515
+
1616
* To create or ensure a backup repository is ready for filesystem based backups for Restic or Kopia.

0 commit comments

Comments
 (0)