Docs update. (commit in progress)

.gitignore

@@ -52,7 +52,7 @@ config.cache
 config.status
 config.nice
 
-configs/records.config.default
+configs/records.yaml.default
 configs/storage.config.default
 
 doc/_build

ci/jenkins/remap.config

@@ -28,13 +28,13 @@ reverse_map http://192.168.3.17:6969 https://ci.trafficserver.apache.org
 
 # Read-the-docs
 #map http://docs.trafficserver.apache.org \
-#    http://trafficserver.readthedocs.org/en/latest/reference/configuration/records.config.en.html
+#    http://trafficserver.readthedocs.org/en/latest/reference/configuration/records.yaml.en.html
 redirect http://docs.trafficserver.apache.org https://docs.trafficserver.apache.org
 
 map https://docs.trafficserver.apache.org/__RTD http://192.168.3.17/RTD
 
 map https://docs.trafficserver.apache.org/records.config \
-    https://trafficserver.readthedocs.org/en/latest/reference/configuration/records.config.en.html \
+    https://trafficserver.readthedocs.org/en/latest/reference/configuration/records.yaml.en.html \
     @plugin=conf_remap.so @pparam=records.config.pristine
 
 map https://docs.trafficserver.apache.org https://trafficserver.readthedocs.org \

configs/records.yaml.default.in

@@ -1,7 +1,7 @@
 ##############################################################################
 # *NOTE*: All options covered in this file should be documented in the docs:
 #
-#    https://docs.trafficserver.apache.org/records.config
+#    https://docs.trafficserver.apache.org/records.yaml
 ##############################################################################
 
 ts:
@@ -10,21 +10,21 @@ ts:
     limits:
       http:
 
-# https://docs.trafficserver.apache.org/records.config#proxy-config-cache-limits-http-max-alts
+# https://docs.trafficserver.apache.org/records.yaml#proxy-config-cache-limits-http-max-alts
         max_alts: !!int '5'
     log:
       alternate:
 
-# https://docs.trafficserver.apache.org/records.config#proxy-config-cache-log-alternate-eviction
+# https://docs.trafficserver.apache.org/records.yaml#proxy-config-cache-log-alternate-eviction
         eviction: !!int '0'
 
-# https://docs.trafficserver.apache.org/records.config#proxy-config-cache-max-doc-size
+# https://docs.trafficserver.apache.org/records.yaml#proxy-config-cache-max-doc-size
     max_doc_size: !!int '0'
     min_average_object_size: !!int '8000'
 
 ##############################################################################
 # RAM and disk cache configurations. Docs:
-#    https://docs.trafficserver.apache.org/records.config#ram-cache
+#    https://docs.trafficserver.apache.org/records.yaml#ram-cache
 #    https://docs.trafficserver.apache.org/en/latest/admin-guide/files/storage.config.en.html
 ##############################################################################
     ram_cache:
@@ -33,19 +33,19 @@ ts:
     threads_per_disk: !!int '8'
 ##############################################################################
 # Debugging. Docs:
-#    https://docs.trafficserver.apache.org/records.config#diagnostic-logging-configuration
+#    https://docs.trafficserver.apache.org/records.yaml#diagnostic-logging-configuration
 ##############################################################################
   diags:
     debug:
       enabled: !!int '0'
       tags: http|dns
 
-#    https://docs.trafficserver.apache.org/records.config#proxy-config-dump-mem-info-frequency
+#    https://docs.trafficserver.apache.org/records.yaml#proxy-config-dump-mem-info-frequency
   dump_mem_info_frequency: !!int '0'
 
 ##############################################################################
 # Thread configurations. Docs:
-#    https://docs.trafficserver.apache.org/records.config#thread-variables
+#    https://docs.trafficserver.apache.org/records.yaml#thread-variables
 ##############################################################################
   exec_thread:
     affinity: !!int '1'
@@ -61,7 +61,7 @@ ts:
 
 ##############################################################################
 # Heuristic cache expiration. Docs:
-#    https://docs.trafficserver.apache.org/records.config#heuristic-expiration
+#    https://docs.trafficserver.apache.org/records.yaml#heuristic-expiration
 ##############################################################################
       heuristic_lm_factor: !!float '0.1'
       heuristic_max_lifetime: !!int '86400'
@@ -75,20 +75,20 @@ ts:
 
 ##############################################################################
 # Cache control. Docs:
-#    https://docs.trafficserver.apache.org/records.config#cache-control
+#    https://docs.trafficserver.apache.org/records.yaml#cache-control
 #    https://docs.trafficserver.apache.org/en/latest/admin-guide/files/cache.config.en.html
 ##############################################################################
       ignore_client_cc_max_age: !!int '1'
 
-# https://docs.trafficserver.apache.org/records.config#proxy-config-http-cache-required-headers
+# https://docs.trafficserver.apache.org/records.yaml#proxy-config-http-cache-required-headers
       required_headers: !!int '2'
 
-# https://docs.trafficserver.apache.org/records.config#proxy-config-http-cache-when-to-revalidate
+# https://docs.trafficserver.apache.org/records.yaml#proxy-config-http-cache-when-to-revalidate
       when_to_revalidate: !!int '0'
 
 ##############################################################################
 # Origin server connect attempts. Docs:
-#    https://docs.trafficserver.apache.org/records.config#origin-server-connect-attempts
+#    https://docs.trafficserver.apache.org/records.yaml#origin-server-connect-attempts
 ##############################################################################
     connect_attempts_max_retries: !!int '3'
     connect_attempts_max_retries_dead_server: !!int '1'
@@ -101,13 +101,13 @@ ts:
 
 ##############################################################################
 # Proxy users variables. Docs:
-#    https://docs.trafficserver.apache.org/records.config#proxy-user-variables
+#    https://docs.trafficserver.apache.org/records.yaml#proxy-user-variables
 ##############################################################################
     insert_client_ip: !!int '1'
 
 ##############################################################################
 # Via: headers. Docs:
-#     https://docs.trafficserver.apache.org/records.config#proxy-config-http-insert-response-via-str
+#     https://docs.trafficserver.apache.org/records.yaml#proxy-config-http-insert-response-via-str
 ##############################################################################
     insert_request_via_str: !!int '1'
     insert_response_via_str: !!int '0'
@@ -117,40 +117,40 @@ ts:
 
 ##############################################################################
 # Negative response caching, for redirects and errors. Docs:
-#    https://docs.trafficserver.apache.org/records.config#negative-response-caching
+#    https://docs.trafficserver.apache.org/records.yaml#negative-response-caching
 ##############################################################################
     negative_caching_enabled: !!int '0'
     negative_caching_lifetime: !!int '1800'
     normalize_ae: !!int '1'
 
 ##############################################################################
 # Parent proxy configuration, in addition to these settings also see parent.config. Docs:
-#    https://docs.trafficserver.apache.org/records.config#parent-proxy-configuration
+#    https://docs.trafficserver.apache.org/records.yaml#parent-proxy-configuration
 #    https://docs.trafficserver.apache.org/en/latest/admin-guide/files/parent.config.en.html
 ##############################################################################
     parent_proxy:
       retry_time: !!int '300'
 
 ##############################################################################
 # Security. Docs:
-#    https://docs.trafficserver.apache.org/records.config#security
+#    https://docs.trafficserver.apache.org/records.yaml#security
 ##############################################################################
     push_method_enabled: !!int '0'
 
 ##############################################################################
 # Specify server addresses and ports to bind for HTTP and HTTPS. Docs:
-#    https://docs.trafficserver.apache.org/records.config#proxy.config.http.server_ports
+#    https://docs.trafficserver.apache.org/records.yaml#proxy.config.http.server_ports
 ##############################################################################
     server_ports: 8080 8080:ipv6
 
-#    https://docs.trafficserver.apache.org/records.config#proxy-config-http-slow-log-threshold
+#    https://docs.trafficserver.apache.org/records.yaml#proxy-config-http-slow-log-threshold
     slow:
       log:
         threshold: !!int '0'
 
 ##############################################################################
 # HTTP connection timeouts (secs). Docs:
-#    https://docs.trafficserver.apache.org/records.config#http-connection-timeouts
+#    https://docs.trafficserver.apache.org/records.yaml#http-connection-timeouts
 ##############################################################################
     transaction_active_timeout_in: !!int '900'
     transaction_active_timeout_out: !!int '0'
@@ -160,7 +160,7 @@ ts:
 
 ##############################################################################
 # Logging Config. Docs:
-#    https://docs.trafficserver.apache.org/records.config#logging-configuration
+#    https://docs.trafficserver.apache.org/records.yaml#logging-configuration
 #    https://docs.trafficserver.apache.org/en/latest/admin-guide/files/logging.yaml.en.html
 ##############################################################################
   log:
@@ -175,18 +175,18 @@ ts:
 
 ##############################################################################
 # Network. Docs:
