Skip to content
This repository was archived by the owner on Nov 24, 2025. It is now read-only.

Add t3c mode flags #6000

Merged
dneuman64 merged 1 commit into from
Aug 13, 2021
Merged

Add t3c mode flags #6000

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
186 changes: 118 additions & 68 deletions cache-config/t3c-apply/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ t3c-apply - Traffic Control Cache Configuration applicator

# SYNOPSIS

t3c-apply [-2bchIpsSvW] [-D seconds] [-d location] [-e location] [-g \<yes|no|auto\>] [-H hostname] [-i location] [-l seconds] [-M location] [-m \<badass|report|revalidate|syncds\>] [-P password] [-r retries] [-R path] [-T seconds] [-t milliseconds] [-u url] [-U username] [-V versions] [-w \<true|false\>]
t3c-apply [-2AbceFhIknopsSvW] [-a service-action] [-D seconds] [-f \<all|reval|none\>] [-g \<yes|no|auto\>] [-H hostname] [-l seconds] [-M location] [-m \<badass|report|revalidate|syncds\>] [-P password] [-r retries] [-R path] [-T seconds] [-t milliseconds] [-u url] [-U username] [-V tls-versions]

[\-\-help]

Expand All @@ -52,40 +52,79 @@ Typical usage is to install t3c on the cache machine, and then run it periodical

-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.
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
[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.
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.

-D, -\-dispersion=value

[seconds] wait a random number of seconds between 0 and
[seconds] before starting, default 300 [300]
[seconds] wait a random number of seconds between 0 and
[seconds] before starting, default 300 [300]

-g, -\-git=value
-e, -\-omit-via-string-release

Whether to set the records.config via header to the ATS
release from the RPM. Default true.

-f, -\-files=value [all | reval]

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]
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
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
Print usage information and exit

-i, -\-no-outgoing-ip

Expand All @@ -94,108 +133,119 @@ Typical usage is to install t3c on the cache machine, and then run it periodical

-I, -\-traffic-ops-insecure

[true | false] ignore certificate errors from Traffic Ops
[true | false] ignore certificate errors from Traffic Ops

-k, -\-install-packages

Whether to install necessary packages. Default is false.

-l, -\-login-dispersion=value

[seconds] wait a random number of seconds between 0 and
[seconds] before login to traffic ops, default 0
[seconds] wait a random number of seconds between 0 and
[seconds] before login to traffic ops, default 0

-M, -\-maxmind-location=value

URL of a maxmind gzipped database file, to be installed into
the trafficserver etc directory.
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, default is
'report' [report]
[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, -\-omit-via-string-release

Whether to set the records.config via header to the ATS
release from the RPM. Default true.

-O, -\-skip-os-check
-o, -\-report-only

[false | true] skip os check, default is false
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
[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
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]
[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
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

-S, -\-syncds-updates-ipallow

Whether syncds mode will update ipallow. This exists because
ATS had a bug where reloading after changing ipallow would
block everything. Default is false.
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, -\-reval-wait-time=value

[seconds] wait a random number of seconds between 0 and
[seconds] before revlidation, default is 60 [60]
[seconds] wait a random number of seconds between 0 and
[seconds] before revlidation, default is 60 [60]

-t, -\-traffic-ops-timeout-milliseconds=value

Timeout in milli-seconds for Traffic Ops requests, default
is 30000 [30000]
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
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
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.
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'.
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 | reval] do not update if parent_pending = 1 in the
update json. Default is 'reval', wait for parents in revalidate
mode, but not syncds (unless Traffic Ops has !use_reval_pending)
[true | false] do not update if parent_pending = 1 in the
update json. Default is false

# MODES

Expand Down
Loading