Improve documentation for the TLS section of the provider connection.
This commit is contained in:
parent
e699662b1e
commit
f929346c18
3 changed files with 30 additions and 15 deletions
|
@ -206,7 +206,7 @@ The `tls` option is the TLS configuration from Traefik to the authentication ser
|
||||||
|
|
||||||
#### `tls.ca`
|
#### `tls.ca`
|
||||||
|
|
||||||
TODO add description.
|
Certificate Authority used for the secured connection to the authentication server.
|
||||||
|
|
||||||
```yaml tab="Docker"
|
```yaml tab="Docker"
|
||||||
labels:
|
labels:
|
||||||
|
@ -266,7 +266,12 @@ http:
|
||||||
|
|
||||||
#### `tls.caOptional`
|
#### `tls.caOptional`
|
||||||
|
|
||||||
TODO add description.
|
Policy used for the secured connection with TLS Client Authentication to the authentication server.
|
||||||
|
Requires `tls.ca` to be defined.
|
||||||
|
|
||||||
|
- `true`: VerifyClientCertIfGiven
|
||||||
|
- `false`: RequireAndVerifyClientCert
|
||||||
|
- if `tls.ca` is undefined NoClientCert
|
||||||
|
|
||||||
```yaml tab="Docker"
|
```yaml tab="Docker"
|
||||||
labels:
|
labels:
|
||||||
|
@ -316,7 +321,7 @@ http:
|
||||||
|
|
||||||
#### `tls.cert`
|
#### `tls.cert`
|
||||||
|
|
||||||
TODO add description.
|
Public certificate used for the secured connection to the authentication server.
|
||||||
|
|
||||||
```yaml tab="Docker"
|
```yaml tab="Docker"
|
||||||
labels:
|
labels:
|
||||||
|
@ -385,7 +390,7 @@ http:
|
||||||
|
|
||||||
#### `tls.key`
|
#### `tls.key`
|
||||||
|
|
||||||
TODO add description.
|
Private certificate used for the secure connection to the authentication server.
|
||||||
|
|
||||||
```yaml tab="Docker"
|
```yaml tab="Docker"
|
||||||
labels:
|
labels:
|
||||||
|
@ -454,7 +459,7 @@ http:
|
||||||
|
|
||||||
#### `tls.insecureSkipVerify`
|
#### `tls.insecureSkipVerify`
|
||||||
|
|
||||||
TODO add description.
|
If `insecureSkipVerify` is `true`, TLS for the connection to authentication server accepts any certificate presented by the server and any host name in that certificate.
|
||||||
|
|
||||||
```yaml tab="Docker"
|
```yaml tab="Docker"
|
||||||
labels:
|
labels:
|
||||||
|
|
|
@ -430,7 +430,7 @@ _Optional_
|
||||||
|
|
||||||
#### `tls.ca`
|
#### `tls.ca`
|
||||||
|
|
||||||
TODO add description.
|
Certificate Authority used for the secured connection to Docker.
|
||||||
|
|
||||||
```toml tab="File (TOML)"
|
```toml tab="File (TOML)"
|
||||||
[providers.docker.tls]
|
[providers.docker.tls]
|
||||||
|
@ -450,7 +450,12 @@ providers:
|
||||||
|
|
||||||
#### `tls.caOptional`
|
#### `tls.caOptional`
|
||||||
|
|
||||||
TODO add description.
|
Policy followed for the secured connection with TLS Client Authentication to Docker.
|
||||||
|
Requires `tls.ca` to be defined.
|
||||||
|
|
||||||
|
- `true`: VerifyClientCertIfGiven
|
||||||
|
- `false`: RequireAndVerifyClientCert
|
||||||
|
- if `tls.ca` is undefined NoClientCert
|
||||||
|
|
||||||
```toml tab="File (TOML)"
|
```toml tab="File (TOML)"
|
||||||
[providers.docker.tls]
|
[providers.docker.tls]
|
||||||
|
@ -470,7 +475,7 @@ providers:
|
||||||
|
|
||||||
#### `tls.cert`
|
#### `tls.cert`
|
||||||
|
|
||||||
TODO add description.
|
Public certificate used for the secured connection to Docker.
|
||||||
|
|
||||||
```toml tab="File (TOML)"
|
```toml tab="File (TOML)"
|
||||||
[providers.docker.tls]
|
[providers.docker.tls]
|
||||||
|
@ -493,7 +498,7 @@ providers:
|
||||||
|
|
||||||
#### `tls.key`
|
#### `tls.key`
|
||||||
|
|
||||||
TODO add description.
|
Private certificate used for the secured connection to Docker.
|
||||||
|
|
||||||
```toml tab="File (TOML)"
|
```toml tab="File (TOML)"
|
||||||
[providers.docker.tls]
|
[providers.docker.tls]
|
||||||
|
@ -516,7 +521,7 @@ providers:
|
||||||
|
|
||||||
#### `tls.insecureSkipVerify`
|
#### `tls.insecureSkipVerify`
|
||||||
|
|
||||||
TODO add description.
|
If `insecureSkipVerify` is `true`, TLS for the connection to Docker accepts any certificate presented by the server and any host name in that certificate.
|
||||||
|
|
||||||
```toml tab="File (TOML)"
|
```toml tab="File (TOML)"
|
||||||
[providers.docker.tls]
|
[providers.docker.tls]
|
||||||
|
|
|
@ -404,7 +404,7 @@ _Optional_
|
||||||
|
|
||||||
#### `tls.ca`
|
#### `tls.ca`
|
||||||
|
|
||||||
TODO add description.
|
Certificate Authority used for the secured connection to Marathon.
|
||||||
|
|
||||||
```toml tab="File (TOML)"
|
```toml tab="File (TOML)"
|
||||||
[providers.marathon.tls]
|
[providers.marathon.tls]
|
||||||
|
@ -424,7 +424,12 @@ providers:
|
||||||
|
|
||||||
#### `tls.caOptional`
|
#### `tls.caOptional`
|
||||||
|
|
||||||
TODO add description.
|
Policy followed for the secured connection to Marathon with TLS Client Authentication.
|
||||||
|
Requires `tls.ca` to be defined.
|
||||||
|
|
||||||
|
- `true`: VerifyClientCertIfGiven
|
||||||
|
- `false`: RequireAndVerifyClientCert
|
||||||
|
- if `tls.ca` is undefined NoClientCert
|
||||||
|
|
||||||
```toml tab="File (TOML)"
|
```toml tab="File (TOML)"
|
||||||
[providers.marathon.tls]
|
[providers.marathon.tls]
|
||||||
|
@ -444,7 +449,7 @@ providers:
|
||||||
|
|
||||||
#### `tls.cert`
|
#### `tls.cert`
|
||||||
|
|
||||||
TODO add description.
|
Public certificate used for the secured connection to Marathon.
|
||||||
|
|
||||||
```toml tab="File (TOML)"
|
```toml tab="File (TOML)"
|
||||||
[providers.marathon.tls]
|
[providers.marathon.tls]
|
||||||
|
@ -467,7 +472,7 @@ providers:
|
||||||
|
|
||||||
#### `tls.key`
|
#### `tls.key`
|
||||||
|
|
||||||
TODO add description.
|
Private certificate used for the secured connection to Marathon.
|
||||||
|
|
||||||
```toml tab="File (TOML)"
|
```toml tab="File (TOML)"
|
||||||
[providers.marathon.tls]
|
[providers.marathon.tls]
|
||||||
|
@ -490,7 +495,7 @@ providers:
|
||||||
|
|
||||||
#### `tls.insecureSkipVerify`
|
#### `tls.insecureSkipVerify`
|
||||||
|
|
||||||
TODO add description.
|
If `insecureSkipVerify` is `true`, TLS for the connection to Marathon accepts any certificate presented by the server and any host name in that certificate.
|
||||||
|
|
||||||
```toml tab="File (TOML)"
|
```toml tab="File (TOML)"
|
||||||
[providers.marathon.tls]
|
[providers.marathon.tls]
|
||||||
|
|
Loading…
Add table
Reference in a new issue