feat: add cluster definition topology and component version for redis (#501)

Co-authored-by: Leon <[email protected]>

Author: Y-Rookie

addons/redis-cluster/templates/_helpers.tpl

@@ -6,7 +6,7 @@ Define redis cluster shardingSpec with ComponentDefinition.
   shards: {{ .Values.redisCluster.shardCount }}
   template:
     name: redis
-    componentDef: redis-cluster
+    componentDef: redis-cluster-7.0
     replicas: {{ .Values.replicas }}
     {{- if .Values.nodePortEnabled }}
     services:
@@ -36,8 +36,6 @@ Define redis ComponentSpec with ComponentDefinition.
 */}}
 {{- define "redis-cluster.componentSpec" }}
 - name: redis
-  componentDef: redis
-  {{- include "kblib.componentMonitor" . | indent 2 }}
   {{- include "redis-cluster.replicaCount" . | indent 2 }}
   {{- if .Values.nodePortEnabled }}
   services:
@@ -52,20 +50,13 @@ Define redis ComponentSpec with ComponentDefinition.
     type: Noop
   {{- include "kblib.componentResources" . | indent 2 }}
   {{- include "kblib.componentStorages" . | indent 2 }}
-{{- if and (eq .Values.mode "replication") .Values.twemproxy.enabled }}
-{{- include "redis-cluster.twemproxyComponentSpec" . }}
-{{- end }}
-{{- if and (eq .Values.mode "replication") .Values.sentinel.enabled }}
-{{- include "redis-cluster.sentinelComponentSpec" . }}
-{{- end }}
 {{- end }}
 
 {{/*
 Define redis sentinel ComponentSpec with ComponentDefinition.
 */}}
 {{- define "redis-cluster.sentinelComponentSpec" }}
-- componentDef: redis-sentinel
-  name: redis-sentinel
+- name: redis-sentinel
   replicas: {{ .Values.sentinel.replicas }}
   {{- if .Values.nodePortEnabled }}
   services:
@@ -95,7 +86,6 @@ Define redis twemproxy ComponentSpec with ComponentDefinition.
 */}}
 {{- define "redis-cluster.twemproxyComponentSpec" }}
 - name: redis-twemproxy
-  componentDef: redis-twemproxy
   serviceAccountName: {{ include "kblib.serviceAccountName" . }}
   replicas: {{ .Values.twemproxy.replicas }}
   resources:
@@ -184,6 +174,8 @@ replication mode: 2
 replicas: 1
 {{- else if eq .Values.mode "replication" }}
 replicas: {{ max .Values.replicas 2 }}
+{{- else if eq .Values.mode "replication-twemproxy" }}
+replicas: {{ max .Values.replicas 2 }}
 {{- end }}
 {{- end }}
 

addons/redis-cluster/templates/cluster.yaml

@@ -4,13 +4,24 @@
   clusterDefinitionRef: redis
   componentSpecs:
   {{- include "redis-cluster.legacyComponentSpec" . | indent 2 }}
-{{- else }}
+{{- else if eq .Values.mode "cluster" }}
+  {{- /* TODO: when clusterDefinition topology supports sharding, migrate the cluster mode to topology as well */ -}}
   {{- include "kblib.clusterCommon" . }}
-  {{- if eq .Values.mode "cluster" }}
   shardingSpecs:
   {{- include "redis-cluster.shardingSpec" . | indent 2 }}
-  {{- else }}
+{{- else }}
+  {{- include "kblib.clusterCommon" . }}
+  clusterDefinitionRef: redis
+  topology: {{ .Values.mode }}
   componentSpecs:
-  {{- include "redis-cluster.componentSpec" . | indent 2 }}
+  {{- if eq .Values.mode "replication" }}
+    {{- include "redis-cluster.componentSpec" . | indent 2 }}
+    {{- include "redis-cluster.sentinelComponentSpec" . | indent 2 }}
+  {{- else if eq .Values.mode "replication-twemproxy" }}
+    {{- include "redis-cluster.componentSpec" . | indent 2 }}
+    {{- include "redis-cluster.sentinelComponentSpec" . | indent 2 }}
+    {{- include "redis-cluster.twemproxyComponentSpec" . | indent 2 }}
+  {{- else }}
+    {{- include "redis-cluster.componentSpec" . | indent 2 }}
   {{- end }}
 {{- end }}

