Skip to content

Commit a5b46cf

Browse files
authored
sync-gh-pages: docs and Helm chart 1.3.1 (#1971)
1 parent 5dc9221 commit a5b46cf

File tree

72 files changed

+1989
-1800
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+1989
-1800
lines changed

docs/api/ArangoBackup.V1.md

Lines changed: 16 additions & 16 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.3.0/pkg/apis/backup/v1/backup_spec_backoff.go#L38)</sup>
13+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/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.3.0/pkg/apis/backup/v1/backup_spec_backoff.go#L35)</sup>
23+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/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.3.0/pkg/apis/backup/v1/backup_spec_backoff.go#L40)</sup>
33+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/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.3.0/pkg/apis/backup/v1/backup_spec_backoff.go#L32)</sup>
41+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/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.3.0/pkg/apis/backup/v1/backup_spec.go#L55)</sup>
51+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/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.3.0/pkg/apis/backup/v1/backup_spec.go#L85)</sup>
61+
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/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.3.0/pkg/apis/backup/v1/backup_spec.go#L82)</sup>
71+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/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.3.0/pkg/apis/backup/v1/backup_spec.go#L93)</sup>
84+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/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.3.0/pkg/apis/backup/v1/backup_spec.go#L78)</sup>
94+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/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.3.0/pkg/apis/backup/v1/backup_spec.go#L48)</sup>
115+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/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.3.0/pkg/apis/backup/v1/backup_spec.go#L67)</sup>
123+
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/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.3.0/pkg/apis/backup/v1/backup_spec.go#L62)</sup>
136+
Type: `number` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/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.3.0/pkg/apis/backup/v1/backup_spec.go#L42)</sup>
148+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/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.3.0/pkg/apis/backup/v1/backup_spec.go#L85)</sup>
158+
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/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.3.0/pkg/apis/backup/v1/backup_spec.go#L82)</sup>
168+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/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.3.0/pkg/apis/backup/v1/backup_spec.go#L78)</sup>
181+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/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.

docs/api/ArangoBackupPolicy.V1.md

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

1111
### .spec.allowConcurrent
1212

13-
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.0/pkg/apis/backup/v1/backup_policy_spec.go#L35)</sup>
13+
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/apis/backup/v1/backup_policy_spec.go#L35)</sup>
1414

1515
AllowConcurrent if false, ArangoBackup will not be created when previous Backups are not finished
1616

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

2121
### .spec.maxBackups
2222

23-
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.0/pkg/apis/backup/v1/backup_policy_spec.go#L43)</sup>
23+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/apis/backup/v1/backup_policy_spec.go#L43)</sup>
2424

2525
MaxBackups defines how many backups should be kept in history (per deployment). Oldest healthy Backups will be deleted.
2626
If not specified or 0 then no limit is applied
@@ -31,7 +31,7 @@ Default Value: `0`
3131

3232
### .spec.schedule
3333

34-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.0/pkg/apis/backup/v1/backup_policy_spec.go#L32)</sup>
34+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/apis/backup/v1/backup_policy_spec.go#L32)</sup>
3535

3636
Schedule is cron-compatible specification of backup schedule
3737
Parsed by https://godoc.org/github.com/robfig/cron
@@ -40,7 +40,7 @@ Parsed by https://godoc.org/github.com/robfig/cron
4040

4141
### .spec.selector
4242

43-
Type: `meta.LabelSelector` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.0/pkg/apis/backup/v1/backup_policy_spec.go#L39)</sup>
43+
Type: `meta.LabelSelector` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/apis/backup/v1/backup_policy_spec.go#L39)</sup>
4444

4545
DeploymentSelector Selector definition for selecting matching ArangoDeployment Custom Resources.
4646

@@ -51,7 +51,7 @@ Links:
5151

5252
### .spec.template.backoff.iterations
5353

54-
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.0/pkg/apis/backup/v1/backup_spec_backoff.go#L38)</sup>
54+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/apis/backup/v1/backup_spec_backoff.go#L38)</sup>
5555

5656
Iterations defines number of iterations before reaching MaxDelay. Default to 5
5757

@@ -61,7 +61,7 @@ Default Value: `5`
6161

6262
### .spec.template.backoff.max_delay
6363

64-
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.0/pkg/apis/backup/v1/backup_spec_backoff.go#L35)</sup>
64+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/apis/backup/v1/backup_spec_backoff.go#L35)</sup>
6565

6666
MaxDelay defines maximum delay in seconds. Default to 600
6767

@@ -71,15 +71,15 @@ Default Value: `600`
7171

7272
### .spec.template.backoff.max_iterations
7373

74-
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.0/pkg/apis/backup/v1/backup_spec_backoff.go#L40)</sup>
74+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/apis/backup/v1/backup_spec_backoff.go#L40)</sup>
7575

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

7878
***
7979

8080
### .spec.template.backoff.min_delay
8181

82-
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.0/pkg/apis/backup/v1/backup_spec_backoff.go#L32)</sup>
82+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/apis/backup/v1/backup_spec_backoff.go#L32)</sup>
8383

8484
MinDelay defines minimum delay in seconds. Default to 30
8585

@@ -89,15 +89,15 @@ Default Value: `30`
8989

9090
### .spec.template.lifetime
9191

92-
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.0/pkg/apis/backup/v1/backup_policy_spec.go#L61)</sup>
92+
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/apis/backup/v1/backup_policy_spec.go#L61)</sup>
9393

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

9696
***
9797

9898
### .spec.template.options.allowInconsistent
9999

100-
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.0/pkg/apis/backup/v1/backup_spec.go#L67)</sup>
100+
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/apis/backup/v1/backup_spec.go#L67)</sup>
101101

102102
AllowInconsistent flag for Backup creation request.
103103
If this value is set to true, backup is taken even if we are not able to acquire lock.
@@ -110,7 +110,7 @@ This field is **immutable**: can't be changed after backup creation
110110

111111
### .spec.template.options.timeout
112112

113-
Type: `number` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.0/pkg/apis/backup/v1/backup_spec.go#L62)</sup>
113+
Type: `number` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/apis/backup/v1/backup_spec.go#L62)</sup>
114114

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

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

123123
### .spec.template.upload.autoDelete
124124

125-
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.0/pkg/apis/backup/v1/backup_spec.go#L85)</sup>
125+
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/apis/backup/v1/backup_spec.go#L85)</sup>
126126

127127
AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
128128

@@ -132,7 +132,7 @@ Default Value: `false`
132132

133133
### .spec.template.upload.credentialsSecretName
134134

135-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.0/pkg/apis/backup/v1/backup_spec.go#L82)</sup>
135+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/apis/backup/v1/backup_spec.go#L82)</sup>
136136

137137
CredentialsSecretName is the name of the secret used while accessing repository
138138

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

146146
### .spec.template.upload.repositoryURL
147147

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

150150
RepositoryURL is the URL path for file storage
151151
Same repositoryURL needs to be defined in `credentialsSecretName` if protocol is other than local.

0 commit comments

Comments
 (0)