feat: add configurable redis timeouts

Makefile

@@ -16,6 +16,9 @@ GOTEST_ARGS ?= -short
 
 OPENWRT_DEVICE ?= 192.168.1.1
 
+SIEGE_URLS_FILE ?= misc/siege/urls.txt
+SIEGE_CONCURRENCY ?= 100
+
 watch: tools/modd/bin/modd deps ## Watching updated files - live reload
 	( set -o allexport && source .env && set +o allexport && tools/modd/bin/modd )
 
@@ -105,7 +108,10 @@ grafterm: tools/grafterm/bin/grafterm
 	tools/grafterm/bin/grafterm -c ./misc/grafterm/dashboard.json -v job=bouncer-proxy -r 5s
 
 siege:
-	siege -i -c 100 -f ./misc/siege/urls.txt
+	$(eval TMP := $(shell mktemp))
+	cat $(SIEGE_URLS_FILE) | envsubst > $(TMP)
+	siege -i -b -c $(SIEGE_CONCURRENCY) -f $(TMP)
+	rm -rf $(TMP)
 
 tools/gitea-release/bin/gitea-release.sh:
 	mkdir -p tools/gitea-release/bin

internal/config/redis.go

@@ -1,5 +1,7 @@
 package config
 
+import "time"
+
 const (
 	RedisModeSimple   = "simple"
 	RedisModeSentinel = "sentinel"
@@ -7,13 +9,19 @@ const (
 )
 
 type RedisConfig struct {
-	Adresses InterpolatedStringSlice `yaml:"addresses"`
+	Adresses     InterpolatedStringSlice `yaml:"addresses"`
-	Master   InterpolatedString      `yaml:"master"`
+	Master       InterpolatedString      `yaml:"master"`
+	ReadTimeout  InterpolatedDuration    `yaml:"readTimeout"`
+	WriteTimeout InterpolatedDuration    `yaml:"writeTimeout"`
+	DialTimeout  InterpolatedDuration    `yaml:"dialTimeout"`
 }
 
 func NewDefaultRedisConfig() RedisConfig {
 	return RedisConfig{
-		Adresses: InterpolatedStringSlice{"localhost:6379"},
+		Adresses:     InterpolatedStringSlice{"localhost:6379"},
-		Master:   "",
+		Master:       "",
+		ReadTimeout:  InterpolatedDuration(30 * time.Second),
+		WriteTimeout: InterpolatedDuration(30 * time.Second),
+		DialTimeout:  InterpolatedDuration(30 * time.Second),
 	}
 }

internal/jwk/jwk.go

@@ -4,7 +4,6 @@ import (
 	"crypto/rand"
 	"crypto/rsa"
 	"encoding/json"
-	"io/ioutil"
 	"os"
 
 	"github.com/btcsuite/btcd/btcutil/base58"
@@ -56,7 +55,7 @@ func PublicKeySet(keys ...jwk.Key) (jwk.Set, error) {
 }
 
 func LoadOrGenerate(path string, size int) (jwk.Key, error) {
-	data, err := ioutil.ReadFile(path)
+	data, err := os.ReadFile(path)
 	if err != nil && !errors.Is(err, os.ErrNotExist) {
 		return nil, errors.WithStack(err)
 	}
@@ -72,7 +71,7 @@ func LoadOrGenerate(path string, size int) (jwk.Key, error) {
 			return nil, errors.WithStack(err)
 		}
 
-		if err := ioutil.WriteFile(path, data, 0o640); err != nil {
+		if err := os.WriteFile(path, data, 0o640); err != nil {
 			return nil, errors.WithStack(err)
 		}
 	}

internal/setup/proxy_repository.go

@@ -10,11 +10,7 @@ import (
 )
 
 func NewProxyRepository(ctx context.Context, conf config.RedisConfig) (store.ProxyRepository, error) {
-	rdb := redis.NewUniversalClient(&redis.UniversalOptions{
+	rdb := newRedisClient(conf)
-		Addrs:      conf.Adresses,
-		MasterName: string(conf.Master),
-	})
-
 	return redisStore.NewProxyRepository(rdb), nil
 }
 

internal/setup/queue_layer.go

@@ -8,7 +8,6 @@ import (
 	"forge.cadoles.com/cadoles/bouncer/internal/proxy/director/layer/queue"
 	queueRedis "forge.cadoles.com/cadoles/bouncer/internal/proxy/director/layer/queue/redis"
 	"github.com/pkg/errors"
-	"github.com/redis/go-redis/v9"
 )
 
 func init() {
@@ -36,10 +35,6 @@ func setupQueueLayer(conf *config.Config) (director.Layer, error) {
 }
 
 func newQueueAdapter(redisConf config.RedisConfig) (queue.Adapter, error) {
-	rdb := redis.NewUniversalClient(&redis.UniversalOptions{
+	rdb := newRedisClient(redisConf)
-		Addrs:      redisConf.Adresses,
-		MasterName: string(redisConf.Master),
-	})
-
 	return queueRedis.NewAdapter(rdb, 2), nil
 }

internal/setup/redis.go

@@ -0,0 +1,20 @@
+package setup
+
+import (
+	"time"
+
+	"forge.cadoles.com/cadoles/bouncer/internal/config"
+	"github.com/redis/go-redis/v9"
+)
+
+func newRedisClient(conf config.RedisConfig) redis.UniversalClient {
+	return redis.NewUniversalClient(&redis.UniversalOptions{
+		Addrs:                 conf.Adresses,
+		MasterName:            string(conf.Master),
+		ReadTimeout:           time.Duration(conf.ReadTimeout),
+		WriteTimeout:          time.Duration(conf.WriteTimeout),
+		DialTimeout:           time.Duration(conf.DialTimeout),
+		RouteByLatency:        true,
+		ContextTimeoutEnabled: true,
+	})
+}

misc/k8s/README.md

@@ -0,0 +1,53 @@
+# Kubernetes
+
+## Getting started with Kind
+
+1. Create your [Kind](https://kind.sigs.k8s.io/) cluster
+
+    ```shell
+    kind create cluster --config misc/k8s/kind/bouncer-cluster.yaml
+    ```
+
+2. Deploy required operators
+
+    ```shell
+    kubectl apply -k misc/k8s/kind/cluster --server-side
+    ```
+
+3. Deploy your Bouncer development environment
+
+    ```shell
+    skaffold dev -p dev --cleanup=false --default-repo reg.cadoles.com/<YOUR_PERSONNAL_USER_NAME>
+    ```
+
+## Testing
+
+1. Open shell in bouncer-admin pod
+
+    ```shell
+    kubectl exec -it -n bouncer-dev bouncer-admin-<suffix> -- /bin/sh
+    ```
+
+2. Create an authentication token
+
+    ```shell
+    bouncer auth create-token > .bouncer-token
+    ```
+
+3. Create a proxy and enable it
+
+    ```shell
+    bouncer admin proxy create --proxy-to https://www.cadoles.com --proxy-name cadoles
+    bouncer admin proxy update --proxy-name cadoles --proxy-enabled=true
+    ```
+
+4. With you host web browser, open http://localhost:9000, you should see the Cadoles website.
+
+## Benchmarking
+
+You can use [`siege`](https://github.com/JoeDog/siege) to benchmark your instance with the Cadoles proxy.
+
+```shell
+BASE_URL=http://localhost:9000 make siege 
+```
+

misc/k8s/kind/bouncer-cluster.yaml

@@ -0,0 +1,3 @@
+kind: Cluster
+apiVersion: kind.x-k8s.io/v1alpha4
+name: bouncer-dev

misc/k8s/kind/cluster/kustomization.yaml

@@ -0,0 +1,5 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+
+resources:
+- https://forge.cadoles.com/CadolesKube/c-kustom//base/redis?ref=develop

misc/k8s/kustomization/base/resources/bouncer-admin/files/config.yml

@@ -28,9 +28,9 @@ admin:
 
 redis:
   addresses:
-  - ${REDIS_SENTINEL_HOST}:${REDIS_SENTINEL_PORT}
+  - rfs-bouncer-redis:${RFS_BOUNCER_REDIS_SERVICE_PORT}
-  master: "${REDIS_MASTER_NAME}"
+  master: mymaster
 
 logger:
-  level: 3
+  level: 2
   format: human

misc/k8s/kustomization/base/resources/bouncer-admin/kustomization.yaml

@@ -10,8 +10,3 @@ configMapGenerator:
   files:
   - ./files/config.yml
   - ./files/admin-key.json
-- name: bouncer-admin-env
-  literals:
-  - REDIS_SENTINEL_HOST="rfs-$(REDIS_SERVICE_NAME)"
-  - REDIS_SENTINEL_PORT="26379"
-  - REDIS_MASTER_NAME="mymaster"

misc/k8s/kustomization/base/resources/bouncer-admin/resources/deployment.yaml

@@ -19,15 +19,9 @@ spec:
       containers:
       - name: bouncer-admin
         image: reg.cadoles.com/cadoles/bouncer:v2024.2.5-1602626
-        command: ["bouncer"]
+        command: ["bouncer", "--debug", "-c", "/etc/bouncer/config.yml", "server", "admin", "run"]
-        args: ["--debug", "-c", "/etc/bouncer/config.yml", "server", "admin", "run"]
         imagePullPolicy: Always
-        envFrom:
+        resources: {}
-        - configMapRef:
-            name: bouncer-admin-env
-        env:
-        - name: REDIS_SENTINEL_HOST
-          value: "rfs-$(REDIS_SERVICE_NAME)"
         ports:
         - name: bouncer-admin
           containerPort: 8081

misc/k8s/kustomization/base/resources/bouncer-admin/resources/service.yaml

@@ -9,6 +9,6 @@ spec:
   ports:
   - name: bouncer-admin
     port: 8081
-    targetPort: 8080
+    targetPort: bouncer-admin
   selector:
     io.kompose.service: bouncer-admin

misc/k8s/kustomization/base/resources/bouncer-server/files/config.yml

@@ -14,9 +14,9 @@ layers:
 
 redis:
   addresses:
-  - ${RFS_BOUNCER_REDIS_SERVICE_HOST}:${RFS_BOUNCER_REDIS_SERVICE_PORT}
+  - rfs-bouncer-redis:${RFS_BOUNCER_REDIS_SERVICE_PORT}
-  master: "${REDIS_MASTER_NAME}"
+  master: mymaster
 
 logger:
-  level: 3
+  level: 2
   format: human

misc/k8s/kustomization/base/resources/bouncer-server/resources/deployment.yaml

@@ -21,6 +21,7 @@ spec:
         image: reg.cadoles.com/cadoles/bouncer:v2024.2.5-1602626
         command: ["bouncer", "-c", "/etc/bouncer/config.yml", "server", "proxy", "run"]
         imagePullPolicy: Always
+        resources: {}
         ports:
         - name: bouncer-server
           containerPort: 8080

misc/k8s/kustomization/base/resources/bouncer-server/resources/service.yaml

@@ -9,6 +9,6 @@ spec:
   ports:
   - name: bouncer-server
     port: 8080
-    targetPort: 8080
+    targetPort: bouncer-server
   selector:
     io.kompose.service: bouncer-server

misc/packaging/common/config.yml

@@ -147,6 +147,9 @@ redis:
   addresses:
   - localhost:6379
   master: ""
+  writeTimeout: 30s
+  readTimeout: 30s
+  dialTimeout: 30s
 
 # Configuration des logs
 logger:

misc/siege/urls.txt

@@ -1,6 +1,6 @@
-http://localhost:8080/blog/
+${BASE_URL}/blog/
-http://localhost:8080/services/
+${BASE_URL}/services/
-http://localhost:8080/
+${BASE_URL}
-http://localhost:8080/recrutement/
+${BASE_URL}/recrutement/
-http://localhost:8080/faq/
+${BASE_URL}/faq/
-http://localhost:8080/societe/histoire/
+${BASE_URL}/societe/histoire/

skaffold.yaml

@@ -33,8 +33,7 @@ build:
       - cmd/**
       - internal/**
       - layers/**
-      - tools/**
+      - misc/**
-      - data/**
     docker:
       dockerfile: Dockerfile
 
@@ -42,7 +41,7 @@ deploy:
   statusCheckDeadlineSeconds: 600
 
 portForward:
-- resourceType: deployment
+- resourceType: service
   resourceName: bouncer-admin
   namespace: bouncer-dev
   port: 8081