changeset 2560:a5bbfdf88bbd

Documented the "min_free" parameter of proxy_cache_path and friends.
author Yaroslav Zhuravlev <yar@nginx.com>
date Fri, 03 Jul 2020 12:04:22 +0100
parents 82e6029db0c0
children 397289aeada7
files xml/en/docs/http/ngx_http_fastcgi_module.xml xml/en/docs/http/ngx_http_proxy_module.xml xml/en/docs/http/ngx_http_scgi_module.xml xml/en/docs/http/ngx_http_uwsgi_module.xml xml/ru/docs/http/ngx_http_fastcgi_module.xml xml/ru/docs/http/ngx_http_proxy_module.xml xml/ru/docs/http/ngx_http_scgi_module.xml xml/ru/docs/http/ngx_http_uwsgi_module.xml
diffstat 8 files changed, 72 insertions(+), 32 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_fastcgi_module.xml
+++ b/xml/en/docs/http/ngx_http_fastcgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_fastcgi_module"
         link="/en/docs/http/ngx_http_fastcgi_module.html"
         lang="en"
-        rev="51">
+        rev="52">
 
 <section id="summary">
 
@@ -386,6 +386,7 @@ will be cached.
     <literal>keys_zone</literal>=<value>name</value>:<value>size</value>
     [<literal>inactive</literal>=<value>time</value>]
     [<literal>max_size</literal>=<value>size</value>]
+    [<literal>min_free</literal>=<value>size</value>]
     [<literal>manager_files</literal>=<value>number</value>]
     [<literal>manager_sleep</literal>=<value>time</value>]
     [<literal>manager_threshold</literal>=<value>time</value>]
@@ -459,10 +460,14 @@ regardless of their freshness.
 By default, <literal>inactive</literal> is set to 10 minutes.
 </para>
 
-<para>
+<para id="fastcgi_cache_path_max_size">
 The special “cache manager” process monitors the maximum cache size set
-by the <literal>max_size</literal> parameter.
-When this size is exceeded, it removes the least recently used data.
+by the <literal>max_size</literal> parameter,
+and the minimum amount of free space set
+by the <literal>min_free</literal> (1.19.1) parameter
+on the file system with cache.
+When the size is exceeded or there is not enough free space,
+it removes the least recently used data.
 The data is removed in iterations configured by
 <literal>manager_files</literal>,
 <literal>manager_threshold</literal>, and
--- a/xml/en/docs/http/ngx_http_proxy_module.xml
+++ b/xml/en/docs/http/ngx_http_proxy_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_proxy_module"
         link="/en/docs/http/ngx_http_proxy_module.html"
         lang="en"
-        rev="65">
+        rev="66">
 
 <section id="summary">
 
@@ -402,6 +402,7 @@ will be cached.
     <literal>keys_zone</literal>=<value>name</value>:<value>size</value>
     [<literal>inactive</literal>=<value>time</value>]
     [<literal>max_size</literal>=<value>size</value>]
+    [<literal>min_free</literal>=<value>size</value>]
     [<literal>manager_files</literal>=<value>number</value>]
     [<literal>manager_sleep</literal>=<value>time</value>]
     [<literal>manager_threshold</literal>=<value>time</value>]
@@ -475,10 +476,14 @@ regardless of their freshness.
 By default, <literal>inactive</literal> is set to 10 minutes.
 </para>
 
-<para>
+<para id="proxy_cache_path_max_size">
 The special “cache manager” process monitors the maximum cache size set
-by the <literal>max_size</literal> parameter.
-When this size is exceeded, it removes the least recently used data.
+by the <literal>max_size</literal> parameter,
+and the minimum amount of free space set
+by the <literal>min_free</literal> (1.19.1) parameter
+on the file system with cache.
+When the size is exceeded or there is not enough free space,
+it removes the least recently used data.
 The data is removed in iterations configured by
 <literal>manager_files</literal>,
 <literal>manager_threshold</literal>, and
--- a/xml/en/docs/http/ngx_http_scgi_module.xml
+++ b/xml/en/docs/http/ngx_http_scgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_scgi_module"
         link="/en/docs/http/ngx_http_scgi_module.html"
         lang="en"
-        rev="39">
+        rev="40">
 
 <section id="summary">
 
@@ -377,6 +377,7 @@ will be cached.
     <literal>keys_zone</literal>=<value>name</value>:<value>size</value>
     [<literal>inactive</literal>=<value>time</value>]
     [<literal>max_size</literal>=<value>size</value>]
+    [<literal>min_free</literal>=<value>size</value>]
     [<literal>manager_files</literal>=<value>number</value>]
     [<literal>manager_sleep</literal>=<value>time</value>]
     [<literal>manager_threshold</literal>=<value>time</value>]
