Skip to content

Commit b9c3a58

Browse files
authored
sync-gh-pages: docs and Helm chart 1.2.48 (#1889)
1 parent 47bdf81 commit b9c3a58

39 files changed

+2434
-1886
lines changed

docs/api/ArangoBackup.V1.md

+37-31
Original file line numberDiff line numberDiff line change
@@ -10,39 +10,45 @@ title: ArangoBackup V1
1010

1111
### .spec.backoff.iterations
1212

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>
1414

1515
Iterations defines number of iterations before reaching MaxDelay. Default to 5
1616

17+
Default Value: `5`
18+
1719
***
1820

1921
### .spec.backoff.max_delay
2022

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>
2224

2325
MaxDelay defines maximum delay in seconds. Default to 600
2426

27+
Default Value: `600`
28+
2529
***
2630

2731
### .spec.backoff.max_iterations
2832

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>
3034

3135
MaxIterations defines maximum number of iterations after backoff will be disabled. Default to nil (no limit)
3236

3337
***
3438

3539
### .spec.backoff.min_delay
3640

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>
3842

3943
MinDelay defines minimum delay in seconds. Default to 30
4044

45+
Default Value: `30`
46+
4147
***
4248

4349
### .spec.deployment.name
4450

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>
4652

4753
Name of the ArangoDeployment Custom Resource within same namespace as ArangoBackup Custom Resource.
4854

@@ -52,7 +58,7 @@ This field is **immutable**: can't be changed after backup creation
5258

5359
### .spec.download.autoDelete
5460

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>
5662

5763
AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
5864

@@ -62,7 +68,7 @@ Default Value: `false`
6268

6369
### .spec.download.credentialsSecretName
6470

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>
6672

6773
CredentialsSecretName is the name of the secret used while accessing repository
6874

@@ -75,7 +81,7 @@ This field is **immutable**: can't be changed after backup creation
7581

7682
### .spec.download.id
7783

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>
7985

8086
ID of the ArangoBackup to be downloaded
8187

@@ -85,7 +91,7 @@ This field is **immutable**: can't be changed after backup creation
8591

8692
### .spec.download.repositoryURL
8793

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>
8995

9096
RepositoryURL is the URL path for file storage
9197
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
106112

107113
### .spec.lifetime
108114

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>
110116

111117
Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "2h45m".
112118

113119
***
114120

115121
### .spec.options.allowInconsistent
116122

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>
118124

119125
AllowInconsistent flag for Backup creation request.
120126
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
127133

128134
### .spec.options.timeout
129135

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>
131137

132138
Timeout for Backup creation request in seconds. Works only when AsyncBackupCreation feature is set to false.
133139

@@ -139,7 +145,7 @@ This field is **immutable**: can't be changed after backup creation
139145

140146
### .spec.policyName
141147

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>
143149

144150
PolicyName name of the ArangoBackupPolicy which created this Custom Resource
145151

@@ -149,7 +155,7 @@ This field is **immutable**: can't be changed after backup creation
149155

150156
### .spec.upload.autoDelete
151157

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>
153159

154160
AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
155161

@@ -159,7 +165,7 @@ Default Value: `false`
159165

160166
### .spec.upload.credentialsSecretName
161167

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>
163169

164170
CredentialsSecretName is the name of the secret used while accessing repository
165171

@@ -172,7 +178,7 @@ This field is **immutable**: can't be changed after backup creation
172178

173179
### .spec.upload.repositoryURL
174180

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>
176182

177183
RepositoryURL is the URL path for file storage
178184
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
193199

194200
### .status.available
195201

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>
197203

198204
Available Determines if we can restore from ArangoBackup
199205

200206
***
201207

202208
### .status.backoff.iterations
203209

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>
205211

206212
***
207213

208214
### .status.backup.downloaded
209215

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>
211217

212218
Downloaded Determines if ArangoBackup has been downloaded.
213219

214220
***
215221

216222
### .status.backup.id
217223

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>
219225

220226
***
221227

222228
### .status.backup.imported
223229

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>
225231

226232
***
227233

228234
### .status.backup.keys
229235

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>
231237

232238
***
233239

234240
### .status.backup.numberOfDBServers
235241

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>
237243

238244
NumberOfDBServers Cluster size of the Backup in ArangoDB
239245

240246
***
241247

242248
### .status.backup.potentiallyInconsistent
243249

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>
245251

246252
***
247253

248254
### .status.backup.sizeInBytes
249255

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>
251257

252258
SizeInBytes Size of the Backup in ArangoDB.
253259

254260
***
255261

256262
### .status.backup.uploaded
257263

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>
259265

260266
Uploaded Determines if ArangoBackup has been uploaded
261267

262268
***
263269

264270
### .status.backup.version
265271

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>
267273

268274
***
269275

270276
### .status.message
271277

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>
273279

274280
Message for the state this object is in.
275281

276282
***
277283

278284
### .status.progress.jobID
279285

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>
281287

282288
JobID ArangoDB job ID for uploading or downloading
283289

284290
***
285291

286292
### .status.progress.progress
287293

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>
289295

290296
Progress ArangoDB job progress in percents
291297

@@ -298,7 +304,7 @@ Example:
298304

299305
### .status.state
300306

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>
302308

303309
State holds the current high level state of the backup
304310

0 commit comments

Comments
 (0)