Skip to content

Commit 66485e8

Browse files
kachkaevtraefiker
authored andcommitted
Normalize parameter names in configs
1 parent e74e7cf commit 66485e8

Some content is hidden

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

43 files changed

+123
-123
lines changed

docs/basics.md

+24-24
Original file line numberDiff line numberDiff line change
@@ -645,18 +645,18 @@ Once a day (the first call begins 10 minutes after the start of Træfik), we col
645645
swarmMode = true
646646

647647
[Docker.TLS]
648-
CA = "dockerCA"
649-
Cert = "dockerCert"
650-
Key = "dockerKey"
651-
InsecureSkipVerify = true
648+
ca = "dockerCA"
649+
cert = "dockerCert"
650+
key = "dockerKey"
651+
insecureSkipVerify = true
652652

653653
[ECS]
654-
Domain = "foo.bar"
655-
ExposedByDefault = true
656-
Clusters = ["foo-bar"]
657-
Region = "us-west-2"
658-
AccessKeyID = "AccessKeyID"
659-
SecretAccessKey = "SecretAccessKey"
654+
domain = "foo.bar"
655+
exposedByDefault = true
656+
clusters = ["foo-bar"]
657+
region = "us-west-2"
658+
accessKeyID = "AccessKeyID"
659+
secretAccessKey = "SecretAccessKey"
660660
```
661661

662662
- Obfuscated and anonymous configuration:
@@ -669,24 +669,24 @@ Once a day (the first call begins 10 minutes after the start of Træfik), we col
669669
[api]
670670

671671
[Docker]
672-
Endpoint = "xxxx"
673-
Domain = "xxxx"
674-
ExposedByDefault = true
675-
SwarmMode = true
672+
endpoint = "xxxx"
673+
domain = "xxxx"
674+
exposedByDefault = true
675+
swarmMode = true
676676

677677
[Docker.TLS]
678-
CA = "xxxx"
679-
Cert = "xxxx"
680-
Key = "xxxx"
681-
InsecureSkipVerify = false
678+
ca = "xxxx"
679+
cert = "xxxx"
680+
key = "xxxx"
681+
insecureSkipVerify = false
682682

683683
[ECS]
684-
Domain = "xxxx"
685-
ExposedByDefault = true
686-
Clusters = []
687-
Region = "us-west-2"
688-
AccessKeyID = "xxxx"
689-
SecretAccessKey = "xxxx"
684+
domain = "xxxx"
685+
exposedByDefault = true
686+
clusters = []
687+
region = "us-west-2"
688+
accessKeyID = "xxxx"
689+
secretAccessKey = "xxxx"
690690
```
691691

692692
### Show me the code !

