https://github.com/fly-apps/redis-geo-cache

A global Redis cache
https://github.com/fly-apps/redis-geo-cache

Last synced: about 2 months ago
JSON representation

A global Redis cache

• Host: GitHub
• URL: https://github.com/fly-apps/redis-geo-cache
• Owner: fly-apps
• Created: 2020-11-10T22:46:45.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-04-12T23:57:43.000Z (over 2 years ago)
• Last Synced: 2024-04-23T11:15:25.862Z (5 months ago)
• Language: Shell
• Size: 3.91 KB
• Stars: 81
• Watchers: 5
• Forks: 9
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Redis Geo Cache

This is an example Redis configuration that runs a primary Redis in one region and replicas in other regions. Writes to the primary region propagate, writes to other regions are region local.

Redis includes a `replica-read-only no` setting that makes it especially effective for geo caching. When you run replicas that allow writes, you can write to the closest replica for most ephemeral cache data, and write to the master for commands that should propagate.

### Usage

This is a Fly app that requires volumes. Assuming you want a primary redis in the `scl` region and a replica in the `ord` region, this is what you need to do.

1. Clone this repository

2. `fly launch`, choose to import the existing config

3. Choose `n` when it asks if you want to deploy

4. Set a redis password: `fly secrets set REDIS_PASSWORD=`

5. Create a volume in your primary region:

   ```

   fly volumes create redis_server --size 10 --region scl

   ```

6. `fly deploy`

7. Add volumes in other regions:

   ```

   fly volumes create redis_server --size 10 --region ord

   ```

8. Add instances: `fly scale count 2`

### Connecting from your application

You should run your application in the same regions as Redis, and use the region specific addresses to connect. It's helpful to set a matching `PRIMARY_REGION` environment variable on any application you connect to your Redis cluster so you can make choices about where to send writes.

The primary Redis URL is:

```bash

# format

redis://x:@..internal:6379

# example in scl

redis://x:[email protected]:6379

```

Read replicas are similar, but using a different region prefix (the `$FLY_REGION` environment variable is handy here).

To generate a local read replica with Node.js, you might do something like:

```javascript

const primary = new URL("redis://x:[email protected]:6379")

const replica = new URL(primary)

replica.hostname = `${process.env['FLY_REGION']}.my-redis-app.internal`

replica.toString()

// 'redis://x:[email protected]:6379'

```