feat: adding ratelimiting parameters (#74)

Author: kevin90n

charts/nidhogg/README.md

@@ -12,6 +12,7 @@ A Helm chart for Kubernetes
 |-----|------|---------|-------------|
 | affinity | object | `{}` |  |
 | configuration | object | `{"taintRemovalDelayInSeconds":5}` | Configuration for nidhogg |
+| extraArgs | object | `{}` |  |
 | extraLabels | object | `{}` |  |
 | fullnameOverride | string | `""` |  |
 | image.pullPolicy | string | `"IfNotPresent"` |  |

charts/nidhogg/templates/statefulset.yaml

@@ -44,6 +44,9 @@ spec:
             - --leader-election
             - --leader-namespace={{ $.Release.Namespace }}
             - --leader-configmap=nidhogg-election
+          {{- range $key, $value := .Values.extraArgs }}
+            - --{{ $key }}={{ $value }}
+          {{- end }}
           env:
             - name: POD_NAMESPACE
               valueFrom:

charts/nidhogg/values.yaml

@@ -84,3 +84,8 @@ nodeSelector: {}
 tolerations: []
 
 affinity: {}
+
+extraArgs: {}
+#  kube-api-qps: 20
+#  kube-api-burst: 30
+#  disable-compression: true

cmd/manager/main.go

@@ -35,11 +35,14 @@ import (
 )
 
 var (
-	metricsAddr     string
-	configPath      string
-	leaderElection  bool
-	leaderConfigMap string
-	leaderNamespace string
+	metricsAddr        string
+	configPath         string
+	leaderElection     bool
+	leaderConfigMap    string
+	leaderNamespace    string
+	clientRequestQPS   float64
+	clientRequestBurst int
+	disableCompression bool
 )
 
 func main() {
@@ -49,6 +52,9 @@ func main() {
 	flag.BoolVar(&leaderElection, "leader-election", false, "enable leader election")
 	flag.StringVar(&leaderConfigMap, "leader-configmap", "", "Name of configmap to use for leader election")
 	flag.StringVar(&leaderNamespace, "leader-namespace", "", "Namespace where leader configmap located")
+	flag.Float64Var(&clientRequestQPS, "kube-api-qps", 20.0, "QPS rate for throttling requests sent to the Kubernetes API server")
+	flag.IntVar(&clientRequestBurst, "kube-api-burst", 30, "Maximum burst for throttling requests sent to the Kubernetes API server")
+	flag.BoolVar(&disableCompression, "disable-compression", true, "Disable response compression for k8s restAPI in client-go")
 	flag.Parse()
 	logf.SetLogger(zap.New())
 	log := logf.Log.WithName("entrypoint")
@@ -68,6 +74,9 @@ func main() {
 	// Get a config to talk to the apiserver
 	log.Info("setting up client for manager")
 	cfg, err := config.GetConfig()
+	cfg.QPS = float32(clientRequestQPS)
+	cfg.Burst = clientRequestBurst
+	cfg.DisableCompression = disableCompression
 	if err != nil {
 		log.Error(err, "unable to set up client config")
 		os.Exit(1)

docs/README.md

@@ -100,5 +100,11 @@ We publish a helm chart to https://ghcr.io/pelotech/charts/nidhogg
     The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster.
 -metrics-addr string
     The address the metric endpoint binds to. (default ":8080")
+-kube-api-qps float
+    QPS rate for throttling requests sent to the Kubernetes API server (default 20)
+-kube-api-burst int
+    Maximum burst for throttling requests sent to the Kubernetes API server (default 30)
+-disable-compression bool
+    Disable response compression for k8s restAPI in client-go (default true)
 ```