docs/benchmarks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ server {
118118
Here is the `traefik.toml` file used:
119119

120120
```toml
121-
MaxIdleConnsPerHost = 100000
121+
maxIdleConnsPerHost = 100000
122122
defaultEntryPoints = ["http"]
123123

124124
[entryPoints]

docs/configuration/backends/boltdb.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ filename = "boltdb.tmpl"
5353
# ca = "/etc/ssl/ca.crt"
5454
# cert = "/etc/ssl/boltdb.crt"
5555
# key = "/etc/ssl/boltdb.key"
56-
# insecureskipverify = true
56+
# insecureSkipVerify = true
5757
```
5858

5959
To enable constraints see [backend-specific constraints section](/configuration/commons/#backend-specific).

docs/configuration/backends/consul.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ prefix = "traefik"
5353
# ca = "/etc/ssl/ca.crt"
5454
# cert = "/etc/ssl/consul.crt"
5555
# key = "/etc/ssl/consul.key"
56-
# insecureskipverify = true
56+
# insecureSkipVerify = true
5757
```
5858

5959
To enable constraints see [backend-specific constraints section](/configuration/commons/#backend-specific).

docs/configuration/backends/consulcatalog.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ prefix = "traefik"
5757
# ca = "/etc/ssl/ca.crt"
5858
# cert = "/etc/ssl/consul.crt"
5959
# key = "/etc/ssl/consul.key"
60-
# insecureskipverify = true
60+
# insecureSkipVerify = true
6161

6262
# Override default configuration template.
6363
# For advanced users :)

docs/configuration/backends/docker.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ watch = true
5454
# Optional
5555
# Default: true
5656
#
57-
exposedbydefault = true
57+
exposedByDefault = true
5858

5959
# Use the IP address from the binded port instead of the inner network one.
6060
# For specific use-case :)
@@ -69,7 +69,7 @@ usebindportip = true
6969
# Optional
7070
# Default: false
7171
#
72-
swarmmode = false
72+
swarmMode = false
7373

7474
# Enable docker TLS connection.
7575
#
@@ -79,7 +79,7 @@ swarmmode = false
7979
# ca = "/etc/ssl/ca.crt"
8080
# cert = "/etc/ssl/docker.crt"
8181
# key = "/etc/ssl/docker.key"
82-
# insecureskipverify = true
82+
# insecureSkipVerify = true
8383
```
8484

8585
To enable constraints see [backend-specific constraints section](/configuration/commons/#backend-specific).
@@ -89,7 +89,7 @@ To enable constraints see [backend-specific constraints section](/configuration/
8989

9090
```toml
9191
################################################################
92-
# Docker Swarmmode configuration backend
92+
# Docker Swarm Mode configuration backend
9393
################################################################
9494

9595
# Enable Docker configuration backend.
@@ -123,7 +123,7 @@ watch = true
123123
# Optional
124124
# Default: false
125125
#
126-
swarmmode = true
126+
swarmMode = true
127127

128128
# Override default configuration template.
129129
# For advanced users :)
@@ -146,7 +146,7 @@ swarmmode = true
146146
# Optional
147147
# Default: true
148148
#
149-
exposedbydefault = false
149+
exposedByDefault = false
150150

151151
# Enable docker TLS connection.
152152
#
@@ -156,7 +156,7 @@ exposedbydefault = false
156156
# ca = "/etc/ssl/ca.crt"
157157
# cert = "/etc/ssl/docker.crt"
158158
# key = "/etc/ssl/docker.key"
159-
# insecureskipverify = true
159+
# insecureSkipVerify = true
160160
```
161161

162162
To enable constraints see [backend-specific constraints section](/configuration/commons/#backend-specific).

docs/configuration/backends/dynamodb.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ watch = true
3939
#
4040
refreshSeconds = 15
4141

42-
# AccessKeyID to use when connecting to AWS.
42+
# Access Key ID to use when connecting to AWS.
4343
#
4444
# Optional
4545
#
4646
accessKeyID = "abc"
4747

48-
# SecretAccessKey to use when connecting to AWS.
48+
# Secret Access Key to use when connecting to AWS.
4949
#
5050
# Optional
5151
#

docs/configuration/backends/ecs.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,13 @@ exposedByDefault = false
6666
#
6767
region = "us-east-1"
6868

69-
# AccessKeyID to use when connecting to AWS.
69+
# Access Key ID to use when connecting to AWS.
7070
#
7171
# Optional
7272
#
7373
accessKeyID = "abc"
7474

75-
# SecretAccessKey to use when connecting to AWS.
75+
# Secret Access Key to use when connecting to AWS.
7676
#
7777
# Optional
7878
#
@@ -95,7 +95,7 @@ secretAccessKey = "123"
9595
# templateVersion = "2"
9696
```
9797

98-
If `AccessKeyID`/`SecretAccessKey` is not given credentials will be resolved in the following order:
98+
If `accessKeyID`/`secretAccessKey` is not given credentials will be resolved in the following order:
9999

100100
- From environment variables; `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and `AWS_SESSION_TOKEN`.
101101
- Shared credentials, determined by `AWS_PROFILE` and `AWS_SHARED_CREDENTIALS_FILE`, defaults to `default` and `~/.aws/credentials`.

docs/configuration/backends/etcd.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ useAPIV3 = true
6363
# ca = "/etc/ssl/ca.crt"
6464
# cert = "/etc/ssl/etcd.crt"
6565
# key = "/etc/ssl/etcd.key"
66-
# insecureskipverify = true
66+
# insecureSkipVerify = true
6767
```
6868

6969
To enable constraints see [backend-specific constraints section](/configuration/commons/#backend-specific).

docs/configuration/backends/kubernetes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ If the service port defined in the ingress spec is 443, then the backend communi
114114
!!! note
115115
Please note that by enabling TLS communication between traefik and your pods, you will have to have trusted certificates that have the proper trust chain and IP subject name.
116116
If this is not an option, you may need to skip TLS certificate verification.
117-
See the [InsecureSkipVerify](/configuration/commons/#main-section) setting for more details.
117+
See the [insecureSkipVerify](/configuration/commons/#main-section) setting for more details.
118118

119119
## Annotations
120120

docs/configuration/backends/marathon.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ domain = "marathon.localhost"
103103
# CA = "/etc/ssl/ca.crt"
104104
# Cert = "/etc/ssl/marathon.cert"
105105
# Key = "/etc/ssl/marathon.key"
106-
# InsecureSkipVerify = true
106+
# insecureSkipVerify = true
107107

108108
# DCOSToken for DCOS environment.
109109
# This will override the Authorization header.

docs/configuration/backends/mesos.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -62,34 +62,34 @@ domain = "mesos.localhost"
6262
# Optional
6363
#
6464
# [mesos.TLS]
65-
# InsecureSkipVerify = true
65+
# insecureSkipVerify = true
6666

6767
# Zookeeper timeout (in seconds).
6868
#
6969
# Optional
7070
# Default: 30
7171
#
72-
# ZkDetectionTimeout = 30
72+
# zkDetectionTimeout = 30
7373

7474
# Polling interval (in seconds).
7575
#
7676
# Optional
7777
# Default: 30
7878
#
79-
# RefreshSeconds = 30
79+
# refreshSeconds = 30
8080

8181
# IP sources (e.g. host, docker, mesos, netinfo).
8282
#
8383
# Optional
8484
#
85-
# IPSources = "host"
85+
# ipSources = "host"
8686

8787
# HTTP Timeout (in seconds).
8888
#
8989
# Optional
9090
# Default: 30
9191
#
92-
# StateTimeoutSecond = "30"
92+
# stateTimeoutSecond = "30"
9393

9494
# Convert groups to subdomains.
9595
# Default behavior: /foo/bar/myapp => foo-bar-myapp.{defaultDomain}

docs/configuration/backends/rancher.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ To enable constraints see [backend-specific constraints section](/configuration/
7777
#
7878
[rancher.metadata]
7979

80-
# Poll the Rancher metadata service for changes every `rancher.RefreshSeconds`.
80+
# Poll the Rancher metadata service for changes every `rancher.refreshSeconds`.
8181
# NOTE: this is less accurate than the default long polling technique which
8282
# will provide near instantaneous updates to Traefik
8383
#

docs/configuration/backends/servicefabric.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ refreshSeconds = 10
4242
# ca = "/etc/ssl/ca.crt"
4343
# cert = "/etc/ssl/servicefabric.crt"
4444
# key = "/etc/ssl/servicefabric.key"
45-
# insecureskipverify = true
45+
# insecureSkipVerify = true
4646
```
4747

4848
## Labels

docs/configuration/backends/zookeeper.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ prefix = "traefik"
5353
# ca = "/etc/ssl/ca.crt"
5454
# cert = "/etc/ssl/zookeeper.crt"
5555
# key = "/etc/ssl/zookeeper.key"
56-
# insecureskipverify = true
56+
# insecureSkipVerify = true
5757
```
5858

5959
To enable constraints see [backend-specific constraints section](/configuration/commons/#backend-specific).

docs/configuration/commons.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -38,29 +38,29 @@
3838
# Optional
3939
# Default: "2s"
4040
#
41-
# ProvidersThrottleDuration = "2s"
41+
# providersThrottleDuration = "2s"
4242

4343
# Controls the maximum idle (keep-alive) connections to keep per-host.
4444
#
4545
# Optional
4646
# Default: 200
4747
#
48-
# MaxIdleConnsPerHost = 200
48+
# maxIdleConnsPerHost = 200
4949

5050
# If set to true invalid SSL certificates are accepted for backends.
5151
# This disables detection of man-in-the-middle attacks so should only be used on secure backend networks.
5252
#
5353
# Optional
5454
# Default: false
5555
#
56-
# InsecureSkipVerify = true
56+
# insecureSkipVerify = true
5757

58-
# Register Certificates in the RootCA.
58+
# Register Certificates in the rootCA.
5959
#
6060
# Optional
6161
# Default: []
6262
#
63-
# RootCAs = [ "/mycert.cert" ]
63+
# rootCAs = [ "/mycert.cert" ]
6464

6565
# Entrypoints to be used by frontends that do not specify any entrypoint.
6666
# Each frontend can specify its own entrypoints.
@@ -76,19 +76,19 @@ Can be provided in a format supported by [time.ParseDuration](https://golang.org
7676
If no units are provided, the value is parsed assuming seconds.
7777
**Note:** in this time frame no new requests are accepted.
7878

79-
- `ProvidersThrottleDuration`: Backends throttle duration: minimum duration in seconds between 2 events from providers before applying a new configuration.
79+
- `providersThrottleDuration`: Backends throttle duration: minimum duration in seconds between 2 events from providers before applying a new configuration.
8080
It avoids unnecessary reloads if multiples events are sent in a short amount of time.
8181
Can be provided in a format supported by [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) or as raw values (digits).
8282
If no units are provided, the value is parsed assuming seconds.
8383

84-
- `MaxIdleConnsPerHost`: Controls the maximum idle (keep-alive) connections to keep per-host.
84+
- `maxIdleConnsPerHost`: Controls the maximum idle (keep-alive) connections to keep per-host.
8585
If zero, `DefaultMaxIdleConnsPerHost` from the Go standard library net/http module is used.
8686
If you encounter 'too many open files' errors, you can either increase this value or change the `ulimit`.
8787

88-
- `InsecureSkipVerify` : If set to true invalid SSL certificates are accepted for backends.
88+
- `insecureSkipVerify` : If set to true invalid SSL certificates are accepted for backends.
8989
**Note:** This disables detection of man-in-the-middle attacks so should only be used on secure backend networks.
9090

91-
- `RootCAs`: Register Certificates in the RootCA. This certificates will be use for backends calls.
91+
- `rootCAs`: Register Certificates in the RootCA. This certificates will be use for backends calls.
9292
**Note** You can use file path or cert content directly
9393

9494
- `defaultEntryPoints`: Entrypoints to be used by frontends that do not specify any entrypoint.
@@ -386,24 +386,24 @@ If no units are provided, the value is parsed assuming seconds.
386386

387387
### Idle Timeout (deprecated)
388388

389-
Use [respondingTimeouts](/configuration/commons/#responding-timeouts) instead of `IdleTimeout`.
389+
Use [respondingTimeouts](/configuration/commons/#responding-timeouts) instead of `idleTimeout`.
390390
In the case both settings are configured, the deprecated option will be overwritten.
391391

392-
`IdleTimeout` is the maximum amount of time an idle (keep-alive) connection will remain idle before closing itself.
392+
`idleTimeout` is the maximum amount of time an idle (keep-alive) connection will remain idle before closing itself.
393393
This is set to enforce closing of stale client connections.
394394

395395
Can be provided in a format supported by [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) or as raw values (digits).
396396
If no units are provided, the value is parsed assuming seconds.
397397

398398
```toml
399-
# IdleTimeout
399+
# idleTimeout
400400
#
401401
# DEPRECATED - see [respondingTimeouts] section.
402402
#
403403
# Optional
404404
# Default: "180s"
405405
#
406-
IdleTimeout = "360s"
406+
idleTimeout = "360s"
407407
```
408408

409409

0 commit comments

Comments
 (0)