[trafficserver] branch 9.1.x updated: Document http.default_buffer_water_mark (#7612)

[zw...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

zwoop pushed a commit to branch 9.1.x
in repository https://gitbox.apache.org/repos/asf/trafficserver.git


The following commit(s) were added to refs/heads/9.1.x by this push:
     new 63a22e5  Document http.default_buffer_water_mark (#7612)
63a22e5 is described below

commit 63a22e5028ba6c39fe87deb097f216320a0aad28
Author: mlibbey <ml...@apache.org>
AuthorDate: Mon Mar 29 11:18:14 2021 -0700

    Document http.default_buffer_water_mark (#7612)
    
    Appears to have been overridable since 2013, and in place as an
    (undocumented) configuration since the beginning.
    
    (cherry picked from commit e678c3fd9a0a68d398c8e14c67c174e123c74472)
---
 doc/admin-guide/files/records.config.en.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/doc/admin-guide/files/records.config.en.rst b/doc/admin-guide/files/records.config.en.rst
index df0f22b..fdf9185 100644
--- a/doc/admin-guide/files/records.config.en.rst
+++ b/doc/admin-guide/files/records.config.en.rst
@@ -1130,6 +1130,17 @@ mptcp
    request bodies which lack a ``Content-length`` header.
 
 .. ts:cv:: CONFIG proxy.config.http.default_buffer_water_mark INT 32768
+   :reloadable:
+   :overridable:
+
+   Number of bytes |TS| is allowed to read ahead of the client from the origin. Note that when
+   :ref:`Read While Write <admin-configuration-reducing-origin-requests>` settings are in place,
+   this setting will apply to the first client to request the object, regardless if subsequent,
+   simultaneous clients of that object can read faster. The buffered bytes will consume memory
+   while waiting for the client to consume them.
+
+   While this setting is reloadable, dramatic changes can cause bigger memory usage than expected
+   and is thus not recommended.
 
 .. ts:cv:: CONFIG proxy.config.http.request_buffer_enabled INT 0
    :overridable: