Skip to content

Commit 95d48f9

Browse files
authored
sync-gh-pages: docs and Helm chart 1.2.49 (#1914)
1 parent b9c3a58 commit 95d48f9

29 files changed

+2154
-1843
lines changed

docs/api/ArangoBackup.V1.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ title: ArangoBackup V1
1010

1111
### .spec.backoff.iterations
1212

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>
13+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_spec_backoff.go#L38)</sup>
1414

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

@@ -20,7 +20,7 @@ Default Value: `5`
2020

2121
### .spec.backoff.max_delay
2222

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>
23+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_spec_backoff.go#L35)</sup>
2424

2525
MaxDelay defines maximum delay in seconds. Default to 600
2626

@@ -30,15 +30,15 @@ Default Value: `600`
3030

3131
### .spec.backoff.max_iterations
3232

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>
33+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_spec_backoff.go#L40)</sup>
3434

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

3737
***
3838

3939
### .spec.backoff.min_delay
4040

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>
41+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_spec_backoff.go#L32)</sup>
4242

4343
MinDelay defines minimum delay in seconds. Default to 30
4444

@@ -48,7 +48,7 @@ Default Value: `30`
4848

4949
### .spec.deployment.name
5050

51-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_spec.go#L55)</sup>
51+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_spec.go#L55)</sup>
5252

5353
Name of the ArangoDeployment Custom Resource within same namespace as ArangoBackup Custom Resource.
5454

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

5959
### .spec.download.autoDelete
6060

61-
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_spec.go#L85)</sup>
61+
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_spec.go#L85)</sup>
6262

6363
AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
6464

@@ -68,7 +68,7 @@ Default Value: `false`
6868

6969
### .spec.download.credentialsSecretName
7070

71-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_spec.go#L82)</sup>
71+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_spec.go#L82)</sup>
7272

7373
CredentialsSecretName is the name of the secret used while accessing repository
7474

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

8282
### .spec.download.id
8383

84-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_spec.go#L93)</sup>
84+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_spec.go#L93)</sup>
8585

8686
ID of the ArangoBackup to be downloaded
8787

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

9292
### .spec.download.repositoryURL
9393

94-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_spec.go#L78)</sup>
94+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_spec.go#L78)</sup>
9595

9696
RepositoryURL is the URL path for file storage
9797
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
112112

113113
### .spec.lifetime
114114

115-
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_spec.go#L48)</sup>
115+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_spec.go#L48)</sup>
116116

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

119119
***
120120

121121
### .spec.options.allowInconsistent
122122

123-
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_spec.go#L67)</sup>
123+
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_spec.go#L67)</sup>
124124

125125
AllowInconsistent flag for Backup creation request.
126126
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
133133

134134
### .spec.options.timeout
135135

136-
Type: `number` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_spec.go#L62)</sup>
136+
Type: `number` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_spec.go#L62)</sup>
137137

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

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

146146
### .spec.policyName
147147

148-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_spec.go#L42)</sup>
148+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_spec.go#L42)</sup>
149149

150150
PolicyName name of the ArangoBackupPolicy which created this Custom Resource
151151

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

156156
### .spec.upload.autoDelete
157157

158-
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_spec.go#L85)</sup>
158+
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_spec.go#L85)</sup>
159159

160160
AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
161161

@@ -165,7 +165,7 @@ Default Value: `false`
165165

166166
### .spec.upload.credentialsSecretName
167167

168-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_spec.go#L82)</sup>
168+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_spec.go#L82)</sup>
169169

170170
CredentialsSecretName is the name of the secret used while accessing repository
171171

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

179179
### .spec.upload.repositoryURL
180180

181-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_spec.go#L78)</sup>
181+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_spec.go#L78)</sup>
182182

183183
RepositoryURL is the URL path for file storage
184184
Same repositoryURL needs to be defined in `credentialsSecretName` if protocol is other than local.
@@ -199,99 +199,99 @@ This field is **immutable**: can't be changed after backup creation
199199

200200
### .status.available
201201

202-
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_status.go#L36)</sup>
202+
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_status.go#L36)</sup>
203203

204204
Available Determines if we can restore from ArangoBackup
205205

206206
***
207207

208208
### .status.backoff.iterations
209209

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>
210+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_status_backoff.go#L30)</sup>
211211

212212
***
213213

214214
### .status.backup.downloaded
215215

216-
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_status.go#L66)</sup>
216+
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_status.go#L66)</sup>
217217

218218
Downloaded Determines if ArangoBackup has been downloaded.
219219

220220
***
221221

222222
### .status.backup.id
223223

224-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_status.go#L56)</sup>
224+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_status.go#L56)</sup>
225225

226226
***
227227

228228
### .status.backup.imported
229229

230-
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_status.go#L67)</sup>
230+
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_status.go#L67)</sup>
231231

232232
***
233233

234234
### .status.backup.keys
235235

236-
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_status.go#L70)</sup>
236+
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_status.go#L70)</sup>
237237

238238
***
239239

240240
### .status.backup.numberOfDBServers
241241

242-
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_status.go#L62)</sup>
242+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_status.go#L62)</sup>
243243

244244
NumberOfDBServers Cluster size of the Backup in ArangoDB
245245

246246
***
247247

248248
### .status.backup.potentiallyInconsistent
249249

250-
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_status.go#L58)</sup>
250+
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_status.go#L58)</sup>
251251

252252
***
253253

254254
### .status.backup.sizeInBytes
255255

256-
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_status.go#L60)</sup>
256+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_status.go#L60)</sup>
257257

258258
SizeInBytes Size of the Backup in ArangoDB.
259259

260260
***
261261

262262
### .status.backup.uploaded
263263

264-
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_status.go#L64)</sup>
264+
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_status.go#L64)</sup>
265265

266266
Uploaded Determines if ArangoBackup has been uploaded
267267

268268
***
269269

270270
### .status.backup.version
271271

272-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_status.go#L57)</sup>
272+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_status.go#L57)</sup>
273273

274274
***
275275

276276
### .status.message
277277

278-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_state.go#L91)</sup>
278+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_state.go#L91)</sup>
279279

280280
Message for the state this object is in.
281281

282282
***
283283

284284
### .status.progress.jobID
285285

286-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_state.go#L114)</sup>
286+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_state.go#L114)</sup>
287287

288288
JobID ArangoDB job ID for uploading or downloading
289289

290290
***
291291

292292
### .status.progress.progress
293293

294-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_state.go#L117)</sup>
294+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_state.go#L117)</sup>
295295

296296
Progress ArangoDB job progress in percents
297297

@@ -304,7 +304,7 @@ Example:
304304

305305
### .status.state
306306

307-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.48/pkg/apis/backup/v1/backup_state.go#L85)</sup>
307+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.49/pkg/apis/backup/v1/backup_state.go#L85)</sup>
308308

309309
State holds the current high level state of the backup
310310

0 commit comments

Comments
 (0)