Merge pull request #234 from logdnalf/master

Add support for custom command renaming in Redis.
spotahome · Feb 5, 2020 · 09f3dc8 · 09f3dc8
2 parents e9c5dea + 19542b3
commit 09f3dc8
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 26 deletions.
diff --git a/api/redisfailover/v1/types.go b/api/redisfailover/v1/types.go
@@ -23,26 +23,33 @@ type RedisFailoverSpec struct {
 	LabelWhitelist []string         `json:"labelWhitelist,omitempty"`
 }
 
+// RedisCommandRename defines the specification of a "rename-command" configuration option
+type RedisCommandRename struct {
+	From string `json:"from,omitempty"`
+	To   string `json:"to,omitempty"`
+}
+
 // RedisSettings defines the specification of the redis cluster
 type RedisSettings struct {
-	Image              string                        `json:"image,omitempty"`
-	ImagePullPolicy    corev1.PullPolicy             `json:"imagePullPolicy,omitempty"`
-	Replicas           int32                         `json:"replicas,omitempty"`
-	Resources          corev1.ResourceRequirements   `json:"resources,omitempty"`
-	CustomConfig       []string                      `json:"customConfig,omitempty"`
-	Command            []string                      `json:"command,omitempty"`
-	ShutdownConfigMap  string                        `json:"shutdownConfigMap,omitempty"`
-	Storage            RedisStorage                  `json:"storage,omitempty"`
-	Exporter           RedisExporter                 `json:"exporter,omitempty"`
-	Affinity           *corev1.Affinity              `json:"affinity,omitempty"`
-	SecurityContext    *corev1.PodSecurityContext    `json:"securityContext,omitempty"`
-	ImagePullSecrets   []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"`
-	Tolerations        []corev1.Toleration           `json:"tolerations,omitempty"`
-	NodeSelector       map[string]string             `json:"nodeSelector,omitempty"`
-	PodAnnotations     map[string]string             `json:"podAnnotations,omitempty"`
-	ServiceAnnotations map[string]string             `json:"serviceAnnotations,omitempty"`
-	HostNetwork        bool                          `json:"hostNetwork,omitempty"`
-	DNSPolicy          corev1.DNSPolicy              `json:"dnsPolicy,omitempty"`
+	Image                string                        `json:"image,omitempty"`
+	ImagePullPolicy      corev1.PullPolicy             `json:"imagePullPolicy,omitempty"`
+	Replicas             int32                         `json:"replicas,omitempty"`
+	Resources            corev1.ResourceRequirements   `json:"resources,omitempty"`
+	CustomConfig         []string                      `json:"customConfig,omitempty"`
+	CustomCommandRenames []RedisCommandRename          `json:"customCommandRenames,omitempty"`
+	Command              []string                      `json:"command,omitempty"`
+	ShutdownConfigMap    string                        `json:"shutdownConfigMap,omitempty"`
+	Storage              RedisStorage                  `json:"storage,omitempty"`
+	Exporter             RedisExporter                 `json:"exporter,omitempty"`
+	Affinity             *corev1.Affinity              `json:"affinity,omitempty"`
+	SecurityContext      *corev1.PodSecurityContext    `json:"securityContext,omitempty"`
+	ImagePullSecrets     []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"`
+	Tolerations          []corev1.Toleration           `json:"tolerations,omitempty"`
+	NodeSelector         map[string]string             `json:"nodeSelector,omitempty"`
+	PodAnnotations       map[string]string             `json:"podAnnotations,omitempty"`
+	ServiceAnnotations   map[string]string             `json:"serviceAnnotations,omitempty"`
+	HostNetwork          bool                          `json:"hostNetwork,omitempty"`
+	DNSPolicy            corev1.DNSPolicy              `json:"dnsPolicy,omitempty"`
 }
 
 // SentinelSettings defines the specification of the sentinel cluster

diff --git a/example/redisfailover/custom-renames.yaml b/example/redisfailover/custom-renames.yaml
@@ -0,0 +1,16 @@
+apiVersion: databases.spotahome.com/v1
+kind: RedisFailover
+metadata:
+  name: redisfailover
+spec:
+  sentinel:
+    replicas: 3
+  redis:
+    replicas: 3
+    customCommandRenames:
+      - from: "monitor"
+        to: ""
+      - from: "flushall"
+        to: "fa"
+      - from: flushdb
+        to: xxfd
diff --git a/operator/redisfailover/service/client.go b/operator/redisfailover/service/client.go
@@ -76,7 +76,7 @@ func (r *RedisFailoverKubeClient) EnsureRedisStatefulset(rf *redisfailoverv1.Red
 	return r.K8SService.CreateOrUpdateStatefulSet(rf.Namespace, ss)
 }
 
-// EnsureRedisConfigMap makes sure the sentinel configmap exists
+// EnsureRedisConfigMap makes sure the Redis ConfigMap exists
 func (r *RedisFailoverKubeClient) EnsureRedisConfigMap(rf *redisfailoverv1.RedisFailover, labels map[string]string, ownerRefs []metav1.OwnerReference) error {
 
 	password, err := k8s.GetRedisPassword(r.K8SService, rf)

diff --git a/operator/redisfailover/service/generator.go b/operator/redisfailover/service/generator.go
@@ -10,13 +10,24 @@ import (
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/util/intstr"
+	"bytes"
 
 	redisfailoverv1 "github.com/spotahome/redis-operator/api/redisfailover/v1"
 	"github.com/spotahome/redis-operator/operator/redisfailover/util"
+	"text/template"
 )
 
 const (
 	redisConfigurationVolumeName         = "redis-config"
+	// Template used to build the Redis configuration
+	redisConfigTemplate = `slaveof 127.0.0.1 6379
+tcp-keepalive 60
+save 900 1
+save 300 10
+{{- range .Spec.Redis.CustomCommandRenames}}
+rename-command "{{.From}}" "{{.To}}"
+{{- end}}
+`
 	redisShutdownConfigurationVolumeName = "redis-shutdown-config"
 	redisReadinessVolumeName             = "redis-readiness-config"
 	redisStorageVolumeName               = "redis-data"
@@ -115,13 +126,19 @@ sentinel parallel-syncs mymaster 2`
 
 func generateRedisConfigMap(rf *redisfailoverv1.RedisFailover, labels map[string]string, ownerRefs []metav1.OwnerReference, password string) *corev1.ConfigMap {
 	name := GetRedisName(rf)
-	namespace := rf.Namespace
-
 	labels = util.MergeLabels(labels, generateSelectorLabels(redisRoleName, rf.Name))
-	redisConfigFileContent := `slaveof 127.0.0.1 6379
-tcp-keepalive 60
-save 900 1
-save 300 10`
+
+	tmpl, err := template.New("redis").Parse(redisConfigTemplate)
+	if err != nil {
+		panic(err)
+	}
+
+	var tplOutput bytes.Buffer
+	if err := tmpl.Execute(&tplOutput, rf); err != nil {
+		panic(err)
+	}
+
+	redisConfigFileContent := tplOutput.String()
 
 	if password != "" {
 		redisConfigFileContent = fmt.Sprintf("%s\nmasterauth %s\nrequirepass %s", redisConfigFileContent, password, password)
@@ -130,7 +147,7 @@ save 300 10`
 	return &corev1.ConfigMap{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:            name,
-			Namespace:       namespace,
+			Namespace:       rf.Namespace,
 			Labels:          labels,
 			OwnerReferences: ownerRefs,
 		},