[Redis] M1 MacOS에서 Docker Redis Cluster 설정하기 + SpringBoot 애플리케이션에 클러스터 연결하기

 

🤔 개요

[Redis] Redis의 백업과 HA를 위한 전략 (RDB, AOF, Replication, Sentinel, Sharding, Cluster)

 

이전 글을 보면, 레디스의 백업과 고가용성에 대한 자세한 이야기가 담겨있습니다.

Redis의 고가용성을 위해서 Cluster를 구성할 수 있습니다. 그 중에서도 Docker Desktop for Mac을 사용하면서 Redis-Cluster를 구축할 수 있도록 Docker-Compose 파일 구성과 SpringBoot Application 설정에 대해 알아보도록 하겠습니다.

클러스터에 대한 자세한 내용이 궁금하다면, 위의 이전 글을 참조해주세요.

 

💜 Docker Compose 세팅

 

Docker의 어떤 이미지를 사용하느냐가 굉장히 중요합니다.

일반적인 Redis 이미지를 사용할 수도 있고, bitnami의 Redis-Cluster 이미지를 사용하셔도 좋습니다.

하지만 여기에서는 Docker Desktop for Mac을 사용하며(M1 MacOS) Docker 환경을 구성하려 하기 때문에 arm64v8/redis 이미지를 사용하시는 것이 좋습니다.

 

Linux 서버 등에서 Cluster를 구축을 시도한다면, bitnami/redis-cluster를 검색해 구현하면 편하게 구축할 수 있을겁니다.

Docker

 

✅ docker-compose.yml

version: '3'

services:
  redis-master-1:
    container_name: redis-master-1
    image: arm64v8/redis:latest
    restart: always
    volumes:
      - ./redis-master-1.conf:/etc/redis-master-1.conf
    command:
      redis-server /etc/redis-master-1.conf
    ports:
      - "7001:7001"
      - "7002:7002"
      - "7003:7003"
      - "7004:7004"
      - "7005:7005"
      - "7006:7006"

  redis-master-2:
    container_name: redis-master-2
    image: arm64v8/redis:latest
    network_mode: "service:redis-master-1"
    restart: always
    volumes:
      - ./redis-master-2.conf:/etc/redis-master-2.conf
    command:
      redis-server /etc/redis-master-2.conf

  redis-master-3:
    container_name: redis-master-3
    image: arm64v8/redis:latest
    network_mode: "service:redis-master-1"
    restart: always
    volumes:
      - ./redis-master-3.conf:/etc/redis-master-3.conf
    command:
      redis-server /etc/redis-master-3.conf

  redis-replica-1:
    container_name: redis-replica-1
    image: arm64v8/redis:latest
    network_mode: "service:redis-master-1"
    restart: always
    volumes:
      - ./redis-replica-1.conf:/etc/redis-replica-1.conf
    command:
      redis-server /etc/redis-replica-1.conf

  redis-replica-2:
    container_name: redis-replica-2
    image: arm64v8/redis:latest
    network_mode: "service:redis-master-1"
    restart: always
    volumes:
      - ./redis-replica-2.conf:/etc/redis-replica-2.conf
    command:
      redis-server /etc/redis-replica-2.conf

  redis-replica-3:
    container_name: redis-replica-3
    image: arm64v8/redis:latest
    network_mode: "service:redis-master-1"
    restart: always
    volumes:
      - ./redis-replica-3.conf:/etc/redis-replica-3.conf
    command:
      redis-server /etc/redis-replica-3.conf

  redis_cluster_entry:
    image: arm64v8/redis:latest
    network_mode: "service:redis-master-1"
    container_name: redis_cluster_entry
    command: redis-cli --cluster create 127.0.0.1:7001 127.0.0.1:7002 127.0.0.1:7003 127.0.0.1:7004 127.0.0.1:7005 127.0.0.1:7006 --cluster-yes
    depends_on:
      - redis-master-1
      - redis-master-2
      - redis-master-3
      - redis-replica-1
      - redis-replica-2
      - redis-replica-3

 

레디스 클러스터의 구성은 Master : Replica = 3 : 3의 비율로 구성되어 있습니다.

이미지는 실리콘 맥 플랫폼을 지원하는 arm64v8/redis의 latest 버전을 사용했습니다.

network_mode는 모든 노드가 redis-master-1으로 설정함으로써 같은 네트워크를 공유하도록 구성했습니다.

각 클러스터의 노드는 볼륨 마운트를 하고 있으므로, docker-compose.yml과 같은 디렉토리 위치에 

- redis-master-1.conf ~ redis-master-3.conf
- redis-replica-1.conf ~ redis-replica-3.conf

