@@ -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.50 /pkg/apis/backup/v1/backup_spec_backoff.go#L38 ) </sup >
13
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.3.0 /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.50 /pkg/apis/backup/v1/backup_spec_backoff.go#L35 ) </sup >
23
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.3.0 /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.50 /pkg/apis/backup/v1/backup_spec_backoff.go#L40 ) </sup >
33
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.3.0 /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.50 /pkg/apis/backup/v1/backup_spec_backoff.go#L32 ) </sup >
41
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.3.0 /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.50 /pkg/apis/backup/v1/backup_spec.go#L55 ) </sup >
51
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.3.0 /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.50 /pkg/apis/backup/v1/backup_spec.go#L85 ) </sup >
61
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.3.0 /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.50 /pkg/apis/backup/v1/backup_spec.go#L82 ) </sup >
71
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.3.0 /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.50 /pkg/apis/backup/v1/backup_spec.go#L93 ) </sup >
84
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.3.0 /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.50 /pkg/apis/backup/v1/backup_spec.go#L78 ) </sup >
94
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.3.0 /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.50 /pkg/apis/backup/v1/backup_spec.go#L48 ) </sup >
115
+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.3.0 /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.50 /pkg/apis/backup/v1/backup_spec.go#L67 ) </sup >
123
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.3.0 /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.50 /pkg/apis/backup/v1/backup_spec.go#L62 ) </sup >
136
+ Type: ` number ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.3.0 /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.50 /pkg/apis/backup/v1/backup_spec.go#L42 ) </sup >
148
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.3.0 /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.50 /pkg/apis/backup/v1/backup_spec.go#L85 ) </sup >
158
+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.3.0 /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.50 /pkg/apis/backup/v1/backup_spec.go#L82 ) </sup >
168
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.3.0 /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.50 /pkg/apis/backup/v1/backup_spec.go#L78 ) </sup >
181
+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.3.0 /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.
@@ -195,134 +195,3 @@ azure://test
195
195
196
196
This field is ** immutable** : can't be changed after backup creation
197
197
198
- ## Status
199
-
200
- ### .status.available
201
-
202
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/backup/v1/backup_status.go#L36 ) </sup >
203
-
204
- Available Determines if we can restore from ArangoBackup
205
-
206
- ***
207
-
208
- ### .status.backoff.iterations
209
-
210
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/backup/v1/backup_status_backoff.go#L30 ) </sup >
211
-
212
- ***
213
-
214
- ### .status.backup.downloaded
215
-
216
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/backup/v1/backup_status.go#L66 ) </sup >
217
-
218
- Downloaded Determines if ArangoBackup has been downloaded.
219
-
220
- ***
221
-
222
- ### .status.backup.id
223
-
224
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/backup/v1/backup_status.go#L56 ) </sup >
225
-
226
- ***
227
-
228
- ### .status.backup.imported
229
-
230
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/backup/v1/backup_status.go#L67 ) </sup >
231
-
232
- ***
233
-
234
- ### .status.backup.keys
235
-
236
- Type: ` array ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/backup/v1/backup_status.go#L70 ) </sup >
237
-
238
- ***
239
-
240
- ### .status.backup.numberOfDBServers
241
-
242
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/backup/v1/backup_status.go#L62 ) </sup >
243
-
244
- NumberOfDBServers Cluster size of the Backup in ArangoDB
245
-
246
- ***
247
-
248
- ### .status.backup.potentiallyInconsistent
249
-
250
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/backup/v1/backup_status.go#L58 ) </sup >
251
-
252
- ***
253
-
254
- ### .status.backup.sizeInBytes
255
-
256
- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/backup/v1/backup_status.go#L60 ) </sup >
257
-
258
- SizeInBytes Size of the Backup in ArangoDB.
259
-
260
- ***
261
-
262
- ### .status.backup.uploaded
263
-
264
- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/backup/v1/backup_status.go#L64 ) </sup >
265
-
266
- Uploaded Determines if ArangoBackup has been uploaded
267
-
268
- ***
269
-
270
- ### .status.backup.version
271
-
272
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/backup/v1/backup_status.go#L57 ) </sup >
273
-
274
- ***
275
-
276
- ### .status.message
277
-
278
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/backup/v1/backup_state.go#L91 ) </sup >
279
-
280
- Message for the state this object is in.
281
-
282
- ***
283
-
284
- ### .status.progress.jobID
285
-
286
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/backup/v1/backup_state.go#L114 ) </sup >
287
-
288
- JobID ArangoDB job ID for uploading or downloading
289
-
290
- ***
291
-
292
- ### .status.progress.progress
293
-
294
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/backup/v1/backup_state.go#L117 ) </sup >
295
-
296
- Progress ArangoDB job progress in percents
297
-
298
- Example:
299
- ``` yaml
300
- 90%
301
- ```
302
-
303
- ***
304
-
305
- ### .status.state
306
-
307
- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/backup/v1/backup_state.go#L85 ) </sup >
308
-
309
- State holds the current high level state of the backup
310
-
311
- Possible Values:
312
- * ` "" ` (default) - state for un-initialized Custom Resource
313
- * ` "Pending" ` - state in which Custom Resource is queued. If Backup is possible changed to "Scheduled"
314
- * ` "Scheduled" ` - state which will start create/download process
315
- * ` "Download" ` - state in which download request will be created on ArangoDB
316
- * ` "DownloadError" ` - state when download failed
317
- * ` "Downloading" ` - state for downloading progress
318
- * ` "Create" ` - state for backup when it is scheduled for creation, field available set to true
319
- * ` "Creating" ` - state for backup when it is creating
320
- * ` "CreateError" ` - state for backup when it is creation failed
321
- * ` "Upload" ` - state in which upload request will be created on ArangoDB
322
- * ` "Uploading" ` - state for uploading progress
323
- * ` "UploadError" ` - state when uploading failed
324
- * ` "Ready" ` - state when Backup is finished
325
- * ` "Deleted" ` - state when Backup was once in ready, but has been deleted
326
- * ` "Failed" ` - state for failure
327
- * ` "Unavailable" ` - state when Backup is not available on the ArangoDB. It can happen in case of upgrades, node restarts etc.
328
-
0 commit comments