trafficserver
Options
Section titled “Options”services.trafficserver.enable
Section titled “services.trafficserver.enable”Whether to enable Apache Traffic Server.
Type: boolean
Default:
falseExample:
trueDeclared by:
services.trafficserver.package
Section titled “services.trafficserver.package”Apache Traffic Server package
Type: package
Default:
pkgs.trafficserverDeclared by:
services.trafficserver.cache
Section titled “services.trafficserver.cache”Caching rules that overrule the origin’s caching policy.
Consult the upstream documentation for more details.
Type: strings concatenated with “\n”
Default:
""Example:
"dest_domain=example.com suffix=js action=never-cache"Declared by:
services.trafficserver.hosting
Section titled “services.trafficserver.hosting”Partition the cache according to origin server or domain
Consult the upstream documentation for more details.
Type: strings concatenated with “\n”
Default:
""Example:
"domain=example.com volume=1"Declared by:
services.trafficserver.ipAllow
Section titled “services.trafficserver.ipAllow”Control client access to Traffic Server and Traffic Server connections to upstream servers.
Consult the upstream documentation for more details.
Type: null or YAML 1.1 value
Default: upstream defaults
Example:
{ ip_allow = [{ apply = "in"; ip_addrs = "127.0.0.1"; action = "allow"; methods = "ALL"; }];}Declared by:
services.trafficserver.logging
Section titled “services.trafficserver.logging”Configure logs.
Consult the upstream documentation for more details.
Type: null or YAML 1.1 value
Default: upstream defaults
Example:
{ }Declared by:
services.trafficserver.parent
Section titled “services.trafficserver.parent”Identify the parent proxies used in an cache hierarchy.
Consult the upstream documentation for more details.
Type: strings concatenated with “\n”
Default:
""Example:
'' dest_domain=. method=get parent="p1.example:8080; p2.example:8080" round_robin=true''Declared by:
services.trafficserver.plugins
Section titled “services.trafficserver.plugins”Controls run-time loadable plugins available to Traffic Server, as well as their configuration.
Consult the upstream documentation for more details.
Type: list of (submodule)
Default:
[ ]Declared by:
services.trafficserver.plugins.*.arg
Section titled “services.trafficserver.plugins.*.arg”arguments to pass to the plugin
Type: string
Default:
""Example:
"--header=ATS-My-Debug"Declared by:
services.trafficserver.plugins.*.path
Section titled “services.trafficserver.plugins.*.path”Path to plugin. The path can either be absolute, or relative to the plugin directory.
Type: string
Example:
"xdebug.so"Declared by:
services.trafficserver.records
Section titled “services.trafficserver.records”List of configurable variables used by Traffic Server.
Consult the upstream documentation for more details.
When defining the values for the option x.y, a nested attribute should
be used. Using a flat attribute set with the attribute name x.y will
result in an error.
If options for both x.y and x.y.z needs to be set, you can set
x.y._ as x.y. This only applies to Traffic Server versions prior to
10. Traffic Server 10 and onwards uses YAML configuration, which doesn’t
have this kind of problem.
Type: Traffic Server records value
Default:
{ }Example:
{ proxy = { config = { proxy_name = "my_server"; }; };}Declared by:
services.trafficserver.remap
Section titled “services.trafficserver.remap”URL remapping rules used by Traffic Server.
Consult the upstream documentation for more details.
Type: strings concatenated with “\n”
Default:
""Example:
"map http://from.example http://origin.example"Declared by:
services.trafficserver.runroot
Section titled “services.trafficserver.runroot”File layout used by Traffic Server
Type: unspecified value (read only)
Declared by:
services.trafficserver.sni
Section titled “services.trafficserver.sni”Configure aspects of TLS connection handling for both inbound and outbound connections.
Consult the upstream documentation for more details.
Type: null or YAML 1.1 value
Default:
nullExample:
{ sni = [{ fqdn = "no-http2.example.com"; https = "off"; }];}Declared by:
services.trafficserver.splitDns
Section titled “services.trafficserver.splitDns”Specify the DNS server that Traffic Server should use under specific conditions.
Consult the upstream documentation for more details.
Type: strings concatenated with “\n”
Default:
""Example:
'' dest_domain=internal.corp.example named="255.255.255.255:212 255.255.255.254" def_domain=corp.example search_list="corp.example corp1.example" dest_domain=!internal.corp.example named=255.255.255.253''Declared by:
services.trafficserver.sslMulticert
Section titled “services.trafficserver.sslMulticert”Configure SSL server certificates to terminate the SSL sessions.
Consult the upstream documentation for more details.
Type: strings concatenated with “\n”
Default:
""Example:
"dest_ip=* ssl_cert_name=default.pem"Declared by:
services.trafficserver.storage
Section titled “services.trafficserver.storage”List all the storage that make up the Traffic Server cache.
Consult the upstream documentation for more details.
Type: strings concatenated with “\n”
Default:
"${config.services.traffic-server.runroot.cachedir} 256M"Example:
"/dev/disk/by-id/XXXXX volume=1"Declared by:
services.trafficserver.strategies
Section titled “services.trafficserver.strategies”Specify the next hop proxies used in an cache hierarchy and the algorithms used to select the next proxy.
Consult the upstream documentation for more details.
Type: null or YAML 1.1 value
Default:
nullDeclared by:
services.trafficserver.volume
Section titled “services.trafficserver.volume”Manage cache space more efficiently and restrict disk usage by creating cache volumes of different sizes.
Consult the upstream documentation for more details.
Type: null or YAML 1.1 value
Default:
""Example:
"volume=1 scheme=http size=20%"Declared by: