t3c-apply - Traffic Control Cache Configuration applicator
t3c-apply [-2AbceFhIknopsSvW] [-a service-action] [-f <all|reval|none>] [-g <yes|no|auto>] [-H hostname] [-M location] [-m <badass|report|revalidate|syncds>] [-P password] [-r retries] [-R path] [-t milliseconds] [-u url] [-U username] [-V tls-versions]
[--help]
[--version]
The t3c-apply command is a transliteration of traffic_ops_ort.pl script to the go language. It is designed to replace the traffic_ops_ort.pl perl script and it is used to apply configuration from Traffic Control, stored in Traffic Ops, to the cache.
Typical usage is to install t3c on the cache machine, and then run it periodically via a CRON job.
-2, --default-client-enable-h2
Whether to enable HTTP/2 on Delivery Services by default, if
they have no explicit Parameter. This is irrelevant if ATS
records.config is not serving H2. If omitted, H2 is
disabled.
-a, --service-action=value
action to perform on Traffic Server and other system
services. Only reloads if necessary, but always restarts.
Default is 'reload'
-A, --update-ipallow
Whether ipallow file will be updated if necessary. This
exists because ATS had a bug where reloading after changing
ipallow would block everything. Default is false.
-b, --dns-local-bind
[true | false] whether to use the server's Service Addresses
to set the ATS DNS local bind address
-c, --disable-parent-config-comments
Whether to disable verbose parent.config comments. Default
false.
-C, --skip-os-check
[false | true] skip os check, default is false
-d, --no-unset-update-flag
Whether to not unset the update flag in Traffic Ops after
applying files. This option makes it possible to generate
test or debug configuration from a production Traffic Ops
without un-setting queue or reval flags. Default is false.
-e, --omit-via-string-release
Whether to set the records.config via header to the ATS
release from the RPM. Default true.
-E, --version
Print version information and exit.
-f, --files=value [all | reval]
Which files to generate. If reval, the Traffic
Ops server reval_pending flag is used instead of the
upd_pending flag. Default is 'all'
-F, --ignore-update-flag
Whether to ignore the upd_pending or reval_pending flag in
Traffic Ops, and always generate and apply files. If true,
the flag is still unset in Traffic Ops after files are
applied. Default is false.
-g, --git=value Create and use a git repo in the config directory. Options are yes, no, and auto. If yes, create and use. If auto, use if it exist. Default is auto. [auto]
-H, --cache-host-name=value
Host name of the cache to generate config for. Must be the
server host name in Traffic Ops, not a URL, and not the FQDN
-h, --help
Print usage information and exit
-i, --no-outgoing-ip
Whether to not set the records.config outgoing IP to the server's addresses in Traffic Ops. Default is false.
-I, --traffic-ops-insecure
[true | false] ignore certificate errors from Traffic Ops
-k, --install-packages
Whether to install necessary packages. Default is false.
-M, --maxmind-location=value
URL of a maxmind gzipped database file, to be installed into
the trafficserver etc directory.
-m, --run-mode=value
[badass | report | revalidate | syncds] run mode. Optional, convenience flag which sets other flags for common usage scenarios.
syncds keeps the defaults:
--report-only=false
--files=all
--install-packages=false
--service-action=reload
--ignore-update-flag=false
--update-ipallow=false
--no-unset-update-flag=false
revalidate sets --files=reval
--wait-for-parents=true
badass sets --install-packages=true
--service-action=restart
--ignore-update-flag=true
--update-ipallow=true
report sets --report-only=true
Note the 'syncds' settings are all the flag defaults. Hence, if no mode is set, the default is effectively 'syncds'.
If any of the related flags are also set, they override the mode's default behavior.
-n, --no-cache
Whether to not use a cache and make conditional requests to Traffic Ops. Default is false: use cache.
-o, --report-only
Log information about necessary files and actions, but take
no action. Default is false
-p, --reverse-proxy-disable
[false | true] bypass the reverse proxy even if one has been
configured default is false
-P, --traffic-ops-password=value
Traffic Ops password. Required. May also be set with the
environment variable TO_PASS
-r, --num-retries=value
[number] retry connection to Traffic Ops URL [number] times,
default is 3 [3]
-R, --trafficserver-home=value
Trafficserver Package directory. May also be set with the
environment variable TS_HOME
-s, --silent
Silent. Errors are not logged, and the 'verbose' flag is
ignored. If a fatal error occurs, the return code will be
non-zero but no text will be output to stderr
-t, --traffic-ops-timeout-milliseconds=value
Timeout in milli-seconds for Traffic Ops requests, default
is 30000 [30000]
-u, --traffic-ops-url=value
Traffic Ops URL. Must be the full URL, including the scheme.
Required. May also be set with the environment variable
TO_URL
-U, --traffic-ops-user=value
Traffic Ops username. Required. May also be set with the
environment variable TO_USER
-V, --default-client-tls-versions=value
Comma-delimited list of default TLS versions for Delivery
Services with no Parameter, e.g.
--default-tls-versions='1.1,1.2,1.3'. If omitted, all
versions are enabled.
-v, --verbose
Log verbosity. Logging is output to stderr. By default,
errors are logged. To log warnings, pass '-v'. To log info,
pass '-vv'. To omit error logging, see '-s' [0]
-W, --wait-for-parents
[true | false] do not update if parent_pending = 1 in the
update json. Default is false
The t3c-apply app can be run in a number of modes.
The syncds mode is the normal mode of operation, which should typically be run periodically via cron or a similar tool.
The badass mode is typically an emergency-fix mode, which will override and replace all files with the configuration generated from the current Traffic Ops data, regardless whether t3c-apply (presumably incorrectly) thinks the files need updating or not. It is recommended to run this mode when something goes wrong, and the configuration on the cache is incorrect, and the data in Traffic Ops and config generation is believed to be correct. It is not recommended to run this in normal operation; use syncds mode for normal operation.
The revalidate mode will apply Revalidations from Traffic Ops (regex_revalidate.config) but no other configuration. This mode was intended to quickly apply revalidations when t3c-apply took a long time to run. It is less relevant with the current speed of t3c-apply but may still be useful on slow networks or very large deployments.
| mode | description |
|---|---|
| report | prints config differences and exits (default) |
| badass | attempts to fix all config differences that it can |
| syncds | syncs delivery services with what is configured in Traffic Ops |
| revalidate | checks for updated revalidations in Traffic Ops and applies them |
When t3c-apply is run, it will:
t3c-apply is in revalidate mode, this will only be regex_revalidate.configt3c-apply is in badass mode, perform a service restart of ATS.t3c-apply is in badass mode, run sysctl -p.t3c-apply is in badass mode, perform a service restart of ntpd.Certain config files perform extra processing.
Global replacements
All config files have certain text directives replaced. This is done by the t3c-generate config generator before the file is returned to `t3c-apply`. __SERVER_TCP_PORT__ is replaced with the Server's Port from Traffic Ops; unless the server's port is 80, 0, or null, in which case any occurrences preceded by a colon are removed. __CACHE_IPV4__ is replaced with the Server's IP address from Traffic Ops. __HOSTNAME__ is replaced with the Server's (short) HostName from Traffic Ops. __FULL_HOSTNAME__ is replaced with the Server's HostName, a dot, and the Server's DomainName from Traffic Ops (i.e. the Server's Fully Qualified Domain Name). __RETURN__ is replaced with a newline character, and any whitespace before or after it is removed.
remap.config
The `t3c-apply` app processes `##OVERRIDE##` directives in the remap.config file. The ##OVERRIDE## template string allows the Delivery Service Raw Remap Text field to override to fully override the Delivery Service’s line in the remap.config ATS configuration file, generated by Traffic Ops. The end result is the original, generated line commented out, prepended with ##OVERRIDDEN## and the ##OVERRIDE## rule is activated in its place. This behavior is used to incrementally deploy plugins used in this configuration file. Normally, this entails cloning the Delivery Service that will have the plugin, ensuring it is assigned to a subset of the cache servers that serve the Delivery Service content, then using this ##OVERRIDE## rule to create a remap.config rule that will use the plugin, overriding the normal rule. Simply grow the subset over time at the desired rate to slowly deploy the plugin. When it encompasses all cache servers that serve the original Delivery Service’s content, the “override Delivery Service” can be deleted and the original can use a non-##OVERRIDE## Raw Remap Text to add the plugin.
50-ats.rules
This is presumed to be a udev file for devices which are block devices to be used as disk storage by ATS. The `t3c-apply` app verifies all devices in the file are owned by the owner listed in the file, and logs errors otherwise. The `t3c-apply` app verifies all devices in the file do not have filesystems. If any device has a filesystem, `t3c-apply` assumes it was a mistake to assign as an ATS storage device, and logs a fatal error.
The t3c application is maintained by Apache Traffic Control project. For help, bug reports, contributing, or anything else, see: