User Documentation

How to Deploy Micronaut on with Redis

Sign up for Upsun

Get your free trial by clicking the link below.

Get your Upsun free trial

To activate Redis and then have it accessed by the Micronaut application already in, it is necessary to modify two files.

1. Add the Redis service Anchor to this heading

In your service configuration, include Persistent Redis with a valid supported version:

    type: redis-persistent:7.2
    disk: 256

2. Add the Redis relationship Anchor to this heading

In your app configuration, use the service name redisdata to grant the application access to Elasticsearch via a relationship:
    redisdata: "data:redis"

3. Export connection credentials to the environment Anchor to this heading

Connection credentials for Redis, like any service, are exposed to the application container through the PLATFORM_RELATIONSHIPS environment variable from the deploy hook onward. Since this variable is a base64 encoded JSON object of all of your project’s services, you’ll likely want a clean way to extract the information specific to Elasticsearch into it’s own environment variables that can be used by Micronaut. On, custom environment variables can be defined programmatically in a .environment file using jq to do just that:

export REDIS_HOST=$(echo $PLATFORM_RELATIONSHIPS|base64 --decode|jq -r ".redisdata[0].host")
export REDIS_PORT=$(echo $PLATFORM_RELATIONSHIPS|base64 --decode|jq -r ".redisdata[0].port")
export REDIS_URI=redis://${REDIS_HOST}:${REDIS_PORT}
export JAVA_OPTS="-Xmx$(jq .info.limits.memory /run/config.json)m -XX:+ExitOnOutOfMemoryError"

4. Connect to Redis Anchor to this heading

Commit that code and push. The Redis instance is ready to be connected from within the Micronaut application.

Is this page helpful?