Skip to content

Commit ed9ab82

Browse files
nikita-vanyasinnikita-vanyasin
authored
Sync improvements for docs for 1.2.35 (#1478)
1 parent 06080ed commit ed9ab82

16 files changed

+890
-890
lines changed

‎docs/api/ArangoBackup.V1.md‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,33 @@
66

77
Iterations defines number of iterations before reaching MaxDelay. Default to 5
88

9-
[Code Reference](/pkg/apis/backup/v1/backup_spec_backoff.go#L31)
9+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L31)
1010

1111
### .spec.backoff.max_delay: integer
1212

1313
MaxDelay defines maximum delay in seconds. Default to 600
1414

15-
[Code Reference](/pkg/apis/backup/v1/backup_spec_backoff.go#L29)
15+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L29)
1616

1717
### .spec.backoff.max_iterations: integer
1818

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

21-
[Code Reference](/pkg/apis/backup/v1/backup_spec_backoff.go#L33)
21+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L33)
2222

2323
### .spec.backoff.min_delay: integer
2424

2525
MinDelay defines minimum delay in seconds. Default to 30
2626

27-
[Code Reference](/pkg/apis/backup/v1/backup_spec_backoff.go#L27)
27+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L27)
2828

2929
### .spec.deployment.name: string
3030

3131
Name of the ArangoDeployment Custom Resource within same namespace as ArangoBackup Custom Resource.
3232

3333
This field is **immutable**: can't be changed after backup creation
3434

35-
[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L54)
35+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L54)
3636

3737
### .spec.download.credentialsSecretName: string
3838

@@ -43,15 +43,15 @@ Links:
4343

4444
This field is **immutable**: can't be changed after backup creation
4545

46-
[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L81)
46+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L81)
4747

4848
### .spec.download.id: string
4949

5050
ID of the ArangoBackup to be downloaded
5151

5252
This field is **immutable**: can't be changed after backup creation
5353

54-
[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L89)
54+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L89)
5555

5656
### .spec.download.repositoryURL: string
5757

@@ -70,42 +70,42 @@ azure://test
7070

7171
This field is **immutable**: can't be changed after backup creation
7272

73-
[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L77)
73+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L77)
7474

7575
### .spec.lifetime: integer
7676

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

79-
[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L47)
79+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L47)
8080

8181
### .spec.options.allowInconsistent: boolean
8282

8383
AllowInconsistent flag for Backup creation request.
8484
If this value is set to true, backup is taken even if we are not able to acquire lock.
8585

86-
Default Value: false
86+
Default Value: `false`
8787

8888
This field is **immutable**: can't be changed after backup creation
8989

90-
[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L66)
90+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L66)
9191

9292
### .spec.options.timeout: number
9393

9494
Timeout for Backup creation request in seconds.
9595

96-
Default Value: 30
96+
Default Value: `30`
9797

9898
This field is **immutable**: can't be changed after backup creation
9999

100-
[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L61)
100+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L61)
101101

102102
### .spec.policyName: string
103103

104104
PolicyName name of the ArangoBackupPolicy which created this Custom Resource
105105

106106
This field is **immutable**: can't be changed after backup creation
107107

108-
[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L42)
108+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L42)
109109

110110
### .spec.upload.credentialsSecretName: string
111111

@@ -116,7 +116,7 @@ Links:
116116

117117
This field is **immutable**: can't be changed after backup creation
118118

119-
[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L81)
119+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L81)
120120

121121
### .spec.upload.repositoryURL: string
122122

@@ -135,75 +135,75 @@ azure://test
135135

136136
This field is **immutable**: can't be changed after backup creation
137137

138-
[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L77)
138+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L77)
139139

140140
## Status
141141

142142
### .status.available: boolean
143143

144144
Available Determines if we can restore from ArangoBackup
145145

146-
[Code Reference](/pkg/apis/backup/v1/backup_status.go#L36)
146+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L36)
147147

148148
### .status.backoff.iterations: integer
149149