의 설정 파일이 존재해야 합니다. 해당 설정 파일 내에서 포트 번호와, 비밀번호, AOF 백업 방식, enable cluster 설정을 마치고 저장합니다.

 

default한 config 파일은 아래의 링크에서 Redis의 버전에 맞게 다운로드 받을 수 있으며, 해당 파일에서 값을 수정해 저장하면 됩니다.

Redis의 버전이 다른 config 파일을 받아 설정하면 실행 중 오류가 생길 여지가 있으므로 반드시 맞춰주시기 바랍니다.

Redis configuration

 

default config 파일의 내부, 주석을 풀어 값을 수정하는 식으로 사용 가능하다.

 

아래는 클러스터 노드로 만들기 위해 config 파일의 대표적으로 수정할 부분입니다.

# 호스트 머신에서 레디스가 커넥션을 받아들일 IP 설정
# bind 192.168.1.100 10.0.0.1     # listens on two specific IPv4 addresses
# bind 127.0.0.1 ::1              # listens on loopback IPv4 and IPv6
# bind * -::*                     # like the default, all available interfaces
# 아래는 예시입니다.
bind 127.0.0.1

# 레디스의 포트 넘버 설정
port 6379

# 백업 방식 AOF 방식 설정
appendonly yes

# Normal Redis instances can't be part of a Redis Cluster; only nodes that are
# started as cluster nodes can. In order to start a Redis instance as a
# cluster node enable the cluster support uncommenting the following:
#
cluster-enabled yes

# Every cluster node has a cluster configuration file. This file is not
# intended to be edited by hand. It is created and updated by Redis nodes.
# Every Redis Cluster node requires a different cluster configuration file.
# Make sure that instances running in the same system do not have
# overlapping cluster configuration file names.
#
cluster-config-file nodes.conf

# Cluster node timeout is the amount of milliseconds a node must be unreachable
# for it to be considered in failure state.
# Most other internal time limits are a multiple of the node timeout.
#
cluster-node-timeout 3000

위와 같은 작업을 각 노드 마다 노드에 맞는 값으로 (마스터 3, 레플리카 3 각 노드에 맞는 포트 번호) conf 파일을 구성하면 됩니다.

 

최종적으로 redis-cluster-entry에서 아래와 같은 명령어를 통해 클러스터 구축을 완료합니다.

redis-cli --cluster create 127.0.0.1:7001 127.0.0.1:7002 127.0.0.1:7003 127.0.0.1:7004 127.0.0.1:7005 127.0.0.1:7006 --cluster-yes

 

구축이 완료된 후, 아래와 같이 도커 프로세스가 구동되는 것을 확인할 수 있습니다.

 

아래는, 데이터가 잘 삽입되는지 테스트용으로, 간단하게 Medis GUI를 통해 Connection을 맺습니다. 하단의 Cluster 모드를 설정해서 MOVED 에러를 후처리 한 후 결과 값을 보여주도록 세팅합니다.

 

 

값이 잘 나오는 것을 확인했습니다.

 

 

💜 SpringBoot Application

 

위와 같이 구성한 레디스 클러스터와 스프링 부트 애플리케이션을 연결해보도록 하겠습니다.

 

✅ build.gradle

implementation 'org.springframework.boot:spring-boot-starter-data-redis'

 

✅ application.yml

spring:
  data:
    redis:
      cluster:
        nodes:
          127.0.0.1:7001,127.0.0.1:7002,127.0.0.1:7003,127.0.0.1:7004,127.0.0.1:7005,127.0.0.1:7006

 

✅ RedisConfig.java

@Configuration
public class NEORedisConfig {

    private final String clusterNodes;

    public NEORedisConfig(@Value("${spring.data.redis.cluster.nodes}") final String clusterNodes) {
        this.clusterNodes = clusterNodes;
    }

    @Bean
    public RedisTemplate<?, ?> redisTemplate() {
        RedisTemplate<byte[], byte[]> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory());
        return redisTemplate;
    }

    @Bean
    public RedisConnectionFactory redisConnectionFactory() {
        RedisClusterConfiguration clusterConfig = new RedisClusterConfiguration(Arrays.asList(clusterNodes.split(",")));
        return new LettuceConnectionFactory(clusterConfig);
    }

}

 

application.yml에서 설정한 cluster의 노드들을 @Value 애노테이션을 통해 cluterNodes 필드에 삽입합니다.

그 후, 각 노드들을 RedisClusterConfiguration 객체를 생성해 LettuceConnectionFactory에 등록합니다.

이것으로 간단한 연결 설정을 마칠 수 있습니다.