@@ -10,39 +10,39 @@ 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.41 /pkg/apis/backup/v1/backup_spec_backoff.go#L31 ) </sup >
13
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_spec_backoff.go#L31 ) </sup >
14
14
15
15
Iterations defines number of iterations before reaching MaxDelay. Default to 5
16
16
17
17
***
18
18
19
19
### .spec.backoff.max_delay
20
20
21
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_spec_backoff.go#L29 ) </sup >
21
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_spec_backoff.go#L29 ) </sup >
22
22
23
23
MaxDelay defines maximum delay in seconds. Default to 600
24
24
25
25
***
26
26
27
27
### .spec.backoff.max_iterations
28
28
29
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_spec_backoff.go#L33 ) </sup >
29
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_spec_backoff.go#L33 ) </sup >
30
30
31
31
MaxIterations defines maximum number of iterations after backoff will be disabled. Default to nil (no limit)
32
32
33
33
***
34
34
35
35
### .spec.backoff.min_delay
36
36
37
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_spec_backoff.go#L27 ) </sup >
37
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_spec_backoff.go#L27 ) </sup >
38
38
39
39
MinDelay defines minimum delay in seconds. Default to 30
40
40
41
41
***
42
42
43
43
### .spec.deployment.name
44
44
45
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_spec.go#L54 ) </sup >
45
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_spec.go#L54 ) </sup >
46
46
47
47
Name of the ArangoDeployment Custom Resource within same namespace as ArangoBackup Custom Resource.
48
48
@@ -52,7 +52,7 @@ This field is **immutable**: can't be changed after backup creation
52
52
53
53
### .spec.download.autoDelete
54
54
55
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_spec.go#L84 ) </sup >
55
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_spec.go#L84 ) </sup >
56
56
57
57
AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
58
58
@@ -62,7 +62,7 @@ Default Value: `false`
62
62
63
63
### .spec.download.credentialsSecretName
64
64
65
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_spec.go#L81 ) </sup >
65
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_spec.go#L81 ) </sup >
66
66
67
67
CredentialsSecretName is the name of the secret used while accessing repository
68
68
@@ -75,7 +75,7 @@ This field is **immutable**: can't be changed after backup creation
75
75
76
76
### .spec.download.id
77
77
78
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_spec.go#L92 ) </sup >
78
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_spec.go#L92 ) </sup >
79
79
80
80
ID of the ArangoBackup to be downloaded
81
81
@@ -85,7 +85,7 @@ This field is **immutable**: can't be changed after backup creation
85
85
86
86
### .spec.download.repositoryURL
87
87
88
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_spec.go#L77 ) </sup >
88
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_spec.go#L77 ) </sup >
89
89
90
90
RepositoryURL is the URL path for file storage
91
91
Same repositoryURL needs to be defined in ` credentialsSecretName ` if protocol is other than local.
@@ -106,15 +106,15 @@ This field is **immutable**: can't be changed after backup creation
106
106
107
107
### .spec.lifetime
108
108
109
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_spec.go#L47 ) </sup >
109
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_spec.go#L47 ) </sup >
110
110
111
111
Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "2h45m".
112
112
113
113
***
114
114
115
115
### .spec.options.allowInconsistent
116
116
117
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_spec.go#L66 ) </sup >
117
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_spec.go#L66 ) </sup >
118
118
119
119
AllowInconsistent flag for Backup creation request.
120
120
If this value is set to true, backup is taken even if we are not able to acquire lock.
@@ -127,7 +127,7 @@ This field is **immutable**: can't be changed after backup creation
127
127
128
128
### .spec.options.timeout
129
129
130
- Type: ` number ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_spec.go#L61 ) </sup >
130
+ Type: ` number ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_spec.go#L61 ) </sup >
131
131
132
132
Timeout for Backup creation request in seconds. Works only when AsyncBackupCreation feature is set to false.
133
133
@@ -139,7 +139,7 @@ This field is **immutable**: can't be changed after backup creation
139
139
140
140
### .spec.policyName
141
141
142
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_spec.go#L42 ) </sup >
142
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_spec.go#L42 ) </sup >
143
143
144
144
PolicyName name of the ArangoBackupPolicy which created this Custom Resource
145
145
@@ -149,7 +149,7 @@ This field is **immutable**: can't be changed after backup creation
149
149
150
150
### .spec.upload.autoDelete
151
151
152
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_spec.go#L84 ) </sup >
152
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_spec.go#L84 ) </sup >
153
153
154
154
AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
155
155
@@ -159,7 +159,7 @@ Default Value: `false`
159
159
160
160
### .spec.upload.credentialsSecretName
161
161
162
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_spec.go#L81 ) </sup >
162
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_spec.go#L81 ) </sup >
163
163
164
164
CredentialsSecretName is the name of the secret used while accessing repository
165
165
@@ -172,7 +172,7 @@ This field is **immutable**: can't be changed after backup creation
172
172
173
173
### .spec.upload.repositoryURL
174
174
175
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_spec.go#L77 ) </sup >
175
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_spec.go#L77 ) </sup >
176
176
177
177
RepositoryURL is the URL path for file storage
178
178
Same repositoryURL needs to be defined in ` credentialsSecretName ` if protocol is other than local.
@@ -193,99 +193,99 @@ This field is **immutable**: can't be changed after backup creation
193
193
194
194
### .status.available
195
195
196
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_status.go#L36 ) </sup >
196
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_status.go#L36 ) </sup >
197
197
198
198
Available Determines if we can restore from ArangoBackup
199
199
200
200
***
201
201
202
202
### .status.backoff.iterations
203
203
204
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_status_backoff.go#L30 ) </sup >
204
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_status_backoff.go#L30 ) </sup >
205
205
206
206
***
207
207
208
208
### .status.backup.downloaded
209
209
210
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_status.go#L66 ) </sup >
210
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_status.go#L66 ) </sup >
211
211
212
212
Downloaded Determines if ArangoBackup has been downloaded.
213
213
214
214
***
215
215
216
216
### .status.backup.id
217
217
218
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_status.go#L56 ) </sup >
218
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_status.go#L56 ) </sup >
219
219
220
220
***
221
221
222
222
### .status.backup.imported
223
223
224
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_status.go#L67 ) </sup >
224
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_status.go#L67 ) </sup >
225
225
226
226
***
227
227
228
228
### .status.backup.keys
229
229
230
- Type: ` array ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_status.go#L70 ) </sup >
230
+ Type: ` array ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_status.go#L70 ) </sup >
231
231
232
232
***
233
233
234
234
### .status.backup.numberOfDBServers
235
235
236
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_status.go#L62 ) </sup >
236
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_status.go#L62 ) </sup >
237
237
238
238
NumberOfDBServers Cluster size of the Backup in ArangoDB
239
239
240
240
***
241
241
242
242
### .status.backup.potentiallyInconsistent
243
243
244
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_status.go#L58 ) </sup >
244
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_status.go#L58 ) </sup >
245
245
246
246
***
247
247
248
248
### .status.backup.sizeInBytes
249
249
250
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_status.go#L60 ) </sup >
250
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_status.go#L60 ) </sup >
251
251
252
252
SizeInBytes Size of the Backup in ArangoDB.
253
253
254
254
***
255
255
256
256
### .status.backup.uploaded
257
257
258
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_status.go#L64 ) </sup >
258
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_status.go#L64 ) </sup >
259
259
260
260
Uploaded Determines if ArangoBackup has been uploaded
261
261
262
262
***
263
263
264
264
### .status.backup.version
265
265
266
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_status.go#L57 ) </sup >
266
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_status.go#L57 ) </sup >
267
267
268
268
***
269
269
270
270
### .status.message
271
271
272
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_state.go#L91 ) </sup >
272
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_state.go#L91 ) </sup >
273
273
274
274
Message for the state this object is in.
275
275
276
276
***
277
277
278
278
### .status.progress.jobID
279
279
280
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_state.go#L114 ) </sup >
280
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_state.go#L114 ) </sup >
281
281
282
282
JobID ArangoDB job ID for uploading or downloading
283
283
284
284
***
285
285
286
286
### .status.progress.progress
287
287
288
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_state.go#L117 ) </sup >
288
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_state.go#L117 ) </sup >
289
289
290
290
Progress ArangoDB job progress in percents
291
291
@@ -298,7 +298,7 @@ Example:
298
298
299
299
### .status.state
300
300
301
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.41 /pkg/apis/backup/v1/backup_state.go#L85 ) </sup >
301
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.42 /pkg/apis/backup/v1/backup_state.go#L85 ) </sup >
302
302
303
303
State holds the current high level state of the backup
304
304
0 commit comments