Portainer Templates logo

Portainer Templates

Valkey Sentinel Valkey Sentinel

Stack

Caches Key Value

High availability for Valkey with automatic failover, using Valkey's built-in Sentinel (the same design as Redis Sentinel). One master, two replicas, and three sentinels that watch the master and promote a replica if it fails.

Configuration

Type
Compose
Platform
linux
Env vars
VALKEY_PASSWORD=''
Source
Repo

Template by deployable-sh·Source

Report issue

Services

valkey-master

Configuration

Volumes
/data : master-data
Env vars
VALKEY_ROLE=masterVALKEY_PASSWORD=${VALKEY_PASSWORD}VALKEY_MASTER_HOST=valkey-masterVALKEY_ANNOUNCE_HOST=valkey-master
Restart
unless-stopped
Build
.

valkey-replica-1

Configuration

Volumes
/data : replica1-data
Env vars
VALKEY_ROLE=replicaVALKEY_PASSWORD=${VALKEY_PASSWORD}VALKEY_MASTER_HOST=valkey-masterVALKEY_ANNOUNCE_HOST=valkey-replica-1
Restart
unless-stopped
Build
.

valkey-replica-2

Configuration

Volumes
/data : replica2-data
Env vars
VALKEY_ROLE=replicaVALKEY_PASSWORD=${VALKEY_PASSWORD}VALKEY_MASTER_HOST=valkey-masterVALKEY_ANNOUNCE_HOST=valkey-replica-2
Restart
unless-stopped
Build
.

valkey-sentinel-1

Configuration

Env vars
VALKEY_ROLE=sentinelVALKEY_PASSWORD=${VALKEY_PASSWORD}VALKEY_MASTER_HOST=valkey-master
Restart
unless-stopped
Build
.

valkey-sentinel-2

Configuration

Env vars
VALKEY_ROLE=sentinelVALKEY_PASSWORD=${VALKEY_PASSWORD}VALKEY_MASTER_HOST=valkey-master
Restart
unless-stopped
Build
.

valkey-sentinel-3

Configuration

Env vars
VALKEY_ROLE=sentinelVALKEY_PASSWORD=${VALKEY_PASSWORD}VALKEY_MASTER_HOST=valkey-master
Restart
unless-stopped
Build
.

Standalone Install

Select an install method, to see config/commands for deploying Valkey Sentinel

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Valkey Sentinel, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

name: valkey-sentinel

services:
  valkey-master:
    build: .
    restart: unless-stopped
    environment:
      VALKEY_ROLE: master
      VALKEY_PASSWORD: ${VALKEY_PASSWORD}
      VALKEY_MASTER_HOST: valkey-master
      VALKEY_ANNOUNCE_HOST: valkey-master
    volumes:
      - master-data:/data

  valkey-replica-1:
    build: .
    restart: unless-stopped
    environment:
      VALKEY_ROLE: replica
      VALKEY_PASSWORD: ${VALKEY_PASSWORD}
      VALKEY_MASTER_HOST: valkey-master
      VALKEY_ANNOUNCE_HOST: valkey-replica-1
    depends_on: [valkey-master]
    volumes:
      - replica1-data:/data

  valkey-replica-2:
    build: .
    restart: unless-stopped
    environment:
      VALKEY_ROLE: replica
      VALKEY_PASSWORD: ${VALKEY_PASSWORD}
      VALKEY_MASTER_HOST: valkey-master
      VALKEY_ANNOUNCE_HOST: valkey-replica-2
    depends_on: [valkey-master]
    volumes:
      - replica2-data:/data

  valkey-sentinel-1:
    build: .
    restart: unless-stopped
    environment:
      VALKEY_ROLE: sentinel
      VALKEY_PASSWORD: ${VALKEY_PASSWORD}
      VALKEY_MASTER_HOST: valkey-master
    depends_on: [valkey-master, valkey-replica-1, valkey-replica-2]

  valkey-sentinel-2:
    build: .
    restart: unless-stopped
    environment:
      VALKEY_ROLE: sentinel
      VALKEY_PASSWORD: ${VALKEY_PASSWORD}
      VALKEY_MASTER_HOST: valkey-master
    depends_on: [valkey-master, valkey-replica-1, valkey-replica-2]

  valkey-sentinel-3:
    build: .
    restart: unless-stopped
    environment:
      VALKEY_ROLE: sentinel
      VALKEY_PASSWORD: ${VALKEY_PASSWORD}
      VALKEY_MASTER_HOST: valkey-master
    depends_on: [valkey-master, valkey-replica-1, valkey-replica-2]

volumes:
  master-data:
  replica1-data:
  replica2-data:

Or deploy it directly from the source:

git clone https://github.com/deployable-sh/stacks
cd stacks
docker compose -f valkey-sentinel/compose.yaml up -d

More install options in our documentation.

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Valkey Sentinel is a Compose stack, a set of containers (6 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 6 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • valkey-master
  • valkey-replica-1, starts after valkey-master
  • valkey-replica-2, starts after valkey-master
  • valkey-sentinel-1, starts after valkey-master, valkey-replica-1, valkey-replica-2
  • valkey-sentinel-2, starts after valkey-master, valkey-replica-1, valkey-replica-2
  • valkey-sentinel-3, starts after valkey-master, valkey-replica-1, valkey-replica-2

Volumes

A volume is where Valkey Sentinel keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /data kept in the master-data volume Docker manages
  • /data kept in the replica1-data volume Docker manages
  • /data kept in the replica2-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Valkey Sentinel takes 4 of them, all with defaults you can leave alone or tweak:

  • VALKEY_ROLE, defaults to sentinel
  • VALKEY_PASSWORD, pulled from your own environment
  • VALKEY_MASTER_HOST, defaults to valkey-master
  • VALKEY_ANNOUNCE_HOST, defaults to valkey-replica-2

Restart policy

The restart policy here is unless-stopped, so Docker restarts Valkey Sentinel after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like valkey-master) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Valkey Sentinel up. Add the template list to Portainer once, then deploying Valkey Sentinel is a click rather than a wall of config.