Skip to content

Commit 5dc9221

Browse files
authored
sync-gh-pages: docs and Helm chart 1.3.0 (#1950)
1 parent 5304f57 commit 5dc9221

33 files changed

+2092
-3635
lines changed

docs/api/ArangoBackup.V1.md

Lines changed: 16 additions & 147 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.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>
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.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>
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.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>
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.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>
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.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>
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.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>
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.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>
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.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>
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.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>
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.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>
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.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>
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.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>
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.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>
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.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>
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.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>
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.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>
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.
@@ -195,134 +195,3 @@ azure://test
195195

196196
This field is **immutable**: can't be changed after backup creation
197197

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

Comments
 (0)