addons/redis-cluster/values.schema.json

@@ -23,7 +23,8 @@
         "standalone",
         "replication",
         "cluster",
-        "sentinel"
+        "sentinel",
+        "replication-twemproxy"
       ]
     },
     "replicas": {

addons/redis-cluster/values.yaml

@@ -2,7 +2,7 @@
 # This is a YAML-formatted file.
 # Declare variables to be passed into your templates.
 # if useLegacyCompDef is false ,cluster will be rendered by compDef rather than componentDefRef in cluster definition
-useLegacyCompDef: true
+useLegacyCompDef: false
 
 
 ## @param version redis cluster version
@@ -12,6 +12,7 @@ version: redis-7.0.6
 ## @param mode redis cluster topology mode, standalone, replication and cluster
 ## standalone: single redis instance
 ## replication: primary-secondary replication with redis sentinel, refer: https://redis.io/docs/management/sentinel
+## replication-twemproxy: primary-secondary replication with sentinel and twemproxy, it is just a demo for how to use twemproxy with redis, not recommended for production
 ## cluster: official redis cluster, refer: https://redis.io/docs/reference/cluster-spec. if mode is cluster, please set useLegacyCompDef to false.
 mode: replication
 

addons/redis/Chart.yaml

@@ -15,6 +15,7 @@ keywords:
   - database
   - nosql
   - replication
+  - redis cluster
 
 maintainers:
   - name: ApeCloud

addons/redis/scripts/redis-sentinel-setup.sh

@@ -13,16 +13,17 @@ set -ex
 {{- $primary_pod := "" }}
 {{- range $i, $e := $.cluster.spec.componentSpecs }}
   {{- if index $e "componentDefRef" }}
-    {{- if eq $e.componentDefRef "redis-sentinel" }}
+    {{- /* xxxx-7.0 suffix just for compatible config render do not panic, this script has been deprecated in KubeBlock v0.10 */}}
+    {{- if eq $e.componentDefRef "redis-sentinel-7.0" }}
       {{- $sentinel_component = $e }}
-    {{- else if eq $e.componentDefRef "redis" }}
+    {{- else if eq $e.componentDefRef "redis-7.0" }}
       {{- $redis_component = $e }}
     {{- end }}
   {{- end }}
   {{- if index $e "componentDef" }}
-    {{- if eq $e.componentDef "redis-sentinel" }}
+    {{- if eq $e.componentDef "redis-sentinel-7.0" }}
       {{- $sentinel_component = $e }}
-    {{- else if eq $e.componentDef "redis" }}
+    {{- else if eq $e.componentDef "redis-7.0" }}
       {{- $redis_component = $e }}
     {{- end }}
   {{- end }}

addons/redis/scripts/redis-sentinel-start.sh

@@ -9,12 +9,12 @@ set -ex
 {{- $redis_component := fromJson "{}" }}
 {{- range $i, $e := $.cluster.spec.componentSpecs }}
   {{- if index $e "componentDefRef" }}
-    {{- if eq $e.componentDefRef "redis" }}
+    {{- if eq $e.componentDefRef "redis-7.0" }}
       {{- $redis_component = $e }}
     {{- end }}
   {{- end }}
   {{- if index $e "componentDef" }}
-    {{- if eq $e.componentDef "redis" }}
+    {{- if eq $e.componentDef "redis-7.0" }}
       {{- $redis_component = $e }}
     {{- end }}
   {{- end }}

addons/redis/scripts/redis-twemproxy-setup-v2.sh

@@ -0,0 +1,24 @@
+#!/bin/sh
+set -ex
+
+build_redis_twemproxy_conf() {
+  ## check REDIS_SERVICE_NAME and REDIS_SERVICE_PORT env exist
+  if [ -z "$REDIS_SERVICE_NAME" ] || [ -z "$REDIS_SERVICE_PORT" ]; then
+    echo "REDIS_SERVICE_NAME and REDIS_SERVICE_PORT must be set"
+    exit 1
+  fi
+
+  echo "alpha:" > /etc/proxy/nutcracker.conf
+  # shellcheck disable=SC2129
+  echo "  listen: 127.0.0.1:22121" >> /etc/proxy/nutcracker.conf
+  echo "  hash: fnv1a_64" >> /etc/proxy/nutcracker.conf
+  echo "  distribution: ketama" >> /etc/proxy/nutcracker.conf
+  echo "  auto_eject_hosts: true" >> /etc/proxy/nutcracker.conf
+  echo "  redis: true" >> /etc/proxy/nutcracker.conf
+  echo "  server_retry_timeout: 2000" >> /etc/proxy/nutcracker.conf
+  echo "  server_failure_limit: 1" >> /etc/proxy/nutcracker.conf
+  echo "  servers:" >> /etc/proxy/nutcracker.conf
+  echo "    - $REDIS_SERVICE_NAME:$REDIS_SERVICE_PORT:1 $KB_CLUSTER_NAME" >> /etc/proxy/nutcracker.conf
+}
+
+build_redis_twemproxy_conf

addons/redis/scripts/redis-twemproxy-setup.sh

@@ -7,16 +7,16 @@ set -ex
 {{- $redis_component := fromJson "{}" }}
 {{- range $i, $e := $.cluster.spec.componentSpecs }}
   {{- if index $e "componentDefRef" }}
-    {{- if eq $e.componentDefRef "redis-twemproxy" }}
+    {{- if eq $e.componentDefRef "redis-twemproxy-0.5" }}
       {{- $proxy_component = $e }}
-    {{- else if eq $e.componentDefRef "redis" }}
+    {{- else if eq $e.componentDefRef "redis-7.0" }}
       {{- $redis_component = $e }}
     {{- end }}
   {{- end }}
   {{- if index $e "componentDef" }}
-    {{- if eq $e.componentDef "redis-twemproxy" }}
+    {{- if eq $e.componentDef "redis-twemproxy-0.5" }}
       {{- $proxy_component = $e }}
-    {{- else if eq $e.componentDef "redis" }}
+    {{- else if eq $e.componentDef "redis-7.0" }}
       {{- $redis_component = $e }}
     {{- end }}
   {{- end }}

addons/redis/templates/_helpers.tpl

@@ -9,46 +9,74 @@ Expand the name of the chart.
 Define redis component defintion name
 */}}
 {{- define "redis.componentDefName" -}}
