@@ -10,7 +10,7 @@ title: ArangoBackup V1
10
10
11
11
### .spec.backoff.iterations
12
12
13
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_spec_backoff.go#L38 ) </sup >
13
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_spec_backoff.go#L38 ) </sup >
14
14
15
15
Iterations defines number of iterations before reaching MaxDelay. Default to 5
16
16
@@ -20,7 +20,7 @@ Default Value: `5`
20
20
21
21
### .spec.backoff.max_delay
22
22
23
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_spec_backoff.go#L35 ) </sup >
23
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_spec_backoff.go#L35 ) </sup >
24
24
25
25
MaxDelay defines maximum delay in seconds. Default to 600
26
26
@@ -30,15 +30,15 @@ Default Value: `600`
30
30
31
31
### .spec.backoff.max_iterations
32
32
33
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_spec_backoff.go#L40 ) </sup >
33
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_spec_backoff.go#L40 ) </sup >
34
34
35
35
MaxIterations defines maximum number of iterations after backoff will be disabled. Default to nil (no limit)
36
36
37
37
***
38
38
39
39
### .spec.backoff.min_delay
40
40
41
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_spec_backoff.go#L32 ) </sup >
41
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_spec_backoff.go#L32 ) </sup >
42
42
43
43
MinDelay defines minimum delay in seconds. Default to 30
44
44
@@ -48,7 +48,7 @@ Default Value: `30`
48
48
49
49
### .spec.deployment.name
50
50
51
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_spec.go#L55 ) </sup >
51
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_spec.go#L55 ) </sup >
52
52
53
53
Name of the ArangoDeployment Custom Resource within same namespace as ArangoBackup Custom Resource.
54
54
@@ -58,7 +58,7 @@ This field is **immutable**: can't be changed after backup creation
58
58
59
59
### .spec.download.autoDelete
60
60
61
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_spec.go#L85 ) </sup >
61
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_spec.go#L85 ) </sup >
62
62
63
63
AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
64
64
@@ -68,7 +68,7 @@ Default Value: `false`
68
68
69
69
### .spec.download.credentialsSecretName
70
70
71
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_spec.go#L82 ) </sup >
71
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_spec.go#L82 ) </sup >
72
72
73
73
CredentialsSecretName is the name of the secret used while accessing repository
74
74
@@ -81,7 +81,7 @@ This field is **immutable**: can't be changed after backup creation
81
81
82
82
### .spec.download.id
83
83
84
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_spec.go#L93 ) </sup >
84
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_spec.go#L93 ) </sup >
85
85
86
86
ID of the ArangoBackup to be downloaded
87
87
@@ -91,7 +91,7 @@ This field is **immutable**: can't be changed after backup creation
91
91
92
92
### .spec.download.repositoryURL
93
93
94
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_spec.go#L78 ) </sup >
94
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_spec.go#L78 ) </sup >
95
95
96
96
RepositoryURL is the URL path for file storage
97
97
Same repositoryURL needs to be defined in ` credentialsSecretName ` if protocol is other than local.
@@ -112,15 +112,15 @@ This field is **immutable**: can't be changed after backup creation
112
112
113
113
### .spec.lifetime
114
114
115
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_spec.go#L48 ) </sup >
115
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_spec.go#L48 ) </sup >
116
116
117
117
Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "2h45m".
118
118
119
119
***
120
120
121
121
### .spec.options.allowInconsistent
122
122
123
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_spec.go#L67 ) </sup >
123
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_spec.go#L67 ) </sup >
124
124
125
125
AllowInconsistent flag for Backup creation request.
126
126
If this value is set to true, backup is taken even if we are not able to acquire lock.
@@ -133,7 +133,7 @@ This field is **immutable**: can't be changed after backup creation
133
133
134
134
### .spec.options.timeout
135
135
136
- Type: ` number ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_spec.go#L62 ) </sup >
136
+ Type: ` number ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_spec.go#L62 ) </sup >
137
137
138
138
Timeout for Backup creation request in seconds. Works only when AsyncBackupCreation feature is set to false.
139
139
@@ -145,7 +145,7 @@ This field is **immutable**: can't be changed after backup creation
145
145
146
146
### .spec.policyName
147
147
148
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_spec.go#L42 ) </sup >
148
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_spec.go#L42 ) </sup >
149
149
150
150
PolicyName name of the ArangoBackupPolicy which created this Custom Resource
151
151
@@ -155,7 +155,7 @@ This field is **immutable**: can't be changed after backup creation
155
155
156
156
### .spec.upload.autoDelete
157
157
158
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_spec.go#L85 ) </sup >
158
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_spec.go#L85 ) </sup >
159
159
160
160
AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
161
161
@@ -165,7 +165,7 @@ Default Value: `false`
165
165
166
166
### .spec.upload.credentialsSecretName
167
167
168
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_spec.go#L82 ) </sup >
168
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_spec.go#L82 ) </sup >
169
169
170
170
CredentialsSecretName is the name of the secret used while accessing repository
171
171
@@ -178,7 +178,7 @@ This field is **immutable**: can't be changed after backup creation
178
178
179
179
### .spec.upload.repositoryURL
180
180
181
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_spec.go#L78 ) </sup >
181
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_spec.go#L78 ) </sup >
182
182
183
183
RepositoryURL is the URL path for file storage
184
184
Same repositoryURL needs to be defined in ` credentialsSecretName ` if protocol is other than local.
@@ -199,99 +199,99 @@ This field is **immutable**: can't be changed after backup creation
199
199
200
200
### .status.available
201
201
202
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_status.go#L36 ) </sup >
202
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_status.go#L36 ) </sup >
203
203
204
204
Available Determines if we can restore from ArangoBackup
205
205
206
206
***
207
207
208
208
### .status.backoff.iterations
209
209
210
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_status_backoff.go#L30 ) </sup >
210
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_status_backoff.go#L30 ) </sup >
211
211
212
212
***
213
213
214
214
### .status.backup.downloaded
215
215
216
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_status.go#L66 ) </sup >
216
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_status.go#L66 ) </sup >
217
217
218
218
Downloaded Determines if ArangoBackup has been downloaded.
219
219
220
220
***
221
221
222
222
### .status.backup.id
223
223
224
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_status.go#L56 ) </sup >
224
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_status.go#L56 ) </sup >
225
225
226
226
***
227
227
228
228
### .status.backup.imported
229
229
230
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_status.go#L67 ) </sup >
230
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_status.go#L67 ) </sup >
231
231
232
232
***
233
233
234
234
### .status.backup.keys
235
235
236
- Type: ` array ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_status.go#L70 ) </sup >
236
+ Type: ` array ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_status.go#L70 ) </sup >
237
237
238
238
***
239
239
240
240
### .status.backup.numberOfDBServers
241
241
242
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_status.go#L62 ) </sup >
242
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_status.go#L62 ) </sup >
243
243
244
244
NumberOfDBServers Cluster size of the Backup in ArangoDB
245
245
246
246
***
247
247
248
248
### .status.backup.potentiallyInconsistent
249
249
250
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_status.go#L58 ) </sup >
250
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_status.go#L58 ) </sup >
251
251
252
252
***
253
253
254
254
### .status.backup.sizeInBytes
255
255
256
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_status.go#L60 ) </sup >
256
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_status.go#L60 ) </sup >
257
257
258
258
SizeInBytes Size of the Backup in ArangoDB.
259
259
260
260
***
261
261
262
262
### .status.backup.uploaded
263
263
264
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_status.go#L64 ) </sup >
264
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_status.go#L64 ) </sup >
265
265
266
266
Uploaded Determines if ArangoBackup has been uploaded
267
267
268
268
***
269
269
270
270
### .status.backup.version
271
271
272
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_status.go#L57 ) </sup >
272
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_status.go#L57 ) </sup >
273
273
274
274
***
275
275
276
276
### .status.message
277
277
278
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_state.go#L91 ) </sup >
278
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_state.go#L91 ) </sup >
279
279
280
280
Message for the state this object is in.
281
281
282
282
***
283
283
284
284
### .status.progress.jobID
285
285
286
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_state.go#L114 ) </sup >
286
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_state.go#L114 ) </sup >
287
287
288
288
JobID ArangoDB job ID for uploading or downloading
289
289
290
290
***
291
291
292
292
### .status.progress.progress
293
293
294
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_state.go#L117 ) </sup >
294
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_state.go#L117 ) </sup >
295
295
296
296
Progress ArangoDB job progress in percents
297
297
@@ -304,7 +304,7 @@ Example:
304
304
305
305
### .status.state
306
306
307
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.48 /pkg/apis/backup/v1/backup_state.go#L85 ) </sup >
307
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.49 /pkg/apis/backup/v1/backup_state.go#L85 ) </sup >
308
308
309
309
State holds the current high level state of the backup
310
310
0 commit comments