feat(entrypoint): add support for slow caching tier (#31)

Allow caching of specified targets to a separate caching location

URIs are provided in nginx regex location format and semi-colon separate in env var e.g `SLOW_TIER_URIS="~^/v2/coreweave/(.*);~^/v2/nvidia/(.+)"`

Author: ChandonPierre

Dockerfile

@@ -75,6 +75,8 @@ ENV DEBUG="false"
 ENV DEBUG_HUB="false"
 # Enable nginx debugging mode; this uses nginx-debug binary and enabled debug logging, which is VERY verbose so separate setting
 ENV DEBUG_NGINX="false"
+# Enable slow caching tier; this allows caching in a secondary cache path on e.g a larger slower disk; for known URIs defined in SLOW_TIER_URIS
+ENV SLOW_TIER_ENABLED="false"
 
 # Manifest caching tiers. Disabled by default, to mimick 0.4/0.5 behaviour.
 # Setting it to true enables the processing of the ENVs below.

entrypoint.sh

@@ -105,7 +105,28 @@ CACHE_DIRECTORY=${CACHE_DIRECTORY:-/docker_mirror_cache}
 
 # The cache directory. This can get huge. Better to use a Docker volume pointing here!
 # Set to 32gb which should be enough
-echo "proxy_cache_path ${CACHE_DIRECTORY} levels=1:2 max_size=$CACHE_MAX_SIZE min_free=${CACHE_MIN_FREE:-1g} inactive=${CACHE_INACTIVE_TIME:-60d} keys_zone=cache:15m use_temp_path=off manager_threshold=${CACHE_MANAGER_THRESHOLD:-1000ms} manager_sleep=${CACHE_MANAGER_SLEEP:-250ms} manager_files=${CACHE_MANAGER_FILES:-100} loader_files=${CACHE_LOADER_FILES:-100} loader_threshold=${CACHE_LOADER_THRESHOLD:-200ms} loader_sleep=${CACHE_LOADER_SLEEP:-50ms};" > /etc/nginx/conf.d/cache_max_size.conf
+echo "proxy_cache_path ${CACHE_DIRECTORY} levels=1:2 max_size=${CACHE_MAX_SIZE:-15g} min_free=${CACHE_MIN_FREE:-1g} inactive=${CACHE_INACTIVE_TIME:-60d} keys_zone=cache:${CACHE_KEYS_ZONE:-15m} use_temp_path=off manager_threshold=${CACHE_MANAGER_THRESHOLD:-1000ms} manager_sleep=${CACHE_MANAGER_SLEEP:-250ms} manager_files=${CACHE_MANAGER_FILES:-100} loader_files=${CACHE_LOADER_FILES:-100} loader_threshold=${CACHE_LOADER_THRESHOLD:-200ms} loader_sleep=${CACHE_LOADER_SLEEP:-50ms};" > /etc/nginx/conf.d/cache_max_size.conf
+
+if [[ "a${SLOW_TIER_ENABLED}" == "atrue" ]]; then
+    {
+        echo ""
+        echo "proxy_cache_path ${SLOW_CACHE_DIRECTORY} levels=1:2 max_size=${SLOW_CACHE_MAX_SIZ:-15g} min_free=${SLOW_CACHE_MIN_FREE:-1g} inactive=${SLOW_CACHE_INACTIVE_TIME:-120d} keys_zone=slow_cache:${SLOW_CACHE_KEYS_ZONE:-150m} use_temp_path=off manager_threshold=${SLOW_CACHE_MANAGER_THRESHOLD:-1000ms} manager_sleep=${SLOW_CACHE_MANAGER_SLEEP:-250ms} manager_files=${SLOW_CACHE_MANAGER_FILES:-100} loader_files=${SLOW_CACHE_LOADER_FILES:-100} loader_threshold=${SLOW_CACHE_LOADER_THRESHOLD:-200ms} loader_sleep=${SLOW_CACHE_LOADER_SLEEP:-50ms};"
+        echo ""
+        echo "map \$request_uri \$cache {"
+        echo "    ${SLOW_TIER_URIS%;};" | sed 's/;/  slow_cache;\n    /g'
+        echo "    default cache;"
+        echo "}"
+        echo ""
+    } >> /etc/nginx/conf.d/cache_max_size.conf; else
+
+    {
+        echo ""
+        echo "map \$request_uri \$cache {"
+        echo "    default cache;"
+        echo "}"
+        echo ""
+    } >> /etc/nginx/conf.d/cache_max_size.conf;
+fi
 
 # Clear the cache directory if the free space is less than the threshold
 # Get the available space in the directory

nginx.conf

@@ -316,7 +316,7 @@ echo "Docker configured with HTTPS_PROXY=$scheme://$http_host/"
 
             # nginx goes to fetch the value from the upstream Location header
             proxy_pass $orig_loc;
-            proxy_cache cache;
+            proxy_cache $cache;
             # But we store the result with the cache key of the original request URI
             # so that future clients don't need to follow the redirect too
             proxy_cache_key $original_uri$slice_range;

nginx.manifest.common.conf

@@ -2,7 +2,7 @@
     add_header X-Docker-Registry-Proxy-Cache-Upstream-Status "$upstream_cache_status";
     add_header X-Docker-Registry-Proxy-Cache-Type "$docker_proxy_request_type";
     proxy_pass https://$targetHost;
-    proxy_cache cache;
+    proxy_cache $cache;
     slice 4m;
     proxy_cache_key   $uri$slice_range;
     proxy_set_header   Range $slice_range;