クバネティス(Kubernetes) 環境で Redis-Sentinel Java App 構築 ①

概要

Redis-Sentinel 用 Java(Spring) App

Kubernetes ポッド(Pod) 環境で構築した Redis-Sentinel 用 Java App を書いてテストします。

Java 21
Spring Boot 3.4.3
Redis 8.8.2 🔗 Redis-Sentinel はここで構築したものを利用します。
PC(ノートPC) IntelliJ で Java(Spring) app 開発
サーバ: Linux(Rocky9.6)、Redis-Sentinel 実行中

Java Spring Project

Java Spring Project 生成

Java Spring Project を生成してアプリケーションを書いてみます。
Spring initializr を使って Java Spring Project を生成する URL: start.spring.io

Project: Gradle-Groovy
Language: Java
Spring Boot: 4.1.0 ➡📍IntelliJ の build.gradle ファイルで 3.4.3 に変更します。
Project Metadata
- Group: com.redisgate
- Artifact: KubeRedis -> Project 名称。この名前で圧縮ファイルができます。
- Package name: com.redisgate.KubeRedis -> Package Name
- Packaging: Jar
- Configuration: Properties
- Java: 21 -> Java バージョン選択
Dependencies で [ADD … CTRL + B] ボタンをクリックし、次の 3つを追加します。
- Spring Web
- Lombok
- Spring Data Redis(Access+Driver)
最後に [GENERATE CTRL + ⏎ ] ボタンをクリックして圧縮ファイル(zip) をダウンロードします。

💾 build.gradle ファイル

'org.springframework.boot' version '4.1.0' -> '3.4.3' 修正
'webmvc' -> 'web' を 2箇所修正
次の 2つのライブラリを追加
implementation 'org.springframework.retry:spring-retry' // Spring Retry ライブラリを追加
implementation 'org.springframework:spring-aspects' // AOP サポート
画面右上の 'ゾウ(Gradle)' アイコンをクリック -> メニューの最初の 'すべての Gradle プロジェクトを再ロード' アイコンをクリック

📄 build.gradle

plugins {
	id 'java'
	id 'org.springframework.boot' version '3.4.3'	📍
	id 'io.spring.dependency-management' version '1.1.7'
}
group = 'com.redisgate'
version = '0.0.1-SNAPSHOT'
java {
	toolchain {
		languageVersion = JavaLanguageVersion.of(21)
	}
}
repositories {
	mavenCentral()
}
dependencies {
	implementation 'org.springframework.retry:spring-retry' // Spring Retry ライブラリを追加 📍
	implementation 'org.springframework:spring-aspects' // AOP サポート 📍
	implementation 'org.springframework.boot:spring-boot-starter-data-redis'
	implementation 'org.springframework.boot:spring-boot-starter-web'  📍
	compileOnly 'org.projectlombok:lombok'
	annotationProcessor 'org.projectlombok:lombok'
	testImplementation 'org.springframework.boot:spring-boot-starter-data-redis-test'
	testImplementation 'org.springframework.boot:spring-boot-starter-web-test'  📍
	testCompileOnly 'org.projectlombok:lombok'
	testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
	testAnnotationProcessor 'org.projectlombok:lombok'
}
tasks.named('test') {
	useJUnitPlatform()
}

💾 Dockerfile ファイル

📄 Dockerfile

# 1. Java 21 実行環境指定 (軽量 Alpine Linux ベース)
FROM eclipse-temurin:21-jre-alpine
# 2. コンテナ内部の作業ディレクトリ設定 (自動生成される)
WORKDIR /app
# 3. ビルドされた JAR ファイルを app.jar という一貫した名前でコンテナ内部へコピー
COPY *.jar app.jar
# 4. コンテナ起動時に Spring Boot アプリ実行
ENTRYPOINT ["java", "-jar", "app.jar"]

💾 application.properties ファイル

'spring.data.redis.sentinel.nodes' に、次のように sentinel-0 から 2 まですべて記録してください。

📄 application.properties

spring.application.name=KubeRedis
# JVM Heap / CPU メモリ注意: スレッドが1つ生成されるたびに約 1MB の Stack メモリ(`-Xss`)が割り当てられます。
# 'threads.max=600' 設定時、スレッドだけで約 600MB のメモリが必要なため、
# K8s Pod メモリ Limit(例: `2Gi` 以上) および CPU Request を余裕をもって割り当ててください。
# Tomcat 最大ワーカスレッド数 (500~800)
server.tomcat.threads.max=600
# 最大スレッド超過時に待機できる作業キューサイズ
server.tomcat.accept-count=1000
# 同時に受け入れ可能な最大ソケット接続数
server.tomcat.max-connections=8192

# Redis Sentinel Config 📍
spring.data.redis.sentinel.nodes=sentinel-0.sentinel-service.default.svc.cluster.local:28504,\
  sentinel-1.sentinel-service.default.svc.cluster.local:28504,\
  sentinel-2.sentinel-service.default.svc.cluster.local:28504
