docs: update warning for gateway listener docs for non-tcp protos

This commit is contained in:
dgotlieb 2022-06-06 17:53:01 +03:00 committed by GitHub
parent af4f976516
commit 116d78a89c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions

View File

@ -119,9 +119,9 @@ envoy_gateway_bind_addresses "<service>" {
- `protocol` `(string: "tcp")` - The protocol associated with the listener. One
of `tcp`, `http`, `http2`, or `grpc`.
~> **Note:** If using `http`, preconfiguring a [service-default] in Consul to
~> **Note:** If using any protocol other than `tcp` (for example: `http` or `grpc`), preconfiguring a [service-default] in Consul to
set the [Protocol](https://www.consul.io/docs/agent/config-entries/service-defaults#protocol)
of the service to `http` is recommended.
of the service to the desired protocol is mandatory due to an [open issue](https://github.com/hashicorp/nomad/issues/8647).
- `service` <code>(array<[service]>: required)</code> - One or more services to be
exposed via this listener. For `tcp` listeners, only a single service is allowed.