-#    https://docs.trafficserver.apache.org/records.config#network
+#    https://docs.trafficserver.apache.org/records.yaml#network
 ##############################################################################
   net:
     connections_throttle: !!int '30000'
     default_inactivity_timeout: !!int '86400'
     max_connections_in: !!int '30000'
     max_requests_in: !!int '0'
 
-#    https://docs.trafficserver.apache.org/records.config#proxy-config-res-track-memory
+#    https://docs.trafficserver.apache.org/records.yaml#proxy-config-res-track-memory
   res_track_memory: !!int '0'
 
-# https://docs.trafficserver.apache.org/records.config#reverse-proxy
+# https://docs.trafficserver.apache.org/records.yaml#reverse-proxy
   reverse_proxy:
     enabled: !!int '1'
   ssl:
@@ -197,7 +197,7 @@ ts:
 
 ##############################################################################
 # SSL Termination. Docs:
-#    https://docs.trafficserver.apache.org/records.config#client-related-configuration
+#    https://docs.trafficserver.apache.org/records.yaml#client-related-configuration
 #    https://docs.trafficserver.apache.org/en/latest/admin-guide/files/ssl_multicert.config.en.html
 ##############################################################################
       verify:
@@ -208,11 +208,11 @@ ts:
 
 ##############################################################################
 # These settings control remapping, and if the proxy allows (open) forward proxy or not. Docs:
-#    https://docs.trafficserver.apache.org/records.config#url-remap-rules
+#    https://docs.trafficserver.apache.org/records.yaml#url-remap-rules
 #    https://docs.trafficserver.apache.org/en/latest/admin-guide/files/remap.config.en.html
 ##############################################################################
   url_remap:
 
-# https://docs.trafficserver.apache.org/records.config#proxy-config-url-remap-pristine-host-hdr
+# https://docs.trafficserver.apache.org/records.yaml#proxy-config-url-remap-pristine-host-hdr
     pristine_host_hdr: !!int '0'
     remap_required: !!int '1'

doc/.tx/config

@@ -98,8 +98,8 @@ source_file = _build/locale/pot/admin-guide/files/plugin.config.en.pot
 source_lang = en
 
 [apache-traffic-server-6x.admin-guide--files--records_config_en]
-file_filter = locale/<lang>/LC_MESSAGES/admin-guide/files/records.config.en.po
-source_file = _build/locale/pot/admin-guide/files/records.config.en.pot
+file_filter = locale/<lang>/LC_MESSAGES/admin-guide/files/records.yaml.en.po
+source_file = _build/locale/pot/admin-guide/files/records.yaml.en.pot
 source_lang = en
 
 [apache-traffic-server-6x.admin-guide--files--remap_config_en]

doc/Pipfile

@@ -39,6 +39,8 @@ sphinxcontrib-plantuml = "*"
 # i18n
 sphinx-intl = "*"
 
+pyyaml = "*"
+
 # For parsing Doxygen XML output, to add links from an API description
 # to the source code for that object
 lxml = "*"

doc/admin-guide/configuration/cache-basics.en.rst

@@ -171,7 +171,7 @@ To specify an absolute freshness limit:
 
 #. 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`.
+   :file:`records.yaml`.
 
 #. Run the :option:`traffic_ctl config reload` command to apply the configuration changes.
 
@@ -190,7 +190,7 @@ information).
 To configure Traffic Server to cache objects with specific headers:
 
 #. Change the value for :ts:cv:`proxy.config.http.cache.required_headers`
-   in :file:`records.config`.
+   in :file:`records.yaml`.
 
 #. Run the :option:`traffic_ctl config reload` command to apply the configuration changes.
 
@@ -276,7 +276,7 @@ can set specific revalidation rules in :file:`cache.config`.
 To configure revalidation options
 
 #. Edit the variable :ts:cv:`proxy.config.http.cache.when_to_revalidate`
-   in :file:`records.config`.
+   in :file:`records.yaml`.
 
 #. Run the :option:`traffic_ctl config reload` command to apply the configuration changes.
 
@@ -298,7 +298,7 @@ must configure Traffic Server to accept ``PUSH`` requests.
 #. Edit :file:`ip_allow.yaml` to allow ``PUSH`` from the appropriate addresses.
 
 #. Update :ts:cv:`proxy.config.http.push_method_enabled` in
-   :file:`records.config`::
+   :file:`records.yaml`::
 
         CONFIG proxy.config.http.push_method_enabled INT 1
 