spring.data.redis.sentinel.master=mymaster
spring.data.redis.database=0
# 👨‍💻 password, clientName: Set it up according to the project.
spring.data.redis.sentinel.password=redisgate
spring.data.redis.password=redisgate
spring.data.redis.clientName=redisgate
# 🔗 ref: https://redisgate.kr/redis/clients/springboot_readfrom.php
# Recommended: replicaPreferred -> (1) Replica -> (2) Master
spring.data.redis.readFrom=replicaPreferred
# 📝 NOTE: The 'connect-timeout' and 'timeout' configurations are explicitly
# defined in RedisSentinelConfig.java via LettuceClientConfigurationBuilderCustomizer.
# To change these timeout values, please update RedisSentinelConfig.java directly.
#spring.data.redis.connect-timeout=1s ➡ プログラムで設定します。
#spring.data.redis.timeout=1s ➡ プログラムで設定します。

💾 KubeRedisApplication.java ファイル

📄 KubeRedisApplication.java

package com.redisgate.KubeRedis;

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.retry.annotation.EnableRetry;

@SpringBootApplication
@EnableScheduling // 📍 スケジューラ有効化は必須
@EnableRetry // 📍 Spring Retry 機能を有効化
@Slf4j
public class KubeRedisApplication {
	public static void main(String[] args) {
		SpringApplication.run(KubeRedisApplication.class, args);
		log.info("----- クバネティス Redis Spring(Spring Boot 3.4.3)/Lettuce, Java 21 App ------");
	}
}

💾 RedisSentinelConfig.java ファイル

主な設定に ✅ または 📍 を付けました

📄 RedisSentinelConfig.java

package com.redisgate.KubeRedis;

import io.lettuce.core.ClientOptions;
import io.lettuce.core.SocketOptions;
import io.lettuce.core.TimeoutOptions;
import org.springframework.boot.autoconfigure.data.redis.LettuceClientConfigurationBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.time.Duration;

@Configuration
public class RedisSentinelConfig {

    @Bean
    public LettuceClientConfigurationBuilderCustomizer lettuceCustomizer() {
        return builder -> builder
                // 1. コマンドタイムアウトを1秒に制限 (failover 中の無限待ち防止)
                .commandTimeout(Duration.ofSeconds(1)) ✅
                // 2. Lettuce クライアント詳細オプション指定
                .clientOptions(ClientOptions.builder()
                        // Replica(Readonly) 状態の旧マスターへ命令送信時に例外を即時処理するオプション
                        .disconnectedBehavior(ClientOptions.DisconnectedBehavior.REJECT_COMMANDS)
                        // 命令応答タイムアウトの強制指定
                        .timeoutOptions(TimeoutOptions.enabled(Duration.ofSeconds(1))) ✅
                        // ソケット接続タイムアウト 1秒指定
                        .socketOptions(SocketOptions.builder()
                                .connectTimeout(Duration.ofSeconds(1)) 📍
                                .build())
                        .build());
    }
}

✅ commandTimeout() と timeoutOptions() は何が違うか？ ▼

1. Spring 設定: commandTimeout(Duration.ofSeconds(1))
- 適用位置: `LettuceClientConfigurationBuilder` (Spring Data Redis の上位設定)
- 主な役割: Spring Data Redis が Lettuce クライアント経由で命令を送るときに使う基本の同期コマンド実行タイムアウトです。
- 動作方式: `RedisTemplate` や `StringRedisTemplate` を使うとき、Redis サーバから 1秒以内に応答(Response) が来なければ `QueryTimeoutException` または `RedisCommandTimeoutException` を発生させます。
- 特徴: もっとも標準的な基本設定値で、特別な TimeoutOptions が定義されていなければ Lettuce が内部的にこの値を基本タイムアウトとして使い、命令をキャンセルします。
2. Lettuce 設定: timeoutOptions(TimeoutOptions.enabled(Duration.ofSeconds(1)))
- 適用位置: `ClientOptions` (Lettuce ドライバ自体の Native オプション)
- 主な役割: Lettuce 内部エンジンレベルで各コマンドのライフサイクル(Lifecycle) およびタイムアウト処理戦略を精密に制御します。
- 動作方式: Lettuce の非同期/リアクティブ(Reactive) パイプライン内部で命令(Command) が発送された後、1秒間結果応答がない、またはネットワーク遅延で応答を受け取れなければ、そのコマンドのカスタムタイムアウトスケジューラが介入して命令を強制キャンセル(Cancel) します。
- 特徴:
  - より精密な失敗制御: `disconnectedBehavior(REJECT_COMMANDS)` オプションと組み合わせたとき、サーバとの接続が切れる、または再接続(Reconnect) 中にキュー(Queue) で待っているコマンドが無期限に閉じ込められず、1秒で直ちにキャンセル処理されるよう強く強制します。
  - 動的タイムアウト(Dynamic Timeout) が可能: `TimeoutOptions` は単一の `Duration` だけでなく、コマンド種類(READ/WRITE) や状況に応じてタイムアウトを変えられる `TimeoutSource` をサポートします。 (例: `GET` は 500ms、`FLUSHALL` は 5s など)

