feat: sentinel support hostname resolve and annonce (OT-CONTAINER-KIT…

…#1247) * feat: Sentinel - support hostname resolve and annonce master Signed-off-by: Michael Kanchuker <[email protected]> * fix Signed-off-by: yangw <[email protected]> * fix Signed-off-by: yangw <[email protected]> --------- Signed-off-by: Michael Kanchuker <[email protected]> Signed-off-by: yangw <[email protected]> Co-authored-by: yangw <[email protected]>
drivebyer · Feb 28, 2025 · aafc663 · aafc663
1 parent 7c91822
commit aafc663
Show file tree

Hide file tree

Showing 11 changed files with 87 additions and 10 deletions.
diff --git a/.gitignore b/.gitignore
@@ -26,5 +26,8 @@ coverage.html
 *~
 .vscode
 
+.DS_Store
+
 docs/build
-kubeconfig
+kubeconfig
+manager
diff --git a/api/common_types.go b/api/common_types.go
@@ -193,4 +193,8 @@ type RedisSentinelConfig struct {
 	FailoverTimeout string `json:"failoverTimeout,omitempty"`
 	// +kubebuilder:default:="30000"
 	DownAfterMilliseconds string `json:"downAfterMilliseconds,omitempty"`
+	// +kubebuilder:default:="no"
+	ResolveHostnames string `json:"resolveHostnames,omitempty"`
+	// +kubebuilder:default:="no"
+	AnnounceHostnames string `json:"announceHostnames,omitempty"`
 }
diff --git a/charts/redis-operator/crds/redis.redis.opstreelabs.in_redissentinels.yaml b/charts/redis-operator/crds/redis.redis.opstreelabs.in_redissentinels.yaml
@@ -2631,6 +2631,12 @@ spec:
                         type: object
                         x-kubernetes-map-type: atomic
                     type: object
+                  resolveHostnames:
+                    default: "no"
+                    type: string
+                  announceHostnames:
+                    default: "no"
+                    type: string
                 required:
                 - redisReplicationName
                 type: object

diff --git a/charts/redis-sentinel/README.md b/charts/redis-sentinel/README.md
@@ -100,6 +100,7 @@ helm delete <my-release> --namespace <namespace>
 | redisSentinel.resources | object | `{}` |  |
 | redisSentinel.serviceType | string | `"ClusterIP"` |  |
 | redisSentinel.tag | string | `"v7.0.15"` |  |
+| redisSentinelConfig.announceHostnames | string | `""` |  |
 | redisSentinelConfig.downAfterMilliseconds | string | `""` |  |
 | redisSentinelConfig.failoverTimeout | string | `""` |  |
 | redisSentinelConfig.masterGroupName | string | `""` |  |
@@ -109,6 +110,7 @@ helm delete <my-release> --namespace <namespace>
 | redisSentinelConfig.redisReplicationName | string | `"redis-replication"` |  |
 | redisSentinelConfig.redisReplicationPassword.secretKey | string | `""` |  |
 | redisSentinelConfig.redisReplicationPassword.secretName | string | `""` |  |
+| redisSentinelConfig.resolveHostnames | string | `""` |  |
 | securityContext | object | `{}` |  |
 | serviceAccountName | string | `""` |  |
 | serviceMonitor.enabled | bool | `false` |  |

diff --git a/charts/redis-sentinel/templates/redis-sentinel.yaml b/charts/redis-sentinel/templates/redis-sentinel.yaml
@@ -25,6 +25,8 @@ spec:
     parallelSyncs: {{ .Values.redisSentinelConfig.parallelSyncs | default "1" | quote}}
     failoverTimeout: {{ .Values.redisSentinelConfig.failoverTimeout | default "180000" | quote}}
     downAfterMilliseconds:  {{ .Values.redisSentinelConfig.downAfterMilliseconds | default "30000" | quote}}
+    resolveHostnames : {{ .Values.redisSentinelConfig.resolveHostnames | default "no" | quote}}
+    announceHostnames : {{ .Values.redisSentinelConfig.announceHostnames | default "no" | quote}}
     {{- if eq .Values.externalConfig.enabled true }}
     additionalSentinelConfig: {{ .Values.redisSentinel.name | default .Release.Name }}-ext-config
     {{- end }}

diff --git a/charts/redis-sentinel/values.yaml b/charts/redis-sentinel/values.yaml
@@ -38,6 +38,8 @@ redisSentinelConfig:
     secretName: ""
     secretKey: ""
   masterGroupName: ""
+  resolveHostnames: ""
+  announceHostnames: ""
   redisPort: ""
   quorum: ""
   parallelSyncs: ""

diff --git a/config/crd/bases/redis.redis.opstreelabs.in_redissentinels.yaml b/config/crd/bases/redis.redis.opstreelabs.in_redissentinels.yaml
@@ -2524,6 +2524,9 @@ spec:
                 properties:
                   additionalSentinelConfig:
                     type: string
+                  announceHostnames:
+                    default: "no"
+                    type: string
                   downAfterMilliseconds:
                     default: "30000"
                     type: string
@@ -2631,6 +2634,9 @@ spec:
                         type: object
                         x-kubernetes-map-type: atomic
                     type: object
+                  resolveHostnames:
+                    default: "no"
+                    type: string
                 required:
                 - redisReplicationName
                 type: object

diff --git a/docs/content/en/docs/CRD Reference/Redis API/_index.md b/docs/content/en/docs/CRD Reference/Redis API/_index.md
@@ -251,6 +251,8 @@ _Appears in:_
 | `parallelSyncs` _string_ |  |
 | `failoverTimeout` _string_ |  |
 | `downAfterMilliseconds` _string_ |  |
+| `resolveHostnames` _string_ |  |
+| `announceHostnames` _string_ |  |
 
 #### RedisExporter
 

diff --git a/docs/content/en/docs/Configuration/RedisReplication/_index.md b/docs/content/en/docs/Configuration/RedisReplication/_index.md
@@ -77,6 +77,8 @@ Redis replication configuration can be customized by [values.yaml](https://githu
 | redisSentinelConfig.redisReplicationName | string | `"redis-replication"` |  |
 | redisSentinelConfig.redisReplicationPassword.secretKey | string | `""` |  |
 | redisSentinelConfig.redisReplicationPassword.secretName | string | `""` |  |
+| redisSentinelConfig.resolveHostnames | string | `"no"` |  |
+| redisSentinelConfig.announceHostnames | string | `"no"` |  |
 | securityContext | object | `{}` |  |
 | serviceAccountName | string | `""` |  |
 | serviceMonitor.enabled | bool | `false` |  |

diff --git a/pkg/k8sutils/redis-sentinel.go b/pkg/k8sutils/redis-sentinel.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"errors"
+	"fmt"
 
 	redisv1beta2 "github.com/OT-CONTAINER-KIT/redis-operator/api/v1beta2"
 	"github.com/OT-CONTAINER-KIT/redis-operator/pkg/util"
@@ -258,14 +259,21 @@ func getSentinelEnvVariable(ctx context.Context, client kubernetes.Interface, cr
 		return &[]corev1.EnvVar{}
 	}
 
+	var IP string
+	if cr.Spec.RedisSentinelConfig.ResolveHostnames == "yes" {
+		IP = getRedisReplicationMasterName(ctx, client, cr, dcl)
+	} else {
+		IP = getRedisReplicationMasterIP(ctx, client, cr, dcl)
+	}
+
 	envVar := &[]corev1.EnvVar{
 		{
 			Name:  "MASTER_GROUP_NAME",
 			Value: cr.Spec.RedisSentinelConfig.MasterGroupName,
 		},
 		{
 			Name:  "IP",
-			Value: getRedisReplicationMasterIP(ctx, client, cr, dcl),
+			Value: IP,
 		},
 		{
 			Name:  "PORT",
@@ -287,6 +295,14 @@ func getSentinelEnvVariable(ctx context.Context, client kubernetes.Interface, cr
 			Name:  "FAILOVER_TIMEOUT",
 			Value: cr.Spec.RedisSentinelConfig.FailoverTimeout,
 		},
+		{
+			Name:  "RESOLVE_HOSTNAMES",
+			Value: cr.Spec.RedisSentinelConfig.ResolveHostnames,
+		},
+		{
+			Name:  "ANNOUNCE_HOSTNAMES",
+			Value: cr.Spec.RedisSentinelConfig.AnnounceHostnames,
+		},
 	}
 
 	if cr.Spec.RedisSentinelConfig != nil && cr.Spec.RedisSentinelConfig.RedisReplicationPassword != nil {
@@ -298,13 +314,18 @@ func getSentinelEnvVariable(ctx context.Context, client kubernetes.Interface, cr
 	return envVar
 }
 
-func getRedisReplicationMasterIP(ctx context.Context, client kubernetes.Interface, cr *redisv1beta2.RedisSentinel, dcl dynamic.Interface) string {
+func getRedisReplicationMasterPod(ctx context.Context, client kubernetes.Interface, cr *redisv1beta2.RedisSentinel, dcl dynamic.Interface) RedisDetails {
 	replicationName := cr.Spec.RedisSentinelConfig.RedisReplicationName
 	replicationNamespace := cr.Namespace
 
 	var replicationInstance redisv1beta2.RedisReplication
 	var realMasterPod string
 
+	emptyRedisInfo := RedisDetails{
+		PodName:   "",
+		Namespace: "",
+	}
+
 	// Get Request on Dynamic Client
 	customObject, err := dcl.Resource(schema.GroupVersionResource{
 		Group:    "redis.redis.opstreelabs.in",
@@ -314,7 +335,7 @@ func getRedisReplicationMasterIP(ctx context.Context, client kubernetes.Interfac
 
 	if err != nil {
 		log.FromContext(ctx).Error(err, "Failed to Execute Get Request", "replication name", replicationName, "namespace", replicationNamespace)
-		return ""
+		return emptyRedisInfo
 	} else {
 		log.FromContext(ctx).V(1).Info("Successfully Execute the Get Request", "replication name", replicationName, "namespace", replicationNamespace)
 	}
@@ -323,19 +344,19 @@ func getRedisReplicationMasterIP(ctx context.Context, client kubernetes.Interfac
 	replicationJSON, err := customObject.MarshalJSON()
 	if err != nil {
 		log.FromContext(ctx).Error(err, "Failed To Load JSON")
-		return ""
+		return emptyRedisInfo
 	}
 
 	// Unmarshal The JSON on Object
 	if err := json.Unmarshal(replicationJSON, &replicationInstance); err != nil {
 		log.FromContext(ctx).Error(err, "Failed To Unmarshal JSON over the Object")
-		return ""
+		return emptyRedisInfo
 	}
 
 	masterPods := GetRedisNodesByRole(ctx, client, &replicationInstance, "master")
 	if len(masterPods) == 0 {
 		log.FromContext(ctx).Error(errors.New("no master pods found"), "")
-		return ""
+		return emptyRedisInfo
 	}
 	for _, podName := range masterPods {
 		redisClient := configureRedisReplicationClient(ctx, client, &replicationInstance, podName)
@@ -348,12 +369,29 @@ func getRedisReplicationMasterIP(ctx context.Context, client kubernetes.Interfac
 	}
 	if realMasterPod == "" {
 		log.FromContext(ctx).Error(errors.New("no real master pod found"), "")
-		return ""
+		return emptyRedisInfo
 	}
 
-	realMasterInfo := RedisDetails{
+	return RedisDetails{
 		PodName:   realMasterPod,
 		Namespace: replicationNamespace,
 	}
-	return getRedisServerIP(ctx, client, realMasterInfo)
+}
+
+func getRedisReplicationMasterIP(ctx context.Context, client kubernetes.Interface, cr *redisv1beta2.RedisSentinel, dcl dynamic.Interface) string {
+	RedisDetails := getRedisReplicationMasterPod(ctx, client, cr, dcl)
+	if RedisDetails.PodName == "" || RedisDetails.Namespace == "" {
+		return ""
+	} else {
+		return getRedisServerIP(ctx, client, RedisDetails)
+	}
+}
+
+func getRedisReplicationMasterName(ctx context.Context, client kubernetes.Interface, cr *redisv1beta2.RedisSentinel, dcl dynamic.Interface) string {
+	RedisDetails := getRedisReplicationMasterPod(ctx, client, cr, dcl)
+	if RedisDetails.PodName == "" || RedisDetails.Namespace == "" {
+		return ""
+	} else {
+		return fmt.Sprintf("%s.%s-headless.%s.svc", RedisDetails.PodName, cr.Spec.RedisSentinelConfig.RedisReplicationName, RedisDetails.Namespace)
+	}
 }
diff --git a/pkg/k8sutils/redis-sentinel_test.go b/pkg/k8sutils/redis-sentinel_test.go
@@ -334,6 +334,8 @@ func Test_getSentinelEnvVariable(t *testing.T) {
 								DownAfterMilliseconds: "30000",
 								ParallelSyncs:         "1",
 								FailoverTimeout:       "180000",
+								ResolveHostnames:      "no",
+								AnnounceHostnames:     "no",
 							},
 						},
 					},
@@ -368,6 +370,14 @@ func Test_getSentinelEnvVariable(t *testing.T) {
 					Name:  "FAILOVER_TIMEOUT",
 					Value: "180000",
 				},
+				{
+					Name:  "RESOLVE_HOSTNAMES",
+					Value: "no",
+				},
+				{
+					Name:  "ANNOUNCE_HOSTNAMES",
+					Value: "no",
+				},
 			},
 		},
 	}