Skip to content

Commit 41470ad

Browse files
authored
remove gRPC Client DNS RoundRobin setting (#1634)
1 parent e484245 commit 41470ad

File tree

3 files changed

+1
-45
lines changed

3 files changed

+1
-45
lines changed

content/docs/reference/grpc.mdx

-37
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ Pomerium's gRPC settings apply to internal communication between:
2121
These settings have no effect on gRPC traffic proxied on a regular Pomerium route.
2222

2323
- [gRPC Address](#grpc-address)
24-
- [gRPC Client DNS RoundRobin](#grpc-client-dns-roundrobin)
2524
- [gRPC Client Timeout](#grpc-client-timeout)
2625
- [gRPC Insecure](#grpc-insecure)
2726

@@ -61,42 +60,6 @@ GRPC_ADDRESS=:8443
6160
</TabItem>
6261
</Tabs>
6362

64-
## gRPC Client DNS RoundRobin {#grpc-client-dns-roundrobin}
65-
66-
**gRPC Client DNS RoundRobin** enables DNS-based round-robin load balancing. This method uses DNS to resolve endpoints and distributes load balancing of _all_ addresses returned by the DNS record client side. **Do not disable** unless you have a specific use case.
67-
68-
### How to configure {#how-to-configure-grpc-client-dns-roundrobin}
69-
70-
<Tabs>
71-
<TabItem value="Core" label="Core">
72-
73-
| **Config file keys** | **Environment variables** | **Type** | **Default** |
74-
| :-- | :-- | :-- | :-- |
75-
| `grpc_client_dns_roundrobin` | `GRPC_CLIENT_DNS_ROUNDROBIN` | `boolean` | `true` |
76-
77-
### Examples {#examples-grpc-client-dns-roundrobin}
78-
79-
```yaml
80-
grpc_client_dns_roundrobin: false
81-
```
82-
83-
```bash
84-
GRPC_CLIENT_DNS_ROUNDROBIN=false
85-
```
86-
87-
</TabItem>
88-
<TabItem value="Enterprise" label="Enterprise">
89-
90-
`grpc_client_dns_roundrobin` is a bootstrap configuration setting and is not configurable in the Console.
91-
92-
</TabItem>
93-
<TabItem value="Kubernetes" label="Kubernetes">
94-
95-
Kubernetes does not support **gRPC Client DNS RoundRobin**
96-
97-
</TabItem>
98-
</Tabs>
99-
10063
## gRPC Client Timeout {#grpc-client-timeout}
10164

10265
**gRPC Client Timeout** sets the maximum time before canceling an upstream gRPC request. During transient failures, the proxy will retry upstream servers for this duration. You should leave this high enough to handle backend service restart and rediscovery so that client requests do not fail.

content/docs/reference/reference.json

-7
Original file line numberDiff line numberDiff line change
@@ -435,13 +435,6 @@
435435
"services": [],
436436
"type": ""
437437
},
438-
"grpc-client-dns-roundrobin": {
439-
"id": "grpc-client-dns-roundrobin",
440-
"title": "gRPC Client DNS RoundRobin",
441-
"path": "/grpc#grpc-client-dns-roundrobin",
442-
"services": [],
443-
"type": "bool"
444-
},
445438
"http-redirect-address": {
446439
"id": "http-redirect-address",
447440
"title": "HTTP Redirect Address",

static/_redirects

+1-1
Original file line numberDiff line numberDiff line change
@@ -419,7 +419,7 @@ https://0-20-0.docs.pomerium.com/category/guides https://0-20-0.docs.pomerium.co
419419
/docs/reference/metrics-certificate /docs/reference/metrics#metrics-certificate
420420

421421
# gRPC
422-
/docs/reference/grpc-client-dns-roundrobin /docs/reference/grpc#grpc-client-dns-roundrobin
422+
/docs/reference/grpc-client-dns-roundrobin /docs/reference/grpc
423423
/docs/reference/grpc-address /docs/reference/grpc#grpc-address
424424
/docs/reference/grpc-insecure /docs/reference/grpc#grpc-insecure
425425
/docs/reference/grpc-client-timeout /docs/reference/grpc#grpc-client-timeout

0 commit comments

Comments
 (0)