Skip to content

Commit 1a7cedb

Browse files
authored
feat: add aws aelasticache docs (#230)
1 parent 7d043ed commit 1a7cedb

File tree

3 files changed

+95
-1
lines changed

3 files changed

+95
-1
lines changed

content/docs/launching-the-platform/self-hosted/platform-installation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ redis:
6666
port: '<redis-port>'
6767
password: '<redis-password>'
6868
tls: true
69+
cluster: false
6970

7071
postgresql:
7172
host: '<postgresql-host>'

content/docs/launching-the-platform/self-hosted/platform-installation.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ redis:
6666
port: '<redis-port>'
6767
password: '<redis-password>'
6868
tls: true
69+
cluster: false
6970

7071
postgresql:
7172
host: '<postgresql-host>'

content/docs/launching-the-platform/self-hosted/prerequisites/redis.mdx

Lines changed: 93 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,55 @@ import { Tab, Tabs } from "fumadocs-ui/components/tabs";
4545
- Enable authentication (recommended)
4646
- Configure VPC network and authorized networks
4747

48+
### AWS ElastiCache
49+
<Tabs items={['Redis', 'Valkey']}>
50+
<Tab value="Redis">
51+
- Go to [AWS Console](https://console.aws.amazon.com/elasticache/)
52+
- Click "Create" to start creating a new cache
53+
- Select "Redis" as the engine
54+
- Choose a name for your cache
55+
- Select the appropriate node type (minimum: cache.t3.small)
56+
- Configure number of replicas (minimum 1 for production)
57+
- Choose your VPC and subnet groups (same as your EKS cluster)
58+
- Set up security groups to allow access from your EKS cluster
59+
- Enable encryption in transit (TLS)
60+
- Configure authentication as needed
61+
62+
<Callout type="warning">
63+
**Important Helm Chart Configuration**
64+
```yaml
65+
redis:
66+
tls: true
67+
cluster: true
68+
```
69+
Leave `redis.password` empty if you disabled authentication
70+
</Callout>
71+
</Tab>
72+
73+
<Tab value="Valkey">
74+
- Go to [AWS Console](https://console.aws.amazon.com/elasticache/)
75+
- Click "Create" to start creating a new cache
76+
- Select "Valkey" as the engine
77+
- Choose a name for your cache
78+
- Select the appropriate node type (minimum: cache.t3.small)
79+
- Configure number of replicas (minimum 1 for production)
80+
- Choose your VPC and subnet groups (same as your EKS cluster)
81+
- Set up security groups to allow access from your EKS cluster
82+
- Enable encryption in transit (TLS)
83+
- Configure authentication as needed
84+
85+
<Callout type="warning">
86+
**Important Helm Chart Configuration**
87+
```yaml
88+
redis:
89+
tls: true
90+
cluster: false
91+
```
92+
Leave `redis.password` empty if you disabled authentication
93+
</Callout>
94+
</Tab>
95+
</Tabs>
96+
4897
### Redis Cloud
4998
- Create account at [Redis Cloud](https://app.redislabs.com)
5099
- Create new subscription:
@@ -145,6 +194,7 @@ redis:
145194
password: "" # Redis password collected in prerequisites
146195
prefix: "sm" # In shared redis servers, this separates queues
147196
tls: false # Set to true to use TLS mode
197+
cluster: false # Set to true for Redis cluster mode
148198
```
149199
150200
<Callout type="info">
@@ -153,11 +203,29 @@ When using Google Memorystore:
153203
2. Ensure your GKE cluster has access to the Memorystore instance
154204
3. Configure the same region as your GKE cluster
155205
</Callout>
206+
207+
<Callout type="info">
208+
When using AWS ElastiCache:
209+
1. For Redis:
210+
```yaml
211+
redis:
212+
tls: true
213+
cluster: true
214+
```
215+
2. For Valkey:
216+
```yaml
217+
redis:
218+
tls: true
219+
cluster: false
220+
```
221+
3. Leave `redis.password` empty if you disabled authentication on ElastiCache
222+
4. Ensure your EKS cluster has network access to the ElastiCache instance
223+
</Callout>
156224
</Callout>
157225

158226
## Validation
159227

160-
<Tabs items={['Google Memorystore', 'Standard Redis']}>
228+
<Tabs items={['Google Memorystore', 'AWS ElastiCache', 'Standard Redis']}>
161229
<Tab value="Google Memorystore">
162230
```bash
163231
# Get the Memorystore instance connection details
@@ -172,6 +240,30 @@ When using Google Memorystore:
172240

173241
</Tab>
174242

243+
<Tab value="AWS ElastiCache">
244+
```bash
245+
# Get the ElastiCache endpoint
246+
REDIS_ENDPOINT=$(aws elasticache describe-replication-groups \
247+
--replication-group-id [CACHE_NAME] \
248+
--query "ReplicationGroups[0].ConfigurationEndpoint.Address" \
249+
--output text)
250+
251+
# If using non-cluster mode, get the primary endpoint instead
252+
REDIS_ENDPOINT=$(aws elasticache describe-replication-groups \
253+
--replication-group-id [CACHE_NAME] \
254+
--query "ReplicationGroups[0].NodeGroups[0].PrimaryEndpoint.Address" \
255+
--output text)
256+
257+
REDIS_PORT=6379 # Default port for ElastiCache
258+
259+
# Test connection using redis-cli with TLS
260+
redis-cli -h $REDIS_ENDPOINT -p $REDIS_PORT --tls -a your-password ping
261+
262+
# Expected response
263+
PONG
264+
```
265+
</Tab>
266+
175267
<Tab value="Standard Redis">
176268
```bash
177269
# Using redis-cli

0 commit comments

Comments
 (0)