Skip to content

Commit

Permalink
Compressing cached endpoints (#2048)
Browse files Browse the repository at this point in the history 
* Adding common compression block

* Compressing cached API

Signed-off-by: Rajesh Rajendran <[email protected]>
  • Loading branch information
@rjshrjndrn
rjshrjndrn authored Nov 20, 2020
1 parent 01e6296 commit 6a2670f
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 64 deletions.
2 changes: 2 additions & 0 deletions kubernetes/helm_charts/core/nginx-public-ingress/templates/configMap.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ metadata:
data:
proxy-default.conf: |
{{ .Values.proxyconfig | indent 4 }}
compression.conf: |
{{ .Values.compressionConfig | indent 4 }}

---
apiVersion: v1
Expand Down
130 changes: 66 additions & 64 deletions kubernetes/helm_charts/core/nginx-public-ingress/values.j2
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,11 @@ proxyconfig: |-
}
# This is Caching mechanism for POST requests location search
location ~ /learner/data/v1/location/search {
# Enabling compression
include /etc/nginx/defaults.d/compression.conf;
# Enabling caching
proxy_cache_key "$request_uri|$request_body";
# caching include Accept-Encoding header also, to provide gziped or plain content as per request
proxy_cache_key "$http_accept_encoding|$request_uri|$request_body";
proxy_cache framework_cache;
add_header X-Proxy-Cache $upstream_cache_status;
add_header X-Proxy-Cache-Date $upstream_http_date;
Expand All @@ -210,8 +213,11 @@ proxyconfig: |-
}
# Caching for content consumption
location ~ /api/(content/v1/read|course/v1/hierarchy) {
# Enabling compression
include /etc/nginx/defaults.d/compression.conf;
# Enabling caching
proxy_cache_key "$request_uri|$request_body";
# caching include Accept-Encoding header also, to provide gziped or plain content as per request
proxy_cache_key "$http_accept_encoding|$request_uri|$request_body";
proxy_cache content_cache;
add_header X-Proxy-Cache $upstream_cache_status;
add_header X-Proxy-Cache-Date $upstream_http_date;
Expand All @@ -237,8 +243,11 @@ proxyconfig: |-
}
# This is Caching mechanism for Content search
location ~ /api/content/v1/search {
# Enabling compression
include /etc/nginx/defaults.d/compression.conf;
# Enabling caching
proxy_cache_key "$request_uri|$request_body";
# caching include Accept-Encoding header also, to provide gziped or plain content as per request
proxy_cache_key "$http_accept_encoding|$request_uri|$request_body";
proxy_cache content_cache;
add_header X-Proxy-Cache $upstream_cache_status;
add_header X-Proxy-Cache-Date $upstream_http_date;
Expand All @@ -264,8 +273,11 @@ proxyconfig: |-
}
# This is Caching mechanism for POST requests
location ~ /api/org/v1/search|/api/data/v1/(form/read|location/search) {
# Enabling compression
include /etc/nginx/defaults.d/compression.conf;
# Enabling caching
proxy_cache_key "$request_uri|$request_body";
# caching include Accept-Encoding header also, to provide gziped or plain content as per request
proxy_cache_key "$http_accept_encoding|$request_uri|$request_body";
proxy_cache framework_cache;
add_header X-Proxy-Cache $upstream_cache_status;
add_header X-Proxy-Cache-Date $upstream_http_date;
Expand All @@ -289,8 +301,11 @@ proxyconfig: |-
proxy_pass http://kong;
}
location ~ /api/(framework/v1/read|data/v1/system/settings/get) {
# Enabling compression
include /etc/nginx/defaults.d/compression.conf;
# Enabling caching
proxy_cache_key $proxy_host$request_uri;
# caching include Accept-Encoding header also, to provide gziped or plain content as per request
proxy_cache_key "$http_accept_encoding|$request_uri|$request_body";
proxy_cache framework_cache;
add_header X-Proxy-Cache $upstream_cache_status;
add_header X-Proxy-Cache-Date $upstream_http_date;
Expand Down Expand Up @@ -327,34 +342,7 @@ proxyconfig: |-
if ( $http_authorization ) {
set $custom_header "$http_authorization";
}
# Compression
gzip on;
gzip_comp_level 5;
gzip_min_length 256; # 256Bytes
gzip_proxied any;
gzip_vary on;
# Content types for compression
gzip_types
application/atom+xml
application/javascript
application/json
application/ld+json
application/manifest+json
application/rss+xml
application/vnd.geo+json
application/vnd.ms-fontobject
application/x-font-ttf
application/x-web-app-manifest+json
application/xhtml+xml
application/xml
font/opentype
image/bmp
image/svg+xml
image/x-icon
text/cache-manifest
text/css
text/plain
#
include /etc/nginx/defaults.d/compression.conf;
proxy_set_header Authorization $custom_header;
rewrite ^/api/(.*) /$1 break;
proxy_set_header Connection "";
Expand Down Expand Up @@ -737,34 +725,7 @@ proxyconfig: |-
# compression for svg certs download
location /api/certreg/v2/certs/download {
rewrite ^/api/(.*) /$1 break;
# Compression
gzip on;
gzip_comp_level 5;
gzip_min_length 50000; # 50KB
gzip_proxied any;
gzip_vary on;
# Content types for compression
gzip_types
application/atom+xml
application/javascript
application/json
application/ld+json
application/manifest+json
application/rss+xml
application/vnd.geo+json
application/vnd.ms-fontobject
application/x-font-ttf
application/x-web-app-manifest+json
application/xhtml+xml
application/xml
font/opentype
image/bmp
image/svg+xml
image/x-icon
text/cache-manifest
text/css
text/plain
add_header test hello;
include /etc/nginx/defaults.d/compression.conf;
proxy_set_header Connection "";
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
Expand Down Expand Up @@ -859,7 +820,11 @@ proxyconfig: |-
proxy_read_timeout 70;
}
location ~ /resourcebundles/v1/read|/learner/data/v1/(role/read|system/settings/get)|/v1/tenant/info {
proxy_cache_key $proxy_host$request_uri;
# Enabling compression
include /etc/nginx/defaults.d/compression.conf;
# Enabling caching
# caching include Accept-Encoding header also, to provide gziped or plain content as per request
proxy_cache_key "$http_accept_encoding|$request_uri|$request_body";
proxy_cache framework_cache;
add_header X-Proxy-Cache $upstream_cache_status;
add_header X-Proxy-Cache-Date $upstream_http_date;
Expand All @@ -877,7 +842,11 @@ proxyconfig: |-
proxy_pass http://player;
}
location /api/channel/v1/read {
proxy_cache_key $proxy_host$request_uri;
# Enabling compression
include /etc/nginx/defaults.d/compression.conf;
# Enabling caching
# caching include Accept-Encoding header also, to provide gziped or plain content as per request
proxy_cache_key "$http_accept_encoding|$request_uri|$request_body";
proxy_cache framework_cache;
add_header X-Proxy-Cache $upstream_cache_status;
add_header X-Proxy-Cache-Date $upstream_http_date;
Expand Down Expand Up @@ -1126,8 +1095,11 @@ keycloakconf: |
}
# Static Assets for keycloak endpoints with caching
location ~ /auth/(resources/(.+\.(png|svg|ico|js|eot|ttf|woff|woff2|css))|welcome-content/(.+\.(png|svg|ico|js|eot|ttf|woff|woff2|css))) {
# Enabling compression
include /etc/nginx/defaults.d/compression.conf;
# Enabling caching
proxy_cache_key $proxy_host$request_uri;
# caching include Accept-Encoding header also, to provide gziped or plain content as per request
proxy_cache_key "$http_accept_encoding|$request_uri|$request_body";
proxy_cache proxy_cache;
add_header X-Proxy-Cache $upstream_cache_status;
add_header X-Proxy-Cache-Date $upstream_http_date;
Expand Down Expand Up @@ -1164,6 +1136,36 @@ keycloakconf: |
}
}

compressionConfig: |-
# Compression
gzip on;
gzip_comp_level 5;
gzip_min_length 256; # 256Bytes
gzip_proxied any;
gzip_vary on;
# Content types for compression
gzip_types
application/atom+xml
application/javascript
application/json
application/ld+json
application/manifest+json
application/rss+xml
application/vnd.geo+json
application/vnd.ms-fontobject
application/x-font-ttf
application/x-web-app-manifest+json
application/xhtml+xml
application/xml
font/opentype
image/bmp
image/svg+xml
image/x-icon
text/cache-manifest
text/css
text/plain
;

serviceMonitor:
enabled: true
labels: # labels with which the prometheus choose the serviceMonitor
Expand Down

0 comments on commit 6a2670f

Please sign in to comment.