💾 RedisOperationService.java ファイル

📄 RedisOperationService.java

package com.redisgate.KubeRedis;

import lombok.RequiredArgsConstructor;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;

@Service
@RequiredArgsConstructor
public class RedisOperationService {

    private final StringRedisTemplate redisTemplate;

    // 📍 障害発生時に1秒間隔で最大5回再試行
    @Retryable(
            retryFor = { Exception.class },
            maxAttempts = 5,
            backoff = @Backoff(delay = 1000)
    )
    public String executeSetAndGet(String key, String value) {
        // 1. Redis 保存
        redisTemplate.opsForValue().set(key, value);
        // 2. Redis 照会
        return redisTemplate.opsForValue().get(key);
    }
}

💾 RedisFailoverTestService.java ファイル

📄 RedisFailoverTestService.java

package com.redisgate.KubeRedis;

import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Service;
import java.util.concurrent.atomic.AtomicLong;

@Service
@RequiredArgsConstructor
@Slf4j
public class RedisFailoverTestService {
    private final RedisOperationService redisOperationService; // 📍 再試行サービス注入
    private final AtomicLong counter = new AtomicLong(1);

    @Scheduled(fixedRate = 100)
    public void runFailoverTest() {
        long seq = counter.getAndIncrement();
        String key = String.format("keyA-%08d", seq);
        String value = String.format("valueA-%08d", seq);

        try {
            // 📍 再試行ロジックを含むメソッド呼び出し
            String retrievedValue = redisOperationService.executeSetAndGet(key, value);

            if (value.equals(retrievedValue)) {
                if (seq % 10 == 0) {
                    log.info(" [SUCCESS] Key: {} -> Normal operation in progress...", key);
                }
            } else {
                log.warn(" [MISMATCH ERROR] Key: {}, Expected: {}, Got: {}", key, value, retrievedValue);
            }

        } catch (Exception e) {
            // 📍 5回再試行(5秒)後も最終的に失敗した場合のみエラーログ発生
            log.error(" [FAIL] Key: {} -> Error after retries: {}", key, e.getMessage());
        }
    }
}

App Docker イメージビルド、YAML ファイル

App Docker イメージビルド

1) コンパイル(make)
IntelliJ [KubeRedis]> ./gradlew clean bootJar
2) 'KubeRedis-0.0.1-SNAPSHOT.jar'、'Dockerfile': 2つのファイルをサーバ(~/kube/app/sentinel/) へ転送します。
app\IntelliJ\workspace\KubeRedis\build\libs\KubeRedis-0.0.1-SNAPSHOT.jar
app\IntelliJ\workspace\KubeRedis\Dockerfile
3) Docker イメージビルド (サーバで作業)
[~/kube/app/sentinel/] $ docker build -t spring-redis-sentinel-app:1.0 .
4) 生成した Docker イメージを k3s 内部(containerd) へ直接インポート
[~/kube/app/sentinel/] $ docker save spring-redis-sentinel-app:1.0 | sudo k3s ctr images import -

💾 app-deployment.yaml ファイル

サーバ "~/kube/app/sentinel" dir に作成

📄 app-deployment.yaml

  1	apiVersion: apps/v1
  2	kind: Deployment
  3	metadata:
  4	  name: spring-redis-sentinel-app
  5	spec:
  6	  replicas: 1
  7	  selector:
  8	    matchLabels:
  9	      app: spring-redis-sentinel-app
 10	  template:
 11	    metadata:
 12	      labels:
 13	        app: spring-redis-sentinel-app
 14	    spec:
 15	      containers:
 16	      - name: spring-app
 17	        image: spring-redis-sentinel-app:1.0
 18	        imagePullPolicy: IfNotPresent   # 📍 ローカルイメージを使用
 19	        ports:
 20	        - containerPort: 8080
 21	        env:
 22	        - name: TZ
 23	          value: Asia/Seoul             # 📍 タイムゾーン環境変数設定
 24	        volumeMounts:
 25	        - name: host-time
 26	          mountPath: /etc/localtime     # 📍 Host OS 時刻設定ファイルのマウント
 27	          readOnly: true
 28	      volumes:
 29	      - name: host-time
 30	        hostPath:
 31	          path: /etc/localtime          # 📍 Host OS の /etc/localtime パス指定
 32	---
 33	apiVersion: v1
 34	kind: Service
 35	metadata:
 36	  name: spring-redis-sentinel-app-service
 37	spec:
 38	  type: NodePort    # 📍 外部(Webブラウザ/Postman)からのテストアクセス用
 39	  ports:
 40	  - port: 8080
 41	    targetPort: 8080
 42	    nodePort: 30080   # Rocky9 IP:30080 でアクセス可能
 43	  selector:
 44	    app: spring-redis-sentinel-app

➡ Java App とポッド(Pod) 生成 YAML を準備したので、Failover(障害対応) テストに行きましょう。

<<K8s Redis-Sentinel テスト ③	K8s Redis-Sentinel App ② >>

Email 返事がかかってなれば、メールでお知らせします。