Redis

​

Overview

• Run it directly to get a managed Redis container with sensible defaults
• Inherit it in your own runnable to seamlessly add an in-memory data store to your stack

​

What this template manages

• Redis container (redis image, configurable tag)
• Network service on port 6379
• Persistent volumes for data storage
• Optional password authentication
• Multiple data structures support

​

Quick start (run directly)

1. Load templates

monk load MANIFEST

2. Run Redis with defaults

monk run redis/redis

3. Customize credentials (recommended via inheritance)

• Preferred: inherit and replace variables with secret("...") as shown below.
• Alternative: fork/clone and edit the variables in redis/redis.yml, then monk load MANIFEST and run.

​

Configuration

variables:
  redis-image-tag: "latest"           # container image tag
  redis-password: "..."               # optional password for authentication
  redis-port: "6379"                  # Redis port
  redis-maxmemory: "256mb"            # maximum memory limit
  redis-persistence: "yes"            # enable/disable RDB snapshots

​

Use by inheritance (recommended for apps)

namespace: myapp
cache:
  defines: runnable
  inherits: redis/redis
api:
  defines: runnable
  containers:
    api:
      image: myorg/api
  connections:
    cache:
      runnable: cache
      service: redis-svc
  variables:
    redis-host:
      value: <- connection-hostname("cache")
    redis-port:
      value: "6379"
    redis-password:
      value: <- secret("redis-password")

monk secrets add -g redis-password="STRONG_PASSWORD"
monk run myapp/api

​

Ports and connectivity

• Service: redis-svc on TCP port 6379
• From other runnables in the same process group, use connection-hostname("\<connection-name>") to resolve the Redis host.

​

Persistence and configuration

• Data path: ${monk-volume-path}/redis:/data
• Redis can persist data using RDB snapshots or AOF (Append Only File)
• Configure persistence options in the template variables

​

Features

• In-memory key-value store
• Multiple data structures (strings, hashes, lists, sets, sorted sets)
• Pub/Sub messaging
• Transactions
• Persistence options (RDB, AOF)
• Lua scripting
• Replication and clustering

​

Related templates

• High‑availability setup: see the redis-cluster-sentinel/ template in this repository for a Redis Sentinel configuration.
• Distributed setup: check redis-cluster-sentinel-haproxy/ for Redis Cluster with HAProxy load balancing.
• Combine with databases for caching layer (MySQL, PostgreSQL, MongoDB).

​

Troubleshooting

• If you changed redis-password but the container has existing data, authentication may fail. Either reset the data volume or update the password configuration.
• Ensure the host volumes are writable by the container user if persistence is enabled.
• Test connection with redis-cli:

redis-cli -h localhost -p 6379 ping

• Check logs:

monk logs -l 500 -f redis/redis

• If memory issues occur, adjust redis-maxmemory variable.