@@ -348,7 +348,7 @@ if it is indeed cacheable.
 
 To set cache pinning rules:
 
-#. Enable :ts:cv:`proxy.config.cache.permit.pinning` in :file:`records.config`::
+#. Enable :ts:cv:`proxy.config.cache.permit.pinning` in :file:`records.yaml`::
 
         CONFIG proxy.config.cache.permit.pinning INT 1
 
@@ -406,7 +406,7 @@ ignores ``no-cache`` headers from client requests and serves the object
 from its cache.
 
 #. Edit :ts:cv:`proxy.config.http.cache.ignore_client_no_cache` in
-   :file:`records.config`. ::
+   :file:`records.yaml`. ::
 
         CONFIG proxy.config.http.cache.ignore_client_no_cache INT 1
 
@@ -450,7 +450,7 @@ in most cases.
 To configure Traffic Server to ignore server ``no-cache`` headers:
 
 #. Edit :ts:cv:`proxy.config.http.cache.ignore_server_no_cache` in
-   :file:`records.config`. ::
+   :file:`records.yaml`. ::
 
         CONFIG proxy.config.http.cache.ignore_server_no_cache INT 1
 
@@ -476,7 +476,7 @@ To configure Traffic Server to ignore server ``WWW-Authenticate``
 headers:
 
 #. Edit :ts:cv:`proxy.config.http.cache.ignore_authentication` in
-   :file:`records.config`. ::
+   :file:`records.yaml`. ::
 
         CONFIG proxy.config.http.cache.ignore_authentication INT 1
 
@@ -513,7 +513,7 @@ detailed below.
 
 To disable HTTP object caching manually:
 
-#. Set :ts:cv:`proxy.config.http.cache.http` to ``0`` in :file:`records.config`. ::
+#. Set :ts:cv:`proxy.config.http.cache.http` to ``0`` in :file:`records.yaml`. ::
 
         CONFIG proxy.config.http.cache.http INT 0
 
@@ -533,7 +533,7 @@ To configure Traffic Server's cache behaviour in regard to dynamic
 content:
 
 #. Edit :ts:cv:`proxy.config.http.cache.cache_urls_that_look_dynamic` in
-   :file:`records.config`. To disable caching, set the variable to ``0``,
+   :file:`records.yaml`. To disable caching, set the variable to ``0``,
    and to explicitly permit caching use ``1``. ::
 
         CONFIG proxy.config.http.cache.cache_urls_that_look_dynamic INT 0
@@ -563,7 +563,7 @@ You can reconfigure Traffic Server to:
 To configure how Traffic Server caches cookied content:
 
 #. Edit :ts:cv:`proxy.config.http.cache.cache_responses_to_cookies` in
-   :file:`records.config`.
+   :file:`records.yaml`.
 
 #. Run the command :option:`traffic_ctl config reload` to apply the configuration changes.
 
@@ -613,7 +613,7 @@ object (the default is 3).
 
 To alter the limit on the number of alternates:
 
-#. Edit :ts:cv:`proxy.config.cache.limits.http.max_alts` in :file:`records.config`. ::
+#. Edit :ts:cv:`proxy.config.cache.limits.http.max_alts` in :file:`records.yaml`. ::
 
     CONFIG proxy.config.cache.limits.http.max_alts INT 5
 
@@ -703,7 +703,7 @@ content being unique to different client requests, ATS will not enable
 read-while-writer functionality until it has determined that it will be able
 to cache the object.
 
-The following settings must be made in :file:`records.config` to enable
+The following settings must be made in :file:`records.yaml` to enable
 read-while-writer functionality in ATS::
 
     CONFIG proxy.config.cache.enable_read_while_writer INT 1

doc/admin-guide/configuration/redirecting-http-requests.en.rst

@@ -269,7 +269,7 @@ Enabling HTTP Reverse Proxy
 
 To enable HTTP reverse proxy:
 
-#. Edit :ts:cv:`proxy.config.reverse_proxy.enabled` in :file:`records.config`. ::
+#. Edit :ts:cv:`proxy.config.reverse_proxy.enabled` in :file:`records.yaml`. ::
 
     CONFIG proxy.config.reverse_proxy.enabled INT 1
 
@@ -279,7 +279,7 @@ Setting Optional HTTP Reverse Proxy Options
 -------------------------------------------
 
 Traffic Server provides several reverse proxy configuration options in
-:file:`records.config` that enable you to:
+:file:`records.yaml` that enable you to:
 
 -  Configure Traffic Server to retain the client host header information
    in a request during translation.