mirror of https://github.com/status-im/consul.git
docs: Add ingress TLS cipher and version documentation (#12163)
Document the new TLS cipher and version parameters that were added to ingress gateways in #11576. Co-authored-by: Mike Morris <mikemorris@users.noreply.github.com>
This commit is contained in:
Blake Covarrubias
GitHub
parent
b199b60ded
commit
a3ad4be429
|
|
@ -979,6 +979,36 @@ You can specify the following parameters to configure ingress gateway configurat
|
|||
"Set this configuration to `true` to enable built-in TLS for every listener on the gateway.<br><br>If TLS is enabled, then each host defined in each service's `hosts` fields will be added as a DNSSAN to the gateway's x509 certificate.",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'TLSMinVersion',
|
||||
type: 'string: ""',
|
||||
description: "Set the default minimum TLS version supported for the gateway's listeners. One of `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, or `TLSv1_3`. If unspecified, Envoy v1.22.0 and newer [will default to TLS 1.2 as a min version](https://github.com/envoyproxy/envoy/pull/19330), while older releases of Envoy default to TLS 1.0.",
|
||||
},
|
||||
{
|
||||
name: 'TLSMaxVersion',
|
||||
type: 'string: ""',
|
||||
description: {
|
||||
hcl:
|
||||
"Set the default maximum TLS version supported for the gateway's listeners. Must be greater than or equal to `TLSMinVersion`. One of `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, or `TLSv1_3`." ,
|
||||
yaml:
|
||||
"Set the default maximum TLS version supported for the gateway's listeners. Must be greater than or equal to `tls_min_version`. One of `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, or `TLSv1_3`." ,
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'CipherSuites',
|
||||
type: 'array<string>: <optional>',
|
||||
description: `Set the default list of TLS cipher suites for the gateway's
|
||||
listeners to support when negotiating connections using
|
||||
TLS 1.2 or earlier. If unspecified, Envoy will use a
|
||||
[default server cipher list](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/transport_sockets/tls/v3/common.proto#envoy-v3-api-field-extensions-transport-sockets-tls-v3-tlsparameters-cipher-suites).
|
||||
The list of supported cipher suites can seen in
|
||||
[\`consul/types/tls.go\`](https://github.com/hashicorp/consul/blob/v1.11.2/types/tls.go#L154-L169)
|
||||
and is dependent on underlying support in Envoy. Future
|
||||
releases of Envoy may remove currently-supported but
|
||||
insecure cipher suites, and future releases of Consul
|
||||
may add new supported cipher suites if any are added to
|
||||
Envoy.`
|
||||
},
|
||||
{
|
||||
name: 'SDS',
|
||||
yaml: false,
|
||||
|
|
@ -1133,11 +1163,40 @@ You can specify the following parameters to configure ingress gateway configurat
|
|||
type: 'bool: false',
|
||||
description: {
|
||||
hcl:
|
||||
"Set this configuration to `true` to enable built-in TLS for this listener.<br><br>If TLS is enabled, then each host defined in each service's `Hosts` field will be added as a DNSSAN to the gateway's x509 certificate. Note that even hosts from other listeners with TLS disabled will be added.",
|
||||
"Set this configuration to `true` to enable built-in TLS for this listener.<br><br>If TLS is enabled, then each host defined in each service's `Hosts` field will be added as a DNSSAN to the gateway's x509 certificate. Note that even hosts from other listeners with TLS disabled will be added. TLS can not be disabled for individual listeners if it is enabled on the gateway.",
|
||||
yaml:
|
||||
"Set this configuration to `true` to enable built-in TLS for this listener.<br><br>If TLS is enabled, then each host defined in the `hosts` field will be added as a DNSSAN to the gateway's x509 certificate. Note that even hosts from other listeners with TLS disabled will be added.",
|
||||
"Set this configuration to `true` to enable built-in TLS for this listener.<br><br>If TLS is enabled, then each host defined in the `hosts` field will be added as a DNSSAN to the gateway's x509 certificate. Note that even hosts from other listeners with TLS disabled will be added. TLS can not be disabled for individual listeners if it is enabled on the gateway.",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'TLSMinVersion',
|
||||
type: 'string: ""',
|
||||
description: "Set the minimum TLS version supported for this listener. One of `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, or `TLSv1_3`. If unspecified, Envoy v1.22.0 and newer [will default to TLS 1.2 as a min version](https://github.com/envoyproxy/envoy/pull/19330), while older releases of Envoy default to TLS 1.0.",
|
||||
},
|
||||
{
|
||||
name: 'TLSMaxVersion',
|
||||
type: 'string: ""',
|
||||
description: {
|
||||
hcl:
|
||||
"Set the maximum TLS version supported for this listener. Must be greater than or equal to `TLSMinVersion`. One of `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, or `TLSv1_3`." ,
|
||||
yaml:
|
||||
"Set the maximum TLS version supported for this listener. Must be greater than or equal to `tls_min_version`. One of `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, or `TLSv1_3`." ,
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'CipherSuites',
|
||||
type: 'array<string>: <optional>',
|
||||
description: `Set the list of TLS cipher suites to support when negotiating
|
||||
connections using TLS 1.2 or earlier. If unspecified,
|
||||
Envoy will use a
|
||||
[default server cipher list](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/transport_sockets/tls/v3/common.proto#envoy-v3-api-field-extensions-transport-sockets-tls-v3-tlsparameters-cipher-suites).
|
||||
The list of supported cipher suites can seen in
|
||||
[\`consul/types/tls.go\`](https://github.com/hashicorp/consul/blob/v1.11.2/types/tls.go#L154-L169)
|
||||
and is dependent on underlying support in Envoy. Future
|
||||
releases of Envoy may remove currently-supported but
|
||||
insecure cipher suites, and future releases of Consul
|
||||
may add new supported cipher suites if any are added to Envoy.`
|
||||
},
|
||||
{
|
||||
name: 'SDS',
|
||||
type: 'SDSConfig: <optional>',
|
||||
|
|
|
|||
Loading…
Reference in New Issue