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