Portainer Templates logo

Portainer Templates

Valkey Cluster Valkey Cluster

Stack

Caches Key Value

Horizontally-scaled Valkey where the keyspace is partitioned across multiple master shards, each with a replica - the same design as Redis Cluster, BSD-licensed and Redis-protocol compatible.

Configuration

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

Template by deployable-sh·Source

Report issue

Services

valkey-node-1

Configuration

Volumes
/data : node1-data
Env vars
VALKEY_ROLE=nodeVALKEY_PASSWORD=${VALKEY_PASSWORD}VALKEY_ANNOUNCE_HOST=valkey-node-1
Restart
unless-stopped
Build
.

valkey-node-2

Configuration

Volumes
/data : node2-data
Env vars
VALKEY_ROLE=nodeVALKEY_PASSWORD=${VALKEY_PASSWORD}VALKEY_ANNOUNCE_HOST=valkey-node-2
Restart
unless-stopped
Build
.

valkey-node-3

Configuration

Volumes
/data : node3-data
Env vars
VALKEY_ROLE=nodeVALKEY_PASSWORD=${VALKEY_PASSWORD}VALKEY_ANNOUNCE_HOST=valkey-node-3
Restart
unless-stopped
Build
.

valkey-node-4

Configuration

Volumes
/data : node4-data
Env vars
VALKEY_ROLE=nodeVALKEY_PASSWORD=${VALKEY_PASSWORD}VALKEY_ANNOUNCE_HOST=valkey-node-4
Restart
unless-stopped
Build
.

valkey-node-5

Configuration

Volumes
/data : node5-data
Env vars
VALKEY_ROLE=nodeVALKEY_PASSWORD=${VALKEY_PASSWORD}VALKEY_ANNOUNCE_HOST=valkey-node-5
Restart
unless-stopped
Build
.

valkey-node-6

Configuration

Volumes
/data : node6-data
Env vars
VALKEY_ROLE=nodeVALKEY_PASSWORD=${VALKEY_PASSWORD}VALKEY_ANNOUNCE_HOST=valkey-node-6
Restart
unless-stopped
Build
.

valkey-init

Configuration

Env vars
VALKEY_ROLE=initVALKEY_PASSWORD=${VALKEY_PASSWORD}CLUSTER_NODES=valkey-node-1:6379 valkey-node-2:6379 valkey-node-3:6379 valkey-node-4:6379 valkey-node-5:6379 valkey-node-6:6379
Restart
no
Build
.

Standalone Install

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

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 Cluster, 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-cluster

services:
  valkey-node-1:
    build: .
    restart: unless-stopped
    environment:
      VALKEY_ROLE: node
      VALKEY_PASSWORD: ${VALKEY_PASSWORD}
      VALKEY_ANNOUNCE_HOST: valkey-node-1
    volumes: [node1-data:/data]

  valkey-node-2:
    build: .
    restart: unless-stopped
    environment:
      VALKEY_ROLE: node
      VALKEY_PASSWORD: ${VALKEY_PASSWORD}
      VALKEY_ANNOUNCE_HOST: valkey-node-2
    volumes: [node2-data:/data]

  valkey-node-3:
    build: .
    restart: unless-stopped
    environment:
      VALKEY_ROLE: node
      VALKEY_PASSWORD: ${VALKEY_PASSWORD}
      VALKEY_ANNOUNCE_HOST: valkey-node-3
    volumes: [node3-data:/data]

  valkey-node-4:
    build: .
    restart: unless-stopped
    environment:
      VALKEY_ROLE: node
      VALKEY_PASSWORD: ${VALKEY_PASSWORD}
      VALKEY_ANNOUNCE_HOST: valkey-node-4
    volumes: [node4-data:/data]

  valkey-node-5:
    build: .
    restart: unless-stopped
    environment:
      VALKEY_ROLE: node
      VALKEY_PASSWORD: ${VALKEY_PASSWORD}
      VALKEY_ANNOUNCE_HOST: valkey-node-5
    volumes: [node5-data:/data]

  valkey-node-6:
    build: .
    restart: unless-stopped
    environment:
      VALKEY_ROLE: node
      VALKEY_PASSWORD: ${VALKEY_PASSWORD}
      VALKEY_ANNOUNCE_HOST: valkey-node-6
    volumes: [node6-data:/data]

  valkey-init:
    build: .
    restart: "no"
    environment:
      VALKEY_ROLE: init
      VALKEY_PASSWORD: ${VALKEY_PASSWORD}
      CLUSTER_NODES: "valkey-node-1:6379 valkey-node-2:6379 valkey-node-3:6379 valkey-node-4:6379 valkey-node-5:6379 valkey-node-6:6379"
    depends_on:
      - valkey-node-1
      - valkey-node-2
      - valkey-node-3
      - valkey-node-4
      - valkey-node-5
      - valkey-node-6

volumes:
  node1-data:
  node2-data:
  node3-data:
  node4-data:
  node5-data:
  node6-data:

Or deploy it directly from the source:

git clone https://github.com/deployable-sh/stacks
cd stacks
docker compose -f valkey-cluster/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 Cluster is a Compose stack, a set of containers (7 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 7 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • valkey-node-1
  • valkey-node-2
  • valkey-node-3
  • valkey-node-4
  • valkey-node-5
  • valkey-node-6
  • valkey-init, starts after valkey-node-1, valkey-node-2, valkey-node-3, valkey-node-4, valkey-node-5, valkey-node-6

Volumes

A volume is where Valkey Cluster 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 node1-data volume Docker manages
  • /data kept in the node2-data volume Docker manages
  • /data kept in the node3-data volume Docker manages
  • /data kept in the node4-data volume Docker manages
  • /data kept in the node5-data volume Docker manages
  • /data kept in the node6-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 Cluster takes 4 of them, all with defaults you can leave alone or tweak:

  • VALKEY_ROLE, defaults to init
  • VALKEY_PASSWORD, pulled from your own environment
  • VALKEY_ANNOUNCE_HOST, defaults to valkey-node-6
  • CLUSTER_NODES, defaults to valkey-node-1:6379 valkey-node-2:6379 valkey-node-3:6379 valkey-node-4:6379 valkey-node-5:6379 valkey-node-6:6379

Restart policy

The restart policy here is unless-stopped, so Docker restarts Valkey Cluster 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-node-1) 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 Cluster up. Add the template list to Portainer once, then deploying Valkey Cluster is a click rather than a wall of config.