@@ -450,10 +451,14 @@ regardless of their freshness.
 By default, <literal>inactive</literal> is set to 10 minutes.
 </para>
 
-<para>
+<para id="scgi_cache_path_max_size">
 The special “cache manager” process monitors the maximum cache size set
-by the <literal>max_size</literal> parameter.
-When this size is exceeded, it removes the least recently used data.
+by the <literal>max_size</literal> parameter,
+and the minimum amount of free space set
+by the <literal>min_free</literal> (1.19.1) parameter
+on the file system with cache.
+When the size is exceeded or there is not enough free space,
+it removes the least recently used data.
 The data is removed in iterations configured by
 <literal>manager_files</literal>,
 <literal>manager_threshold</literal>, and
--- a/xml/en/docs/http/ngx_http_uwsgi_module.xml
+++ b/xml/en/docs/http/ngx_http_uwsgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_uwsgi_module"
         link="/en/docs/http/ngx_http_uwsgi_module.html"
         lang="en"
-        rev="43">
+        rev="44">
 
 <section id="summary">
 
@@ -377,6 +377,7 @@ will be cached.
     <literal>keys_zone</literal>=<value>name</value>:<value>size</value>
     [<literal>inactive</literal>=<value>time</value>]
     [<literal>max_size</literal>=<value>size</value>]
+    [<literal>min_free</literal>=<value>size</value>]
     [<literal>manager_files</literal>=<value>number</value>]
     [<literal>manager_sleep</literal>=<value>time</value>]
     [<literal>manager_threshold</literal>=<value>time</value>]
@@ -450,10 +451,14 @@ regardless of their freshness.
 By default, <literal>inactive</literal> is set to 10 minutes.
 </para>
 
-<para>
+<para id="uwsgi_cache_path_max_size">
 The special “cache manager” process monitors the maximum cache size set
-by the <literal>max_size</literal> parameter.
-When this size is exceeded, it removes the least recently used data.
+by the <literal>max_size</literal> parameter,
+and the minimum amount of free space set
+by the <literal>min_free</literal> (1.19.1) parameter
+on the file system with cache.
+When the size is exceeded or there is not enough free space,
+it removes the least recently used data.
 The data is removed in iterations configured by
 <literal>manager_files</literal>,
 <literal>manager_threshold</literal>, and
--- a/xml/ru/docs/http/ngx_http_fastcgi_module.xml
+++ b/xml/ru/docs/http/ngx_http_fastcgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_fastcgi_module"
         link="/ru/docs/http/ngx_http_fastcgi_module.html"
         lang="ru"
-        rev="51">
+        rev="52">
 
 <section id="summary">
 
@@ -387,6 +387,7 @@ range-запрос будет передан на FastCGI-сервер
     <literal>keys_zone</literal>=<value>имя</value>:<value>размер</value>
     [<literal>inactive</literal>=<value>время</value>]
     [<literal>max_size</literal>=<value>размер</value>]
+    [<literal>min_free</literal>=<value>размер</value>]
     [<literal>manager_files</literal>=<value>число</value>]
     [<literal>manager_sleep</literal>=<value>время</value>]
     [<literal>manager_threshold</literal>=<value>время</value>]
@@ -459,10 +460,14 @@ fastcgi_cache_path /data/nginx/cache lev
 По умолчанию <literal>inactive</literal> равен 10 минутам.
 </para>
 
-<para>
+<para id="fastcgi_cache_path_max_size">
 Специальный процесс “cache manager” следит за максимальным размером кэша,
-заданным параметром <literal>max_size</literal>, и при превышении
-его размеров удаляет наименее востребованные данные.
+заданным параметром <literal>max_size</literal>,
+и также за минимальным объёмом свободного места на файловой системе с кэшем,
+заданным параметром <literal>min_free</literal> (1.19.1).
+При превышении максимального размера кэша
+или недостаточном объёме свободного места
+процесс удаляет наименее востребованные данные.
 Удаление данных происходит итерациями, настраиваемыми параметрами (1.11.5)
 <literal>manager_files</literal>,
 <literal>manager_threshold</literal> и
--- a/xml/ru/docs/http/ngx_http_proxy_module.xml
+++ b/xml/ru/docs/http/ngx_http_proxy_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_proxy_module"
         link="/ru/docs/http/ngx_http_proxy_module.html"
         lang="ru"
-        rev="65">
+        rev="66">
 
 <section id="summary">
 
@@ -404,6 +404,7 @@ range-запрос будет передан на проксируемый сервер
     <literal>keys_zone</literal>=<value>имя</value>:<value>размер</value>
     [<literal>inactive</literal>=<value>время</value>]
     [<literal>max_size</literal>=<value>размер</value>]
