Skip to content

Commit de6a29c

Browse files
bignimbusclaude
andcommitted
docs(DXM-100): add shared Redis TLS config component to feature pages
Refactor the Redis TLS configuration documentation into a reusable shared MDX component (docs/shared/redis-tls.mdx) and include it on every feature page that exposes Redis configuration—APQ, query plan caching, response cache customization, and the TLS overview—so users discover the TLS option contextually rather than only on the overview page. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent d020543 commit de6a29c

File tree

5 files changed

+24
-79
lines changed

5 files changed

+24
-79
lines changed

docs/shared/redis-tls.mdx

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
1-
For Redis TLS connections, you can set up a client certificate or override the root certificate authority by configuring `tls` in your router's [YAML config file](https://www.apollographql.com/docs/router/overview/#yaml-config-file). For example:
1+
For Redis TLS connections, you can set up a client certificate or override the root certificate authority by configuring `tls` in your router's [YAML config file](/graphos/routing/configuration/overview#yaml-config-file). Nest the `tls` configuration under the `redis` section for your feature. For example:
22

33
```yaml
4-
apq:
5-
router:
6-
cache:
7-
redis:
8-
urls: [ "rediss://redis.example.com:6379" ]
9-
#highlight-start
10-
tls:
11-
certificate_authorities: ${file./path/to/ca.crt}
12-
client_authentication:
13-
certificate_chain: ${file./path/to/certificate_chain.pem}
14-
key: ${file./path/to/key.pem}
15-
#highlight-end
4+
redis:
5+
urls: ["rediss://redis.example.com:6379"]
6+
#highlight-start
7+
tls:
8+
certificate_authorities: ${file./path/to/ca.crt}
9+
client_authentication:
10+
certificate_chain: ${file./path/to/certificate_chain.pem}
11+
key: ${file./path/to/key.pem}
12+
#highlight-end
1613
```
14+
15+
For comprehensive TLS configuration details, including client-side and subgraph TLS, see [TLS configuration](/router/configuration/tls).

docs/source/routing/operations/apq.mdx

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ subtitle: Configure caching for automatic persisted queries
44
description: Configure automatic persisted queries (APQ) in GraphOS Router to reduce network usage by sending query hashes instead of full query strings.
55
---
66

7+
import RedisTls from '../../../shared/redis-tls.mdx';
8+
79
[Automatic Persisted Queries (**APQ**)](/apollo-server/performance/apq) enable GraphQL clients to send a server the _hash_ of their query string, _instead of_ sending the query string itself. When query strings are very large, this can significantly reduce network usage.
810

911
The router supports using APQ in its communications with both clients _and_ subgraphs:
@@ -198,20 +200,7 @@ When using the same Redis instance for multiple purposes, the `namespace` option
198200

199201
#### TLS
200202

201-
For Redis TLS connections, you can set up a client certificate or override the root certificate authority by configuring `tls` in your router's [YAML config file](/graphos/routing/configuration/overview#yaml-config-file). For example:
202-
203-
```yaml
204-
apq:
205-
router:
206-
cache:
207-
redis:
208-
urls: ["rediss://redis.example.com:6379"]
209-
tls:
210-
certificate_authorities: ${file./path/to/ca.crt}
211-
client_authentication:
212-
certificate_chain: ${file./path/to/certificate_chain.pem}
213-
key: ${file./path/to/key.pem}
214-
```
203+
<RedisTls />
215204

216205
#### Required to start
217206

docs/source/routing/performance/caching/response-caching/customization.mdx

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: Configure per-user caching with private data, create custom cache k
55
minVersion: Router v2.10.0
66
---
77

8+
import RedisTls from '../../../../../shared/redis-tls.mdx';
9+
810
Beyond basic response caching, the router supports customization for caching private data, modifying cache keys, and advanced Redis configuration.
911

1012
## When to customize
@@ -254,28 +256,7 @@ or, if configured with multiple URLs:
254256

255257
### TLS and authentication
256258

257-
For Redis TLS connections, you can set up a client certificate or override the root certificate authority by configuring `tls` in your router's [YAML config file](https://www.apollographql.com/docs/router/overview/#yaml-config-file). For example:
258-
259-
```yaml title="router.yaml"
260-
# Enable response caching globally
261-
response_cache:
262-
enabled: true
263-
subgraph:
264-
all:
265-
enabled: true
266-
# Configure Redis globally
267-
redis:
268-
urls: [ "rediss://redis.example.com:6379" ]
269-
#highlight-start
270-
username: root
271-
password: ${env.REDIS_PASSWORD}
272-
tls:
273-
certificate_authorities: ${file./path/to/ca.crt}
274-
client_authentication:
275-
certificate_chain: ${file./path/to/certificate_chain.pem}
276-
key: ${file./path/to/key.pem}
277-
#highlight-end
278-
```
259+
<RedisTls />
279260

280261
### Timeout configuration
281262

docs/source/routing/query-planning/caching.mdx

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ subtitle: Configure in-memory and distributed caching for query plans
44
description: Configure query plan caching to improve router performance by storing generated query plans in memory or Redis.
55
---
66

7+
import RedisTls from '../../../shared/redis-tls.mdx';
8+
79
Whenever your router receives an incoming GraphQL operation, it generates a [query plan](/graphos/resources/federation/query-plans) to determine which subgraphs it needs to query to resolve that operation.
810

911
By caching previously generated query plans, your router can skip generating them again if a client later sends the exact same operation—improving your router's responsiveness.
@@ -243,20 +245,7 @@ When using the same Redis instance for multiple purposes, the `namespace` option
243245

244246
#### TLS
245247

246-
For Redis TLS connections, you can set up a client certificate or override the root certificate authority by configuring `tls` in your router's [YAML config file](/graphos/routing/configuration/overview#yaml-config-file). For example:
247-
248-
```yaml
249-
supergraph:
250-
query_planning:
251-
cache:
252-
redis:
253-
urls: ["rediss://redis.example.com:6379"]
254-
tls:
255-
certificate_authorities: ${file./path/to/ca.crt}
256-
client_authentication:
257-
certificate_chain: ${file./path/to/certificate_chain.pem}
258-
key: ${file./path/to/key.pem}
259-
```
248+
<RedisTls />
260249

261250
#### Required to start
262251

docs/source/routing/security/tls.mdx

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ redirectFrom:
55
- /router/configuration/overview/#tls
66
---
77

8+
import RedisTls from '../../../shared/redis-tls.mdx';
9+
810
The GraphOS Router supports TLS to authenticate and encrypt communications, both on the client side and the subgraph side. It works automatically on the subgraph side if the subgraph URL starts with `https://`.
911

1012
```yaml title="Example TLS configuration"
@@ -128,19 +130,4 @@ tls:
128130

129131
## Redis TLS configuration
130132

131-
For Redis TLS connections, you can set up a client certificate or override the root certificate authority by configuring `tls` in your router's [YAML config file](https://www.apollographql.com/docs/router/overview/#yaml-config-file). For example:
132-
133-
```yaml
134-
apq:
135-
router:
136-
cache:
137-
redis:
138-
urls: [ "rediss://redis.example.com:6379" ]
139-
#highlight-start
140-
tls:
141-
certificate_authorities: ${file./path/to/ca.crt}
142-
client_authentication:
143-
certificate_chain: ${file./path/to/certificate_chain.pem}
144-
key: ${file./path/to/key.pem}
145-
#highlight-end
146-
```
133+
<RedisTls />

0 commit comments

Comments
 (0)