docs: Remove note on ingress gateway hosts field needing a port number #11042
Conversation
Update the ingress gateway documentation to remove the note stating that a port must be specified for values in the `hosts` field when the ingress gateway is listening on a non-standard HTTP port. Specifying a port was required in Consul 1.8.0, but that requirement was removed in 1.8.1 with hashicorp/consul#8190 which made Consul include the port number when constructing the Envoy configuration. Related Consul docs PR: hashicorp/consul#10827
There was a problem hiding this comment.
Hi @blake and thanks for raising this PR. I wonder whether it's worth keeping the note, albeit modified to detail the version of Consul it relates to? My thought being that someone running Consul 1.8.0 could hit this and find it hard to find the appropriate information.
I initially opted to just remove the callout to specify a port was only required for the 1.8.0 release. There have been a number of bug and security fixes (to address CVEs) in the more recent 1.8.x releases (the latest stable is 1.8.14) which I assume would be enough to encourage operators to use/upgrade to a newer version that does not have this requirement. I can modify the PR to keep this callout and add the affected version info if you really feel it's necessary. |
|
I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions. |
Update the ingress gateway documentation to remove the note stating that a port must be specified for values in the
hostsfield when the ingress gateway is listening on a non-standard HTTP port.Specifying a port was required in Consul 1.8.0, but that requirement was removed in 1.8.1 with hashicorp/consul#8190 which made Consul include the port number when constructing the Envoy configuration.
Related Consul docs PR: hashicorp/consul#10827