+    [<literal>min_free</literal>=<value>размер</value>]
     [<literal>manager_files</literal>=<value>число</value>]
     [<literal>manager_sleep</literal>=<value>время</value>]
     [<literal>manager_threshold</literal>=<value>время</value>]
@@ -476,10 +477,14 @@ proxy_cache_path /data/nginx/cache level
 По умолчанию <literal>inactive</literal> равен 10 минутам.
 </para>
 
-<para>
+<para id="proxy_cache_path_max_size">
 Специальный процесс “cache manager” следит за максимальным размером кэша,
-заданным параметром <literal>max_size</literal>, и при превышении
-его размеров удаляет наименее востребованные данные.
+заданным параметром <literal>max_size</literal>,
+и также за минимальным объёмом свободного места на файловой системе с кэшем,
+заданным параметром <literal>min_free</literal> (1.19.1).
+При превышении максимального размера кэша
+или недостаточном объёме свободного места
+процесс удаляет наименее востребованные данные.
 Удаление данных происходит итерациями, настраиваемыми параметрами (1.11.5)
 <literal>manager_files</literal>,
 <literal>manager_threshold</literal> и
--- a/xml/ru/docs/http/ngx_http_scgi_module.xml
+++ b/xml/ru/docs/http/ngx_http_scgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_scgi_module"
         link="/ru/docs/http/ngx_http_scgi_module.html"
         lang="ru"
-        rev="39">
+        rev="40">
 
 <section id="summary">
 
@@ -378,6 +378,7 @@ range-запрос будет передан на SCGI-сервер
     <literal>keys_zone</literal>=<value>имя</value>:<value>размер</value>
     [<literal>inactive</literal>=<value>время</value>]
     [<literal>max_size</literal>=<value>размер</value>]
+    [<literal>min_free</literal>=<value>размер</value>]
     [<literal>manager_files</literal>=<value>число</value>]
     [<literal>manager_sleep</literal>=<value>время</value>]
     [<literal>manager_threshold</literal>=<value>время</value>]
@@ -450,10 +451,14 @@ scgi_cache_path /data/nginx/cache levels
 По умолчанию <literal>inactive</literal> равен 10 минутам.
 </para>
 
-<para>
+<para id="scgi_cache_path_max_size">
 Специальный процесс “cache manager” следит за максимальным размером кэша,
-заданным параметром <literal>max_size</literal>, и при превышении
-его размеров удаляет наименее востребованные данные.
+заданным параметром <literal>max_size</literal>,
+и также за минимальным объёмом свободного места на файловой системе с кэшем,
+заданным параметром <literal>min_free</literal> (1.19.1).
+При превышении максимального размера кэша
+или недостаточном объёме свободного места
+процесс удаляет наименее востребованные данные.
 Удаление данных происходит итерациями, настраиваемыми параметрами (1.11.5)
 <literal>manager_files</literal>,
 <literal>manager_threshold</literal> и
--- a/xml/ru/docs/http/ngx_http_uwsgi_module.xml
+++ b/xml/ru/docs/http/ngx_http_uwsgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_uwsgi_module"
         link="/ru/docs/http/ngx_http_uwsgi_module.html"
         lang="ru"
-        rev="43">
+        rev="44">
 
 <section id="summary">
 
@@ -377,6 +377,7 @@ range-запрос будет передан на uwsgi-сервер
     <literal>keys_zone</literal>=<value>имя</value>:<value>размер</value>
     [<literal>inactive</literal>=<value>время</value>]
     [<literal>max_size</literal>=<value>размер</value>]
+    [<literal>min_free</literal>=<value>размер</value>]
     [<literal>manager_files</literal>=<value>число</value>]
     [<literal>manager_sleep</literal>=<value>время</value>]
     [<literal>manager_threshold</literal>=<value>время</value>]
@@ -449,10 +450,14 @@ uwsgi_cache_path /data/nginx/cache level
 По умолчанию <literal>inactive</literal> равен 10 минутам.
 </para>
 
-<para>
+<para id="uwsgi_cache_path_max_size">
 Специальный процесс “cache manager” следит за максимальным размером кэша,
-заданным параметром <literal>max_size</literal>, и при превышении
-его размеров удаляет наименее востребованные данные.
+заданным параметром <literal>max_size</literal>,
+и также за минимальным объёмом свободного места на файловой системе с кэшем,
+заданным параметром <literal>min_free</literal> (1.19.1).
+При превышении максимального размера кэша
+или недостаточном объёме свободного места
+процесс удаляет наименее востребованные данные.
 Удаление данных происходит итерациями, настраиваемыми параметрами (1.11.5)
 <literal>manager_files</literal>,
 <literal>manager_threshold</literal> и