How to Deploy Spring on Platform.sh with Redis
To activate Redis and then have it accessed by the Spring application already in Platform.sh, it is necessary to modify two files.
This guide only covers the addition of a service configuration to an existing Spring project already configured to deploy on Platform.sh. Please see the deployment guide for more detailed instructions for setting up app containers and initial projects.
.platform/services.yaml file, include Persistent Redis with a valid supported version:
data: type: redis-persistent:6.0 disk: 256
.platform.app.yaml file, use the service name
searchelastic to grant the application access to Elasticsearch via a relationship:
relationships: redisdata: "data:redis"
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 easily used by Spring. On Platform.sh, custom environment variables can be defined programmatically in a
.environment file using
jq to do just that:
export SPRING_REDIS_HOST=$(echo $PLATFORM_RELATIONSHIPS | base64 --decode | jq -r ".redisdata.host") export SPRING_REDIS_PORT=$(echo $PLATFORM_RELATIONSHIPS | base64 --decode | jq -r ".redisdata.port") export JAVA_OPTS="-Xmx$(jq .info.limits.memory /run/config.json)m -XX:+ExitOnOutOfMemoryError"
Commit that code and push. The Redis instance is ready to be connected from within the Spring application.