-{{- if eq (len .Values.compDefinitionVersionSuffix) 0 -}}
+{{- if eq (len .Values.compDefinitionVersion.redis) 0 -}}
 redis
 {{- else -}}
-{{- printf "redis-%s" .Values.compDefinitionVersionSuffix -}}
+{{- printf "redis-%s" .Values.compDefinitionVersion.redis -}}
 {{- end -}}
 {{- end -}}
 
+{{/*
+Define redis component defintion name prefix
+*/}}
+{{- define "redis.componentDefNamePrefix" -}}
+{{- printf "redis-%s" .Values.compDefinitionVersion.redis -}}
+{{- end -}}
+
 {{/*
 Define redis-sentinel component defintion name
 */}}
 {{- define "redis-sentinel.componentDefName" -}}
-{{- if eq (len .Values.compDefinitionVersionSuffix) 0 -}}
+{{- if eq (len .Values.compDefinitionVersion.sentinel) 0 -}}
 redis-sentinel
 {{- else -}}
-{{- printf "redis-sentinel-%s" .Values.compDefinitionVersionSuffix -}}
+{{- printf "redis-sentinel-%s" .Values.compDefinitionVersion.sentinel -}}
 {{- end -}}
 {{- end -}}
 
+{{/*
+Define redis-sentinel component defintion name prefix
+*/}}
+{{- define "redis-sentinel.componentDefNamePrefix" -}}
+{{- printf "redis-sentinel-%s" .Values.compDefinitionVersion.sentinel -}}
+{{- end -}}
+
 {{/*
 Define redis-cluster component defintion name
 */}}
 {{- define "redis-cluster.componentDefName" -}}