150-
[Code Reference](/pkg/apis/backup/v1/backup_status_backoff.go#L30)
150+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status_backoff.go#L30)
151151

152152
### .status.backup.downloaded: boolean
153153

154154
Downloaded Determines if ArangoBackup has been downloaded.
155155

156-
[Code Reference](/pkg/apis/backup/v1/backup_status.go#L66)
156+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L66)
157157

158158
### .status.backup.id: string
159159

160-
[Code Reference](/pkg/apis/backup/v1/backup_status.go#L56)
160+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L56)
161161

162162
### .status.backup.imported: boolean
163163

164-
[Code Reference](/pkg/apis/backup/v1/backup_status.go#L67)
164+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L67)
165165

166166
### .status.backup.keys: array
167167

168-
[Code Reference](/pkg/apis/backup/v1/backup_status.go#L70)
168+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L70)
169169

170170
### .status.backup.numberOfDBServers: integer
171171

172172
NumberOfDBServers Cluster size of the Backup in ArangoDB
173173

174-
[Code Reference](/pkg/apis/backup/v1/backup_status.go#L62)
174+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L62)
175175

176176
### .status.backup.potentiallyInconsistent: boolean
177177

178-
[Code Reference](/pkg/apis/backup/v1/backup_status.go#L58)
178+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L58)
179179

180180
### .status.backup.sizeInBytes: integer
181181

182182
SizeInBytes Size of the Backup in ArangoDB.
183183

184-
[Code Reference](/pkg/apis/backup/v1/backup_status.go#L60)
184+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L60)
185185

186186
### .status.backup.uploaded: boolean
187187

188188
Uploaded Determines if ArangoBackup has been uploaded
189189

190-
[Code Reference](/pkg/apis/backup/v1/backup_status.go#L64)
190+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L64)
191191

192192
### .status.backup.version: string
193193

194-
[Code Reference](/pkg/apis/backup/v1/backup_status.go#L57)
194+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L57)
195195

196196
### .status.message: string
197197

198198
Message for the state this object is in.
199199

200-
[Code Reference](/pkg/apis/backup/v1/backup_state.go#L86)
200+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L86)
201201

202202
### .status.progress.jobID: string
203203

204204
JobID ArangoDB job ID for uploading or downloading
205205

206-
[Code Reference](/pkg/apis/backup/v1/backup_state.go#L109)
206+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L109)
207207

208208
### .status.progress.progress: string
209209

@@ -214,7 +214,7 @@ Example:
214214
90%
215215
```
216216

217-
[Code Reference](/pkg/apis/backup/v1/backup_state.go#L112)
217+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L112)
218218

219219
### .status.state: string
220220

@@ -235,5 +235,5 @@ Possible Values:
235235
* Failed - state for failure
236236
* Unavailable - state when Backup is not available on the ArangoDB. It can happen in case of upgrades, node restarts etc.
237237

238-
[Code Reference](/pkg/apis/backup/v1/backup_state.go#L80)
238+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L80)
239239

‎docs/api/ArangoBackupPolicy.V1.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,25 @@
66

77
AllowConcurrent if false, ArangoBackup will not be created when previous Backups are not finished
88

9-
Default Value: true
9+
Default Value: `true`
1010

11-
[Code Reference](/pkg/apis/backup/v1/backup_policy_spec.go#L35)
11+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L35)
1212

1313
### .spec.maxBackups: integer
1414

1515
MaxBackups defines how many backups should be kept in history (per deployment). Oldest healthy Backups will be deleted.
1616
If not specified or 0 then no limit is applied
1717

18-
Default Value: 0
18+
Default Value: `0`
1919

20-
[Code Reference](/pkg/apis/backup/v1/backup_policy_spec.go#L43)
20+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L43)
2121

2222
### .spec.schedule: string
2323

2424
Schedule is cron-compatible specification of backup schedule
2525
Parsed by https://godoc.org/github.com/robfig/cron
2626

27-
[Code Reference](/pkg/apis/backup/v1/backup_policy_spec.go#L32)
27+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L32)
2828

2929
### .spec.selector: meta.LabelSelector
3030

@@ -33,58 +33,58 @@ DeploymentSelector Selector definition for selecting matching ArangoBackup Custo
3333
Links:
3434
* [Kubernetes Documentation](https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#LabelSelector)
3535

36-
[Code Reference](/pkg/apis/backup/v1/backup_policy_spec.go#L39)
36+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L39)
3737

3838
### .spec.template.backoff.iterations: integer
3939

4040
Iterations defines number of iterations before reaching MaxDelay. Default to 5
4141

42-
[Code Reference](/pkg/apis/backup/v1/backup_spec_backoff.go#L31)
42+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L31)
4343

4444
### .spec.template.backoff.max_delay: integer
4545

4646
MaxDelay defines maximum delay in seconds. Default to 600
4747

48-
[Code Reference](/pkg/apis/backup/v1/backup_spec_backoff.go#L29)
48+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L29)
4949

5050
### .spec.template.backoff.max_iterations: integer
5151

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

54-
[Code Reference](/pkg/apis/backup/v1/backup_spec_backoff.go#L33)
54+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L33)
5555

5656
### .spec.template.backoff.min_delay: integer
5757

5858
MinDelay defines minimum delay in seconds. Default to 30
5959

60-
[Code Reference](/pkg/apis/backup/v1/backup_spec_backoff.go#L27)
60+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L27)
6161

6262
### .spec.template.lifetime: integer
6363

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

66-
[Code Reference](/pkg/apis/backup/v1/backup_policy_spec.go#L61)
66+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L61)
6767

6868
### .spec.template.options.allowInconsistent: boolean
6969

7070
AllowInconsistent flag for Backup creation request.
7171
If this value is set to true, backup is taken even if we are not able to acquire lock.
7272

73-
Default Value: false
73+
Default Value: `false`
7474

7575
This field is **immutable**: can't be changed after backup creation
7676

77-
[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L66)
77+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L66)
7878

7979
### .spec.template.options.timeout: number
8080

8181
Timeout for Backup creation request in seconds.
8282

83-
Default Value: 30
83+
Default Value: `30`
8484

8585
This field is **immutable**: can't be changed after backup creation
8686

87-
[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L61)
87+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L61)
8888

8989
### .spec.template.upload.credentialsSecretName: string
9090

@@ -95,7 +95,7 @@ Links:
9595

9696
This field is **immutable**: can't be changed after backup creation
9797

98-
[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L81)
98+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L81)
9999

100100
### .spec.template.upload.repositoryURL: string
101101

@@ -114,19 +114,19 @@ azure://test
114114

115115
This field is **immutable**: can't be changed after backup creation
116116

117-
[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L77)
117+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L77)
118118

119119
## Status
120120

121121
### .status.message: string
122122

123123
Message from the operator in case of failures - schedule not valid, ArangoBackupPolicy not valid
124124

125-
[Code Reference](/pkg/apis/backup/v1/backup_policy_status.go#L33)
125+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_status.go#L33)
126126

127127
### .status.scheduled: meta.Time
128128

129129
Scheduled Next scheduled time in UTC
130130

131-
[Code Reference](/pkg/apis/backup/v1/backup_policy_status.go#L31)
131+
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_status.go#L31)
132132

0 commit comments

Comments
 (0)