@@ -10,39 +10,39 @@ title: ArangoBackup V1
1010
1111### .spec.backoff.iterations
1212
13- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_spec_backoff.go#L31 ) </sup >
13+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_spec_backoff.go#L31 ) </sup >
1414
1515Iterations defines number of iterations before reaching MaxDelay. Default to 5
1616
1717***
1818
1919### .spec.backoff.max_delay
2020
21- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_spec_backoff.go#L29 ) </sup >
21+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_spec_backoff.go#L29 ) </sup >
2222
2323MaxDelay defines maximum delay in seconds. Default to 600
2424
2525***
2626
2727### .spec.backoff.max_iterations
2828
29- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_spec_backoff.go#L33 ) </sup >
29+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_spec_backoff.go#L33 ) </sup >
3030
3131MaxIterations defines maximum number of iterations after backoff will be disabled. Default to nil (no limit)
3232
3333***
3434
3535### .spec.backoff.min_delay
3636
37- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_spec_backoff.go#L27 ) </sup >
37+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_spec_backoff.go#L27 ) </sup >
3838
3939MinDelay defines minimum delay in seconds. Default to 30
4040
4141***
4242
4343### .spec.deployment.name
4444
45- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_spec.go#L54 ) </sup >
45+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_spec.go#L54 ) </sup >
4646
4747Name of the ArangoDeployment Custom Resource within same namespace as ArangoBackup Custom Resource.
4848
@@ -52,7 +52,7 @@ This field is **immutable**: can't be changed after backup creation
5252
5353### .spec.download.autoDelete
5454
55- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_spec.go#L84 ) </sup >
55+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_spec.go#L84 ) </sup >
5656
5757AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
5858
@@ -62,7 +62,7 @@ Default Value: `false`
6262
6363### .spec.download.credentialsSecretName
6464
65- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_spec.go#L81 ) </sup >
65+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_spec.go#L81 ) </sup >
6666
6767CredentialsSecretName is the name of the secret used while accessing repository
6868
@@ -75,7 +75,7 @@ This field is **immutable**: can't be changed after backup creation
7575
7676### .spec.download.id
7777
78- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_spec.go#L92 ) </sup >
78+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_spec.go#L92 ) </sup >
7979
8080ID of the ArangoBackup to be downloaded
8181
@@ -85,7 +85,7 @@ This field is **immutable**: can't be changed after backup creation
8585
8686### .spec.download.repositoryURL
8787
88- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_spec.go#L77 ) </sup >
88+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_spec.go#L77 ) </sup >
8989
9090RepositoryURL is the URL path for file storage
9191Same 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
106106
107107### .spec.lifetime
108108
109- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_spec.go#L47 ) </sup >
109+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_spec.go#L47 ) </sup >
110110
111111Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "2h45m".
112112
113113***
114114
115115### .spec.options.allowInconsistent
116116
117- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_spec.go#L66 ) </sup >
117+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_spec.go#L66 ) </sup >
118118
119119AllowInconsistent flag for Backup creation request.
120120If 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
127127
128128### .spec.options.timeout
129129
130- Type: ` number ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_spec.go#L61 ) </sup >
130+ Type: ` number ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_spec.go#L61 ) </sup >
131131
132132Timeout for Backup creation request in seconds. Works only when AsyncBackupCreation feature is set to false.
133133
@@ -139,7 +139,7 @@ This field is **immutable**: can't be changed after backup creation
139139
140140### .spec.policyName
141141
142- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_spec.go#L42 ) </sup >
142+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_spec.go#L42 ) </sup >
143143
144144PolicyName name of the ArangoBackupPolicy which created this Custom Resource
145145
@@ -149,7 +149,7 @@ This field is **immutable**: can't be changed after backup creation
149149
150150### .spec.upload.autoDelete
151151
152- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_spec.go#L84 ) </sup >
152+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_spec.go#L84 ) </sup >
153153
154154AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
155155
@@ -159,7 +159,7 @@ Default Value: `false`
159159
160160### .spec.upload.credentialsSecretName
161161
162- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_spec.go#L81 ) </sup >
162+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_spec.go#L81 ) </sup >
163163
164164CredentialsSecretName is the name of the secret used while accessing repository
165165
@@ -172,7 +172,7 @@ This field is **immutable**: can't be changed after backup creation
172172
173173### .spec.upload.repositoryURL
174174
175- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_spec.go#L77 ) </sup >
175+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_spec.go#L77 ) </sup >
176176
177177RepositoryURL is the URL path for file storage
178178Same 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
193193
194194### .status.available
195195
196- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_status.go#L36 ) </sup >
196+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_status.go#L36 ) </sup >
197197
198198Available Determines if we can restore from ArangoBackup
199199
200200***
201201
202202### .status.backoff.iterations
203203
204- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_status_backoff.go#L30 ) </sup >
204+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_status_backoff.go#L30 ) </sup >
205205
206206***
207207
208208### .status.backup.downloaded
209209
210- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_status.go#L66 ) </sup >
210+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_status.go#L66 ) </sup >
211211
212212Downloaded Determines if ArangoBackup has been downloaded.
213213
214214***
215215
216216### .status.backup.id
217217
218- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_status.go#L56 ) </sup >
218+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_status.go#L56 ) </sup >
219219
220220***
221221
222222### .status.backup.imported
223223
224- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_status.go#L67 ) </sup >
224+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_status.go#L67 ) </sup >
225225
226226***
227227
228228### .status.backup.keys
229229
230- Type: ` array ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_status.go#L70 ) </sup >
230+ Type: ` array ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_status.go#L70 ) </sup >
231231
232232***
233233
234234### .status.backup.numberOfDBServers
235235
236- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_status.go#L62 ) </sup >
236+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_status.go#L62 ) </sup >
237237
238238NumberOfDBServers Cluster size of the Backup in ArangoDB
239239
240240***
241241
242242### .status.backup.potentiallyInconsistent
243243
244- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_status.go#L58 ) </sup >
244+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_status.go#L58 ) </sup >
245245
246246***
247247
248248### .status.backup.sizeInBytes
249249
250- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_status.go#L60 ) </sup >
250+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_status.go#L60 ) </sup >
251251
252252SizeInBytes Size of the Backup in ArangoDB.
253253
254254***
255255
256256### .status.backup.uploaded
257257
258- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_status.go#L64 ) </sup >
258+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_status.go#L64 ) </sup >
259259
260260Uploaded Determines if ArangoBackup has been uploaded
261261
262262***
263263
264264### .status.backup.version
265265
266- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_status.go#L57 ) </sup >
266+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_status.go#L57 ) </sup >
267267
268268***
269269
270270### .status.message
271271
272- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_state.go#L91 ) </sup >
272+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_state.go#L91 ) </sup >
273273
274274Message for the state this object is in.
275275
276276***
277277
278278### .status.progress.jobID
279279
280- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_state.go#L114 ) </sup >
280+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_state.go#L114 ) </sup >
281281
282282JobID ArangoDB job ID for uploading or downloading
283283
284284***
285285
286286### .status.progress.progress
287287
288- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_state.go#L117 ) </sup >
288+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_state.go#L117 ) </sup >
289289
290290Progress ArangoDB job progress in percents
291291
@@ -298,7 +298,7 @@ Example:
298298
299299### .status.state
300300
301- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.43 /pkg/apis/backup/v1/backup_state.go#L85 ) </sup >
301+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.44 /pkg/apis/backup/v1/backup_state.go#L85 ) </sup >
302302
303303State holds the current high level state of the backup
304304
0 commit comments