diff --git a/ci/jenkins/bin/cache-tests.sh b/ci/jenkins/bin/cache-tests.sh index 21771f94f9d..ae2453fd8aa 100755 --- a/ci/jenkins/bin/cache-tests.sh +++ b/ci/jenkins/bin/cache-tests.sh @@ -18,7 +18,6 @@ PREFIX="${ATS_BUILD_BASEDIR}/install" REMAP="${PREFIX}/etc/trafficserver/remap.config" -RECORDS="${PREFIX}/etc/trafficserver/records.config" TWEAK="" [ "1" == "$enable_tweak" ] && TWEAK="-tweak" @@ -58,8 +57,7 @@ ${PREFIX}/bin/trafficserver stop # Now run it again, maybe, with the tweaked configs if [ "" != "$TWEAK" ]; then -# echo "CONFIG proxy.config.http.cache.required_headers INT 1" >> $RECORDS - echo "CONFIG proxy.config.http.negative_caching_enabled INT 1" >> $RECORDS + ${PREFIX}/bin/traffic_ctl config set proxy.config.http.negative_caching_enabled 1 -c $RECORDS ${PREFIX}/bin/trafficserver start cd /home/jenkins/cache-tests npm run --silent cli --base=http://127.0.0.1:8080 > /CA/cache-tests/${ATS_BRANCH}${TWEAK}.json diff --git a/configs/records.yaml.default.in b/configs/records.yaml.default.in index 72711d876fa..47c51208dfa 100644 --- a/configs/records.yaml.default.in +++ b/configs/records.yaml.default.in @@ -47,11 +47,16 @@ ts: # Thread configurations. Docs: # https://docs.trafficserver.apache.org/records.yaml#thread-variables ############################################################################## + diags: + debug: + enabled: 0 + tags: http|dns + exec_thread: affinity: 1 autoconfig: enabled: 1 - scale: 1.13 + scale: 1.0 limit: 2 http: accept_no_activity_timeout: 120 diff --git a/configs/remap.config.default b/configs/remap.config.default index c193aa0e7ee..faf983ddf46 100644 --- a/configs/remap.config.default +++ b/configs/remap.config.default @@ -10,9 +10,12 @@ # 2) Protect the proxy server, to only allow certain requests. # # With the default configurations, at least one remap rule is required. This -# can be relaxed with the following configuration in records.config: +# can be relaxed with the following configuration in records.yaml: +# +# ts: +# url_remap: +# remap_required: 0 # -# CONFIG proxy.config.url_remap.remap_required INT 0 # # Be aware, doing so makes the proxy a generic, open-relay! # @@ -96,13 +99,19 @@ # At least one regular expressions must be specified in order to activate # 'deep linking protection'. There are limitations for the number of referer # regular expression strings - 2048. In order to enable the 'deep linking -# protection' feature in Traffic Server, configure records.config with: +# protection' feature in Traffic Server, configure records.yaml with: +# +# ts: +# http: +# referer_filter: 1 # -# CONFIG proxy.config.http.referer_filter INT 1 # # In order to enable run-time formatting for redirect0URL, configure # -# CONFIG proxy.config.http.referer_format_redirect INT 1 +# ts: +# http: +# referer_format_redirect: 1 +# # # When run-time formatting for redirect-URL was enabled the following format # symbols can be used: diff --git a/configs/ssl_multicert.config.default b/configs/ssl_multicert.config.default index f4fab20638d..43eb43e4cb5 100644 --- a/configs/ssl_multicert.config.default +++ b/configs/ssl_multicert.config.default @@ -13,7 +13,7 @@ # is the leftmost domain component. # # The certificate file path, CA path and key path specified in -# records.config will be used for all certificates, CAs and keys +# records.yaml will be used for all certificates, CAs and keys # specified here. # # Fields: diff --git a/doc/admin-guide/configuring-traffic-server.en.rst b/doc/admin-guide/configuring-traffic-server.en.rst index 2da1895f93a..a532b9cc0c6 100644 --- a/doc/admin-guide/configuring-traffic-server.en.rst +++ b/doc/admin-guide/configuring-traffic-server.en.rst @@ -68,11 +68,23 @@ full restart of Traffic Server. The following is a sample portion of :file:`records.yaml`: -.. figure:: ../static/images/admin/records.jpg - :align: center - :alt: Sample records.config file - Sample records.config file +.. code-block:: yaml + :linenos: + + diags: + debug: + enabled: 0 + tags: http|dns + + exec_thread: + affinity: 1 + autoconfig: + enabled: 1 + scale: 1.0 + limit: 2 + + Sample records.yaml file In addition to :file:`records.yaml`, Traffic Server provides other configuration files that are used to diff --git a/doc/admin-guide/files/remap.config.en.rst b/doc/admin-guide/files/remap.config.en.rst index cae4ca64cbf..ddf6a266f62 100644 --- a/doc/admin-guide/files/remap.config.en.rst +++ b/doc/admin-guide/files/remap.config.en.rst @@ -343,13 +343,25 @@ redirected to 'redirect-URL'. At least one regular expressions must be specified in order to activate 'deep linking protection'. There are limitations for the number of referer regular expression strings - 2048. In order to enable the 'deep linking -protection' feature in Traffic Server, configure records.config with:: +protection' feature in Traffic Server, configure records.yaml with: - CONFIG proxy.config.http.referer_filter INT 1 +.. code-block:: yaml + :linenos: + :emphasize-lines: 3 -In order to enable run-time formatting for redirect URL, configure:: + ts: + http: + referer_filter: 1 - CONFIG proxy.config.http.referer_format_redirect INT 1 +In order to enable run-time formatting for redirect URL, configure: + +.. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + ts: + http: + referer_format_redirect: 1 When run-time formatting for redirect-URL was enabled the following format symbols can be used:: diff --git a/doc/admin-guide/files/sni.yaml.en.rst b/doc/admin-guide/files/sni.yaml.en.rst index 7ed07c1d6fe..cf15490ff73 100644 --- a/doc/admin-guide/files/sni.yaml.en.rst +++ b/doc/admin-guide/files/sni.yaml.en.rst @@ -172,7 +172,7 @@ Pre-warming TLS Tunnel =============================== ======================================================================================== Key Meaning =============================== ======================================================================================== -tunnel_prewarm Override :ts:cv:`proxy.config.tunnel.prewarm` in records.config. +tunnel_prewarm Override :ts:cv:`proxy.config.tunnel.prewarm` in records.yaml. tunnel_prewarm_srv Enable SRV record lookup on pre-warming. Default is ``false``. diff --git a/doc/admin-guide/files/storage.config.en.rst b/doc/admin-guide/files/storage.config.en.rst index ec360b0411f..2fd0a2d674c 100644 --- a/doc/admin-guide/files/storage.config.en.rst +++ b/doc/admin-guide/files/storage.config.en.rst @@ -72,7 +72,7 @@ Server user is in the group which owns the device file. However, some operating systems have stronger requirements - see the following examples for more information. -As with standard ``records.config`` integers, human readable prefixes are also +As with standard ``records.yaml`` integers, human readable prefixes are also supported. They include - ``K`` Kilobytes (1024 bytes) diff --git a/doc/admin-guide/performance/index.en.rst b/doc/admin-guide/performance/index.en.rst index 512476a70f2..5a2f3664e97 100644 --- a/doc/admin-guide/performance/index.en.rst +++ b/doc/admin-guide/performance/index.en.rst @@ -196,9 +196,13 @@ On multi-socket servers, such as Intel architectures with NUMA, you can adjust the thread affinity configuration to take advantage of cache pipelines and faster memory access, as well as preventing possibly costly thread migrations across sockets. This is adjusted with :ts:cv:`proxy.config.exec_thread.affinity` -in :file:`records.yaml`. :: +in :file:`records.yaml`.: - CONFIG proxy.config.exec_thread.affinity INT 1 +.. code-block:: yaml + + ts: + exec_thread: + affinity: 1 Thread Stack Size ~~~~~~~~~~~~~~~~~ @@ -264,9 +268,12 @@ inactive (have not sent data). Lowering this timeout can ease pressure on the proxy if misconfigured or misbehaving clients are opening a large number of connections without submitting requests. -:: - CONFIG proxy.config.http.accept_no_activity_timeout INT 120 +.. code-block:: yaml + + ts: + http: + accept_no_activity_timeout: 120 Background Fill Timeout ~~~~~~~~~~~~~~~~~~~~~~~ @@ -278,9 +285,11 @@ server connection that was being used. Setting this to zero disables the timeout, but modifying the value and enforcing a timeout may help in situations where your origin servers stall connections without closing. -:: +.. code-block:: yaml - CONFIG proxy.config.http.background_fill_active_timeout INT 0 + ts: + http: + background_fill_active_timeout: 0 DNS Timeouts ~~~~~~~~~~~~ @@ -298,10 +307,13 @@ instance from updating its records to reflect external DNS record changes in a timely manner (refer to :ts:cv:`proxy.config.hostdb.ttl_mode` for more information on when this TTL value will actually be used). -:: - CONFIG proxy.config.hostdb.timeout INT 1440 - CONFIG proxy.config.hostdb.lookup_timeout INT 30 +.. code-block:: yaml + + ts: + hostdb: + lookup_timeout: 30 + timeout: 1440 Keepalive Timeouts ~~~~~~~~~~~~~~~~~~ @@ -316,10 +328,12 @@ Both are specified in seconds. Keep in mind that effectively an advisory maximum, as the origin server may have its own keepalive timeout which (if set lower) will likely take precedence. -:: +.. code-block:: yaml - CONFIG proxy.config.http.keep_alive_no_activity_timeout_in INT 120 - CONFIG proxy.config.http.keep_alive_no_activity_timeout_out INT 120 + ts: + http: + keep_alive_no_activity_timeout_in: 120 + keep_alive_no_activity_timeout_out: 120 Origin Connection Timeouts ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -331,18 +345,24 @@ connection attempt until the origin fully establishes a connection (the connecti After the connection is established the value of :ts:cv:`proxy.config.http.transaction_no_activity_timeout_out` is used to established timeouts on the data over the connection. -:: +.. code-block:: yaml - CONFIG proxy.config.http.connect_attempts_timeout INT 30 + ts: + http: + connect_attempts_timeout: 30 Polling Timeout ~~~~~~~~~~~~~~~ If you are experiencing unusually or unacceptably high CPU utilization during idle workloads, you may consider adjusting the polling timeout with -:ts:cv:`proxy.config.net.poll_timeout`:: +:ts:cv:`proxy.config.net.poll_timeout`. + +.. code-block:: yaml - CONFIG proxy.config.net.poll_timeout INT 60 + ts: + net: + poll_timeout: 60 SOCKS Timeouts ~~~~~~~~~~~~~~ @@ -358,12 +378,15 @@ is the timeout for the actual connection attempt on a retry, not the delay after which a retry will be performed (the delay is configured with :ts:cv:`proxy.config.socks.server_retry_time`). -:: +.. code-block:: yaml + + ts: + socks: + server_connect_timeout: 10 + server_retry_time: 300 + server_retry_timeout: 300 + socks_timeout: 100 - CONFIG proxy.config.socks.socks_timeout INT 100 - CONFIG proxy.config.socks.server_connect_timeout INT 10 - CONFIG proxy.config.socks.server_retry_timeout INT 300 - CONFIG proxy.config.socks.server_retry_time INT 300 SSL Timeouts ~~~~~~~~~~~~ @@ -385,12 +408,17 @@ the remote OCSP responders, in seconds, with Lastly, you can control the number of seconds for which SSL sessions will be cached in |TS| using :ts:cv:`proxy.config.ssl.session_cache.timeout`. -:: +.. code-block:: yaml + + ts: + ssl: + handshake_timeout_in: 30 + ocsp: + cache_timeout: 3600 + request_timeout: 10 + session_cache: + timeout: 0 - CONFIG proxy.config.ssl.handshake_timeout_in INT 30 - CONFIG proxy.config.ssl.ocsp.cache_timeout INT 3600 - CONFIG proxy.config.ssl.ocsp.request_timeout INT 10 - CONFIG proxy.config.ssl.session_cache.timeout INT 0 Transaction Activity Timeouts ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -427,12 +455,14 @@ and not transmitting data, for clients and origin servers respectively. Unlike the active transaction timeouts, these two inactive transaction timeout values prove somewhat more generally applicable. -:: +.. code-block:: yaml - CONFIG proxy.config.http.transaction_active_timeout_in INT 900 - CONFIG proxy.config.http.transaction_active_timeout_out INT 0 - CONFIG proxy.config.http.transaction_no_activity_timeout_in INT 30 - CONFIG proxy.config.http.transaction_no_activity_timeout_out INT 30 + ts: + http: + transaction_active_timeout_in: 900 + transaction_active_timeout_out: 0 + transaction_no_activity_timeout_in: 30 + transaction_no_activity_timeout_out: 30 WebSocket Timeouts ~~~~~~~~~~~~~~~~~~ @@ -443,10 +473,13 @@ length of time a stalled WebSocket connection will remain before |TS| closes it. :ts:cv:`proxy.config.websocket.active_timeout` sets the maximum duration for all WebSocket connections, regardless of their level of activity. -:: +.. code-block:: yaml + + ts: + websocket: + active_timeout: 3600 + no_activity_timeout: 600 - CONFIG proxy.config.websocket.no_activity_timeout INT 600 - CONFIG proxy.config.websocket.active_timeout INT 3600 Memory Optimization ------------------- @@ -481,11 +514,15 @@ client request resulting in an origin request. This behavior is controlled by both enabling the feature via :ts:cv:`proxy.config.http.negative_caching_enabled` and setting the cache time (in seconds) with :ts:cv:`proxy.config.http.negative_caching_lifetime`. Configured -status code for negative caching can be set with :ts:cv:`proxy.config.http.negative_caching_list`. :: +status code for negative caching can be set with :ts:cv:`proxy.config.http.negative_caching_list`. + +.. code-block:: yaml - CONFIG proxy.config.http.negative_caching_enabled INT 1 - CONFIG proxy.config.http.negative_caching_lifetime INT 10 - CONFIG proxy.config.http.negative_caching_list STRING 204 305 403 404 414 500 501 502 503 504 + ts: + http: + negative_caching_enabled: 1 + negative_caching_lifetime: 10 + negative_caching_list: 204 305 403 404 414 500 501 502 503 504 SSL-Specific Options ~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/admin-guide/plugins/conf_remap.en.rst b/doc/admin-guide/plugins/conf_remap.en.rst index d31749d05d9..6c05caf016e 100644 --- a/doc/admin-guide/plugins/conf_remap.en.rst +++ b/doc/admin-guide/plugins/conf_remap.en.rst @@ -91,9 +91,13 @@ Instead of specifying the directives and their values in :file:`remap.config` as you do with the in-line method, you place all the affected directives in a separate text file. The location and name is entirely up to you, but we'll use `/etc/trafficserver/cdn_conf_remap.config` here. The contents of this file -should mirror how configuration directives are written in :file:`records.yaml`:: +should mirror how configuration directives are written in :file:`records.yaml`: - CONFIG proxy.config.url_remap.pristine_host_hdr INT 1 +.. code-block:: yaml + + ts: + url_remap: + pristine_host_hdr: 1 Your :file:`remap.config` will then contain remapping rules that point to this external file:: diff --git a/doc/admin-guide/plugins/lua.en.rst b/doc/admin-guide/plugins/lua.en.rst index 29f8a21ff0a..63c4c5d6567 100644 --- a/doc/admin-guide/plugins/lua.en.rst +++ b/doc/admin-guide/plugins/lua.en.rst @@ -149,11 +149,16 @@ If it is used as remap plugin, we can write the following in remap.config to def The maximum number of allowed states is set to 256 which is also the default states value. The default value can be globally changed by -adding a configuration option to records.config. +adding a configuration option to records.yaml. -:: +.. code-block:: yaml + :linenos: + :emphasize-lines: 4 - CONFIG proxy.config.plugin.lua.max_states INT 64 + ts: + plugin: + lua: + max_states: 64 Any per plugin --states value overrides this default value but must be less than or equal to this value. This setting is not reloadable since it must be applied when all the lua states are first initialized. @@ -296,9 +301,19 @@ Here is an example: ts.debug('I am in do_remap now.') ts.debug("scw", "hello world") -We should write this TAG in records.config(If TAG is missing, default TAG will be set): +We should write this TAG in :ts:cv:`proxy.config.diags.debug.tags` in records.yaml. (If TAG is missing, default TAG will be set): + + +.. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + ts: + diags: + debug: + tags: TAG + -``CONFIG proxy.config.diags.debug.tags STRING TAG`` :ref:`TOP ` diff --git a/doc/admin-guide/plugins/url_sig.en.rst b/doc/admin-guide/plugins/url_sig.en.rst index 37a6a611793..873cca7fcab 100644 --- a/doc/admin-guide/plugins/url_sig.en.rst +++ b/doc/admin-guide/plugins/url_sig.en.rst @@ -301,10 +301,15 @@ Edge Cache Debugging To include debugging output for this plugin in your |TS| logs, adjust the values for :ts:cv:`proxy.config.diags.debug.enabled` and -:ts:cv:`proxy.config.diags.debug.tags` in your :file:`records.yaml` as so:: +:ts:cv:`proxy.config.diags.debug.tags` in your :file:`records.yaml` as so: - CONFIG proxy.config.diags.debug.enabled INT 1 - CONFIG proxy.config.diags.debug.tags STRING url_sig +.. code-block:: yaml + + ts: + diags: + debug: + enabled: 1 + tags: url_sig Once updated, issue a :option:`traffic_ctl config reload` to make the settings active. diff --git a/doc/admin-guide/security/index.en.rst b/doc/admin-guide/security/index.en.rst index 1c71ddbaf5b..e4e1d396d7f 100644 --- a/doc/admin-guide/security/index.en.rst +++ b/doc/admin-guide/security/index.en.rst @@ -109,10 +109,17 @@ Client/|TS| connections, you must do the following: :ts:cv:`proxy.config.http.server_ports` in :file:`records.yaml`. #. Set the appropriate base path for your SSL certificates and private keys - in :file:`records.yaml`. :: + in :file:`records.yaml`. - CONFIG proxy.config.ssl.server.cert.path STRING /opt/ts/etc/ssl/certs/ - CONFIG proxy.config.ssl.server.private_key.path STRING /opt/ts/etc/ssl/keys/ + .. code-block:: yaml + + ts: + ssl: + server: + cert: + path: /opt/ts/etc/ssl/certs/ + private_key: + path: /opt/ts/etc/ssl/keys #. Add an entry to :file:`ssl_multicert.config` for each certificate and key which your |TS| system will be using to terminate SSL connections @@ -129,9 +136,14 @@ Client/|TS| connections, you must do the following: client certificates, or if you configure certificates to be optional and the connecting client does not present one, then access to |TS| is managed through other |TS| options that have been set (such as - rules in :file:`ip_allow.yaml`). :: + rules in :file:`ip_allow.yaml`).: + + .. code-block:: yaml - CONFIG proxy.config.ssl.client.certification_level INT 0 + ts: + ssl: + client: + certification_level: 0 This variable permits one of the following values to be set: @@ -146,9 +158,16 @@ Client/|TS| connections, you must do the following: #. *Optional*: Configure the use of Certification Authorities (CAs). CAs add security by verifying the identity of the person requesting a certificate. The list of acceptable CA signers is configured with - :ts:cv:`proxy.config.ssl.CA.cert.path` in :file:`records.yaml`. :: + :ts:cv:`proxy.config.ssl.CA.cert.path` in :file:`records.yaml`.: + + .. code-block:: yaml + + ts: + ssl: + CA: + cert: + path: /opt/CA/certs/private-ca.pem - CONFIG proxy.config.ssl.CA.cert.path STRING /opt/CA/certs/private-ca.pem #. Restart Traffic Server. @@ -208,32 +227,59 @@ and origin server connections, you must do the following: If you are using a client certificate, you must add its location to :file:`records.yaml` in the setting :ts:cv:`proxy.config.ssl.client.cert.path` - and :ts:cv:`proxy.config.ssl.client.cert.filename`. :: + and :ts:cv:`proxy.config.ssl.client.cert.filename`.: + + .. code-block:: yaml - CONFIG proxy.config.ssl.client.cert.path STRING /opt/ts/etc/ssl/certs/ - CONFIG proxy.config.ssl.client.cert.filename STRING client.pem + ts: + ssl: + client: + cert: + filename: client.pem + path: /opt/ts/etc/ssl/certs/ You must also provide the paths to the private key for this certificate, unless the key is contained within the same file as the certificate, using :ts:cv:`proxy.config.ssl.client.private_key.path` and - :ts:cv:`proxy.config.ssl.client.private_key.filename`. :: + :ts:cv:`proxy.config.ssl.client.private_key.filename`.: + + .. code-block:: yaml + + ts: + ssl: + client: + private_key: + filename: client.pem + path: /opt/ts/etc/ssl/keys/ - CONFIG proxy.config.ssl.client.private_key.path STRING /opt/ts/etc/ssl/keys/ - CONFIG proxy.config.ssl.client.private_key.filename STRING client.pem #. Enable or disable, per your security policy, server SSL certificate verification using :ts:cv:`proxy.config.ssl.client.verify.server.policy` in - :file:`records.yaml`. :: + :file:`records.yaml`. : + +.. code-block:: yaml - CONFIG proxy.config.ssl.client.verify.server.policy STRING ENFORCED + ts: + ssl: + client: + verify: + server: + policy: ENFORCED #. Add the collection of authorized Certificate Authorities to the Traffic Server configuration in :file:`records.yaml` using the settings :ts:cv:`proxy.config.ssl.client.CA.cert.path` and - :ts:cv:`proxy.config.ssl.client.CA.cert.filename`. :: + :ts:cv:`proxy.config.ssl.client.CA.cert.filename`.: - CONFIG proxy.config.ssl.client.CA.cert.path STRING /opt/ts/etc/ssl/certs/ - CONFIG proxy.config.ssl.client.CA.cert.filename STRING CAs.pem +.. code-block:: yaml + + ts: + ssl: + client: + CA: + cert: + filename: CAs.pem + path: /opt/ts/etc/ssl/certs/ #. Restart Traffic Server. @@ -338,9 +384,14 @@ To configure Split DNS: These rules are located in :file:`splitdns.config`. #. Enable the *Split DNS* option by adjusting :ts:cv:`proxy.config.dns.splitDNS.enabled` - in :file:`records.yaml`. :: + in :file:`records.yaml`.: + +.. code-block:: yaml - CONFIG proxy.config.dns.splitDNS.enabled INT 1 + ts: + dns: + splitDNS: + enabled: 1 #. Run the command :option:`traffic_ctl config reload` to apply the configuration changes. diff --git a/doc/appendices/faq.en.rst b/doc/appendices/faq.en.rst index 8e686eaea21..f5e4cbbdded 100644 --- a/doc/appendices/faq.en.rst +++ b/doc/appendices/faq.en.rst @@ -390,7 +390,7 @@ A requested object was larger than the maximum size allowed in the Traffic Server cache, so Traffic Server provided proxy service for the oversized object but did not cache it. To set the object size limit for the cache, modify the :ts:cv:`proxy.config.cache.max_doc_size` -variable in the records.config file. If you do not want to limit the +variable in the :file:`records.yaml` file. If you do not want to limit the size of objects in the cache, then set the document size to ``0`` (zero). diff --git a/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst b/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst index 324ca889590..1389f9b3170 100644 --- a/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst +++ b/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst @@ -63,7 +63,7 @@ Configurations Testing :enumerator:`TS_CONFIG_BODY_FACTORY_TEMPLATE_BASE`. -The following configurations (from ``records.config``) are overridable: +The following configurations (from ``records.yaml``) are overridable: ======================================================================== ==================================================================== TSOverridableConfigKey Value Configuration Value diff --git a/doc/developer-guide/config-vars.en.rst b/doc/developer-guide/config-vars.en.rst index 890eeb064c1..2ebbd396284 100644 --- a/doc/developer-guide/config-vars.en.rst +++ b/doc/developer-guide/config-vars.en.rst @@ -219,7 +219,7 @@ This will display the name as a link to the full definition. In general, a new configuration variable should not be present in the default :file:`records.yaml`. If it is added, such defaults should be added to the -file ``proxy/config/records.config.default.in``. This is used to generate the +file ``proxy/config/records.yaml.default.in``. This is used to generate the default :file:`records.yaml`. Just add the variable to the file in an appropriate place with a proper default as this will now override whatever default you put in the code for new installs. diff --git a/doc/developer-guide/debugging/debug-tags.en.rst b/doc/developer-guide/debugging/debug-tags.en.rst index 342f6087ac0..9fb73b7def2 100644 --- a/doc/developer-guide/debugging/debug-tags.en.rst +++ b/doc/developer-guide/debugging/debug-tags.en.rst @@ -64,10 +64,14 @@ below: Sets the following variables in :file:`records.yaml` (in the Traffic Server ``config`` directory): -:: +.. code-block:: yaml + + ts: + diags: + debug: + enabled: 1 + tags: debug-tag-name - CONFIG proxy.config.diags.debug.enabled INT 1 - CONFIG proxy.config.diags.debug.tags STRING debug-tag-name (Performance will be better if ``enabled`` is set to 3 rather than 1, but, using 3, output from ``TSDebug()`` will not be enabled, only from ``TSDbg()``.) diff --git a/doc/developer-guide/debugging/memory-leaks.en.rst b/doc/developer-guide/debugging/memory-leaks.en.rst index 2d7563071f8..93b63752f81 100644 --- a/doc/developer-guide/debugging/memory-leaks.en.rst +++ b/doc/developer-guide/debugging/memory-leaks.en.rst @@ -26,26 +26,29 @@ Memory leaks in a plugin can be detected using e.g. an MRTG graph related to memory - you can use memory dump information. Enable ``mem dump`` in :file:`records.yaml` as follows: -:: +.. code-block:: yaml - CONFIG proxy.config.dump_mem_info_frequency INT + ts: + dump_mem_info_frequency: value This causes Traffic Server to dump memory information to ``traffic.out`` at ```` (intervals are in seconds). A zero value means that it is disabled. -:: +.. code-block:: yaml - CONFIG proxy.config.res_track_memory INT + ts: + res_track_memory: value - When enabled makes Traffic Server track memory usage (allocations and releases). This - information is dumped to ``traffic.out`` when the user sends a SIGUSR1 signal or - periodically when :ts:cv:`proxy.config.dump_mem_info_frequency` is enabled. - ===== ====================================================================== - Value Description - ===== ====================================================================== - ``0`` Memory tracking Disabled - ``1`` Tracks IO Buffer Memory allocations and releases - ``2`` Tracks IO Buffer Memory and OpenSSL Memory allocations and releases - ===== ====================================================================== +When enabled makes Traffic Server track memory usage (allocations and releases). This +information is dumped to ``traffic.out`` when the user sends a SIGUSR1 signal or +periodically when :ts:cv:`proxy.config.dump_mem_info_frequency` is enabled. + +===== ====================================================================== +Value Description +===== ====================================================================== +``0`` Memory tracking Disabled +``1`` Tracks IO Buffer Memory allocations and releases +``2`` Tracks IO Buffer Memory and OpenSSL Memory allocations and releases +===== ====================================================================== diff --git a/doc/developer-guide/plugins/example-plugins/tls_bridge.en.rst b/doc/developer-guide/plugins/example-plugins/tls_bridge.en.rst index adebd924a24..ac400e69661 100644 --- a/doc/developer-guide/plugins/example-plugins/tls_bridge.en.rst +++ b/doc/developer-guide/plugins/example-plugins/tls_bridge.en.rst @@ -70,29 +70,56 @@ ingress |TS|, and the peer |TS| connects to the service. The Peer could in theor connect on to a further |TS| instance, acting as the ingress to that peer, but that doesn't seem a useful case. -#. Disable caching on |TS| in ``records.config``:: +#. Disable caching on |TS| in ``records.yaml``: - CONFIG proxy.config.http.cache.http INT 0 +.. code-block:: yaml + :linenos: + :emphasize-lines: 4 + + ts: + http: + cache: + http: 0 #. Configure the ports. * The Peer |TS| must be listening on an SSL enabled proxy port. For instance, if the proxy port - for the Peer is 4443, then configuration in ``records.config`` would have:: + for the Peer is 4443, then configuration in ``records.yaml`` would have: + + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + ts: + http: + server_ports: 4443:ssl - CONFIG proxy.config.http.server_ports STRING 4443:ssl * The Ingress |TS| must allow ``CONNECT`` to the Peer proxy port. This would be set in - ``records.config`` by:: + ``records.yaml`` by: + + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 + + ts: + http: + connect_ports: 4443 - CONFIG proxy.config.http.connect_ports STRING 4443 The Ingress |TS| also needs ``proxy.config.http.server_ports`` configured to have proxy ports to which the Client can connect. #. By default |TS| requires remap in order to allow to outbound request to the peer. To disable this - requirement and allow all connections, use the setting :: + requirement and allow all connections, use the setting: + + .. code-block:: yaml + :linenos: + :emphasize-lines: 3 - CONFIG proxy.config.url_remap.remap_required INT 0 + ts: + url_remap: + remap_required: 0 In this case |TS| will act as an open proxy which is unlikely to be a good idea. Therefore if this approach is used |TS| will need to run in a restricted environment or use access control @@ -116,24 +143,60 @@ useful case. supported by the two |TS| instances. This rule serves to allows the ``CONNECT`` sent from the ingress to cause a tunnel connection from the peer to the service. -#. Configure the Ingress |TS| to verify the Peer server certificate:: +#. Configure the Ingress |TS| to verify the Peer server certificate: + + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 - CONFIG proxy.config.ssl.client.verify.server.policy STRING ENFORCED + ts: + ssl: + client: + verify: + server: + policy: ENFORCED #. Configure Certificate Authority used by the Ingress |TS| to verify the Peer server certificate. If this is a directory, all of the certificates in the directory are treated as Certificate - Authorities. :: + Authorities. + + .. code-block:: yaml + :linenos: + :emphasize-lines: 6 + + ts: + ssl: + client: + CA: + cert: + filename: + + +#. Configure the Ingress |TS| to provide a client certificate: + + .. code-block:: yaml + :linenos: + :emphasize-lines: 5-6 + + ts: + ssl: + client: + cert: + filename: + path: - CONFIG proxy.config.ssl.client.CA.cert.filename STRING -#. Configure the Ingress |TS| to provide a client certificate:: +#. Configure the Peer |TS| to verify the Ingress client certificate: - CONFIG proxy.config.ssl.client.cert.path STRING - CONFIG proxy.config.ssl.client.cert.filename STRING + .. code-block:: yaml + :linenos: + :emphasize-lines: 4 -#. Configure the Peer |TS| to verify the Ingress client certificate:: + ts: + ssl: + client: + certification_level: 2 - CONFIG proxy.config.ssl.client.certification_level INT 2 #. Enable the |Name| plugin in ``plugin.config``. The plugin is configured by arguments in ``plugin.config``. These are arguments are in pairs of a *destination* and a *peer*. The diff --git a/doc/developer-guide/testing/blackbox-testing.en.rst b/doc/developer-guide/testing/blackbox-testing.en.rst index db1b1908c53..2154270aec8 100644 --- a/doc/developer-guide/testing/blackbox-testing.en.rst +++ b/doc/developer-guide/testing/blackbox-testing.en.rst @@ -113,7 +113,7 @@ A number of file objects are also defined to help test TrafficServer. Files that - squid.log - error.log - diags.log -- records.config +- records.yaml - cache.config - hosting.config - ip_allow.yaml @@ -134,7 +134,7 @@ Example ts1 = Test.MakeATSProcess("ts1",select_ports=False) # uses the setup object in the scope of the process object - ts1.Setup.ts.CopyConfig('config/records_8090.config','records.config') + ts1.Setup.ts.CopyConfig('config/records_8090.yaml','records.yaml') Origin Server diff --git a/doc/ext/traffic-server.py b/doc/ext/traffic-server.py index 929675fb9b8..104f6eeecf1 100644 --- a/doc/ext/traffic-server.py +++ b/doc/ext/traffic-server.py @@ -65,7 +65,7 @@ class TSConfVar(std.Target): """ Description of a traffic server configuration variable. - Argument is the variable as defined in records.config. + Argument is the variable as defined in records.yaml. Descriptive text should follow, indented. @@ -454,7 +454,7 @@ def find_doc(self, key, obj_type): def resolve_xref(self, env, src_doc, builder, obj_type, target, node, cont_node): dst_doc = self.find_doc(target, obj_type) if (dst_doc): - return sphinx.util.nodes.make_refnode(builder, src_doc, dst_doc, nodes.make_id(target), cont_node, 'records.config') + return sphinx.util.nodes.make_refnode(builder, src_doc, dst_doc, nodes.make_id(target), cont_node, 'records.yaml') # Python 2/3 compat - iteritems is 2, items is 3 # Although perhaps the lists are small enough items could be used in Python 2. diff --git a/doc/getting-started/index.en.rst b/doc/getting-started/index.en.rst index 070d142fc59..95dcb58a508 100644 --- a/doc/getting-started/index.en.rst +++ b/doc/getting-started/index.en.rst @@ -243,13 +243,21 @@ Enable Reverse Proxying ~~~~~~~~~~~~~~~~~~~~~~~ Within the :file:`records.yaml` configuration file, ensure that the following -settings have been configured as shown below:: +settings have been configured as shown below: + +.. code-block:: yaml + + ts: + http: + cache: + http: 1 + server_ports: 8080 8080:ipv6 + reverse_proxy: + enabled: 1 + url_remap: + pristine_host_hdr: 1 + remap_required: 1 - CONFIG proxy.config.http.cache.http INT 1 - CONFIG proxy.config.reverse_proxy.enabled INT 1 - CONFIG proxy.config.url_remap.remap_required INT 1 - CONFIG proxy.config.url_remap.pristine_host_hdr INT 1 - CONFIG proxy.config.http.server_ports STRING 8080 8080:ipv6 :ts:cv:`proxy.config.http.cache.http` Enables caching of proxied HTTP requests. @@ -374,13 +382,21 @@ Final Configurations Once completed, the following configuration files for |AW| contain the following entries: -:file:`records.yaml`:: +:file:`records.yaml`: + +.. code-block:: yaml + + ts: + http: + cache: + http: 1 + server_ports: 8080 8080:ipv6 + reverse_proxy: + enabled: 1 + url_remap: + pristine_host_hdr: 1 + remap_required: 1 - CONFIG proxy.config.http.cache.http INT 1 - CONFIG proxy.config.reverse_proxy.enabled INT 1 - CONFIG proxy.config.url_remap.remap_required INT 1 - CONFIG proxy.config.url_remap.pristine_host_hdr INT 1 - CONFIG proxy.config.http.server_ports STRING 80 80:ipv6 :file:`remap.config`:: @@ -417,10 +433,17 @@ Contrary to a reverse proxy, where you have a defined list of origin servers for which you wish to proxy (and optionally cache), a forward proxy is used to proxy (and optionally cache) for arbitrary remote hosts. As such, the following settings in :file:`records.yaml` are the base configuration for a minimal -forward proxy:: +forward proxy: + +.. code-block:: yaml + + ts: + http: + cache: + http: 1 + url_remap: + remap_required: 0 - CONFIG proxy.config.url_remap.remap_required INT 0 - CONFIG proxy.config.http.cache.http INT 1 :ts:cv:`proxy.config.url_remap.remap_required` Disables the requirement for a remap rule to exist and match the incoming @@ -430,9 +453,13 @@ forward proxy:: Enables caching of proxied HTTP requests. If your installation will be strictly a forwarding proxy, then reverse proxying -should be explicitly disabled:: +should be explicitly disabled: + +.. code-block:: yaml - CONFIG proxy.config.reverse_proxy.enabled INT 0 + ts: + reverse_proxy: + enabled: 0 Explicit Versus Transparent ~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/locale/ja/LC_MESSAGES/admin-guide/configuration/cache-basics.en.po b/doc/locale/ja/LC_MESSAGES/admin-guide/configuration/cache-basics.en.po index 92817ae091f..956adef7d06 100644 --- a/doc/locale/ja/LC_MESSAGES/admin-guide/configuration/cache-basics.en.po +++ b/doc/locale/ja/LC_MESSAGES/admin-guide/configuration/cache-basics.en.po @@ -328,7 +328,7 @@ msgstr "絶対フレッシュネスリミットを指定するには：" msgid "" "Edit the variables :ts:cv:`proxy.config.http.cache.heuristic_min_lifetime` " "and :ts:cv:`proxy.config.http.cache.heuristic_max_lifetime` in :file:" -"`records.config`." +"`records.yaml`." msgstr "" ":file:`records.yaml` 内の :ts:cv:`proxy.config.http.cache." "heuristic_min_lifetime` 変数と :ts:cv:`proxy.config.http.cache." @@ -366,7 +366,7 @@ msgstr "" #: ../../../admin-guide/configuration/cache-basics.en.rst:192 msgid "" "Change the value for :ts:cv:`proxy.config.http.cache.required_headers` in :" -"file:`records.config`." +"file:`records.yaml`." msgstr "" ":file:`records.yaml` 内の :ts:cv:`proxy.config.http.cache." "required_headers` の値を変更してください。" @@ -581,7 +581,7 @@ msgstr "再確認のオプションを設定するには" #: ../../../admin-guide/configuration/cache-basics.en.rst:278 msgid "" "Edit the variable :ts:cv:`proxy.config.http.cache.when_to_revalidate` in :" -"file:`records.config`." +"file:`records.yaml`." msgstr "" ":file:`records.yaml` の :ts:cv:`proxy.config.http.cache." "when_to_revalidate` を編集してください。" @@ -832,7 +832,7 @@ msgstr "" #: ../../../admin-guide/configuration/cache-basics.en.rst:408 msgid "" "Edit :ts:cv:`proxy.config.http.cache.ignore_client_no_cache` in :file:" -"`records.config`. ::" +"`records.yaml`. ::" msgstr "" ":file:`records.yaml` の :ts:cv:`proxy.config.http.cache." "ignore_client_no_cache` を編集してください。" @@ -913,7 +913,7 @@ msgstr "" #: ../../../admin-guide/configuration/cache-basics.en.rst:452 msgid "" "Edit :ts:cv:`proxy.config.http.cache.ignore_server_no_cache` in :file:" -"`records.config`. ::" +"`records.yaml`. ::" msgstr "" ":file:`records.yaml` の :ts:cv:`proxy.config.http.cache." "ignore_server_no_cache ` を編集してください。" @@ -961,7 +961,7 @@ msgstr "" #: ../../../admin-guide/configuration/cache-basics.en.rst:478 msgid "" "Edit :ts:cv:`proxy.config.http.cache.ignore_authentication` in :file:" -"`records.config`. ::" +"`records.yaml`. ::" msgstr "" ":file:`records.yaml` の :ts:cv:`proxy.config.http.cache." "ignore_authentication ` を編集してください。" @@ -1069,7 +1069,7 @@ msgstr "動的コンテンツに配慮した Traffic Server の振る舞いを #: ../../../admin-guide/configuration/cache-basics.en.rst:535 msgid "" "Edit :ts:cv:`proxy.config.http.cache.cache_urls_that_look_dynamic` in :file:" -"`records.config`. To disable caching, set the variable to ``0``, and to " +"`records.yaml`. To disable caching, set the variable to ``0``, and to " "explicitly permit caching use ``1``. ::" msgstr "" ":file:`records.yaml` の :ts:cv:`proxy.config.http.cache." @@ -1116,7 +1116,7 @@ msgstr "" #: ../../../admin-guide/configuration/cache-basics.en.rst:565 msgid "" "Edit :ts:cv:`proxy.config.http.cache.cache_responses_to_cookies` in :file:" -"`records.config`." +"`records.yaml`." msgstr "" ":file:`records.yaml` の :ts:cv:`proxy.config.http.cache." "cache_responses_to_cookies` を編集してください。" @@ -1255,7 +1255,7 @@ msgstr "このオプションを有効にするには :" #: ../../../admin-guide/configuration/cache-basics.en.rst:654 msgid "" "Set :ts:cv:`proxy.config.http.congestion_control.enabled` to ``1`` in :file:" -"`records.config`. ::" +"`records.yaml`. ::" msgstr "" ":file:`records.yaml` の :ts:cv:`proxy.config.http.congestion_control." "enabled` を ``1`` にセットしてください ::" diff --git a/doc/locale/ja/LC_MESSAGES/admin-guide/configuration/redirecting-http-requests.en.po b/doc/locale/ja/LC_MESSAGES/admin-guide/configuration/redirecting-http-requests.en.po index a81cf471e04..a9fe555de77 100644 --- a/doc/locale/ja/LC_MESSAGES/admin-guide/configuration/redirecting-http-requests.en.po +++ b/doc/locale/ja/LC_MESSAGES/admin-guide/configuration/redirecting-http-requests.en.po @@ -540,7 +540,7 @@ msgstr "HTTP リクエスト用マッピングルールの使用" #: ../../admin-guide/configuration/redirecting-http-requests.en.rst:281 msgid "" "Traffic Server provides several reverse proxy configuration options in :" -"file:`records.config` that enable you to:" +"file:`records.yaml` that enable you to:" msgstr "" "Traffic Server は :file:`records.yaml` でいくつかのリバースプロキシー設定" "オプションを提供し次のことを可能にします。" diff --git a/doc/locale/ja/LC_MESSAGES/admin-guide/configuring-traffic-server.en.po b/doc/locale/ja/LC_MESSAGES/admin-guide/configuring-traffic-server.en.po index a80d66116ef..c8a38201c8e 100644 --- a/doc/locale/ja/LC_MESSAGES/admin-guide/configuring-traffic-server.en.po +++ b/doc/locale/ja/LC_MESSAGES/admin-guide/configuring-traffic-server.en.po @@ -112,8 +112,8 @@ msgid "The following is a sample portion of :file:`records.yaml`:" msgstr "以下は :file:`records.yaml` ファイルの部分的なサンプルです" #: ../../../admin-guide/configuring-traffic-server.en.rst:75 -msgid "Sample records.config file" -msgstr "records.config ファイルのサンプル" +msgid "Sample records.yaml file" +msgstr "records.yaml ファイルのサンプル" #: ../../../admin-guide/configuring-traffic-server.en.rst:77 msgid "" @@ -122,7 +122,7 @@ msgid "" "manually edit all configuration files as described in :ref:`admin-" "configuration-files`." msgstr "" -"file:`records.config` ファイルに加え、Traffic Server は特定の機能を設定する" +"file:`records.yaml` ファイルに加え、Traffic Server は特定の機能を設定する" "ために使用されるその他の複数の設定ファイルを提供します。:ref:`admin-" "configuration-files` で説明されているように、すべての設定ファイルを手動で編" "集することができます。" diff --git a/doc/locale/ja/LC_MESSAGES/admin-guide/files/records.config.en.po b/doc/locale/ja/LC_MESSAGES/admin-guide/files/records.config.en.po index ccc16771219..e6cf623095e 100644 --- a/doc/locale/ja/LC_MESSAGES/admin-guide/files/records.config.en.po +++ b/doc/locale/ja/LC_MESSAGES/admin-guide/files/records.config.en.po @@ -28,8 +28,8 @@ msgstr "" "Generated-By: Babel 2.2.0\n" #: ../../../admin-guide/files/records.yaml.en.rst:23 -msgid "records.config" -msgstr "records.config" +msgid "records.yaml" +msgstr "records.yaml" #: ../../../admin-guide/files/records.yaml.en.rst:25 msgid "" @@ -346,7 +346,7 @@ msgstr "設定変数" #: ../../../admin-guide/files/records.yaml.en.rst:179 msgid "" "The following list describes the configuration variables available in the :" -"file:`records.config` file." +"file:`records.yaml` file." msgstr "" "次の一覧では :file:`records.yaml` ファイル内で利用可能な設定変数について説" "明します。" @@ -3958,7 +3958,7 @@ msgstr "" #: ../../../admin-guide/files/records.yaml.en.rst:2599 msgid "" "The following defaults (with the format``CONFIG proxy.config.log.[format]." -"[default]`` have been removed from ``records.config``. They can be accessed " +"[default]`` have been removed from ``records.yaml``. They can be accessed " "by editing :file:`logging.config`." msgstr "" @@ -4382,7 +4382,7 @@ msgstr "" #: ../../../admin-guide/files/records.yaml.en.rst:2881 msgid "" -"The current default, included in the ``records.config.default`` example " +"The current default, included in the ``records.yaml.default`` example " "configuration is:" msgstr "" diff --git a/doc/locale/ja/LC_MESSAGES/admin-guide/files/remap.config.en.po b/doc/locale/ja/LC_MESSAGES/admin-guide/files/remap.config.en.po index ddd8337ae78..125ac6e953e 100644 --- a/doc/locale/ja/LC_MESSAGES/admin-guide/files/remap.config.en.po +++ b/doc/locale/ja/LC_MESSAGES/admin-guide/files/remap.config.en.po @@ -543,11 +543,11 @@ msgid "" "At least one regular expressions must be specified in order to activate " "'deep linking protection'. There are limitations for the number of referer " "regular expression strings - 2048. In order to enable the 'deep linking " -"protection' feature in Traffic Server, configure records.config with::" +"protection' feature in Traffic Server, configure records.yaml with::" msgstr "" "'直リンク禁止機能' を動作させるためには少なくとも一つの正規表現が指定されて" "いなければ成りません。リファラー正規表現の数には制限があり 2048 です。" -"Traffic Server で '直リンク禁止機能' を有効化するためには records.config の" +"Traffic Server で '直リンク禁止機能' を有効化するためには records.yaml の" "次の変数を設定してください。" #: ../../../admin-guide/files/remap.config.en.rst:311 diff --git a/doc/locale/ja/LC_MESSAGES/admin-guide/files/storage.config.en.po b/doc/locale/ja/LC_MESSAGES/admin-guide/files/storage.config.en.po index 924a56fc439..2b66f1e6b14 100644 --- a/doc/locale/ja/LC_MESSAGES/admin-guide/files/storage.config.en.po +++ b/doc/locale/ja/LC_MESSAGES/admin-guide/files/storage.config.en.po @@ -135,10 +135,10 @@ msgstr "" #: ../../../admin-guide/files/storage.config.en.rst:71 msgid "" -"As with standard ``records.config`` integers, human readable prefixes are " +"As with standard ``records.yaml`` integers, human readable prefixes are " "also supported. They include" msgstr "" -"標準的な ``records.config`` の数値と同様、ヒューマンリーダブルなプレフィック" +"標準的な ``records.yaml`` の数値と同様、ヒューマンリーダブルなプレフィック" "スもサポートされています。これらには以下のものを含みます。" #: ../../../admin-guide/files/storage.config.en.rst:74 diff --git a/doc/locale/ja/LC_MESSAGES/admin-guide/monitoring/logging/managing-logs.en.po b/doc/locale/ja/LC_MESSAGES/admin-guide/monitoring/logging/managing-logs.en.po index ed25467b28c..68e35e90a08 100644 --- a/doc/locale/ja/LC_MESSAGES/admin-guide/monitoring/logging/managing-logs.en.po +++ b/doc/locale/ja/LC_MESSAGES/admin-guide/monitoring/logging/managing-logs.en.po @@ -48,7 +48,7 @@ msgid "" "By default, Traffic Server writes all event log files in the ``logs`` " "directory located in the directory where you installed |TS|. To change this " "location, adjust the value of :ts:cv:`proxy.config.log.logfile_dir` in :" -"file:`records.config`. You will need to either restart |TS| or run the " +"file:`records.yaml`. You will need to either restart |TS| or run the " "command :option:`traffic_ctl config reload` for changes to take effect." msgstr "" @@ -359,7 +359,7 @@ msgstr "" msgid "" "To set log file rolling options and/or configure |TS| to roll log files " "when they reach a certain size, adjust the following settings in :file:" -"`records.config`:" +"`records.yaml`:" msgstr "" #: ../../../admin-guide/monitoring/logging/managing-logs.en.rst:197 diff --git a/doc/locale/ja/LC_MESSAGES/admin-guide/plugins/ts_lua.en.po b/doc/locale/ja/LC_MESSAGES/admin-guide/plugins/ts_lua.en.po index ffa7e672fec..e7228f9d463 100644 --- a/doc/locale/ja/LC_MESSAGES/admin-guide/plugins/ts_lua.en.po +++ b/doc/locale/ja/LC_MESSAGES/admin-guide/plugins/ts_lua.en.po @@ -404,7 +404,7 @@ msgstr "" #: ../../../admin-guide/plugins/ts_lua.en.rst:165 msgid "" -"The debug tag is **ts_lua** and we should write this in records.config:" +"The debug tag is **ts_lua** and we should write this in records.yaml:" msgstr "" #: ../../../admin-guide/plugins/ts_lua.en.rst:167 diff --git a/doc/locale/ja/LC_MESSAGES/admin-guide/security/index.en.po b/doc/locale/ja/LC_MESSAGES/admin-guide/security/index.en.po index 39dacd5cc78..26ddfca7aba 100644 --- a/doc/locale/ja/LC_MESSAGES/admin-guide/security/index.en.po +++ b/doc/locale/ja/LC_MESSAGES/admin-guide/security/index.en.po @@ -315,7 +315,7 @@ msgstr "" #: ../../../admin-guide/security/index.en.rst:209 msgid "" "If you are using a client certificate, you must add its location to :file:" -"`records.config` in the setting :ts:cv:`proxy.config.ssl.client.cert.path` " +"`records.yaml` in the setting :ts:cv:`proxy.config.ssl.client.cert.path` " "and :ts:cv:`proxy.config.ssl.client.cert.filename`. ::" msgstr "" @@ -331,7 +331,7 @@ msgstr "" msgid "" "Enable or disable, per your security policy, server SSL certificate " "verification using :ts:cv:`proxy.config.ssl.client.verify.server` in :file:" -"`records.config`. ::" +"`records.yaml`. ::" msgstr "" #: ../../../admin-guide/security/index.en.rst:230 diff --git a/doc/locale/ja/LC_MESSAGES/appendices/command-line/traffic_ctl.en.po b/doc/locale/ja/LC_MESSAGES/appendices/command-line/traffic_ctl.en.po index acde4258bca..197c0ad2004 100644 --- a/doc/locale/ja/LC_MESSAGES/appendices/command-line/traffic_ctl.en.po +++ b/doc/locale/ja/LC_MESSAGES/appendices/command-line/traffic_ctl.en.po @@ -191,7 +191,7 @@ msgstr "" #: ../../../appendices/command-line/traffic_ctl.en.rst:158 msgid "" "Set the named configuration record to the specified value. Refer to the :" -"file:`records.config` documentation for a list of the configuration " +"file:`records.yaml` documentation for a list of the configuration " "variables you can specify. Note that this is not a synchronous operation." msgstr "" diff --git a/doc/locale/ja/LC_MESSAGES/appendices/faq.en.po b/doc/locale/ja/LC_MESSAGES/appendices/faq.en.po index f38b648d385..c7bcf4e0177 100644 --- a/doc/locale/ja/LC_MESSAGES/appendices/faq.en.po +++ b/doc/locale/ja/LC_MESSAGES/appendices/faq.en.po @@ -1056,7 +1056,7 @@ msgstr "" "リクエストされたオブジェクトが Traffic Server のキャッシュで許された最大サイ" "ズより大きかったので、Traffic Server はその大きすぎるオブジェクトへのプロキ" "シーは提供しましたがキャッシュは行いませんでした。キャッシュのオブジェクトサ" -"イズ制限を設定するには、records.config ファイルの :ts:cv:`proxy.config." +"イズ制限を設定するには、records.yaml ファイルの :ts:cv:`proxy.config." "cache.max_doc_size` 設定変数を変更してください。キャッシュ内のオブジェクトと" "のサイズを制限したくない場合は、ドキュメントサイズを ``0`` ( ゼロ ) に設定し" "てください。" @@ -1134,7 +1134,7 @@ msgid "" msgstr "" "正しいディレクトリを見ているかを確認してください。デフォルトでは Traffic " "Server はログファイルを ``logs`` ディレクトリに作成します。これは :file:" -"`records.config` の :ts:cv:`proxy.config.log.logfile_dir` で変更可能です。" +"`records.yaml` の :ts:cv:`proxy.config.log.logfile_dir` で変更可能です。" #: ../../../appendices/faq.en.rst:525 msgid "" diff --git a/doc/locale/ja/LC_MESSAGES/developer-guide/api/functions/TSHttpOverridableConfig.en.po b/doc/locale/ja/LC_MESSAGES/developer-guide/api/functions/TSHttpOverridableConfig.en.po index 7cf834ff19c..8a3d6be4a1b 100644 --- a/doc/locale/ja/LC_MESSAGES/developer-guide/api/functions/TSHttpOverridableConfig.en.po +++ b/doc/locale/ja/LC_MESSAGES/developer-guide/api/functions/TSHttpOverridableConfig.en.po @@ -85,7 +85,7 @@ msgstr "設定" #: ../../../developer-guide/api/functions/TSHttpOverridableConfig.en.rst:64 msgid "" -"The following configurations (from ``records.config``) are overridable." +"The following configurations (from ``records.yaml``) are overridable." msgstr "" #: ../../../developer-guide/api/functions/TSHttpOverridableConfig.en.rst:66 diff --git a/doc/locale/ja/LC_MESSAGES/developer-guide/architecture/architecture.en.po b/doc/locale/ja/LC_MESSAGES/developer-guide/architecture/architecture.en.po index d48ed8f59f3..5ca8bd0f3ad 100644 --- a/doc/locale/ja/LC_MESSAGES/developer-guide/architecture/architecture.en.po +++ b/doc/locale/ja/LC_MESSAGES/developer-guide/architecture/architecture.en.po @@ -1561,7 +1561,7 @@ msgstr "レンジリクエスト" #: ../../../developer-guide/architecture/architecture.en.rst:719 msgid "" "Cache valid only if :ts:cv:`proxy.config.http.cache.range.lookup` in :file:" -"`records.config` is non-zero. This does not mean the range request can be " +"`records.yaml` is non-zero. This does not mean the range request can be " "cached, only that it might be satisfiable from the cache. In addition, :ts:" "cv:`proxy.config.http.cache.range.write` can be set to try to force a write " "on a range request. This probably has little value at the moment, but if " @@ -1723,7 +1723,7 @@ msgid "" "serving an object from cache in one transaction while it is being written " "in another. Several settings are needed for it to be used. See :ref:`admin-" "configuration-reducing-origin-requests`. It must specifically enabled in :" -"file:`records.config` and if not, a cache read will fail if the object is " +"file:`records.yaml` and if not, a cache read will fail if the object is " "currently be written or updated." msgstr "" "コード内には *書込みながら読込み* をサポートするための条件があります。 *書" diff --git a/doc/locale/ja/LC_MESSAGES/developer-guide/config-vars.en.po b/doc/locale/ja/LC_MESSAGES/developer-guide/config-vars.en.po index 2a91ff6b684..aa59fa539f0 100644 --- a/doc/locale/ja/LC_MESSAGES/developer-guide/config-vars.en.po +++ b/doc/locale/ja/LC_MESSAGES/developer-guide/config-vars.en.po @@ -384,7 +384,7 @@ msgstr "" msgid "" "In general, a new configuration variable should not be present in the " "default :file:`records.yaml`. If it is added, such defaults should be " -"added to the file ``proxy/config/records.config.default.in``. This is used " +"added to the file ``proxy/config/records.yaml.default.in``. This is used " "to generate the default :file:`records.yaml`. Just add the variable to " "the file in an appropriate place with a proper default as this will now " "override whatever default you put in the code for new installs." diff --git a/doc/locale/ja/LC_MESSAGES/developer-guide/debugging/memory-leaks.en.po b/doc/locale/ja/LC_MESSAGES/developer-guide/debugging/memory-leaks.en.po index 5725b1b74ac..900932b8655 100644 --- a/doc/locale/ja/LC_MESSAGES/developer-guide/debugging/memory-leaks.en.po +++ b/doc/locale/ja/LC_MESSAGES/developer-guide/debugging/memory-leaks.en.po @@ -36,7 +36,7 @@ msgstr "" msgid "" "Memory leaks in a plugin can be detected using e.g. an MRTG graph related " "to memory - you can use memory dump information. Enable ``mem dump`` in :" -"file:`records.config` as follows:" +"file:`records.yaml` as follows:" msgstr "" #: ../../developer-guide/debugging/memory-leaks.en.rst:33 diff --git a/doc/locale/ja/LC_MESSAGES/developer-guide/plugins/getting-started/a-simple-plugin.en.po b/doc/locale/ja/LC_MESSAGES/developer-guide/plugins/getting-started/a-simple-plugin.en.po index b9981660597..0a10e9046ef 100644 --- a/doc/locale/ja/LC_MESSAGES/developer-guide/plugins/getting-started/a-simple-plugin.en.po +++ b/doc/locale/ja/LC_MESSAGES/developer-guide/plugins/getting-started/a-simple-plugin.en.po @@ -87,7 +87,7 @@ msgstr "" msgid "" "All plugins must be located in the directory specified by the configuration " "variable ``proxy.config.plugin.plugin_dir``, which is located in the :file:" -"`records.config` file. The directory can be specified as an absolute or " +"`records.yaml` file. The directory can be specified as an absolute or " "relative path." msgstr "" @@ -95,7 +95,7 @@ msgstr "" msgid "" "**Note:** in the example above, Traffic Server notes are directed to the " "console by specifying ``E`` for ``proxy.config.diags.output.note`` in :file:" -"`records.config`. The second note shows Traffic Server attempting to load " +"`records.yaml`. The second note shows Traffic Server attempting to load " "the ``hello-world`` plugin. The third line of Traffic Server output is from " "your plugin." msgstr "" diff --git a/doc/locale/ja/LC_MESSAGES/developer-guide/plugins/getting-started/index.en.po b/doc/locale/ja/LC_MESSAGES/developer-guide/plugins/getting-started/index.en.po index c89a6c4051e..66608654940 100644 --- a/doc/locale/ja/LC_MESSAGES/developer-guide/plugins/getting-started/index.en.po +++ b/doc/locale/ja/LC_MESSAGES/developer-guide/plugins/getting-started/index.en.po @@ -285,7 +285,7 @@ msgid "" "file to determine the names of all shared plugin libraries that need to be " "loaded. The ``plugin.config`` file also defines arguments that are to be " "passed to each plugin's initialization function, ``TSPluginInit``. The :" -"file:`records.config` file defines the path to each plugin shared library, " +"file:`records.yaml` file defines the path to each plugin shared library, " "as described in :ref:`specify-the-plugins-location`." msgstr "" diff --git a/doc/release-notes/upgrading.en.rst b/doc/release-notes/upgrading.en.rst index edaab81de16..e0155e40176 100644 --- a/doc/release-notes/upgrading.en.rst +++ b/doc/release-notes/upgrading.en.rst @@ -64,7 +64,7 @@ Configuration changes --------------------- The following incompatible changes to the configurations have been made in this version of ATS. -The records.config entry proxy.config.http.down_server.abort_threshold has been removed. +The records.yaml entry proxy.config.http.down_server.abort_threshold has been removed. Plugins diff --git a/doc/static/images/admin/records.jpg b/doc/static/images/admin/records.jpg deleted file mode 100644 index 381d1387052..00000000000 Binary files a/doc/static/images/admin/records.jpg and /dev/null differ diff --git a/example/plugins/c-api/passthru/passthru.cc b/example/plugins/c-api/passthru/passthru.cc index 6ddef92e671..5fd828b7745 100644 --- a/example/plugins/c-api/passthru/passthru.cc +++ b/example/plugins/c-api/passthru/passthru.cc @@ -26,7 +26,7 @@ * * This plugin demonstrates: * - * - Using TSMgmtStringCreate() to add custom records into records.config. + * - Using TSMgmtStringCreate() to add custom records into records.yaml. * - Listening on a custom socket with TSPortDescriptorAccept(). * - Using TSHttpConnectWithPluginId() and the VConn API to proxy HTTP traffic. */ diff --git a/include/records/I_RecordsConfig.h b/include/records/I_RecordsConfig.h index ebb710afc83..a5538758a0f 100644 --- a/include/records/I_RecordsConfig.h +++ b/include/records/I_RecordsConfig.h @@ -29,7 +29,7 @@ extern int max_records_entries; enum RecordRequiredType { - RR_NULL, // config is _not_ required to be defined in records.config + RR_NULL, // config is _not_ required to be defined in records.yaml RR_REQUIRED // config _is_ required to be defined in record.config }; @@ -40,7 +40,7 @@ struct RecordElement { RecDataT value_type; // type of the record value (INT, FLOAT, etc) const char *value; // default value for the record RecUpdateT update; // action necessary to change a configuration - RecordRequiredType required; // is records required to be in records.config? + RecordRequiredType required; // is records required to be in records.yaml? RecCheckT check; const char *regex; RecAccessT access; // access level of the record diff --git a/include/ts/apidefs.h.in b/include/ts/apidefs.h.in index 8ede2bc26a0..de29b257c8b 100644 --- a/include/ts/apidefs.h.in +++ b/include/ts/apidefs.h.in @@ -899,7 +899,7 @@ typedef enum { } TSOverridableConfigKey; /* The TASK pool of threads is the primary method of off-loading continuations from the - net-threads. Configure this with proxy.config.task_threads in records.config. */ + net-threads. Configure this with proxy.config.task_threads in records.yaml. */ typedef enum { TS_THREAD_POOL_NET, TS_THREAD_POOL_TASK, diff --git a/include/ts/experimental.h b/include/ts/experimental.h index 3e7fe574436..ade7ccee53c 100644 --- a/include/ts/experimental.h +++ b/include/ts/experimental.h @@ -231,7 +231,7 @@ tsapi TSReturnCode TSIpStringToAddr(const char *str, size_t str_len, struct sock /** Attempt to attach the contp continuation to sockets that have already been opened by the traffic manager and defined as belonging to plugins (based on - records.config configuration). If a connection is successfully accepted, + records.yaml configuration). If a connection is successfully accepted, the TS_EVENT_NET_ACCEPT is delivered to the continuation. The event data will be a valid TSVConn bound to the accepted connection. In order to configure such a socket, add the "plugin" keyword to a port @@ -239,7 +239,7 @@ tsapi TSReturnCode TSIpStringToAddr(const char *str, size_t str_len, struct sock Transparency/IP settings can also be defined, but a port cannot have both the "ssl" or "plugin" keywords configured. - Need to update records.config comments on proxy.config.http.server_ports + Need to update records.yaml comments on proxy.config.http.server_ports when this option is promoted from experimental. */ tsapi TSReturnCode TSPluginDescriptorAccept(TSCont contp); @@ -325,7 +325,7 @@ tsapi char *TSMatcherLineName(TSMatcherLine ml, int element); tsapi char *TSMatcherLineValue(TSMatcherLine ml, int element); /**************************************************************************** - * Set a records.config integer variable + * Set a records.yaml integer variable ****************************************************************************/ // DEPRECATED tsapi TSReturnCode TSMgmtConfigIntSet(const char *var_name, TSMgmtInt value); diff --git a/include/ts/ts.h b/include/ts/ts.h index 2028e6a219e..a5ff3815885 100644 --- a/include/ts/ts.h +++ b/include/ts/ts.h @@ -1309,7 +1309,7 @@ tsapi char *TSSslSecretGet(const char *secret_name, int secret_name_length, int tsapi TSReturnCode TSSslSecretUpdate(const char *secret_name, int secret_name_length); -/* Create a new SSL context based on the settings in records.config */ +/* Create a new SSL context based on the settings in records.yaml */ tsapi TSSslContext TSSslServerContextCreate(TSSslX509 cert, const char *certname, const char *rsp_file); tsapi void TSSslContextDestroy(TSSslContext ctx); tsapi TSReturnCode TSSslTicketKeyUpdate(char *ticketData, int ticketDataLen); @@ -2125,7 +2125,7 @@ typedef enum { TS_STAT_SYNC_TIMEAVG, } TSStatSync; -/* APIs to create new records.config configurations */ +/* APIs to create new records.yaml configurations */ tsapi TSReturnCode TSMgmtStringCreate(TSRecordType rec_type, const char *name, const TSMgmtString data_default, TSRecordUpdateType update_type, TSRecordCheckType check_type, const char *check_regex, TSRecordAccessType access_type); diff --git a/include/tscore/Filenames.h b/include/tscore/Filenames.h index c828acca2ad..c65723ddb17 100644 --- a/include/tscore/Filenames.h +++ b/include/tscore/Filenames.h @@ -30,7 +30,7 @@ namespace filename constexpr const char *VOLUME = "volume.config"; constexpr const char *PLUGIN = "plugin.config"; - // These still need to have their corresponding records.config settings removed. + // These still need to have their corresponding records.yaml settings removed. constexpr const char *LOGGING = "logging.yaml"; constexpr const char *CACHE = "cache.config"; constexpr const char *IP_ALLOW = "ip_allow.yaml"; diff --git a/include/tscpp/api/Logger.h b/include/tscpp/api/Logger.h index bfad9247099..be849de2df1 100644 --- a/include/tscpp/api/Logger.h +++ b/include/tscpp/api/Logger.h @@ -105,7 +105,7 @@ extern "C" void TSError(const char *fmt, ...) ATSCPPAPI_PRINTFLIKE(1, 2); /** * A helper macro to get access to the Diag messages available in traffic server. These can be enabled * via traffic_server -T "tag.*" or since this macro includes the file can you further refine to an - * individual file or even a particular line! This can also be enabled via records.config. + * individual file or even a particular line! This can also be enabled via records.yaml. */ #define TS_DEBUG(tag, fmt, ...) \ do { \ @@ -115,7 +115,7 @@ extern "C" void TSError(const char *fmt, ...) ATSCPPAPI_PRINTFLIKE(1, 2); /** * A helper macro to get access to the error.log messages available in traffic server. This * will also output a DEBUG message visible via traffic_server -T "tag.*", or by enabling the - * tag in records.config. + * tag in records.yaml. */ #define TS_ERROR(tag, fmt, ...) \ do { \ @@ -131,7 +131,7 @@ struct LoggerState; * @brief Create log files that are automatically rolled and cleaned up as space is required. * * Log files created using the Logger class will be placed in the same directory as - * other log files, that directory is specified in records.config. All of the logging + * other log files, that directory is specified in records.yaml. All of the logging * configuration such as max space available for all logs includes any logs created * using the Logger class. * diff --git a/iocore/dns/I_DNSProcessor.h b/iocore/dns/I_DNSProcessor.h index cfd01d6f8d1..c5029fabc59 100644 --- a/iocore/dns/I_DNSProcessor.h +++ b/iocore/dns/I_DNSProcessor.h @@ -89,7 +89,7 @@ struct DNSProcessor : public Processor { /// Default: single threaded handler. DNSHandler *handler = nullptr; /// Query timeout value. - /// Default: @c DEFAULT_DNS_TIMEOUT (or as set in records.config) + /// Default: @c DEFAULT_DNS_TIMEOUT (or as set in records.yaml) int timeout = 0; ///< Timeout value for request. /// Host resolution style. /// Default: IPv4, IPv6 ( @c HOST_RES_IPV4 ) diff --git a/iocore/net/Net.cc b/iocore/net/Net.cc index 0fc615b5032..5d3e64fe40a 100644 --- a/iocore/net/Net.cc +++ b/iocore/net/Net.cc @@ -34,7 +34,7 @@ RecRawStatBlock *net_rsb = nullptr; // All in milli-seconds -int net_config_poll_timeout = -1; // This will get set via either command line or records.config. +int net_config_poll_timeout = -1; // This will get set via either command line or records.yaml. int net_event_period = 10; int net_accept_period = 10; int net_retry_delay = 10; diff --git a/iocore/net/SSLSNIConfig.cc b/iocore/net/SSLSNIConfig.cc index 8214d12cbfe..3ee810e5b33 100644 --- a/iocore/net/SSLSNIConfig.cc +++ b/iocore/net/SSLSNIConfig.cc @@ -296,7 +296,7 @@ SNIConfig::release(SNIConfigParams *params) } // See if any of the client-side actions would trigger for this combination of servername and client IP -// host_sni_policy is an in/out parameter. It starts with the global policy from the records.config +// host_sni_policy is an in/out parameter. It starts with the global policy from the records.yaml // setting proxy.config.http.host_sni_policy and is possibly overridden if the sni policy // contains a host_sni_policy entry bool diff --git a/iocore/net/quic/QUICLossDetector.h b/iocore/net/quic/QUICLossDetector.h index 5ed1c228b7a..87de012fea4 100644 --- a/iocore/net/quic/QUICLossDetector.h +++ b/iocore/net/quic/QUICLossDetector.h @@ -72,7 +72,7 @@ class QUICLossDetector : public Continuation, public QUICFrameHandler uint8_t _ack_delay_exponent = 3; // Recovery A.2. Constants of Interest - // Values will be loaded from records.config via QUICConfig at constructor + // Values will be loaded from records.yaml via QUICConfig at constructor uint32_t _k_packet_threshold = 0; float _k_time_threshold = 0.0; // kGranularity, kInitialRtt are defined in QUICRTTMeasure diff --git a/iocore/net/quic/QUICNewRenoCongestionController.h b/iocore/net/quic/QUICNewRenoCongestionController.h index 43a870ccc53..c1154d2d18c 100644 --- a/iocore/net/quic/QUICNewRenoCongestionController.h +++ b/iocore/net/quic/QUICNewRenoCongestionController.h @@ -65,7 +65,7 @@ class QUICNewRenoCongestionController : public QUICCongestionController const QUICSentPacketInfoUPtr &largest_lost_packet, ink_hrtime period) const; // Recovery B.1. Constants of interest - // Values will be loaded from records.config via QUICConfig at constructor + // Values will be loaded from records.yaml via QUICConfig at constructor uint32_t _k_initial_window = 0; uint32_t _k_minimum_window = 0; float _k_loss_reduction_factor = 0.0; diff --git a/iocore/utils/diags.i b/iocore/utils/diags.i index 60ee7b60a70..c94c26a7be9 100644 --- a/iocore/utils/diags.i +++ b/iocore/utils/diags.i @@ -30,7 +30,7 @@ // void reconfigure_diags() // // This function extracts the current diags configuration settings from -// records.config, and rebuilds the Diags data structures. +// records.yaml, and rebuilds the Diags data structures. // ////////////////////////////////////////////////////////////////////////////// diff --git a/plugins/esi/README.combo b/plugins/esi/README.combo index 211e8e0dc89..f19d0be860c 100644 --- a/plugins/esi/README.combo +++ b/plugins/esi/README.combo @@ -85,7 +85,7 @@ Config sample map http://localhost/combo.com http://os.combo.com map http://localhost/dir1 http://os1.combo.com - (note that if pristine_host_hdr is enabled in records.config, the Host header + (note that if pristine_host_hdr is enabled in records.yaml, the Host header of request to your combo origin server is 'localhost') Version 1.2.0 diff --git a/plugins/experimental/fastcgi/src/fcgi_config.cc b/plugins/experimental/fastcgi/src/fcgi_config.cc index 428c58f98b2..91aa52550bb 100644 --- a/plugins/experimental/fastcgi/src/fcgi_config.cc +++ b/plugins/experimental/fastcgi/src/fcgi_config.cc @@ -638,7 +638,7 @@ FcgiPluginConfig::initConfig(const char *fn) // Find the configuration name tok = strtok_r(nullptr, " \t", &ln); if (fcgiHttpTxnConfigFind(tok, -1, &name, &expected_type) != TS_SUCCESS) { - TSError("[ats_fastcgi] File %s, line %d: no records.config name given", fn, line_num); + TSError("[ats_fastcgi] File %s, line %d: no records.yaml name given", fn, line_num); continue; } @@ -801,4 +801,4 @@ void InterceptPluginData::setGlobalConfigObj(FcgiPluginConfig *config) { global_config = config; -} \ No newline at end of file +} diff --git a/plugins/experimental/url_sig/README b/plugins/experimental/url_sig/README index c7e397845db..f2e8a45e51b 100644 --- a/plugins/experimental/url_sig/README +++ b/plugins/experimental/url_sig/README @@ -32,10 +32,15 @@ Quick install: Edge cache debugging - To enable the TSDebug verbose logging, change records.config to have: - - CONFIG proxy.config.diags.debug.enabled INT 1 - CONFIG proxy.config.diags.debug.tags STRING url_sig + To enable the TSDebug verbose logging, change records.yaml to have: + + ```yaml + ts: + diags: + debug: + enabled: 1 + tags: url_sig + ``` and do a traffic_ctl config reload; Debug output will go to traffic.out. Failed transactions (signature check fails that is) will be logged diff --git a/plugins/lua/ts_lua.c b/plugins/lua/ts_lua.c index 400b8bfef4d..9154e105516 100644 --- a/plugins/lua/ts_lua.c +++ b/plugins/lua/ts_lua.c @@ -45,7 +45,7 @@ static ts_lua_main_ctx *ts_lua_g_main_ctx_array = NULL; static pthread_key_t lua_g_state_key; static pthread_key_t lua_state_key; -// records.config entry injected by plugin +// records.yaml entry injected by plugin static char const *const ts_lua_mgmt_state_str = "proxy.config.plugin.lua.max_states"; static char const *const ts_lua_mgmt_state_regex = "^[1-9][0-9]*$"; @@ -112,7 +112,7 @@ create_lua_vms() { ts_lua_main_ctx *ctx_array = NULL; - // Inject the setting into records.config + // Inject the setting into records.yaml static bool ts_mgt_int_inserted = false; if (!ts_mgt_int_inserted) { if (TS_SUCCESS == TSMgmtIntCreate(TS_RECORDTYPE_CONFIG, ts_lua_mgmt_state_str, TS_LUA_MAX_STATE_COUNT, diff --git a/proxy/Plugin.h b/proxy/Plugin.h index 86691a535f2..4b65bbeaef6 100644 --- a/proxy/Plugin.h +++ b/proxy/Plugin.h @@ -28,7 +28,7 @@ typedef enum { RELOAD_OFF, RELOAD_ON, RELOAD_COUNT } PluginDynamicReloadMode; -// read records.config to parse plugin related configs +// read records.yaml to parse plugin related configs void parsePluginConfig(); bool isPluginDynamicReloadEnabled(); diff --git a/proxy/http/HttpBodyFactory.cc b/proxy/http/HttpBodyFactory.cc index 1f3e01ce51f..eda6f03c72a 100644 --- a/proxy/http/HttpBodyFactory.cc +++ b/proxy/http/HttpBodyFactory.cc @@ -254,14 +254,14 @@ HttpBodyFactory::reconfigure() } // callbacks not setup right //////////////////////////////////////////// - // extract relevant records.config values // + // extract relevant records.yaml values // //////////////////////////////////////////// Debug("body_factory", "config variables changed, reconfiguring..."); all_found = true; - // enable_customizations if records.config set + // enable_customizations if records.yaml set rec_err = RecGetRecordInt("proxy.config.body_factory.enable_customizations", &e); enable_customizations = ((rec_err == REC_ERR_OKAY) ? e : 0); all_found = all_found && (rec_err == REC_ERR_OKAY); diff --git a/proxy/http/HttpSM.cc b/proxy/http/HttpSM.cc index db0096b476c..e478ba67c35 100644 --- a/proxy/http/HttpSM.cc +++ b/proxy/http/HttpSM.cc @@ -292,7 +292,7 @@ HttpVCTable::cleanup_all() /* * Helper functions to ensure that the parallel - * API set timeouts are set consistently with the records.config settings + * API set timeouts are set consistently with the records.yaml settings */ ink_hrtime HttpSM::get_server_inactivity_timeout() diff --git a/proxy/http/HttpTransact.cc b/proxy/http/HttpTransact.cc index 5d1e2ba8987..63dfd5d6dcb 100644 --- a/proxy/http/HttpTransact.cc +++ b/proxy/http/HttpTransact.cc @@ -3622,7 +3622,7 @@ HttpTransact::handle_response_from_parent(State *s) s->current.server->connect_result = ENOTCONN; // only mark the parent down in hostdb if the configuration allows it and the parent, - // is not congested, see proxy.config.http.parent_proxy.mark_down_hostdb in records.config. + // is not congested, see proxy.config.http.parent_proxy.mark_down_hostdb in records.yaml. if (s->txn_conf->parent_failures_update_hostdb && s->current.state != OUTBOUND_CONGESTION) { s->state_machine->do_hostdb_update_if_necessary(); } @@ -5183,7 +5183,7 @@ HttpTransact::get_ka_info_from_config(State *s, ConnectionAttributes *server_inf TxnDebug("http_trans", "server_info->http_version %d.%d, check_hostdb %d", server_info->http_version.get_major(), server_info->http_version.get_minor(), check_hostdb); - // Set keep_alive info based on the records.config setting + // Set keep_alive info based on the records.yaml setting server_info->keep_alive = s->txn_conf->keep_alive_enabled_out ? HTTP_KEEPALIVE : HTTP_NO_KEEPALIVE; return check_hostdb; diff --git a/proxy/http2/HTTP2.h b/proxy/http2/HTTP2.h index 3353888660b..fdb2d6f1d41 100644 --- a/proxy/http2/HTTP2.h +++ b/proxy/http2/HTTP2.h @@ -362,7 +362,7 @@ ParseResult http2_convert_header_from_1_1_to_2(HTTPHdr *); void http2_init(); /** Each of these values correspond to the flow control policy described in or - * records.config documentation for proxy.config.http2.flow_control.policy_in. + * records.yaml documentation for proxy.config.http2.flow_control.policy_in. */ enum class Http2FlowControlPolicy { STATIC_SESSION_AND_STATIC_STREAM, diff --git a/proxy/logging/Log.cc b/proxy/logging/Log.cc index e8d15e66d04..4ab29e90402 100644 --- a/proxy/logging/Log.cc +++ b/proxy/logging/Log.cc @@ -297,7 +297,7 @@ struct LoggingFlushContinuation : public Continuation { Define the available logging fields. This used to be part of the init() function, but now is separate so that standalone programs that do not require more services (e.g., that do not - need to read records.config) can just call init_fields. + need to read records.yaml) can just call init_fields. Note that the LogFields are added to the list with the copy flag false so that the LogFieldList destructor will reclaim this memory. diff --git a/proxy/logging/LogAccess.h b/proxy/logging/LogAccess.h index f34e7cee162..c95ad18431f 100644 --- a/proxy/logging/LogAccess.h +++ b/proxy/logging/LogAccess.h @@ -267,12 +267,12 @@ class LogAccess int marshal_http_header_field_escapify(LogField::Container container, char *field, char *buf); // - // named records.config int variables + // named records.yaml int variables // int marshal_config_int_var(char *config_var, char *buf); // - // named records.config string variables + // named records.yaml string variables // int marshal_config_str_var(char *config_var, char *buf); diff --git a/proxy/logging/LogConfig.h b/proxy/logging/LogConfig.h index 1885b0d05a2..b0ddbd344a2 100644 --- a/proxy/logging/LogConfig.h +++ b/proxy/logging/LogConfig.h @@ -88,14 +88,14 @@ struct dirent; are changed in the config file, using log::change_configuration(). to add a new config variable: - 1. add a line in records.config for the new config variable. - the name in records.config should be "proxy.config.log.xxx". + 1. add a line in records.yaml for the new config variable. + the name in records.yaml should be "proxy.config.log.xxx". 2. create a member variable to store the current value. the name of the member variable should be "xxx". 3. if the member variable is a string, add a delete for it in the destructor, logconfig::~logconfig. 4. initialize the member variable in logconfig::setup_default_values - 5. update the member variable from the records.config file + 5. update the member variable from the records.yaml file in logconfig::read_configuration_variables() using a call to configreadinteger or configreadstring. 6. add a line in the logconfig::register_config_callbacks() function diff --git a/proxy/logging/LogStandalone.cc b/proxy/logging/LogStandalone.cc index 3bb9c1d8c87..a112ac54cae 100644 --- a/proxy/logging/LogStandalone.cc +++ b/proxy/logging/LogStandalone.cc @@ -197,7 +197,7 @@ init_log_standalone(const char *pgm_name, bool one_copy) init_log_standalone_basic This routine is similar to init_log_standalone, but it is intended for - simple standalone applications that do not read the records.config file + simple standalone applications that do not read the records.yaml file and that do not need a process manager, thus it: 1) does not call initialize_process_manager diff --git a/proxy/shared/DiagsConfig.cc b/proxy/shared/DiagsConfig.cc index f8d1f9f5f51..45efffe9100 100644 --- a/proxy/shared/DiagsConfig.cc +++ b/proxy/shared/DiagsConfig.cc @@ -34,7 +34,7 @@ // void reconfigure_diags() // // This function extracts the current diags configuration settings from -// records.config, and rebuilds the Diags data structures. +// records.yaml, and rebuilds the Diags data structures. // ////////////////////////////////////////////////////////////////////////////// @@ -66,7 +66,7 @@ DiagsConfig::reconfigure_diags() register_diags_callbacks(); } //////////////////////////////////////////// - // extract relevant records.config values // + // extract relevant records.yaml values // //////////////////////////////////////////// all_found = true; @@ -75,7 +75,7 @@ DiagsConfig::reconfigure_diags() c.enabled(DiagsTagType_Debug, _diags->base_debug_tags != nullptr ? 1 : 0); c.enabled(DiagsTagType_Action, _diags->base_action_tags != nullptr ? 1 : 0); - // enabled if records.config set + // enabled if records.yaml set e = static_cast(REC_readInteger("proxy.config.diags.debug.enabled", &found)); if (e && found) { @@ -137,7 +137,7 @@ DiagsConfig::reconfigure_diags() _diags->deactivate_all(DiagsTagType_Action); ////////////////////////////////////////////////////////////////////// - // add new tag tables from records.config or command line overrides // + // add new tag tables from records.yaml or command line overrides // ////////////////////////////////////////////////////////////////////// _diags->activate_taglist((_diags->base_debug_tags ? _diags->base_debug_tags : dt), DiagsTagType_Debug); @@ -165,7 +165,7 @@ DiagsConfig::reconfigure_diags() // // static void *diags_config_callback(void *opaque_token, void *data) // -// This is the records.config registration callback that is called +// This is the records.yaml registration callback that is called // when any diags value is changed. Each time a diags value changes // the entire diags state is reconfigured. // @@ -243,7 +243,7 @@ DiagsConfig::config_diags_norecords() c.enabled(DiagsTagType_Action, 0); } - // Route all outputs to stderr by default until reconfigured with records.config + // Route all outputs to stderr by default until reconfigured with records.yaml for (auto &o : c.outputs) { o.to_stderr = true; } @@ -336,7 +336,7 @@ DiagsConfig::DiagsConfig(std::string_view prefix_string, const char *filename, c // right now, this system kind of sucks, we rebuild the tag tables // // from scratch for *every* proxy.config.diags value that changed; // // dgourley is looking into changing the management API to provide // -// a callback each time records.config changed, possibly better. // +// a callback each time records.yaml changed, possibly better. // // ////////////////////////////////////////////////////////////////////////////// void diff --git a/src/records/RecCore.cc b/src/records/RecCore.cc index 3b1609a64f6..52f4ff0f65c 100644 --- a/src/records/RecCore.cc +++ b/src/records/RecCore.cc @@ -166,7 +166,7 @@ link_byte(const char * /* name */, RecDataT /* data_type */, RecData data, void // mimic Config.cc::config_string_alloc_cb // cookie e.g. is the DEFAULT_xxx_str value which this function keeps up to date with -// the latest default applied during a config update from records.config +// the latest default applied during a config update from records static int link_string_alloc(const char * /* name */, RecDataT /* data_type */, RecData data, void *cookie) { diff --git a/src/records/RecordsConfig.cc b/src/records/RecordsConfig.cc index c30820ba32c..c29fcc8ffc6 100644 --- a/src/records/RecordsConfig.cc +++ b/src/records/RecordsConfig.cc @@ -40,7 +40,7 @@ static const RecordElement RecordsConfig[] = { //############################################################################## //# - //# records.config items + //# records.yaml items //# //############################################################################## {RECT_CONFIG, "proxy.config.product_company", RECD_STRING, "Apache Software Foundation", RECU_NULL, RR_NULL, RECC_NULL, nullptr, RECA_NULL} diff --git a/src/traffic_server/InkAPI.cc b/src/traffic_server/InkAPI.cc index 7467223faa8..c7a59333060 100644 --- a/src/traffic_server/InkAPI.cc +++ b/src/traffic_server/InkAPI.cc @@ -9125,7 +9125,7 @@ TSHttpTxnPrivateSessionSet(TSHttpTxn txnp, int private_session) return TS_ERROR; } -// APIs to register new Mgmt (records.config) entries. +// APIs to register new Mgmt (records) entries. TSReturnCode TSMgmtStringCreate(TSRecordType rec_type, const char *name, const TSMgmtString data_default, TSRecordUpdateType update_type, TSRecordCheckType check_type, const char *check_regex, TSRecordAccessType access_type) diff --git a/src/traffic_server/traffic_server.cc b/src/traffic_server/traffic_server.cc index 6322af6e24a..24caf2be495 100644 --- a/src/traffic_server/traffic_server.cc +++ b/src/traffic_server/traffic_server.cc @@ -1775,7 +1775,7 @@ main(int /* argc ATS_UNUSED */, const char **argv) } #endif - // Bootstrap syslog. Since we haven't read records.config + // Bootstrap syslog. Since we haven't read records.yaml // yet we do not know where openlog("traffic_server", LOG_PID | LOG_NDELAY | LOG_NOWAIT, LOG_DAEMON); @@ -1885,7 +1885,7 @@ main(int /* argc ATS_UNUSED */, const char **argv) EThread *main_thread = new EThread; main_thread->set_specific(); - // Re-initialize diagsConfig based on records.config configuration + // Re-initialize diagsConfig based on records.yaml configuration REC_ReadConfigString(diags_log_filename, "proxy.config.diags.logfile.filename", sizeof(diags_log_filename)); if (strnlen(diags_log_filename, sizeof(diags_log_filename)) == 0) { strncpy(diags_log_filename, DEFAULT_DIAGS_LOG_FILENAME, sizeof(diags_log_filename)); @@ -1994,7 +1994,7 @@ main(int /* argc ATS_UNUSED */, const char **argv) REC_ReadConfigInteger(stacksize, "proxy.config.thread.default.stacksize"); // This has some special semantics, in that providing this configuration on - // command line has higher priority than what is set in records.config. + // command line has higher priority than what is set in records.yaml. if (-1 != poll_timeout) { net_config_poll_timeout = poll_timeout; } else { diff --git a/src/tscore/Diags.cc b/src/tscore/Diags.cc index 4cf4d5dfc5b..63e63f68833 100644 --- a/src/tscore/Diags.cc +++ b/src/tscore/Diags.cc @@ -108,13 +108,13 @@ location(const SourceLocation *loc, DiagsShowLocation show, DiagsLevel level) // This is the constructor for the Diags class. The constructor takes // two strings called the "base debug tags" (bdt) and the // "base action tags" (bat). These represent debug/action overrides, -// to override the records.config values. They current come from +// to override the records.yaml values. They current come from // command-line options. // -// If bdt is not nullptr, and not "", it overrides records.config settings. -// If bat is not nullptr, and not "", it overrides records.config settings. +// If bdt is not nullptr, and not "", it overrides records.yaml settings. +// If bat is not nullptr, and not "", it overrides records.yaml settings. // -// When the constructor is done, records.config callbacks will be set, +// When the constructor is done, records.yaml callbacks will be set, // the initial values read, and the Diags instance will be ready to use. // ////////////////////////////////////////////////////////////////////////////// @@ -773,7 +773,7 @@ Diags::should_roll_outputlog() // If for some reason, someone wants the feature to have stdout pointing to some file on // disk, and stderr pointing to a different file on disk, and then also wants both files to // rotate according to the (same || different) scheme, it would not be difficult to add - // some more config options in records.config and said feature into this function. + // some more config options in records.yaml and said feature into this function. if (ret_val) { ink_assert(!need_consider_stderr); } diff --git a/src/tscpp/api/Logger.cc b/src/tscpp/api/Logger.cc index 2322febb145..3ed269de4c3 100644 --- a/src/tscpp/api/Logger.cc +++ b/src/tscpp/api/Logger.cc @@ -61,7 +61,7 @@ struct atscppapi::LoggerState : noncopyable { namespace { // Since the TSTextLog API doesn't support override the log file sizes (I will add this to TS api at some point) -// we will use the roll size specified by default in records.config. +// we will use the roll size specified by default in records.yaml. const int ROLL_ON_TIME = 1; // See RollingEnabledValues in LogConfig.h } // namespace diff --git a/tests/README.md b/tests/README.md index e1ff360cb08..579527680e3 100644 --- a/tests/README.md +++ b/tests/README.md @@ -99,7 +99,7 @@ A number of file objects are defined to help with adding values to a given confi * diags.log ##### config files - * records.config + * records.yaml * cache.config * hosting.config * ip_allow.yaml @@ -121,7 +121,7 @@ Create a server ```python # don't set ports because a config file will set them ts1 = Test.MakeATSProcess("ts1",select_ports=False) -ts1.Setup.ts.CopyConfig('config/records_8090.config','records.config') +ts1.Setup.ts.CopyConfig('config/records_8090.yaml','records.yaml') ``` Create a server and get the dynamic port value @@ -172,14 +172,14 @@ Copy a file over ```python ts1 = Test.MakeATSProcess("ts1",select_ports=False) # uses the setup object in the scope of the process object -ts1.Setup.ts.CopyConfig('config/records_8090.config','records.config') +ts1.Setup.ts.CopyConfig('config/records_8090.yaml','records.yaml') ``` ```python ts1 = Test.MakeATSProcess("ts1",select_ports=False) # uses the Setup in the global process via a variable passing -Test.Setup.ts.CopyConfig('config/records_8090.config','records.config',ts1) +Test.Setup.ts.CopyConfig('config/records_8090.yaml','records.yaml',ts1) # same as above, but uses the dynamic object model form -Test.Setup.ts.CopyConfig('config/records_8090.config','records.config',Test.Processes.ts1) +Test.Setup.ts.CopyConfig('config/records_8090.yaml','records.yaml',Test.Processes.ts1) ``` ## Setting up Origin Server diff --git a/tests/gold_tests/autest-site/trafficserver.test.ext b/tests/gold_tests/autest-site/trafficserver.test.ext index 06b863c46b8..94a7a9c4062 100755 --- a/tests/gold_tests/autest-site/trafficserver.test.ext +++ b/tests/gold_tests/autest-site/trafficserver.test.ext @@ -370,7 +370,7 @@ def MakeATSProcess(obj, name, command='traffic_server', select_ports=True, }) if enable_cache: - # In records.config, the cache is enabled by default so there's nothing + # In records.yaml, the cache is enabled by default so there's nothing # we have to do here to functionally enable it. However, the tests that # rely upon the cache will not function correctly if ATS starts # processing traffic before the cache is ready. Thus we set the diff --git a/tests/gold_tests/forward_proxy/forward_proxy.test.py b/tests/gold_tests/forward_proxy/forward_proxy.test.py index 14e64b69f03..71bcc87630c 100644 --- a/tests/gold_tests/forward_proxy/forward_proxy.test.py +++ b/tests/gold_tests/forward_proxy/forward_proxy.test.py @@ -33,7 +33,7 @@ def __init__(self, verify_scheme_matches_protocol: Union[int, None]): :param verify_scheme_matches_protocol: The value with which to configure Traffic Server's proxy.config.ssl.client.scheme_proto_mismatch_policy. A value of None - means that no value will be explicitly set in the records.config. + means that no value will be explicitly set in the records.yaml. :type verify_scheme_matches_protocol: int or None """ self._scheme_proto_mismatch_policy = verify_scheme_matches_protocol diff --git a/tests/gold_tests/h2/http2_flow_control.test.py b/tests/gold_tests/h2/http2_flow_control.test.py index 0094583fb34..03e1058f47b 100644 --- a/tests/gold_tests/h2/http2_flow_control.test.py +++ b/tests/gold_tests/h2/http2_flow_control.test.py @@ -53,17 +53,17 @@ def __init__( :param initial_window_size: The value with which to configure the proxy.config.http2.initial_window_size_in ATS parameter in the - records.config file. If the paramenter is None, then no window size + records.yaml file. If the paramenter is None, then no window size will be explicitly set and ATS will use the default value. :param max_concurrent_streams_in: The value with which to configure the proxy.config.http2.max_concurrent_streams_in ATS parameter in the - records.config file. If the paramenter is None, then no window size + records.yaml file. If the paramenter is None, then no window size will be explicitly set and ATS will use the default value. :param flow_control_policy: The value with which to configure the proxy.config.http2.flow_control.policy_in ATS parameter the - records.config file. If the paramenter is None, then no policy + records.yaml file. If the paramenter is None, then no policy configuration will be explicitly set and ATS will use the default value. """ diff --git a/tests/gold_tests/tls/tls_client_alpn_configuration.test.py b/tests/gold_tests/tls/tls_client_alpn_configuration.test.py index 1e4fac50817..be69463219a 100644 --- a/tests/gold_tests/tls/tls_client_alpn_configuration.test.py +++ b/tests/gold_tests/tls/tls_client_alpn_configuration.test.py @@ -38,7 +38,7 @@ def __init__( """Declare the various test Processes. :param records_config_alpn: The string with which to configure the ATS - ALPN via proxy.config.ssl.client.alpn_protocols in the records.config. + ALPN via proxy.config.ssl.client.alpn_protocols in the records.yaml. If the paramenter is None, then no ALPN configuration will be explicitly set and ATS will use the default value. @@ -48,7 +48,7 @@ def __init__( will be set. :param alpn_is_malformed: If True, then the configured ALPN string in - the records.config will be malformed. The TestRun will be configured to + the records.yaml will be malformed. The TestRun will be configured to expect a warning and the server will be configured to receive no ALPN. """ self._alpn = records_config_alpn diff --git a/tests/gold_tests/tls/tls_client_cert.test.py b/tests/gold_tests/tls/tls_client_cert.test.py index 3a66eb658b2..b8e11cea7e0 100644 --- a/tests/gold_tests/tls/tls_client_cert.test.py +++ b/tests/gold_tests/tls/tls_client_cert.test.py @@ -170,7 +170,7 @@ ' client_cert: {0}/signed-bar.pem'.format(ts.Variables.SSLDir)) tr2.Disk.sni_yaml.AddLine( ' client_key: {0}/signed-bar.key'.format(ts.Variables.SSLDir)) -# recreate the records.config with the cert filename changed +# recreate the records.yaml with the cert filename changed tr2.Disk.File(recordspath, id="records_config", typename="ats:config:records"), tr2.Disk.records_config.update({ 'proxy.config.ssl.server.cert.path': '{0}'.format(ts.Variables.SSLDir), @@ -245,9 +245,9 @@ trupdate.StillRunningAfter = ts trupdate.StillRunningAfter = server trupdate.StillRunningAfter = server2 -# Make a meaningless config change on the path so the records.config reload logic will trigger +# Make a meaningless config change on the path so the records.yaml reload logic will trigger trupdate.Setup.CopyAs("ssl/signed2-bar.pem", ".", "{0}/signed-bar.pem".format(ts.Variables.SSLDir)) -# in the config/ssl directory for records.config +# in the config/ssl directory for records.yaml trupdate.Setup.CopyAs("ssl/signed-foo.pem", ".", "{0}/signed2-foo.pem".format(ts.Variables.SSLDir)) trupdate.Processes.Default.Command = 'traffic_ctl config set proxy.config.ssl.client.cert.path {0}/; touch {1}'.format( ts.Variables.SSLDir, snipath) diff --git a/tests/gold_tests/tls/tls_client_cert_override_plugin.test.py b/tests/gold_tests/tls/tls_client_cert_override_plugin.test.py index a3f2a29cc72..7724236d6a9 100644 --- a/tests/gold_tests/tls/tls_client_cert_override_plugin.test.py +++ b/tests/gold_tests/tls/tls_client_cert_override_plugin.test.py @@ -167,7 +167,7 @@ trupdate.StillRunningAfter = ts trupdate.StillRunningAfter = server trupdate.StillRunningAfter = server2 -# in the config/ssl directory for records.config +# in the config/ssl directory for records.yaml trupdate.Setup.CopyAs("ssl/signed-foo.pem", ".", "{0}/signed2-foo.pem".format(ts.Variables.SSLDir)) trupdate.Processes.Default.Command = 'traffic_ctl config set proxy.config.ssl.client.cert.path {0}/; touch {1}'.format( shortdir, snipath) diff --git a/tests/gold_tests/tls/tls_client_cert_plugin.test.py b/tests/gold_tests/tls/tls_client_cert_plugin.test.py index 749b2d2cc83..24cde9a2cf9 100644 --- a/tests/gold_tests/tls/tls_client_cert_plugin.test.py +++ b/tests/gold_tests/tls/tls_client_cert_plugin.test.py @@ -164,7 +164,7 @@ ' client_cert: {0}/../signed-bar.pem'.format(ts.Variables.SSLDir)) tr2.Disk.sni_yaml.AddLine( ' client_key: {0}/../signed-bar.key'.format(ts.Variables.SSLDir)) -# recreate the records.config with the cert filename changed +# recreate the records.yaml with the cert filename changed tr2.Disk.File(recordspath, id="records_config", typename="ats:config:records"), tr2.Disk.records_config.update({ 'proxy.config.ssl.server.cert.path': '{0}'.format(ts.Variables.SSLDir), @@ -240,9 +240,9 @@ trupdate.StillRunningAfter = ts trupdate.StillRunningAfter = server trupdate.StillRunningAfter = server2 -# Make a meaningless config change on the path so the records.config reload logic will trigger +# Make a meaningless config change on the path so the records.yaml reload logic will trigger trupdate.Setup.CopyAs("ssl/signed2-bar.pem", ".", "{0}/signed-bar.pem".format(ts.Variables.SSLDir)) -# in the config/ssl directory for records.config +# in the config/ssl directory for records.yaml trupdate.Setup.CopyAs("ssl/signed-foo.pem", ".", "{0}/signed2-foo.pem".format(ts.Variables.SSLDir)) trupdate.Processes.Default.Command = 'traffic_ctl config set proxy.config.ssl.client.cert.path {0}/../; touch {1}; touch {2}'.format( ts.Variables.SSLDir, snipath, recordspath) diff --git a/tests/tools/microDNS/README.md b/tests/tools/microDNS/README.md index d6b533ea0a0..c7595202c27 100644 --- a/tests/tools/microDNS/README.md +++ b/tests/tools/microDNS/README.md @@ -41,6 +41,14 @@ For a detailed description of flags, see `python3 uDNS.py -h` Use with Apache Traffic Server ------ -1. In `records.config`, add configuration lines: `CONFIG proxy.config.dns.nameservers STRING ip_address:PORT` and `CONFIG proxy.config.dns.round_robin_nameservers INT 0`, where `PORT` is whatever port you want uDNS to serve on. +1. In `records.yaml`, add configuration field: + +```yaml +ts: + dns: + nameservers: ip_address:PORT + round_robin_nameservers: 0 +``` +where `PORT` is whatever port you want uDNS to serve on. 2. Run uDNS on `Ip_addr`:`PORT` 3. Now all domains mapped in the uDNS JSON config file should be mapped by ATS as well diff --git a/tests/tools/plugins/cont_schedule.cc b/tests/tools/plugins/cont_schedule.cc index 7706d895564..46553b856ac 100644 --- a/tests/tools/plugins/cont_schedule.cc +++ b/tests/tools/plugins/cont_schedule.cc @@ -21,7 +21,7 @@ #include // for debug // debug messages viewable by setting 'proxy.config.diags.debug.tags' -// in 'records.config' +// in 'records.yaml' // debug messages during one-time initialization static const char DEBUG_TAG_INIT[] = "TSContSchedule_test.init"; diff --git a/tests/tools/plugins/continuations_verify.cc b/tests/tools/plugins/continuations_verify.cc index 5e6525d9c7f..c88a0ac881e 100644 --- a/tests/tools/plugins/continuations_verify.cc +++ b/tests/tools/plugins/continuations_verify.cc @@ -27,7 +27,7 @@ #include // for debug // debug messages viewable by setting 'proxy.config.diags.debug.tags' -// in 'records.config' +// in 'records.yaml' // debug messages during one-time initialization static const char DEBUG_TAG_INIT[] = "continuations_verify.init"; diff --git a/tests/tools/plugins/emergency_shutdown.cc b/tests/tools/plugins/emergency_shutdown.cc index 993d89d7ae6..ce8eab602d6 100644 --- a/tests/tools/plugins/emergency_shutdown.cc +++ b/tests/tools/plugins/emergency_shutdown.cc @@ -21,7 +21,7 @@ #include // for debug // debug messages viewable by setting 'proxy.config.diags.debug.tags' -// in 'records.config' +// in 'records.yaml' // debug messages during one-time initialization static const char DEBUG_TAG[] = "TSEmergency_test"; diff --git a/tests/tools/plugins/fatal_shutdown.cc b/tests/tools/plugins/fatal_shutdown.cc index 65eec2b1da5..abfd90b5ad7 100644 --- a/tests/tools/plugins/fatal_shutdown.cc +++ b/tests/tools/plugins/fatal_shutdown.cc @@ -21,7 +21,7 @@ #include // for debug // debug messages viewable by setting 'proxy.config.diags.debug.tags' -// in 'records.config' +// in 'records.yaml' // debug messages during one-time initialization static const char DEBUG_TAG[] = "TSFatal_test"; diff --git a/tests/tools/plugins/ssntxnorder_verify.cc b/tests/tools/plugins/ssntxnorder_verify.cc index ad856cdaf4f..b137858682b 100644 --- a/tests/tools/plugins/ssntxnorder_verify.cc +++ b/tests/tools/plugins/ssntxnorder_verify.cc @@ -31,7 +31,7 @@ #include // debug messages viewable by setting 'proxy.config.diags.debug.tags' -// in 'records.config' +// in 'records.yaml' // debug messages during one-time initialization static const char DEBUG_TAG_INIT[] = "ssntxnorder_verify.init"; diff --git a/tools/jtest/README.zh.md b/tools/jtest/README.zh.md index 286ad9e8b7c..241c0d5861f 100644 --- a/tools/jtest/README.zh.md +++ b/tools/jtest/README.zh.md @@ -408,10 +408,16 @@ ATS的内存是一个历来敏感的话题，内存泄漏也是最最难排查 0 | 0 | 131072 | memory/ioBufAllocator[10] 0 | 0 | 65536 | memory/ioBufAllocator[9] -如上所示中结果中，ram在records.config中的相关配置为： +如上所示中结果中，ram在records.yaml中的相关配置为： + +```yaml + ts: + cache: + ram_cache: + size: 3221225470 + ram_cache_cutoff: 41943040 +``` - CONFIG proxy.config.cache.ram_cache.size INT 3221225470 - CONFIG proxy.config.cache.ram_cache_cutoff INT 41943040 remap.config配置为：