@@ -10,62 +10,72 @@ title: ArangoBackup V1
1010
1111### .spec.backoff.iterations
1212
13- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_spec_backoff.go#L31 ) </sup >
13+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /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.36 /pkg/apis/backup/v1/backup_spec_backoff.go#L29 ) </sup >
21+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /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.36 /pkg/apis/backup/v1/backup_spec_backoff.go#L33 ) </sup >
29+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /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.36 /pkg/apis/backup/v1/backup_spec_backoff.go#L27 ) </sup >
37+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /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.36 /pkg/apis/backup/v1/backup_spec.go#L54 ) </sup >
45+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_spec.go#L54 ) </sup >
4646
4747Name of the ArangoDeployment Custom Resource within same namespace as ArangoBackup Custom Resource.
4848
4949This field is ** immutable** : can't be changed after backup creation
5050
5151***
5252
53+ ### .spec.download.autoDelete
54+
55+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec.go#L84 ) </sup >
56+
57+ AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
58+
59+ Default Value: ` false `
60+
61+ ***
62+
5363### .spec.download.credentialsSecretName
5464
55- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_spec.go#L81 ) </sup >
65+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_spec.go#L81 ) </sup >
5666
5767CredentialsSecretName is the name of the secret used while accessing repository
5868
5969Links:
60- * [ Defining a secret for backup upload or download] ( /docs /backup-resource.md#defining-a-secret-for-backup-upload-or-download)
70+ * [ Defining a secret for backup upload or download] ( .. /backup-resource.md#defining-a-secret-for-backup-upload-or-download)
6171
6272This field is ** immutable** : can't be changed after backup creation
6373
6474***
6575
6676### .spec.download.id
6777
68- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_spec.go#L89 ) </sup >
78+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_spec.go#L92 ) </sup >
6979
7080ID of the ArangoBackup to be downloaded
7181
@@ -75,7 +85,7 @@ This field is **immutable**: can't be changed after backup creation
7585
7686### .spec.download.repositoryURL
7787
78- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_spec.go#L77 ) </sup >
88+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_spec.go#L77 ) </sup >
7989
8090RepositoryURL is the URL path for file storage
8191Same repositoryURL needs to be defined in ` credentialsSecretName ` if protocol is other than local.
@@ -96,15 +106,15 @@ This field is **immutable**: can't be changed after backup creation
96106
97107### .spec.lifetime
98108
99- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_spec.go#L47 ) </sup >
109+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_spec.go#L47 ) </sup >
100110
101111Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "2h45m".
102112
103113***
104114
105115### .spec.options.allowInconsistent
106116
107- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_spec.go#L66 ) </sup >
117+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_spec.go#L66 ) </sup >
108118
109119AllowInconsistent flag for Backup creation request.
110120If this value is set to true, backup is taken even if we are not able to acquire lock.
@@ -117,7 +127,7 @@ This field is **immutable**: can't be changed after backup creation
117127
118128### .spec.options.timeout
119129
120- Type: ` number ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_spec.go#L61 ) </sup >
130+ Type: ` number ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_spec.go#L61 ) </sup >
121131
122132Timeout for Backup creation request in seconds. Works only when AsyncBackupCreation feature is set to false.
123133
@@ -129,30 +139,40 @@ This field is **immutable**: can't be changed after backup creation
129139
130140### .spec.policyName
131141
132- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_spec.go#L42 ) </sup >
142+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_spec.go#L42 ) </sup >
133143
134144PolicyName name of the ArangoBackupPolicy which created this Custom Resource
135145
136146This field is ** immutable** : can't be changed after backup creation
137147
138148***
139149
150+ ### .spec.upload.autoDelete
151+
152+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec.go#L84 ) </sup >
153+
154+ AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
155+
156+ Default Value: ` false `
157+
158+ ***
159+
140160### .spec.upload.credentialsSecretName
141161
142- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_spec.go#L81 ) </sup >
162+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_spec.go#L81 ) </sup >
143163
144164CredentialsSecretName is the name of the secret used while accessing repository
145165
146166Links:
147- * [ Defining a secret for backup upload or download] ( /docs /backup-resource.md#defining-a-secret-for-backup-upload-or-download)
167+ * [ Defining a secret for backup upload or download] ( .. /backup-resource.md#defining-a-secret-for-backup-upload-or-download)
148168
149169This field is ** immutable** : can't be changed after backup creation
150170
151171***
152172
153173### .spec.upload.repositoryURL
154174
155- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_spec.go#L77 ) </sup >
175+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_spec.go#L77 ) </sup >
156176
157177RepositoryURL is the URL path for file storage
158178Same repositoryURL needs to be defined in ` credentialsSecretName ` if protocol is other than local.
@@ -173,99 +193,99 @@ This field is **immutable**: can't be changed after backup creation
173193
174194### .status.available
175195
176- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_status.go#L36 ) </sup >
196+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_status.go#L36 ) </sup >
177197
178198Available Determines if we can restore from ArangoBackup
179199
180200***
181201
182202### .status.backoff.iterations
183203
184- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_status_backoff.go#L30 ) </sup >
204+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_status_backoff.go#L30 ) </sup >
185205
186206***
187207
188208### .status.backup.downloaded
189209
190- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_status.go#L66 ) </sup >
210+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_status.go#L66 ) </sup >
191211
192212Downloaded Determines if ArangoBackup has been downloaded.
193213
194214***
195215
196216### .status.backup.id
197217
198- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_status.go#L56 ) </sup >
218+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_status.go#L56 ) </sup >
199219
200220***
201221
202222### .status.backup.imported
203223
204- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_status.go#L67 ) </sup >
224+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_status.go#L67 ) </sup >
205225
206226***
207227
208228### .status.backup.keys
209229
210- Type: ` array ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_status.go#L70 ) </sup >
230+ Type: ` array ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_status.go#L70 ) </sup >
211231
212232***
213233
214234### .status.backup.numberOfDBServers
215235
216- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_status.go#L62 ) </sup >
236+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_status.go#L62 ) </sup >
217237
218238NumberOfDBServers Cluster size of the Backup in ArangoDB
219239
220240***
221241
222242### .status.backup.potentiallyInconsistent
223243
224- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_status.go#L58 ) </sup >
244+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_status.go#L58 ) </sup >
225245
226246***
227247
228248### .status.backup.sizeInBytes
229249
230- Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_status.go#L60 ) </sup >
250+ Type: ` integer ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_status.go#L60 ) </sup >
231251
232252SizeInBytes Size of the Backup in ArangoDB.
233253
234254***
235255
236256### .status.backup.uploaded
237257
238- Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_status.go#L64 ) </sup >
258+ Type: ` boolean ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_status.go#L64 ) </sup >
239259
240260Uploaded Determines if ArangoBackup has been uploaded
241261
242262***
243263
244264### .status.backup.version
245265
246- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_status.go#L57 ) </sup >
266+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_status.go#L57 ) </sup >
247267
248268***
249269
250270### .status.message
251271
252- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_state.go#L91 ) </sup >
272+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_state.go#L91 ) </sup >
253273
254274Message for the state this object is in.
255275
256276***
257277
258278### .status.progress.jobID
259279
260- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_state.go#L114 ) </sup >
280+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_state.go#L114 ) </sup >
261281
262282JobID ArangoDB job ID for uploading or downloading
263283
264284***
265285
266286### .status.progress.progress
267287
268- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_state.go#L117 ) </sup >
288+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_state.go#L117 ) </sup >
269289
270290Progress ArangoDB job progress in percents
271291
@@ -278,7 +298,7 @@ Example:
278298
279299### .status.state
280300
281- Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.36 /pkg/apis/backup/v1/backup_state.go#L85 ) </sup >
301+ Type: ` string ` <sup >[ \[ ref\] ] ( https://github.com/arangodb/kube-arangodb/blob/1.2.37 /pkg/apis/backup/v1/backup_state.go#L85 ) </sup >
282302
283303State holds the current high level state of the backup
284304
0 commit comments