From 5bfce06c42ff82eb8e3ffff039616b28ce1bb764 Mon Sep 17 00:00:00 2001 From: dgotlieb Date: Thu, 24 Mar 2022 11:26:25 +0200 Subject: [PATCH 1/5] Add grpc and http2 listeners to gateway docs Stating at Nomad version 1.2.0 `grpc` and `http2` [protocols are supported](https://github.com/hashicorp/nomad/pull/11187): --- website/content/docs/job-specification/gateway.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/website/content/docs/job-specification/gateway.mdx b/website/content/docs/job-specification/gateway.mdx index 50641bbd6bde..6d45e556699b 100644 --- a/website/content/docs/job-specification/gateway.mdx +++ b/website/content/docs/job-specification/gateway.mdx @@ -101,8 +101,9 @@ envoy_gateway_bind_addresses "" { #### `listener` Parameters - `port` `(int: required)` - The port that the listener should receive traffic on. -- `protocol` `(string: "tcp")` - The protocol associated with the listener. Either - `tcp` or `http`. +- `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 set the [Protocol](https://www.consul.io/docs/agent/config-entries/service-defaults#protocol) From 2f074214a8fd0e60530e4ecbb15ca2844e061bde Mon Sep 17 00:00:00 2001 From: dgotlieb Date: Thu, 24 Mar 2022 11:29:58 +0200 Subject: [PATCH 2/5] Update gateway.mdx --- website/content/docs/job-specification/gateway.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/job-specification/gateway.mdx b/website/content/docs/job-specification/gateway.mdx index 6d45e556699b..1a69a53826d8 100644 --- a/website/content/docs/job-specification/gateway.mdx +++ b/website/content/docs/job-specification/gateway.mdx @@ -102,7 +102,7 @@ envoy_gateway_bind_addresses "" { - `port` `(int: required)` - The port that the listener should receive traffic on. - `protocol` `(string: "tcp")` - 'The protocol associated with the listener. - One of `tcp`, `http`, `http2`, or `grpc`.', + One of `tcp`, `http`, `http2`, or `grpc`.', ~> **Note:** If using `http`, preconfiguring a [service-default] in Consul to From 952d81e310c867ad4a4ee514cdbe95f67112c481 Mon Sep 17 00:00:00 2001 From: Luiz Aoqui Date: Thu, 24 Mar 2022 17:06:56 -0400 Subject: [PATCH 3/5] docs: fix markup --- website/content/docs/job-specification/gateway.mdx | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/website/content/docs/job-specification/gateway.mdx b/website/content/docs/job-specification/gateway.mdx index 1a69a53826d8..ef3474ffcb61 100644 --- a/website/content/docs/job-specification/gateway.mdx +++ b/website/content/docs/job-specification/gateway.mdx @@ -101,9 +101,8 @@ envoy_gateway_bind_addresses "" { #### `listener` Parameters - `port` `(int: required)` - The port that the listener should receive traffic on. -- `protocol` `(string: "tcp")` - 'The protocol associated with the listener. - One of `tcp`, `http`, `http2`, or `grpc`.', - +- `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 set the [Protocol](https://www.consul.io/docs/agent/config-entries/service-defaults#protocol) From 034c2eb8fa1082f7e3afdaa08d08dd1da45e0d0e Mon Sep 17 00:00:00 2001 From: dgotlieb Date: Mon, 6 Jun 2022 15:47:57 +0300 Subject: [PATCH 4/5] fix docs for gateway listener --- website/content/docs/job-specification/gateway.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/content/docs/job-specification/gateway.mdx b/website/content/docs/job-specification/gateway.mdx index ef3474ffcb61..e4e466001b10 100644 --- a/website/content/docs/job-specification/gateway.mdx +++ b/website/content/docs/job-specification/gateway.mdx @@ -104,9 +104,9 @@ envoy_gateway_bind_addresses "" { - `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 Consul issue](https://github.com/hashicorp/nomad/issues/8647). - `service` (array<[service]>: required) - One or more services to be exposed via this listener. For `tcp` listeners, only a single service is allowed. From c00417e5c62ec0cf9ef5242b6c71b9507361bfda Mon Sep 17 00:00:00 2001 From: dgotlieb Date: Mon, 6 Jun 2022 15:52:17 +0300 Subject: [PATCH 5/5] Update gateway.mdx --- website/content/docs/job-specification/gateway.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/job-specification/gateway.mdx b/website/content/docs/job-specification/gateway.mdx index 764ca42e2ecf..05a0fcc87c4f 100644 --- a/website/content/docs/job-specification/gateway.mdx +++ b/website/content/docs/job-specification/gateway.mdx @@ -121,7 +121,7 @@ envoy_gateway_bind_addresses "" { ~> **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 the desired protocol is mandatory due to an [open Consul issue](https://github.com/hashicorp/nomad/issues/8647). + of the service to the desired protocol is mandatory due to an [open issue](https://github.com/hashicorp/nomad/issues/8647). - `service` (array<[service]>: required) - One or more services to be exposed via this listener. For `tcp` listeners, only a single service is allowed.