Refactor Redis url into servers in configuration (#494)

Author: JohnRoesler

cmd/chirpstack-application-server/cmd/configfile.go

@@ -84,27 +84,40 @@ max_idle_connections={{ .PostgreSQL.MaxIdleConnections }}
 #
 # Please note that Redis 2.6.0+ is required.
 [redis]
-# Redis url (e.g. redis://user:password@hostname/0)
+
+# Server address or addresses.
+#
+# Set multiple addresses when connecting to a cluster.
+servers=[{{ range $index, $elm := .Redis.Servers }}
+  "{{ $elm }}",{{ end }}
+]
+
+# Password.
 #
-# For more information about the Redis URL format, see:
-# https://www.iana.org/assignments/uri-schemes/prov/redis
-url="{{ .Redis.URL }}"
+# Set the password when connecting to Redis requires password authentication.
+password="{{ .Redis.Password }}"
+
+# Database index.
+#
+# By default, this can be a number between 0-15.
+database={{ .Redis.Database }}
+
 
 # Redis Cluster.
 #
-# Set this to true when the provided URL is pointing to a Redis Cluster
+# Set this to true when the provided URLs are pointing to a Redis Cluster
 # instance.
 cluster={{ .Redis.Cluster }}
 
-# The master name.
+# Master name.
 #
-# Set the master name when the provided URL is pointing to a Redis Sentinel
+# Set the master name when the provided URLs are pointing to a Redis Sentinel
 # instance.
 master_name="{{ .Redis.MasterName }}"
 
 # Connection pool size.
 #
-# Default is 10 connections per every CPU.
+# Default (when set to 0) is 10 connections per every CPU.
 pool_size={{ .Redis.PoolSize }}
 
 

cmd/chirpstack-application-server/cmd/root.go

@@ -9,6 +9,7 @@ import (
 	"time"
 
 	"github.com/brocaar/chirpstack-application-server/internal/config"
+	"github.com/go-redis/redis/v7"
 	"github.com/spf13/viper"
 
 	log "github.com/sirupsen/logrus"
@@ -40,7 +41,7 @@ func init() {
 	viper.SetDefault("postgresql.dsn", "postgres://localhost/chirpstack_as?sslmode=disable")
 	viper.SetDefault("postgresql.automigrate", true)
 	viper.SetDefault("postgresql.max_idle_connections", 2)
-	viper.SetDefault("redis.url", "redis://localhost:6379")
+	viper.SetDefault("redis.servers", []string{"localhost:6379"})
 	viper.SetDefault("application_server.api.public_host", "localhost:8001")
 	viper.SetDefault("application_server.id", "6d5db27e-4ce2-4b2b-b5d7-91f069397978")
 	viper.SetDefault("application_server.api.bind", "0.0.0.0:8001")
@@ -135,6 +136,17 @@ func initConfig() {
 	if config.C.ApplicationServer.Integration.Backend != "" {
 		config.C.ApplicationServer.Integration.Enabled = []string{config.C.ApplicationServer.Integration.Backend}
 	}
+
+	if config.C.Redis.URL != "" {
+		opt, err := redis.ParseURL(config.C.Redis.URL)
+		if err != nil {
+			log.WithError(err).Fatal("redis url error")
+		}
+
+		config.C.Redis.Servers = []string{opt.Addr}
+		config.C.Redis.Database = opt.DB
+		config.C.Redis.Password = opt.Password
+	}
 }
 
 func viperBindEnvs(iface interface{}, parts ...string) {

docker-compose.yml

@@ -15,7 +15,7 @@ services:
       - kafka
     environment:
       - TEST_POSTGRES_DSN=postgres://chirpstack_as:chirpstack_as@postgres/chirpstack_as?sslmode=disable
-      - TEST_REDIS_URL=redis://redis:6379
+      - TEST_REDIS_SERVERS=redis:6379
       - TEST_MQTT_SERVER=tcp://mosquitto:1883
       - TEST_RABBITMQ_URL=amqp://guest:guest@rabbitmq:5672/
       - TEST_KAFKA_BROKER=kafka:9092

docs/content/install/config.md

@@ -137,27 +137,40 @@ max_idle_connections=2
 #
 # Please note that Redis 2.6.0+ is required.
 [redis]
-# Redis url (e.g. redis://user:password@hostname/0)
+
+# Server address or addresses.
+#
+# Set multiple addresses when connecting to a cluster.
+servers=[
+  "localhost:6379",
+]
+
+# Password.
 #
-# For more information about the Redis URL format, see:
-# https://www.iana.org/assignments/uri-schemes/prov/redis
-url="redis://localhost:6379"
+# Set the password when connecting to Redis requires password authentication.
+password=""
+
+# Database index.
+#
+# By default, this can be a number between 0-15.
+database=0
+
 
 # Redis Cluster.
 #
-# Set this to true when the provided URL is pointing to a Redis Cluster
+# Set this to true when the provided URLs are pointing to a Redis Cluster
 # instance.
 cluster=false
 
-# The master name.
+# Master name.
 #
-# Set the master name when the provided URL is pointing to a Redis Sentinel
+# Set the master name when the provided URLs are pointing to a Redis Sentinel
 # instance.
 master_name=""
 
 # Connection pool size.
 #
-# Default is 10 connections per every CPU.
+# Default (when set to 0) is 10 connections per every CPU.
 pool_size=0
 
 

internal/config/config.go

@@ -20,10 +20,13 @@ type Config struct {
 	} `mapstructure:"postgresql"`
 
 	Redis struct {
-		URL        string `mapstructure:"url"`
-		Cluster    bool   `mapstructure:"cluster"`
-		MasterName string `mapstructure:"master_name"`
-		PoolSize   int    `mapstructure:"pool_size"`
+		URL        string   `mapstructure:"url"` // deprecated
+		Servers    []string `mapstructure:"servers"`
+		Cluster    bool     `mapstructure:"cluster"`
+		MasterName string   `mapstructure:"master_name"`
+		PoolSize   int      `mapstructure:"pool_size"`
+		Password   string   `mapstructure:"password"`
+		Database   int      `mapstructure:"database"`
 	} `mapstructure:"redis"`
 
 	ApplicationServer struct {

internal/storage/storage.go

@@ -57,27 +57,32 @@ func Setup(c config.Config) error {
 	)
 
 	log.Info("storage: setting up Redis client")
-	opt, err := redis.ParseURL(c.Redis.URL)
-	if err != nil {
-		return errors.Wrap(err, "parse redis url error")
+	if len(c.Redis.Servers) == 0 {
+		return errors.New("at least one redis server must be configured")
 	}
-	opt.PoolSize = c.Redis.PoolSize
+
 	if c.Redis.Cluster {
 		redisClient = redis.NewClusterClient(&redis.ClusterOptions{
-			Addrs:    []string{opt.Addr},
-			PoolSize: opt.PoolSize,
-			Password: opt.Password,
+			Addrs:    c.Redis.Servers,
+			PoolSize: c.Redis.PoolSize,
+			Password: c.Redis.Password,
 		})
 	} else if c.Redis.MasterName != "" {
 		redisClient = redis.NewFailoverClient(&redis.FailoverOptions{
 			MasterName:       c.Redis.MasterName,
-			SentinelAddrs:    []string{opt.Addr},
-			SentinelPassword: opt.Password,
-			DB:               opt.DB,
-			PoolSize:         opt.PoolSize,
+			SentinelAddrs:    c.Redis.Servers,
+			SentinelPassword: c.Redis.Password,
+			DB:               c.Redis.Database,
+			PoolSize:         c.Redis.PoolSize,
+			Password:         c.Redis.Password,
 		})
 	} else {
-		redisClient = redis.NewClient(opt)
+		redisClient = redis.NewClient(&redis.Options{
+			Addr:     c.Redis.Servers[0],
+			DB:       c.Redis.Database,
+			Password: c.Redis.Password,
+			PoolSize: c.Redis.PoolSize,
+		})
 	}
 
 	log.Info("storage: connecting to PostgreSQL database")

internal/test/test.go

@@ -2,6 +2,7 @@ package test
 
 import (
 	"os"
+	"strings"
 
 	"github.com/jmoiron/sqlx"
 	migrate "github.com/rubenv/sql-migrate"
@@ -23,7 +24,7 @@ func GetConfig() config.Config {
 	var c config.Config
 
 	c.PostgreSQL.DSN = "postgres://localhost/chirpstack_as_test?sslmode=disable"
-	c.Redis.URL = "redis://localhost:6379"
+	c.Redis.Servers = []string{"localhost:6379"}
 	c.ApplicationServer.Integration.MQTT.Server = "tcp://localhost:1883"
 	c.ApplicationServer.ID = "6d5db27e-4ce2-4b2b-b5d7-91f069397978"
 	c.ApplicationServer.Integration.AMQP.EventRoutingKeyTemplate = "application.{{ .ApplicationID }}.device.{{ .DevEUI }}.event.{{ .EventType }}"
@@ -34,8 +35,8 @@ func GetConfig() config.Config {
 		c.PostgreSQL.DSN = v
 	}
 
-	if v := os.Getenv("TEST_REDIS_URL"); v != "" {
-		c.Redis.URL = v
+	if v := os.Getenv("TEST_REDIS_SERVERS"); v != "" {
+		c.Redis.Servers = strings.Split(v, ",")
 	}
 
 	if v := os.Getenv("TEST_MQTT_SERVER"); v != "" {