option to use nginx cache

cost-analyzer/templates/cost-analyzer-frontend-config-map-template.yaml

@@ -51,6 +51,35 @@ data:
         text/x-component
         text/x-cross-domain-policy;
 
+    {{- if (.Values.kubecostFrontend.cache).enabled -}}
+    # this is the name of the cache
+    proxy_cache kubecost_cache;
+    # this is the path where the cache will be stored
+    proxy_cache_path {{ (.Values.kubecostFrontend.cache).proxyCachePath }};
+    # this is the key that will be used to identify the cache
+    proxy_cache_key "$request_method|$host|$request_uri|$is_args$args";
+    # this is the time to live for the cache
+    proxy_cache_valid 200 {{ (.Values.kubecostFrontend.cache).cacheTTL }};
+    proxy_cache_valid any 10m;
+    # this allows Nginx to ignore the headers that are set by the upstream server
+    proxy_ignore_headers Expires Cache-Control X-Accel-Expires Set-Cookie;
+    # only cache GET and POST requests
+    proxy_cache_methods {{ (.Values.kubecostFrontend.cache).proxyCacheMethods }};
+    # this allows Nginx to try the next upstream server in case of an error on the current one
+    proxy_next_upstream error timeout invalid_header http_500 http_502 http_503 http_504;
+    add_header X-Cache-Status $upstream_cache_status;
+    add_header X-Upstream-Server $upstream_addr;
+    # this allows Nginx to serve stale cached content in various error scenarios or when the upstream server is having issues
+    proxy_cache_use_stale error timeout updating http_500 http_502 http_503 http_504;
+    proxy_cache_revalidate on;
+    proxy_cache_background_update on;
+
+    log_format  cache_status  '$remote_addr - $remote_user [$time_local] "$request" '
+                      '$status $body_bytes_sent "$http_referer" $bytes_sent "$http_referer" '
+                      '"$http_user_agent" "$http_x_forwarded_for" "$upstream_cache_status"';
+    access_log /var/log/nginx/access.log cache_status;
+    {{- end }}
+
     upstream api {
 {{- if .Values.kubecostFrontend.useDefaultFqdn }}
         server {{ $serviceName }}.{{ .Release.Namespace }}.svc.cluster.local:9001;
@@ -128,6 +157,10 @@ data:
         server {{ .Release.Name }}-aggregator.{{ .Release.Namespace }}:9004;
         {{- end }}
         {{- end }}
+        {{- if (.Values.kubecostFrontend.aggregatorFailoverSvc) -}}
+        # this allows Nginx to try the next upstream server in case of an error on the primary
+        server {{ .Values.kubecostFrontend.aggregatorFailoverSvc }} backup;
+        {{- end }}
     }
     upstream cloudCost {
         {{- if .Values.kubecostFrontend.useDefaultFqdn }}

cost-analyzer/values.yaml

@@ -487,6 +487,19 @@ kubecostFrontend:
 #  clusterController:
 #    fqdn: cluster-controller.kubecost.svc.cluster.local:9731
 
+# Cache configuration
+# caching is experimental and only supported with Kubecost Enterprise
+  cache:
+    enabled: false
+    cacheSize: 2000m
+    cacheTTL: 1h
+    proxyCachePath: "/tmp/cache levels=1:2:2 keys_zone=kubecost_cache:2g max_size=10g inactive=6h use_temp_path=off"
+    proxyCacheMethods: "GET POST HEAD"
+
+# aggregatorFailoverSvc is experimental and only supported with Kubecost Enterprise
+# location of the aggregator service to use as a failover
+  # aggregatorFailoverSvc: kubecost2-aggregator.kubecost2.svc.cluster.local:9004
+
 # Kubecost Metrics deploys a separate pod which will emit kubernetes specific metrics required
 # by the cost-model. This pod is designed to remain active and decoupled from the cost-model itself.
 # However, disabling this service/pod deployment will flag the cost-model to emit the metrics instead.