Skip to content

Commit b6e7391

Browse files
CarmiWisemonCarmiWisemon
committed
OADP1442 Timeouts
1 parent 7678e75 commit b6e7391

File tree

1 file changed

+94
-82
lines changed

1 file changed

+94
-82
lines changed

‎modules/oadp-installing-dpa.adoc

Lines changed: 94 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -54,40 +54,42 @@ spec:
5454
defaultPlugins:
5555
- openshift <1>
5656
- aws
57+
resourceTimeout: 10m <2>
5758
restic:
58-
enable: true <2>
59+
enable: true <3>
5960
podConfig:
60-
nodeSelector: <node selector> <3>
61+
nodeSelector: <node_selector> <4>
6162
backupLocations:
6263
- name: default
6364
velero:
6465
provider: {provider}
6566
default: true
6667
objectStorage:
67-
bucket: <bucket_name> <4>
68-
prefix: <prefix> <5>
68+
bucket: <bucket_name> <5>
69+
prefix: <prefix> <6>
6970
config:
7071
region: <region>
7172
profile: "default"
7273
credential:
7374
key: cloud
74-
name: {credentials} <6>
75-
snapshotLocations: <7>
75+
name: {credentials} <7>
76+
snapshotLocations: <8>
7677
- name: default
7778
velero:
7879
provider: {provider}
7980
config:
80-
region: <region> <8>
81+
region: <region> <9>
8182
profile: "default"
8283
----
8384
<1> The `openshift` plugin is mandatory.
84-
<2> Set to `false` if you want to disable the Restic installation. Restic deploys a daemon set, which means that each worker node has `Restic` pods running. You configure Restic for backups by adding `spec.defaultVolumesToRestic: true` to the `Backup` CR.
85-
<3> Specify the node selector to be supplied to Restic podSpec.
86-
<4> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
87-
<5> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
88-
<6> Specify the name of the `Secret` object that you created. If you do not specify this value, the default name, `{credentials}`, is used. If you specify a custom name, the custom name is used for the backup location.
89-
<7> You do not need to specify a snapshot location if you use CSI snapshots or Restic to back up PVs.
90-
<8> The snapshot location must be in the same region as the PVs.
85+
<2> Specify how many minutes to wait for several Velero resources before timeout occurs, such as Velero CRD availability, volumeSnapshot deletion, and backup repository availability. The default is 10m.
86+
<3> Set to `false`, if you want to disable the Restic installation. Restic deploys a daemon set, which means that each worker node has `Restic` pods running. You can configure Restic for backups by adding `spec.defaultVolumesToRestic: true` to the `Backup` CR.
87+
<4> Specify on which nodes Restic is available. By default, Restic runs on all nodes.
88+
<5> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
89+
<6> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
90+
<7> Specify the name of the `Secret` object that you created. If you do not specify this value, the default name, `{credentials}`, is used. If you specify a custom name, the custom name is used for the backup location.
91+
<8> Specify a snapshot location, unless you use CSI snapshots or Restic to back up PVs.
92+
<9> The snapshot location must be in the same region as the PVs.
9193
endif::[]
9294
ifdef::installing-oadp-azure[]
9395
+
@@ -104,26 +106,27 @@ spec:
104106
defaultPlugins:
105107
- azure
106108
- openshift <1>
109+
resourceTimeout: 10m <2>
107110
restic:
108-
enable: true <2>
111+
enable: true <3>
109112
podConfig:
110-
nodeSelector: <node selector> <3>
113+
nodeSelector: <node_selector> <4>
111114
backupLocations:
112115
- velero:
113116
config:
114-
resourceGroup: <azure_resource_group> <4>
115-
storageAccount: <azure_storage_account_id> <5>
116-
subscriptionId: <azure_subscription_id> <6>
117+
resourceGroup: <azure_resource_group> <5>
118+
storageAccount: <azure_storage_account_id> <6>
119+
subscriptionId: <azure_subscription_id> <7>
117120
storageAccountKeyEnvVar: AZURE_STORAGE_ACCOUNT_ACCESS_KEY
118121
credential:
119122
key: cloud
120-
name: {credentials} <7>
123+
name: {credentials} <8>
121124
provider: {provider}
122125
default: true
123126
objectStorage:
124-
bucket: <bucket_name> <8>
125-
prefix: <prefix> <9>
126-
snapshotLocations: <10>
127+
bucket: <bucket_name> <9>
128+
prefix: <prefix> <10>
129+
snapshotLocations: <11>
127130
- velero:
128131
config:
129132
resourceGroup: <azure_resource_group>
@@ -133,15 +136,16 @@ spec:
133136
provider: {provider}
134137
----
135138
<1> The `openshift` plugin is mandatory.
136-
<2> Set to `false` if you want to disable the Restic installation. Restic deploys a daemon set, which means that each worker node has `Restic` pods running. You configure Restic for backups by adding `spec.defaultVolumesToRestic: true` to the `Backup` CR.
137-
<3> Specify the node selector to be supplied to Restic podSpec.
138-
<4> Specify the Azure resource group.
139-
<5> Specify the Azure storage account ID.
140-
<6> Specify the Azure subscription ID.
141-
<7> If you do not specify this value, the default name, `{credentials}`, is used. If you specify a custom name, the custom name is used for the backup location.
142-
<8> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
143-
<9> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
144-
<10> You do not need to specify a snapshot location if you use CSI snapshots or Restic to back up PVs.
139+
<2> Specify how many minutes to wait for several Velero resources before timeout occurs, such as Velero CRD availability, volumeSnapshot deletion, and backup repository availability. The default is 10m.
140+
<3> Set to `false`, if you want to disable the Restic installation. Restic deploys a daemon set, which means that each worker node has `Restic` pods running. You can configure Restic for backups by adding `spec.defaultVolumesToRestic: true` to the `Backup` CR.
141+
<4> Specify on which nodes Restic is available. By default, Restic runs on all nodes.
142+
<5> Specify the Azure resource group.
143+
<6> Specify the Azure storage account ID.
144+
<7> Specify the Azure subscription ID.
145+
<8> If you do not specify this value, the default name, `{credentials}`, is used. If you specify a custom name, the custom name is used for the backup location.
146+
<9> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
147+
<10> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
148+
<11> You do not need to specify a snapshot location if you use CSI snapshots or Restic to back up PVs.
145149
endif::[]
146150
ifdef::installing-oadp-gcp[]
147151
+
@@ -158,36 +162,38 @@ spec:
158162
defaultPlugins:
159163
- gcp
160164
- openshift <1>
165+
resourceTimeout: 10m <2>
161166
restic:
162-
enable: true <2>
167+
enable: true <3>
163168
podConfig:
164-
nodeSelector: <node selector> <3>
169+
nodeSelector: <node_selector> <4>
165170
backupLocations:
166171
- velero:
167172
provider: {provider}
168173
default: true
169174
credential:
170175
key: cloud
171-
name: {credentials} <4>
176+
name: {credentials} <5>
172177
objectStorage:
173-
bucket: <bucket_name> <5>
174-
prefix: <prefix> <6>
175-
snapshotLocations: <7>
178+
bucket: <bucket_name> <6>
179+
prefix: <prefix> <7>
180+
snapshotLocations: <8>
176181
- velero:
177182
provider: {provider}
178183
default: true
179184
config:
180185
project: <project>
181-
snapshotLocation: us-west1 <8>
186+
snapshotLocation: us-west1 <9>
182187
----
183188
<1> The `openshift` plugin is mandatory.
184-
<2> Set to `false` if you want to disable the Restic installation. Restic deploys a daemon set, which means that each worker node has `Restic` pods running. You configure Restic for backups by adding `spec.defaultVolumesToRestic: true` to the `Backup` CR.
185-
<3> Specify the node selector to be supplied to Restic podSpec.
186-
<4> If you do not specify this value, the default name, `{credentials}`, is used. If you specify a custom name, the custom name is used for the backup location.
187-
<5> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
188-
<6> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
189-
<7> You do not need to specify a snapshot location if you use CSI snapshots or Restic to back up PVs.
190-
<8> The snapshot location must be in the same region as the PVs.
189+
<2> Specify how many minutes to wait for several Velero resources before timeout occurs, such as Velero CRD availability, volumeSnapshot deletion, and backup repository availability. The default is 10m.
190+
<3> Set to `false`, if you want to disable the Restic installation. Restic deploys a daemon set, which means that each worker node has `Restic` pods running. You can configure Restic for backups by adding `spec.defaultVolumesToRestic: true` to the `Backup` CR.
191+
<4> Specify on which nodes Restic is available. By default, Restic runs on all nodes.
192+
<5> If you do not specify this value, the default name, `{credentials}`, is used. If you specify a custom name, the custom name is used for the backup location.
193+
<6> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
194+
<7> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
195+
<8> Specify a snapshot location, unless you use CSI snapshots or Restic to back up PVs.
196+
<9> The snapshot location must be in the same region as the PVs.
191197
endif::[]
192198
ifdef::installing-oadp-mcg[]
193199
+
@@ -204,34 +210,36 @@ spec:
204210
defaultPlugins:
205211
- aws
206212
- openshift <1>
213+
resourceTimeout: 10m <2>
207214
restic:
208-
enable: true <2>
215+
enable: true <3>
209216
podConfig:
210-
nodeSelector: <node selector> <3>
217+
nodeSelector: <node_selector> <4>
211218
backupLocations:
212219
- velero:
213220
config:
214221
profile: "default"
215222
region: minio
216-
s3Url: <url> <4>
223+
s3Url: <url> <5>
217224
insecureSkipTLSVerify: "true"
218225
s3ForcePathStyle: "true"
219226
provider: {provider}
220227
default: true
221228
credential:
222229
key: cloud
223-
name: {credentials} <5>
230+
name: {credentials} <6>
224231
objectStorage:
225-
bucket: <bucket_name> <6>
226-
prefix: <prefix> <7>
232+
bucket: <bucket_name> <7>
233+
prefix: <prefix> <8>
227234
----
228235
<1> The `openshift` plugin is mandatory.
229-
<2> Set to `false` if you want to disable the Restic installation. Restic deploys a daemon set, which means that each worker node has `Restic` pods running. You configure Restic for backups by adding `spec.defaultVolumesToRestic: true` to the `Backup` CR.
230-
<3> Specify the node selector to be supplied to Restic podSpec.
231-
<4> Specify the URL of the S3 endpoint.
232-
<5> If you do not specify this value, the default name, `{credentials}`, is used. If you specify a custom name, the custom name is used for the backup location.
233-
<6> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
234-
<7> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
236+
<2> Specify how many minutes to wait for several Velero resources before timeout occurs, such as Velero CRD availability, volumeSnapshot deletion, and backup repository availability. The default is 10m.
237+
<3> Set to `false`, if you want to disable the Restic installation. Restic deploys a daemon set, which means that each worker node has `Restic` pods running. You can configure Restic for backups by adding `spec.defaultVolumesToRestic: true` to the `Backup` CR.
238+
<4> Specify on which nodes Restic is available. By default, Restic runs on all nodes.
239+
<5> Specify the URL of the S3 endpoint.
240+
<6> If you do not specify this value, the default name, `{credentials}`, is used. If you specify a custom name, the custom name is used for the backup location.
241+
<7> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
242+
<8> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
235243
endif::[]
236244
ifdef::installing-oadp-ocs[]
237245
+
@@ -250,31 +258,33 @@ spec:
250258
- gcp <2>
251259
- csi <3>
252260
- openshift <4>
261+
resourceTimeout: 10m <5>
253262
restic:
254-
enable: true <5>
263+
enable: true <6>
255264
podConfig:
256-
nodeSelector: <node selector> <6>
265+
nodeSelector: <node_selector> <7>
257266
backupLocations:
258267
- velero:
259-
provider: {provider} <7>
268+
provider: {provider} <8>
260269
default: true
261270
credential:
262271
key: cloud
263-
name: <default_secret> <8>
272+
name: <default_secret> <9>
264273
objectStorage:
265-
bucket: <bucket_name> <9>
266-
prefix: <prefix> <10>
274+
bucket: <bucket_name> <10>
275+
prefix: <prefix> <11>
267276
----
268277
<1> Optional: The `kubevirt` plugin is used with {VirtProductName}.
269278
<2> Specify the default plugin for the backup provider, for example, `gcp`, if appropriate.
270279
<3> Specify the `csi` default plugin if you use CSI snapshots to back up PVs. The `csi` plugin uses the link:https://{velero-domain}/docs/main/csi/[Velero CSI beta snapshot APIs]. You do not need to configure a snapshot location.
271280
<4> The `openshift` plugin is mandatory.
272-
<5> Set to `false` if you want to disable the Restic installation. Restic deploys a daemon set, which means that each worker node has `Restic` pods running. You configure Restic for backups by adding `spec.defaultVolumesToRestic: true` to the `Backup` CR.
273-
<6> Specify the node selector to be supplied to Restic podSpec
274-
<7> Specify the backup provider.
275-
<8> If you use a default plugin for the backup provider, you must specify the correct default name for the `Secret`, for example, `cloud-credentials-gcp`. If you specify a custom name, the custom name is used for the backup location. If you do not specify a `Secret` name, the default name is used.
276-
<9> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
277-
<10> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
281+
<5> Specify how many minutes to wait for several Velero resources before timeout occurs, such as Velero CRD availability, volumeSnapshot deletion, and backup repository availability. The default is 10m.
282+
<6> Set to `false`, if you want to disable the Restic installation. Restic deploys a daemon set, which means that each worker node has `Restic` pods running. You can configure Restic for backups by adding `spec.defaultVolumesToRestic: true` to the `Backup` CR.
283+
<7> Specify on which nodes Restic is available. By default, Restic runs on all nodes.
284+
<8> Specify the backup provider.
285+
<9> Specify the correct default name for the `Secret`, for example, `cloud-credentials-gcp`, if you use a default plugin for the backup provider. If specifying a custom name, then the custom name is used for the backup location. If you do not specify a `Secret` name, the default name is used.
286+
<10> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
287+
<11> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
278288
endif::[]
279289
ifdef::virt-installing-configuring-oadp[]
280290
+
@@ -293,31 +303,33 @@ spec:
293303
- gcp <2>
294304
- csi <3>
295305
- openshift <4>
306+
resourceTimeout: 10m <5>
296307
restic:
297-
enable: true <5>
308+
enable: true <6>
298309
podConfig:
299-
nodeSelector: <node selector> <6>
310+
nodeSelector: <node_selector> <7>
300311
backupLocations:
301312
- velero:
302-
provider: {provider} <7>
313+
provider: {provider} <8>
303314
default: true
304315
credential:
305316
key: cloud
306-
name: <default_secret> <8>
317+
name: <default_secret> <9>
307318
objectStorage:
308-
bucket: <bucket_name> <9>
309-
prefix: <prefix> <10>
319+
bucket: <bucket_name> <10>
320+
prefix: <prefix> <11>
310321
----
311322
<1> The `kubevirt` plugin is mandatory for {VirtProductName}.
312323
<2> Specify the plugin for the backup provider, for example, `gcp`, if it exists.
313324
<3> The `csi` plugin is mandatory for backing up PVs with CSI snapshots. The `csi` plugin uses the link:https://{velero-domain}/docs/main/csi/[Velero CSI beta snapshot APIs]. You do not need to configure a snapshot location.
314325
<4> The `openshift` plugin is mandatory.
315-
<5> Set to `false` if you want to disable the Restic installation. Restic deploys a daemon set, which means that each worker node has `Restic` pods running. You configure Restic for backups by adding `spec.defaultVolumesToRestic: true` to the `Backup` CR.
316-
<6> Specify the node selector to be supplied to Restic podSpec
317-
<7> Specify the backup provider.
318-
<8> If you use a default plugin for the backup provider, you must specify the correct default name for the `Secret`, for example, `cloud-credentials-gcp`. If you specify a custom name, the custom name is used for the backup location. If you do not specify a `Secret` name, the default name is used.
319-
<9> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
320-
<10> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
326+
<5> Specify how many minutes to wait for several Velero resources before timeout occurs, such as Velero CRD availability, volumeSnapshot deletion, and backup repository availability. The default is 10m.
327+
<6> Set to `false`, if you want to disable the Restic installation. Restic deploys a daemon set, which means that each worker node has `Restic` pods running. You can configure Restic for backups by adding `spec.defaultVolumesToRestic: true` to the `Backup` CR.
328+
<7> Specify on which nodes Restic is available. By default, Restic runs on all nodes.
329+
<8> Specify the backup provider.
330+
<9> Specify the correct default name for the `Secret`, for example, `cloud-credentials-gcp`, if you use a default plugin for the backup provider. If specifying a custom name, then the custom name is used for the backup location. If you do not specify a `Secret` name, the default name is used.
331+
<10> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
332+
<11> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
321333
endif::[]
322334

323335
. Click *Create*.

0 commit comments

Comments
 (0)