This is an automated email from the ASF dual-hosted git repository. cmcfarlen pushed a commit to branch 10.1.x in repository https://gitbox.apache.org/repos/asf/trafficserver.git
commit b43ff3e1a4bfec243f54259393367d54417d71f3 Author: Brian Neradt <[email protected]> AuthorDate: Mon Jun 8 12:51:40 2026 -0500 Correct records.yaml record drift (#13177) Several records.yaml entries had drifted from the names or reloadability registered in RecordsConfig, which leaves generated config references pointing at records that do not exist or implying runtime updates that are not supported. This corrects the obvious doc-only mismatches: typoed directives, stale QUIC record names and defaults, an unregistered deprecated admin record, and reloadable annotations that disagree with the registered update type. (cherry picked from commit 60b81a72ece8a1e318673048c71d3497e8cf96a5) --- doc/admin-guide/files/records.yaml.en.rst | 47 +++++++++++-------------------- 1 file changed, 16 insertions(+), 31 deletions(-) diff --git a/doc/admin-guide/files/records.yaml.en.rst b/doc/admin-guide/files/records.yaml.en.rst index d6af41667e..d131424a99 100644 --- a/doc/admin-guide/files/records.yaml.en.rst +++ b/doc/admin-guide/files/records.yaml.en.rst @@ -437,7 +437,7 @@ Thread Variables before :program:`traffic_server` drops privilege. If this variable is set to ``NULL``, no helper will be spawned. -.. ts::vc:: CONFIG proxy.config.core_limit INT -1 +.. ts:cv:: CONFIG proxy.config.core_limit INT -1 This option specifies the size limit for core files in the event that :program:`traffic_server` crashes. ``-1`` means there is @@ -691,11 +691,6 @@ Management * Set the ``user_id=#-1`` and start trafficserver as root. -.. ts:cv:: CONFIG proxy.config.admin.api.restricted INT 0 - - This is now deprecated, please refer to :ref:`admin-jsonrpc-configuration` to find - out about the new admin API mechanism. - HTTP Engine =========== @@ -2406,7 +2401,6 @@ Cache Control Setting this to ``0`` disables the feature. .. ts:cv:: CONFIG proxy.config.http.cache.try_compat_key_read INT 0 - :reloadable: When enabled (``1``), |TS| will try to lookup the cached object using the previous cache key generation algorithm, but will always write new objects @@ -2550,7 +2544,7 @@ Cache Control a minimum time, and the actual sync may be delayed if the disks are larger than how fast we allow it to write to disk (see next options). -.. ts:cv:: CONFIG proxy.config.cache.dir.sync_max_writes INT 2097152 +.. ts:cv:: CONFIG proxy.config.cache.dir.sync_max_write INT 2097152 :units: bytes How much of a stripes cache directory we will write to disk in each write cycle. @@ -2725,13 +2719,11 @@ Dynamic Content & Content Negotiation ===================================== .. ts:cv:: CONFIG proxy.config.http.cache.open_read_retry_time INT 10 - :reloadable: :overridable: The number of milliseconds a cacheable request will wait before requesting the object from cache if an equivalent request is in flight. .. ts:cv:: CONFIG proxy.config.http.cache.max_open_read_retries INT -1 - :reloadable: :overridable: The number of times to attempt fetching an object from cache if there was an equivalent request in flight. @@ -2825,7 +2817,6 @@ Customizable User Response Pages Maximum size of the error template response page. .. ts:cv:: CONFIG proxy.config.body_factory.response_suppression_mode INT 0 - :reloadable: :overridable: Specifies when |TS| suppresses generated response pages: @@ -3347,7 +3338,7 @@ Logging Configuration How often |TS| executes log related periodic tasks, in seconds -.. ts:cv:: CONFIG proxy.config.log.proxy.config.log.throttling_interval_msec INT 60000 +.. ts:cv:: CONFIG proxy.config.log.throttling_interval_msec INT 60000 :reloadable: :units: milliseconds @@ -3525,7 +3516,7 @@ Diagnostic Logging Configuration For details about how log throttling works, see :ts:cv:`log.throttling_interval_msec - <proxy.config.log.proxy.config.log.throttling_interval_msec>`. + <proxy.config.log.throttling_interval_msec>`. .. ts:cv:: CONFIG proxy.config.diags.logfile.filename STRING diags.log @@ -4820,14 +4811,12 @@ removed in the future without prior notice. A size of hash table that stores connection information. -.. ts:cv:: CONFIG proxy.config.quic.proxy.config.quic.num_alt_connection_ids INT 65521 - :reloadable: +.. ts:cv:: CONFIG proxy.config.quic.num_alt_connection_ids INT 8 A number of alternate Connection IDs that |TS| provides to a peer. It has to be at least 8. -.. ts:cv:: CONFIG proxy.config.quic.stateless_retry_enabled INT 0 - :reloadable: +.. ts:cv:: CONFIG proxy.config.quic.server.stateless_retry_enabled INT 0 Enables Stateless Retry. @@ -4842,19 +4831,16 @@ removed in the future without prior notice. Enables connection migration exercise on origin server connections. .. ts:cv:: CONFIG proxy.config.quic.server.supported_groups STRING "P-256:X25519:P-384:P-521" - :reloadable: Configures the list of supported groups provided by OpenSSL which will be used to determine the set of shared groups on QUIC origin server connections. .. ts:cv:: CONFIG proxy.config.quic.client.supported_groups STRING "P-256:X25519:P-384:P-521" - :reloadable: Configures the list of supported groups provided by OpenSSL which will be used to determine the set of shared groups on QUIC client connections. .. ts:cv:: CONFIG proxy.config.quic.client.session_file STRING "" - :reloadable: Only available for :program:`traffic_quic`. If specified, TLS session data will be stored to the file, and will be used @@ -4904,61 +4890,61 @@ removed in the future without prior notice. This value will be advertised as ``initial_max_data`` Transport Parameter. -.. ts:cv:: CONFIG proxy.config.quic.max_stream_data_bidi_local_in INT 0 +.. ts:cv:: CONFIG proxy.config.quic.initial_max_stream_data_bidi_local_in INT 0 :reloadable: This value will be advertised as ``initial_max_stream_data_bidi_local`` Transport Parameter. -.. ts:cv:: CONFIG proxy.config.quic.max_stream_data_bidi_local_out INT 4096 +.. ts:cv:: CONFIG proxy.config.quic.initial_max_stream_data_bidi_local_out INT 4096 :reloadable: This value will be advertised as ``initial_max_stream_data_bidi_local`` Transport Parameter. -.. ts:cv:: CONFIG proxy.config.quic.max_stream_data_bidi_remote_in INT 4096 +.. ts:cv:: CONFIG proxy.config.quic.initial_max_stream_data_bidi_remote_in INT 4096 :reloadable: This value will be advertised as ``initial_max_stream_data_bidi_remote`` Transport Parameter. -.. ts:cv:: CONFIG proxy.config.quic.max_stream_data_bidi_remote_out INT 0 +.. ts:cv:: CONFIG proxy.config.quic.initial_max_stream_data_bidi_remote_out INT 0 :reloadable: This value will be advertised as ``initial_max_stream_data_bidi_remote`` Transport Parameter. -.. ts:cv:: CONFIG proxy.config.quic.max_stream_data_uni_in INT 4096 +.. ts:cv:: CONFIG proxy.config.quic.initial_max_stream_data_uni_in INT 4096 :reloadable: This value will be advertised as ``initial_max_stream_data_uni`` Transport Parameter. -.. ts:cv:: CONFIG proxy.config.quic.max_stream_data_uni_out INT 0 +.. ts:cv:: CONFIG proxy.config.quic.initial_max_stream_data_uni_out INT 4096 :reloadable: This value will be advertised as ``initial_max_stream_data_uni`` Transport Parameter. -.. ts:cv:: CONFIG proxy.config.quic.max_streams_bidi_in INT 100 +.. ts:cv:: CONFIG proxy.config.quic.initial_max_streams_bidi_in INT 100 :reloadable: This value will be advertised as ``initial_max_streams_bidi`` Transport Parameter. -.. ts:cv:: CONFIG proxy.config.quic.max_streams_bidi_out INT 100 +.. ts:cv:: CONFIG proxy.config.quic.initial_max_streams_bidi_out INT 100 :reloadable: This value will be advertised as ``initial_max_streams_bidi`` Transport Parameter. -.. ts:cv:: CONFIG proxy.config.quic.max_streams_uni_in INT 100 +.. ts:cv:: CONFIG proxy.config.quic.initial_max_streams_uni_in INT 100 :reloadable: This value will be advertised as ``initial_max_streams_uni`` Transport Parameter. -.. ts:cv:: CONFIG proxy.config.quic.max_streams_uni_out INT 100 +.. ts:cv:: CONFIG proxy.config.quic.initial_max_streams_uni_out INT 100 :reloadable: This value will be advertised as ``initial_max_streams_uni`` @@ -5179,7 +5165,6 @@ Sockets Note: If MPTCP is enabled, TCP_DEFER_ACCEPT is only supported on Linux kernels 5.19+. .. ts:cv:: CONFIG proxy.config.net.listen_backlog INT -1 - :reloadable: This directive sets the maximum number of pending connections. If it is set to -1, |TS| will automatically set this