-{{- if eq (len .Values.compDefinitionVersionSuffix) 0 -}}
+{{- if eq (len .Values.compDefinitionVersion.redisCluster) 0 -}}
 redis-cluster
 {{- else -}}
-{{- printf "redis-cluster-%s" .Values.compDefinitionVersionSuffix -}}
+{{- printf "redis-cluster-%s" .Values.compDefinitionVersion.redisCluster -}}
 {{- end -}}
 {{- end -}}
 
+{{/*
+Define redis-cluster component defintion name prefix
+*/}}
+{{- define "redis-cluster.componentDefNamePrefix" -}}
+{{- printf "redis-cluster-%s" .Values.compDefinitionVersion.redisCluster -}}
+{{- end -}}
+
 {{/*
 Define redis-twemproxy component defintion name
 */}}
 {{- define "redis-twemproxy.componentDefName" -}}
-{{- if eq (len .Values.compDefinitionVersionSuffix) 0 -}}
+{{- if eq (len .Values.compDefinitionVersion.twemproxy) 0 -}}
 redis-twemproxy
 {{- else -}}
-{{- printf "redis-twemproxy-%s" .Values.compDefinitionVersionSuffix -}}
+{{- printf "redis-twemproxy-%s" .Values.compDefinitionVersion.twemproxy -}}
 {{- end -}}
 {{- end -}}
 
+{{/*
+Define redis-twemproxy component defintion name prefix
+*/}}
+{{- define "redis-twemproxy.componentDefNamePrefix" -}}
+{{- printf "redis-twemproxy-%s" .Values.compDefinitionVersion.twemproxy -}}
+{{- end -}}
+
 {{/*
 Create a default fully qualified app name.
 We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
@@ -105,7 +133,7 @@ Define image
 {{ .Values.image.registry | default "docker.io" }}/{{ .Values.image.repository }}:{{ .Values.image.tag }}
 {{- end }}
 
-{{- define "redis-proxy.image" -}}
+{{- define "redis-twemproxy.image" -}}
 {{ .Values.redisTwemproxyImage.registry | default "docker.io" }}/{{ .Values.redisTwemproxyImage.repository }}:{{ .Values.redisTwemproxyImage.tag }}
 {{- end }}
 

addons/redis/templates/clusterdefinition.yaml

@@ -403,3 +403,46 @@ spec:
                 - sh
                 - -c
                 - /scripts/redis-sentinel-ping.sh 1
+  topologies:
+    - name: standalone
+      components:
+        - name: redis
+          compDef: {{ include "redis.componentDefNamePrefix" . }}
+      default: true
+    - name: replication
+      components:
+        - name: redis
+          compDef: {{ include "redis.componentDefNamePrefix" . }}
+        - name: redis-sentinel
+          compDef: {{ include "redis-sentinel.componentDefNamePrefix" . }}
+      orders:
+        provision:
+          - redis-sentinel
+          - redis
+        terminate:
+          - redis-sentinel
+          - redis
+        update:
+          - redis-sentinel
+          - redis
+    - name: replication-twemproxy
+      components:
+        - name: redis
+          compDef: {{ include "redis.componentDefNamePrefix" . }}
+        - name: redis-sentinel
+          compDef: {{ include "redis-sentinel.componentDefNamePrefix" . }}
+        - name: redis-twemproxy
+          compDef: {{ include "redis-twemproxy.componentDefNamePrefix" . }}
+      orders:
+        provision:
+          - redis-sentinel
+          - redis
+          - redis-twemproxy
+        terminate:
+          - redis-twemproxy
+          - redis-sentinel
+          - redis
+        update:
+          - redis-sentinel
+          - redis-twemproxy
+          - redis

addons/redis/templates/clusterversion.yaml

@@ -34,5 +34,5 @@ spec:
           imagePullPolicy: {{ default .Values.busyboxImage.pullPolicy "IfNotPresent" }}
       containers:
         - name: redis-twemproxy
-          image: {{ include "redis-proxy.image" . }}
+          image: {{ include "redis-twemproxy.image" . }}
           imagePullPolicy: {{ default .Values.redisTwemproxyImage.pullPolicy "IfNotPresent" }}