如何在Kubernetes部署中注入Java Play项目的Redis集群数组环境变量？

在Play Framework中，你可以通过环境变量覆盖HOCON配置，对于数组/序列类型的配置，有两种常用方式将其注入到Kubernetes部署中，下面分别介绍：

方法一：为每个集群节点设置单独的环境变量 #

Play允许通过带索引的环境变量名来指定数组中的元素，命名规则是：

• 将配置路径的.替换为_并转为大写
• 数组元素使用_索引_来定位（索引从0开始）

针对你的play.cache.redis.cluster配置，每个节点的环境变量命名如下：

• 第一个节点的主机：PLAY_CACHE_REDIS_CLUSTER_0_HOST
• 第一个节点的端口：PLAY_CACHE_REDIS_CLUSTER_0_PORT
• 第一个节点的密码（可选）：PLAY_CACHE_REDIS_CLUSTER_0_PASSWORD
• 第二个节点的主机：PLAY_CACHE_REDIS_CLUSTER_1_HOST
• 以此类推...

在Kubernetes的Deployment YAML中，你可以这样配置：

apiVersion: apps/v1
kind: Deployment
metadata:
  name: your-play-app
spec:
  replicas: 1
  selector:
    matchLabels:
      app: your-play-app
  template:
    metadata:
      labels:
        app: your-play-app
    spec:
      containers:
      - name: your-play-app
        image: your-play-image:latest
        env:
        - name: PLAY_CACHE_REDIS_CLUSTER_0_HOST
          value: "redis-node-1"
        - name: PLAY_CACHE_REDIS_CLUSTER_0_PORT
          value: "6379"
        - name: PLAY_CACHE_REDIS_CLUSTER_1_HOST
          value: "redis-node-2"
        - name: PLAY_CACHE_REDIS_CLUSTER_1_PORT
          value: "6379"
        # 如果需要密码，添加以下行
        # - name: PLAY_CACHE_REDIS_CLUSTER_0_PASSWORD
        #   value: "your-redis-password"

这种方式的优点是可以单独调整某个节点的配置，不需要修改整个数组。

方法二：通过单个环境变量传入完整的集群数组 #

如果你希望一次性传入整个集群配置，可以直接将HOCON格式的数组字符串作为环境变量的值。Play会自动解析这个字符串为HOCON结构。

在Kubernetes的Deployment YAML中，你可以这样配置：

apiVersion: apps/v1
kind: Deployment
metadata:
  name: your-play-app
spec:
  replicas: 1
  selector:
    matchLabels:
      app: your-play-app
  template:
    metadata:
      labels:
        app: your-play-app
    spec:
      containers:
      - name: your-play-app
        image: your-play-image:latest
        env:
        - name: PLAY_CACHE_REDIS_CLUSTER
          value: '[ { host: "redis-node-1", port: 6379 }, { host: "redis-node-2", port: 6379 } ]'
        # 或者使用多行格式更易读：
        # - name: PLAY_CACHE_REDIS_CLUSTER
        #   value: |
        #     [
        #       { host: "redis-node-1", port: 6379 },
        #       { host: "redis-node-2", port: 6379 }
        #     ]

调整application.conf以支持环境变量覆盖 #

为了让Play优先使用环境变量中的配置，你可以修改application.conf中的cluster配置行，使用HOCON的${?VAR}语法，表示如果环境变量存在则使用其值：

play.cache.redis {
  # enable cluster mode
  source: cluster
  # nodes are defined as a sequence of objects:
  cluster: [ {
    # required string, defining a host the node is running on
    host: localhost
    # required integer, defining a port the node is running on
    port: 6379
    # optional string, defines a password to use
    password: null
  } ]
  # 添加上这一行，优先使用环境变量的值
  cluster: ${?PLAY_CACHE_REDIS_CLUSTER}
}

这样，如果Kubernetes注入了PLAY_CACHE_REDIS_CLUSTER环境变量，Play会用它覆盖默认的集群配置；如果没有注入，则使用原来的默认值。

两种方式的选择建议 #

• 如果你的集群节点数量固定，且需要偶尔调整单个节点的配置，推荐使用方法一。
• 如果集群节点较多，或者需要一次性替换整个集群配置，推荐使用方法二，配置更简洁。

内容的提问来源于stack exchange，提问作者Jonathan Perry