atscfg

const (
	TopologyCacheTierFirst   = TopologyCacheTier("first")
	TopologyCacheTierInner   = TopologyCacheTier("inner")
	TopologyCacheTierLast    = TopologyCacheTier("last")
	TopologyCacheTierInvalid = TopologyCacheTier("")
)

These are the allowed values for a TopologyCacheTier.

const (
	// The format in API versions 4.0 and later.
	JobV4TimeFormat = time.RFC3339Nano
	// The format in API versions prior to 4.0.
	JobLegacyTimeFormat = "2006-01-02 15:04:05-07"
)

These are the formats for the "lastUpdated" timestamps of Content Invalidation Jobs in different Traffic Ops API versions.

const (
	JobLegacyRefetchSuffix = `##REFETCH##`
	JobLegacyRefreshSuffix = `##REFRESH##`
)

These special suffixes when found on a rule override the default type of a Content Invalidation Job. Deprecated: these are no longer necessary in Traffic Ops API versions 4.0 and later.

const (
	JobLegacyParamPrefix = "TTL:"
	JobLegacyParamSuffix = "h"
	JobLegacyKeyword     = "PURGE"
)

These strings are used to parse legacy representations of Content Invalidation Jobs. Deprecated: When the Traffic Ops API version 4.0 representation of Content Invalidation Jobs becomes standard (i.e. when 3.x API version support is dropped) these will have no meaning or purpose.

const (
	// "ALL" has the special meaning "all HTTP Methods".
	MethodAll = "ALL"
	// MethodPush is a non-standard HTTP request method understood by Apache
	// Traffic Server used to directly insert content for the requested URI into
	// the cache.
	MethodPush = "PUSH"
	// MethodPurge is a non-standard HTTP request method understood by Apache
	// Traffic Server used to directly remove the requested URI from the cache.
	MethodPurge  = "PURGE"
	MethodDelete = "DELETE"
)

These are the ATS HTTP request methods that may be granted using ipallow configuration file rules.

const (
	ParentAbstractionServiceParentSecondaryModeExhaust   = ParentAbstractionServiceParentSecondaryMode("exhaust")
	ParentAbstractionServiceParentSecondaryModeAlternate = ParentAbstractionServiceParentSecondaryMode("alternate")
	ParentAbstractionServiceParentSecondaryModePeering   = ParentAbstractionServiceParentSecondaryMode("peering")
	ParentAbstractionServiceParentSecondaryModeInvalid   = ParentAbstractionServiceParentSecondaryMode("")
)

The allowable values of a ParentAbstractionServiceParentSecondaryMode (with the exception of ParentAbstractionServiceParentSecondaryModeInvalid, which does not represent a valid ParentAbstractionServiceParentSecondaryMode).

const (
	ParentAbstractionServiceRetryPolicyRoundRobinIP     = ParentAbstractionServiceRetryPolicy("round_robin_ip")
	ParentAbstractionServiceRetryPolicyRoundRobinStrict = ParentAbstractionServiceRetryPolicy("round_robin_strict")
	ParentAbstractionServiceRetryPolicyFirst            = ParentAbstractionServiceRetryPolicy("first")
	ParentAbstractionServiceRetryPolicyLatched          = ParentAbstractionServiceRetryPolicy("latched")
	ParentAbstractionServiceRetryPolicyConsistentHash   = ParentAbstractionServiceRetryPolicy("consistent_hash")
	ParentAbstractionServiceRetryPolicyInvalid          = ParentAbstractionServiceRetryPolicy("")
)

These are the valid value of a ParentAbstractionServiceRetryPolicy - with the exception of ParentAbstractionServiceRetryPolicyInvalid, which does not represent a valid ParentAbstractionServiceRetryPolicy.

const (
	ParentConfigCacheParamWeight     = "weight"
	ParentConfigCacheParamPort       = "port"
	ParentConfigCacheParamUseIP      = "use_ip_address"
	ParentConfigCacheParamRank       = "rank"
	ParentConfigCacheParamNotAParent = "not_a_parent"
)

These are the Names of Parameters that can affect cache server parentage in unknown ways.

TODO: determine/describe how these work.

const ATSDotRulesFileName = StorageFileName

ATSDotRulesFileName is the name of a "rules" configuration file.

TODO: This isn't actually correct. This is just the ConfigFile value that a cache server's Profile's Drive_Prefix, Drive_Letters, RAM_Drive_Prefix, and RAM_Drive_Letters Parameters must have for generation to be successful (in fact it seems to panic if those aren't found), but the actual name of the file for which MakeATSDotRules outputs content is '50-ats.rules'. Is this misleading? Maybe it just doesn't even need to be exported? Or exist at all?

const ActionAllow = "ip_allow"

ActionAllow specifies that IPs matching the line's pattern should be allowed to use the explicitly listed HTTP request methods.

const ActionDeny = "ip_deny"

ActionDeny specifies that IPs matching the line's pattern should NOT be allowed to use the explicitly listed HTTP request methods.

const AstatsFileName = "astats.config"

AstatsFileName is the name of the file used to contain configuration for the astats_over_http Traffic Server plugin.

const AstatsSeparator = "="

AstatsSeparator is the string used by astats.config to separate configuration option names from values.

const CacheUrlPrefix = "cacheurl_"

CacheUrlPrefix is an unused constant of unknown purpose.

Deprecated: It's likely that this is related to the removed "Cache URL" property of Delivery Services and the old "cacheurl" plugin for ATS which is not supported by any supported version of ATS.

const ChkconfigFileName = `chkconfig`

ChkconfigFileName is the name of the ckconfig configuration file.

const ChkconfigParamConfigFile = `chkconfig`

ChkconfigParamConfigFile is the ConfigFile value of Parameters that affect the generation of the chkconfig configuration file.

const ConfigSuffix = ".config"

ConfigSuffix is a suffix (or "file extension") appended to many configuration file names, most notably those for the Header Rewrite Traffic Server plugin.

TODO: Unexport? This is only used by the header rewrite configuration file generation functions, and doesn't have much practical purpose outside of that limited usage.

const ContentType12MFacts = ContentTypeTextASCII

ContentType12MFacts is the MIME type of the contents of a 12M_facts file.

const ContentTypeATSDotRules = ContentTypeTextASCII

ContentTypeATSDotRules is the MIME type of the contents of a 50-ats.rules file.

const ContentTypeAstatsDotConfig = ContentTypeTextASCII

ContentTypeAstatsDotConfig is the MIME type of the content of astats.config file.

const ContentTypeBGFetchDotConfig = ContentTypeTextASCII

ContentTypeBGFetchDotConfig is the MIME type of the contents of a bg_fetch.config file.

const ContentTypeCacheDotConfig = ContentTypeTextASCII

ContentTypeCacheDotConfig is the MIME type of the contents of a cache.config file.

const ContentTypeChkconfig = ContentTypeTextASCII

ContentTypeChkconfig is the MIME content type of the contents of the chkconfig configuration file.

Note that the GoDoc for MakeChkconfig says "This is a JSON object, and should be served with an 'application/json' Content-Type." but actually the file contents on disk are not JSON-encoded.

const ContentTypeDropQStringDotConfig = ContentTypeTextASCII

ContentTypeDropQStringDotConfig is the MIME type of the contents of a drop_qstring.config file.

const ContentTypeHeaderRewriteDotConfig = ContentTypeTextASCII

ContentTypeHeaderRewriteDotConfig is the MIME type of the contents of a configuration file for the Header Rewrite ATS plugin.

const ContentTypeHostingDotConfig = ContentTypeTextASCII

ContentTypeHostingDotConfig is the MIME type of the contents of a hosting.config file.

const ContentTypeIPAllowDotConfig = ContentTypeTextASCII

ContentTypeIPAllowDotConfig is the MIME type of the contents of an ip_allow.config file.

const ContentTypeIPAllowDotYAML = ContentTypeYAML

ContentTypeIPAllowDotYAML is the MIME type of the contents of an ip_allow.yaml file.

Note YAML has no IANA standard mime type. This is one of several common usages, and is likely to be the standardized value. If you're reading this, please check IANA to see if YAML has been added, and change this to the IANA definition if so. Also note we include 'charset=us-ascii' because YAML is commonly UTF-8, but ATS is likely to be unable to handle UTF.

const ContentTypeLoggingDotConfig = ContentTypeTextASCII

ContentTypeLoggingDotConfig is the MIME type of the contents of a logging configuration file used by ATS 7.1.x.

const ContentTypeLoggingDotYAML = ContentTypeYAML

ContentTypeLoggingDotYAML is the content type of the contents of a logging configuration file used by ATS version 8 and later.

Note YAML has no IANA standard mime type. This is one of several common usages, and is likely to be the standardized value. If you're reading this, please check IANA to see if YAML has been added, and change this to the IANA definition if so. Also note we include 'charset=us-ascii' because YAML is commonly UTF-8, but ATS is likely to be unable to handle UTF.

const ContentTypeLogsDotXML = `text/xml`

ContentTypeLogsDotXML is the MIME content type of the logging configuration file used by ATS version 6 and earlier.

Deprecated: The versions of ATS that use this file are not supported, either by ATC or the ATS project itself.

const ContentTypePackages = ContentTypeTextASCII

ContentTypePackages is a MIME type of unknown meaning and purpose.

Deprecated: Since the 'package' ConfigFile value is a "dummy" value used to indicate packages that should be installed through yum, there isn't a need for any definition of a content type for a file that doesn't exist, and this value is never used for anything anyway. The contents of the file as output by tc3-generate are actually encoded as JSON, so at best this is inaccurate.

const ContentTypeParentDotConfig = ContentTypeTextASCII

ContentTypeParentDotConfig is the MIME type of the contents of a parent.config file.

const ContentTypePluginDotConfig = ContentTypeTextASCII

ContentTypePluginDotConfig is the MIME type of the contents of a plugin.config ATS configuration file.

const ContentTypeRecordsDotConfig = ContentTypeTextASCII

ContentTypeRecordsDotConfig is the MIME type of the contents of a records.config ATS configuration file.

const ContentTypeRegexRemapDotConfig = ContentTypeTextASCII

ContentTypeRegexRemapDotConfig is the MIME type of the contents of a regex_remap.config ATS configuration file.

const ContentTypeRegexRevalidateDotConfig = ContentTypeTextASCII

ContentTypeRegexRevalidateDotConfig is the MIME content type of the contents of a regex_revalidate.config ATS configuration file.

const ContentTypeRemapDotConfig = ContentTypeTextASCII

ContentTypeRemapDotConfig is the MIME type of the contents of a remap.config ATS configuration file.

const ContentTypeSNIDotYAML = ContentTypeYAML

ContentTypeSNIDotYAML is the MIME type of the contents of an sni.yaml ATS configuration file.

const ContentTypeSSLMultiCertDotConfig = ContentTypeTextASCII

ContentTypeSSLMultiCertDotConfig is the MIME type of the contents of an ssl_multicert.config ATS configuration file.

const ContentTypeSSLServerNameYAML = ContentTypeYAML

ContentTypeSSLServerNameYAML is the MIME type of the contents of an ssl_server_name.yaml ATS configuration file.

const ContentTypeServerUnknownConfig = ContentTypeTextASCII

ContentTypeServerUnknownConfig is the MIME content type of the contents of an arbitrary file not handled specially by t3c.

Note that the actual grammar of such files is unknowable and may be more appropriately represented by some other MIME type, but treating it as this MIME type will never cause problems, since t3c is only capable of generating such files as regular text files.

const ContentTypeSetDSCPDotConfig = ContentTypeTextASCII

ContentTypeSetDSCPDotConfig is the MIME type of the contents of an ATS configuration file used to set the DSCP of IP packets.

const ContentTypeStorageDotConfig = ContentTypeTextASCII

ContentTypeStorageDotConfig is the MIME type of the contents of a storage.config ATS configuration file.

const ContentTypeStrategiesDotYAML = ContentTypeYAML

ContentTypeStrategiesDotYAML is the MIME type of the contents of a strategies.yaml ATS configuration file.

const ContentTypeSysctlDotConf = ContentTypeTextASCII

ContentTypeSysctlDotConf is the MIME type of the contents of a sysctl.conf ATS configuration file.

const ContentTypeTextASCII = `text/plain; charset=us-ascii`

ContentTypeTextASCII is the MIME type for plain text using an ASCII character set.

TODO: Move to lib/go-rfc package?

const ContentTypeURISigningDotConfig = `application/json; charset=us-ascii`

ContentTypeURISigningDotConfig is the MIME type of the contents of a uri_signing.config ATS configuration file.

const ContentTypeURLSig = ContentTypeTextASCII

ContentTypeURLSig is the MIME type of the contents of a url_sig.config ATS configuration file.

const ContentTypeVolumeDotConfig = ContentTypeTextASCII

ContentTypeVolumeDotConfig is the MIME type of the contents of a volume.config ATS configuration file.

const ContentTypeYAML = "application/yaml; charset=us-ascii"

ContentTypeYAML is the MIME type of YAML-format files and text.

Note YAML has no IANA standard mime type. This is one of several common usages, and is likely to be the standardized value. If you're reading this, please check IANA to see if YAML has been added, and change this to the IANA definition if so. Also note we include 'charset=us-ascii' because YAML is commonly UTF-8, but ATS is likely to be unable to handle UTF.

TODO: Move this into lib/go-rfc?

const DefaultATSVersion = "5"

DefaultATSVersion is the version of Traffic Server assumed when one is not directly specified in a server's Parameters.

TODO: Emulates Perl; change to 6? ATC no longer officially supports ATS 5.

const DefaultCoalesceMaskLenV4 = 24

DefaultCoalesceMaskLenV4 is the value that will be used for the mask length for IPv4 network specifications used to coalesce groups of addresses in an ip_allow.config file, if a value is not given by a Parameter.

TODO: unexport? This is only used in this package.

const DefaultCoalesceMaskLenV6 = 48

DefaultCoalesceMaskLenV6 is the value that will be used for the mask length for IPv6 network specifications used to coalesce groups of addresses in an ip_allow.config file, if a value is not given by a Parameter.

TODO: unexport? This is only used in this package.

const DefaultCoalesceNumberV4 = 5

DefaultCoalesceNumberV4 is the value that will be used for the minimum number of IPv4 addresses in an ip_allow.config file that must be covered by a mask in order to allow coalescing them, if a value is not given by a Parameter.

TODO: unexport? This is only used in this package.

const DefaultCoalesceNumberV6 = 5

DefaultCoalesceNumberV6 is the value that will be used for the minimum number of IPv6 addresses in an ip_allow.config file that must be covered by a mask in order to allow coalescing them, if a value is not given by a Parameter.

TODO: unexport? This is only used in this package.

const DefaultDefaultEnableH2 = false

DefaultDefaultEnableH2 is whether Delivery Services will have HTTP/2 enabled by default if they don't have an explicit Parameter, and no Opt is passed to the Make func. We disable by default, to prevent potentially enabling broken clients.

const DefaultFirstRemapConfigTemplateString = `` /* 191-byte string literal not displayed */

const DefaultIgnoreQueryStringInParentSelection = false

DefaultIgnoreQueryStringInParentSelection is used to decide whether a request's query string should be used or dropped during selecting a parent when that behavior is not explicitly configured.

const DefaultInnerRemapConfigTemplateString = DefaultLastRemapConfigTemplateString

const DefaultLastRemapConfigTemplateString = `map {{{Source}}} {{{Destination}}} {{{Strategy}}} {{{HeaderRewrite}}} {{{Cachekey}}} {{{RangeRequests}}} {{{RawText}}}`

const DefaultMaxRevalDurationDays = 90

DefaultMaxRevalDurationDays is the maximum duration (in days) of Content Invalidation Requests if not overridden by a Parameter.

const DefaultParentAbstractionServiceRetryPolicy = ParentAbstractionServiceRetryPolicyConsistentHash

DefaultParentAbstractionServiceRetryPolicy is the "retry policy" that will be used by Delivery Service parenting if one is not explicitly configured.

const DefaultParentWeight = 0.999

DefaultParentWeight is the weight given to a parent if one isn't explicitly configured - *or* in the case that the parent has a Parameter set for the weight, but its Value cannot be parsed.

const DropQStringDotConfigFileName = "drop_qstring.config"

DropQStringDotConfigFileName is the name of the drop_qstring.config file - this is also the ConfigFile value of Parameters that are able to affect the contents of this file.

const DropQStringDotConfigParamName = "content"

DropQStringDotConfigParamName is the Name a Parameter must have to dictate the contents of drop_qstring.config - Parameters by other Names (even in the correct ConfigFile) are ignored.

const HeaderCommentDateFormat = "Mon Jan 2 15:04:05 MST 2006"

HeaderCommentDateFormat is an unused format for dates and times.

TODO: Remove this, it's unused.

const HeaderRewriteFirstPrefix = HeaderRewritePrefix + "first_"

HeaderRewriteFirstPrefix is a prefix on filenames of configuration files for the Header Rewrite ATS plugin for cache servers at the first (or "edge") tier of a Topology. The rest of the filename is dependent on the Delivery Service for which the file contains rewrite rules.

const HeaderRewriteInnerPrefix = HeaderRewritePrefix + "inner_"

HeaderRewriteInnerPrefix is a prefix on filenames of configuration files for the Header Rewrite ATS plugin for cache servers at any tier between the first and last tier of a Topology. The rest of the filename is dependent on the Delivery Service for which the file contains rewrite rules.

const HeaderRewriteLastPrefix = HeaderRewritePrefix + "last_"

HeaderRewriteLastPrefix is a prefix on filenames of configuration files for the Header Rewrite ATS plugin for cache servers at the last tier of a Topology. The rest of the filename is dependent on the Delivery Service for which the file contains rewrite rules.

const HeaderRewriteMidPrefix = "hdr_rw_mid_"

HeaderRewriteMidPrefix is a prefix on filenames of configuration files for the Header Rewrite ATS plugin for mid-tier cache servers. The rest of the filename is dependent on the Delivery Service for which the file contains rewrite rules.

const HeaderRewritePrefix = "hdr_rw_"

HeaderRewritePrefix is a prefix on filenames of configuration files for the Header Rewrite ATS plugin for edge-tier cache servers. The rest of the filename is dependent on the Delivery Service for which the file contains rewrite rules.

const HostingConfigFileName = `hosting.config`

HostingConfigFileName is the file name of a hosting.config file.

TODO: Remove? This is unused, even internally in this package.

const HostingConfigParamConfigFile = `storage.config`

HostingConfigParamConfigFile is the ConfigFile value of Parameters which can affect the contents of hosting.config files.

const IPAllowConfigFileName = `ip_allow.config`

IPAllowConfigFileName is both the file name of ip_allow.config files and the ConfigFile value of Parameters that can affect its contents.

const IPAllowYamlFileName = `ip_allow.yaml`

IPAllowYamlFileName is the name of the configuration file that controls IP address-restricted access to various request methods.

TODO: Replace instances of 'ip_allow.yaml' with this currently unused constant.

const InvalidID = -1

InvalidID is used as a placeholder value when determining the ID of a parent Cache Group.

This is not strictly invalid; when a Cache Group's Parent's ID is "detected" as this value, then it may simply mean that the Cache Group is "top-level", and has no parent.

TODO: unexport this? It's highly specific to this package, and isn't used anywhere else.

const JobKeywordPurge = "PURGE"

JobKeywordPurge is the "keyword" of "jobs" that determines if a "job" represents a Content Invalidation Job - "jobs" with other "keywords" are ignored.

TODO: Figure out if this can be deprecated/removed, along with the check for it; all "jobs" created through the API have this "keyword", and the notion of generic-purpose "jobs" has been abandoned.

const LineComment12MFacts = LineCommentHash

LineComment12MFacts is the string that signifies the start of a line comment in the grammar of a 12M_facts file.

const LineCommentATSDotRules = LineCommentHash

LineCommentATSDotRules is the string used by parsers of 50-ats.rules to determine that the rest of the current line's content is a comment.

const LineCommentAstatsDotConfig = LineCommentHash

LineCommentAstatsDotConfig is the string used to mark the beginning of a line comment as understood by parsers of astats.config files.

const LineCommentBGFetchDotConfig = LineCommentHash

LineCommentBGFetchDotConfig is the string understood by parsers of bg_fetch.config files to be the beginning of a line comment.

const LineCommentCacheDotConfig = LineCommentHash

LineCommentCacheDotConfig is the string that signifies the beginning of a line comment in the grammar of a cache.config file.

const LineCommentChkconfig = LineCommentHash

LineCommentChkconfig is the string that signifies the start of a line comment in the grammar of a chkconfig configuration file.

const LineCommentDropQStringDotConfig = LineCommentHash

LineCommentDropQStringDotConfig is the string that signifies the start of a line comment in the grammar of a drop_qstring.config file.

const LineCommentHash = "#"

LineCommentHash is the string that denotes the beginning of a line comment, for grammars that use the number sign for line comments.

TODO: Unexport? This is only used, it seems, to group multiple usages into a single symbol not used outside this package. It's conceivable to want to know the line comment string for a given grammar, but it's unlikely that anyone importing this package would find an alias for "#" itself helpful, with no other attached semantics.

const LineCommentHeaderRewriteDotConfig = LineCommentHash

LineCommentHeaderRewriteDotConfig is the string used to signify the beginning of a line comment in the grammar of configuration files for the Header Rewrite ATS plugin.

const LineCommentHostingDotConfig = LineCommentHash

LineCommentHostingDotConfig is the string used to indicate the beginning of a line comment in the grammar of a hosting.config file.

const LineCommentIPAllowDotConfig = LineCommentHash

LineCommentIPAllowDotConfig is the string that signifies the start of a line comment in the grammar of an ip_allow.config file.

const LineCommentIPAllowDotYAML = LineCommentHash

LineCommentIPAllowDotYAML is the string used to signify the beginning of a line comment in the grammar of an ip_allow.yaml file.

const LineCommentLoggingDotConfig = LineCommentHash

LineCommentLoggingDotConfig is the string used to indicate the start of a line comment in the grammar of the logging configuration files used by ATS 7.1.x.

TODO: Is this true? According to the ATS docs, the contents of logging.config are a Lua script, which uses "--" for comments, not "#".

const LineCommentLoggingDotYAML = LineCommentHash

LineCommentLoggingDotYAML is the string used to indicate the beginning of a line comment in the grammar of a logging configuration file used by ATS version 8 and later.

const LineCommentLogsDotXML = `<!--`

LineCommentLogsDotXML is the string used in the grammar of a logging configuration file used by ATS version 6 and earlier to indicate the beginning of a comment node.

Note that XML does not have "line" comments, only comment nodes - which MUST have the associated closing tag (-->).

Deprecated: The versions of ATS that use this file are not supported, either by ATC or the ATS project itself.

const LineCommentPackages = ""

LineCommentPackages is used only to convey the idea that since "package Parameters" don't define file contents they don't have comments and therefore no string signifies the beginning of a comment for this non-existent grammar.

Deprecated: This constant expresses a concept that by its own definition has no meaning.

const LineCommentParentDotConfig = LineCommentHash

LineCommentParentDotConfig is the string used to begin a line comment in the grammar of a parent.config file.

const LineCommentPluginDotConfig = LineCommentHash

LineCommentPluginDotConfig is the string that denotes the start of a line comment in the grammar of a plugin.config ATS configuration file.

const LineCommentRecordsDotConfig = LineCommentHash

LineCommentRecordsDotConfig is the string that indicates the beginning of a line comment in the grammar of a records.config ATS configuration file.

const LineCommentRegexRemapDotConfig = LineCommentHash

LineCommentRegexRemapDotConfig is the string used to indicate the start of a line comment in the grammar of a regex_remap.config ATS configuration file.

const LineCommentRegexRevalidateDotConfig = LineCommentHash

LineCommentRegexRevalidateDotConfig is the string that indicates the beginning of a line comment in the grammar of a regex_revalidate.config ATS configuration file.

const LineCommentRemapDotConfig = LineCommentHash

LineCommentRemapDotConfig is the string used to signal the beginning of a line comment in the grammar of a remap.config ATS configuration file.

const LineCommentSNIDotYAML = LineCommentYAML

LineCommentSNIDotYAML is the string used by the grammar of an sni.yaml file to indicate the start of a line comment.

const LineCommentSSLMultiCertDotConfig = LineCommentHash

LineCommentSSLMultiCertDotConfig is the string used to indicate the start of a line comment in the grammar of an ssl_multicert.config ATS configuration file.

const LineCommentSSLServerNameYAML = LineCommentYAML

LineCommentSSLServerNameYAML is the string used to indicate the start of a line comment in the grammar of an ssl_server_name.yaml ATS configuration file.

const LineCommentSetDSCPDotConfig = LineCommentHash

LineCommentSetDSCPDotConfig is the string that, in the grammar of an ATS configuration file used to set the DSCP of IP packets, indicates that the rest of the line is a comment.

const LineCommentStorageDotConfig = LineCommentHash

LineCommentStorageDotConfig is the string used to indicate in the grammar of a storage.config ATS configuration file that the rest of the line is a comment.

const LineCommentStrategiesDotYAML = LineCommentHash

LineCommentStrategiesDotYAML is the string used to signal the beginning of a line comment in the grammar of a strategies.yaml ATS configuration file.

const LineCommentSysctlDotConf = LineCommentHash

LineCommentSysctlDotConf is the string understood by parses of sysctl.conf to be the beginning of a line comment.

const LineCommentURISigningDotConfig = ""

LineCommentURISigningDotConfig is the string used to indicate the start of a line comment in the grammar of a uri_signing.config ATS configuration file.

Note that uri_signing.config is a JSON-encoded object, and as such comments are not allowed in that file, because the JSON lexicon has no comment token.

const LineCommentURLSig = LineCommentHash

LineCommentURLSig is the string used to indicate the start of a line comment in the grammar of a url_sig.config ATS configuration file.

const LineCommentVolumeDotConfig = LineCommentHash

LineCommentVolumeDotConfig is the string used to indicate the beginning of a line comment in the grammar of a volume.config ATS configuration file.

const LineCommentYAML = LineCommentHash

LineCommentYAML is the string used to start a line comment in YAML syntax.

const LoggingFileName = "logging.config"

LoggingFileName is the name of the logging configuration file used by ATS 7.1.x. This is also the ConfigFile value of Parameters that can affect ATS logging configuration - regardless of the actual name of the configuration file used by the ATS version installed on the cache server.

const LoggingYAMLFileName = "logging.yaml"

LoggingYAMLFileName is the name of a logging configuration file used by ATS version 8 and later.

const LogsXMLFileName = "logs_xml.config"

LogsXMLFileName is the name of a logging configuration file used by ATS version 6 and earlier.

Deprecated: The versions of ATS that use this file are not supported, either by ATC or the ATS project itself.

const MaxLogObjects = 10

MaxLogObjects is the maximum number of "Log Objects" that can be defined in a logging configuration file for ATS (logging.config, logging.yaml, logs_xml.config).

See the ATS documentatio for logging configuration for details: https://docs.trafficserver.apache.org/en/8.1.x/admin-guide/files/logging.yaml.en.html ... although documentation for unsupported ATS versions may be more helpful: https://docs.trafficserver.apache.org/en/6.1.x/admin-guide/files/logs_xml.config.en.html Note that it's not possible to select this version of the documentation from the version footer in the sidebar at https://docs.trafficserver.apache.org/ anymore at the time of this writing, and may be removed entirely by the time of reading.

const MaxOriginConnectionsNoMax = 0 // 0 indicates no limit on origin connections

MaxOriginConnectionsNoMax is a value specially interpreted by ATS to mean "no maximum origin connections".

TODO: Remove this? It's not used anywhere, not even internally in this package.

const MethodSeparator = `|`

MethodSeparator is the string used as an infix operator in ipallow.config ATS configuration files to express a union of allowed HTTP request methods.

const PackagesFileName = `packages`

PackagesFileName is an unused constant of unknown purpose.

Deprecated: Since the 'package' ConfigFile value is a "dummy" value used to indicate packages that should be installed through yum, there isn't a need for any definition of a file name, and the Parameter ConfigFile value is already exported as PackagesParamConfigFile.

const PackagesParamConfigFile = `package`

PackagesParamConfigFile is the ConfigFile value of Parameters that define system packages to be installed on a cache server.

const ParamCoalesceMaskLenV4 = "coalesce_masklen_v4"

ParamCoalesceMaskLenV4 is the Name of a Parameter which can be used to set the mask length for IPv4 network specifications used to coalesce groups of addresses in an ip_allow.config file.

TODO: unexport? This is only used in this package.

const ParamCoalesceMaskLenV6 = "coalesce_masklen_v6"

ParamCoalesceMaskLenV6 is the Name of a Parameter which can be used to set the mask length for IPv6 network specifications used to coalesce groups of addresses in an ip_allow.config file.

TODO: unexport? This is only used in this package.

const ParamCoalesceNumberV4 = "coalesce_number_v4"

ParamCoalesceNumberV4 is the Name of a Parameter that can be used to set the minimum number of IPv4 addresses in an ip_allow.config file that must be covered by a mask in order to allow coalescing them.

TODO: unexport? This is only used in this package.

const ParamCoalesceNumberV6 = "coalesce_number_v6"

ParamCoalesceNumberV6 is the Name of a Parameter that can be used to set the minimum number of IPv6 addresses in an ip_allow.config file that must be covered by a mask in order to allow coalescing them.

TODO: unexport? This is only used in this package.

const ParamDrivePrefix = "Drive_Prefix"

ParamDrivePrefix is the Name of the Parameter that determines the path prefix for disk storage caching block devices.

const ParamPurgeAllowIP = "purge_allow_ip"

ParamPurgeAllowIP is the Name of Parameters which can specify an IP address to be allowed ALL methods on the cache server (not just PURGE).

TODO: replace instances of "purge_allow_ip" with this currently-unused constant. TODO: unexport? This is only used in this package.

const ParamRAMDrivePrefix = "RAM_Drive_Prefix"

ParamRAMDrivePrefix is the Name of the Parameter that determines the path prefix for RAM caching block devices.

const ParentAbstractionServiceParentSecondaryModeDefault = ParentAbstractionServiceParentSecondaryModeAlternate

ParentAbstractionServiceParentSecondaryModeDefault is the "secondary parent mode" that is used in parenting abstraction if one is not explicitly configured.

const ParentConfigDSParamDefaultMSOAlgorithm = ParentAbstractionServiceRetryPolicyConsistentHash

ParentConfigDSParamDefaultMSOAlgorithm is the parent selection algorithm used by cache servers when not overridden by any Parameters.

const ParentConfigDSParamDefaultMSOParentRetry = "both"

ParentConfigDSParamDefaultMSOParentRetry is the argument to a parent_retry directive in a line in a parent.config ATS configuration file that is used by cache servers when not overridden by any Parameters.

const ParentConfigDSParamDefaultMSOUnavailableServerRetryResponses = ""

ParentConfigDSParamDefaultMSOUnavailableServerRetryResponses is the argument passed to a directive used to set the HTTP response codes that will trigger a cache server to retry its parent and mark it unavailable, in parent.config lines that are generated for MSO Delivery Services.

const ParentConfigDSParamDefaultMaxSimpleRetries = 1

ParentConfigDSParamDefaultMaxSimpleRetries is the maximum number of "simple" retries a cache server will attempt when its parent is unavailable, if not overridden by Parameters.

const ParentConfigDSParamDefaultMaxUnavailableServerRetries = 1

ParentConfigDSParamDefaultMaxUnavailableServerRetries is the maximum number of retries a cache server will attempt when its parent is unavailable, if not overridden by Parameters.

const ParentConfigFileName = "parent.config"

ParentConfigFileName is the name of an ATS parent.config configuration file, as well as the ConfigFile value of Parameters that can affect its contents.

TODO: Replace instances of "parent.config" in t3c with this constant.

const ParentConfigGoDirectEdge = ParentConfigGoDirectParam + ".edge"

const ParentConfigGoDirectFirst = ParentConfigGoDirectParam + ".first"

const ParentConfigGoDirectInner = ParentConfigGoDirectParam + ".inner"

const ParentConfigGoDirectLast = ParentConfigGoDirectParam + ".last"

const ParentConfigGoDirectMid = ParentConfigGoDirectParam + ".mid"

const ParentConfigGoDirectParam = "go_direct"

const ParentConfigParamAlgorithm = "algorithm"

ParentConfigParamAlgorithm is the Name of a Parameter that can be used to set the parent selection algorithm for cache servers that use Origin Shields.

const ParentConfigParamMSOAlgorithm = "mso.algorithm"

ParentConfigParamMSOAlgorithm is the Name of a Parameter that can be used to set the parent selection algorithm for Delivery Services that use MSO, if found in their Profile.

This has no known effect if found in a server Profile.

const ParentConfigParamMSOMaxSimpleRetries = "mso.max_simple_retries"

ParentConfigParamMSOMaxSimpleRetries is the Name of a Parameter that can be used to set the maximum number of "simple" retries a cache server will attempt when its parent is unavailable, if found in the Profile of an MSO Delivery Service.

Refer to ATS Documentation for the difference between this and ParentConfigParamMSOMaxUnavailableServerRetries.

const ParentConfigParamMSOMaxUnavailableServerRetries = "mso.max_unavailable_server_retries"

ParentConfigParamMSOMaxUnavailableServerRetries is the Name of a Parameter that can be used to set the maximum number of retries a cache server will attempt when its parent is unavailable, if found in the Profile of an MSO Delivery Service.

Refer to ATS Documentation for the difference between this and ParentConfigParamMSOMaxSimpleRetries.

const ParentConfigParamMSOParentRetry = "mso.parent_retry"

ParentConfigParamMSOParentRetry is the Name of a Parameter that can be used to set the retry behavior of cache servers trying to reach a parent for an MSO Delivery Service, if found in the Profile of said Delivery Service.

const ParentConfigParamMSOUnavailableServerRetryResponses = "mso.unavailable_server_retry_responses"

ParentConfigParamMSOUnavailableServerRetryResponses is the Name of a Parameter that can be used to set the HTTP response codes that a cache server will consider indicative of its parent being unavailable, if found in the Profile of an MSO Delivery Service.

The format is defined by the grammar of the parent.config ATS configuration file.

const ParentConfigParamMaxSimpleRetries = "max_simple_retries"

ParentConfigParamMaxSimpleRetries is the Name of a Parameter that can be used to set the maximum number of "simple" retries a cache server will attempt when its parent is unavailable, if found in the Profile of a non-MSO Delivery Service.

Refer to ATS Documentation for the difference between this and ParentConfigParamMaxUnavailableServerRetries.

const ParentConfigParamMaxUnavailableServerRetries = "max_unavailable_server_retries"

ParentConfigParamMaxUnavailableServerRetries is the Name of a Parameter that can be used to set the maximum number of retries a cache server will attempt when its parent is unavailable, if found in the Profile of a non-MSO Delivery Service.

Refer to ATS Documentation for the difference between this and ParentConfigParamMaxSimpleRetries.

const ParentConfigParamMergeGroups = "merge_parent_groups"

ParentConfigParamMergeGroups is the Name of a Parameter on Delivery Service Profiles that is used to specify a list of Cache Group names that should merge their secondary parents into their set of primary parents when servicing content for said Delivery Service.

const ParentConfigParamParentRetry = "parent_retry"

ParentConfigParamParentRetry is the Name of a Parameter which can be used to directly set the argument to the parent_retry directive in a line in a parent.config ATS configuration file, if found in the Profile of the Delivery Service represented by that line.

const ParentConfigParamQString = "qstring"

ParentConfigParamQString is the Name of a Parameter that can be used to set the query string handling behavior for the default destination for non-top-level cache servers.

const ParentConfigParamQStringHandling = "psel.qstring_handling"

ParentConfigParamQStringHandling is the Name of a Parameter in the ConfigFile parent.config that will override the text of the argument 'qstring' in a line in parent.config for ALL Delivery Services if found in the Profile of the server for which parent.config is being generated, or ALL servers for the Delivery Service if found in the Profile of a Delivery Service.

Server Profiles have priority when conflicts arise.

const ParentConfigParamSecondaryMode = "try_all_primaries_before_secondary"

ParentConfigParamSecondaryMode is the Name of a Parameter that, if it is found on a server's Profile, will cause the cache server to try all primary parents before resorting to a secondary parent (which presumably differs from the default behavior in some way).

The Value of these Parameters have no meaning; the Parameter's existence is all of the information it conveys.

const ParentConfigParamUnavailableServerRetryResponses = "unavailable_server_retry_responses"

ParentConfigParamUnavailableServerRetryResponses is the Name of a Parameter that can be used to set the HTTP response codes that a cache server will consider indicative of its parent being unavailable, if found in the Profile of a non-MSO Delivery Service.

The format is defined by the grammar of the parent.config ATS configuration file.

const ParentDotConfigParentSeparator = `;`

ParentDotConfigParentSeparator is the string used to delimit multiple parents on a line in a parent.config Apache Traffic Server configuration file.

const PluginFileName = "plugin.config"

PluginFileName is the name of the configuration file used by ATS to configure its plugins, as well as the ConfigFile value of Parameters that can affect the contents of this file.

const PluginSeparator = " "

PluginSeparator is the string used to separate Parameter Names from their Values for lines in plugin.config configuration files.

const RecordsFileName = "records.config"

RecordsFileName is the name of the configuration file used by ATS to configure various miscellaneous options, as well as the ConfigFile value of Parameters that can affect the contents of this file.

const RecordsSeparator = " "

RecordsSeparator is the string used to separate Parameter Names from their Values for lines in records.config configuration files.

const RefetchSuffix = "##REFETCH##"

RefetchSuffix is a special suffix which, if present at the end of an asset URL for a Content Invalidation Job, will cause ATS to treat matching URIs as cache "misses" - effectively this forces ATS to fetch the asset anew from an upstream cache server or origin.

const RefreshSuffix = "##REFRESH##"

RefreshSuffix is a special suffix which, if present at the end of an asset URL for a Content Invalidation Job, will cause ATS to treat matching URIs as "stale" - effectively this forces ATS to retrieve confirmation from an upstream cache server or origin that the cached content is still valid, and according to their response either fetch the content anew or update its age and caching validity markers (ETag, If-Unmodified-Since etc.).

const RegexRemapPrefix = "regex_remap_"

RegexRemapPrefix is a prefix applied to regex_remap.config ATS configuration files for a sepecific Delivery Service. The rest of the name is made up of the Delivery Service's XMLID, followed by '.config' as a suffix (or "file extension").

const RegexRevalidateFileName = "regex_revalidate.config"

RegexRevalidateFileName is the name of a configuration file used by ATS to revalidate or invalidate cached contents based on regular expression matches. This is also the ConfigFile value of GLOBAL Parameters that modify how content invalidation is handled.

const RegexRevalidateMaxRevalDurationDaysParamName = "maxRevalDurationDays"

RegexRevalidateMaxRevalDurationDaysParamName is the Name of a GLOBAL Parameter that can be used to set the maximum duration (in days) of Content Invalidation Requests.

const RegexRevalidateMinTTL = time.Hour

RegexRevalidateMinTTL is a time.Duration that specifies the minimum duration for which Content Invalidation Jobs will remain active. Content Invalidation Jobs with TTLs less than this will use this duration instead.

const RemapConfigCachekeyDirective = `__CACHEKEY_DIRECTIVE__`

RemapConfigCachekeyDirective is a special string which, if found in a Delivery Service's Raw Remap Text, will be replaced by t3c during configuration generation with the parts of a remap.config file line that call the 'cachekey.so' ATS plugin.

const RemapConfigDropQstringConfigFile = `drop_qstring.config`

RemapConfigDropQstringConfigFile is the configuration file for the `drop_qstring` plugin used in remap.config files.

const RemapConfigRangeDirective = `__RANGE_DIRECTIVE__`

RemapConfigRangeDirective is a special string which, if found in a Delivery Service's Raw Remap Text, will be replaced by t3c during configuration generation with the parts of a remap.config file line that are necessary to implement said Delivery Service's declared Range Request Handling.

const RemapConfigRegexRemapDirective = `__REGEX_REMAP_DIRECTIVE__`

RemapConfigRegexRemapDirective is a special string which, if found in a Delivery Service's Raw Remap Text, will be replaced by t3c during configuration generation with the parts of a remap.config file line that call the 'regex_remap.so' ATS plugin.

const RemapConfigTemplateFirst = `template.first`

const RemapConfigTemplateInner = `template.inner`

const RemapConfigTemplateLast = `template.last`

const RemapFile = "remap.config"

RemapFile is the name of a configuration file used by ATS to map client requests.

TODO: replace instances of "remap.config" with this constant.

const RevalTypeDefault = RevalTypeStale

RevalTypeDefault is the type of revalidation that will be performed by default, if not otherwise specified.

const RevalTypeMiss = RevalType("MISS")

RevalTypeMiss represents the caching condition where the asset requested could not be found in cache.

const RevalTypeStale = RevalType("STALE")

RevalTypeStale represents the caching condition where the asset requested is in cache, but it has expired and must be revalidated upstream.

const SNIDotYAMLFileName = "sni.yaml"

SNIDotYAMLFileName is an unused constant that probably defines either the name on disk of an sni.yaml ATS configuration file, the ConfigFile value of Parameters that may influence the generation of such files, or both.

TODO: replace instances of sni.yaml with this constant.

const SSLMultiCertConfigFileName = `ssl_multicert.config`

SSLMultiCertConfigFileName is the name of an ATS configuration file which contains information on the locations of one or more SSL key and certificate pairs.

const SSLServerNameYAMLFileName = "ssl_server_name.yaml"

SSLServerNameYAMLFileName is an unused constant that probably refers to the name of an ATS ssl_server_name.yaml file on disk, the ConfigFile value of Parameters that can affect the generation of such a file, or both.

const SSLServerNameYAMLParamEnableH2 = "enable_h2"

SSLServerNameYAMLParamEnableH2 is the Name of a Parameter which, if found on the Profile of a Delivery Service and having the ConfigFile value "parent.config" - NOT ssl_server_name.yaml, which would cause it to be ignored - will enable the use of the HTTP/2 protocol for Delivery Services if its value begins with 'T', 't', 'Y', or 'y'.

Examples of Values for these Parameters that would cause HTTP/2 to be enabled are:

true
TrUe
Yes
yno
yFalse
tFalse
talse
ts"<>an177otehucau$%*(@YDU)

Examples of Values for these Parameters that would cause HTTP/2 to be disabled are:

false
No
off
on
use
enable
1
affirmative
I wish to use this feature
frue
nYes
s"<>an177otehucau$%*(@YDU)

const SSLServerNameYAMLParamTLSVersions = "tls_versions"

SSLServerNameYAMLParamTLSVersions is the Name of a Parameter which, if found on the Profile of a Delivery Service and having the ConfigFile value "parent.config" - NOT ssl_server_name.yaml, which would cause it to be ignored - will set the explicitly allowed TLS versions for communication with edge-tier cache servers.

The Value of such Parameters should be a list of TLS versions, which may be separated by spaces, new lines, semicolons, or commas (but only one thereof, and only consistently a single of those delimeters, not a mixture).

Deprecated: Now that Delivery Services support setting TLS versions to be explicitly allowed directly on their configuration, that feature should be used rather than this Parameter.

const ServerCacheDotConfigIncludeInactiveDSes = false

ServerCacheDotConfigIncludeInactiveDSes is the definition of whether or not inactive Delivery Services should be considered when generating the contents of a cache.config ATS configuration file.

const ServerHostingDotConfigEdgeIncludeInactive = true

ServerHostingDotConfigEdgeIncludeInactive controls whether or not to include configurations for inactive Delivery Services in hosting.config for edge-tier cache servers.

const ServerHostingDotConfigMidIncludeInactive = false

ServerHostingDotConfigMidIncludeInactive controls whether or not to include configurations for inactive Delivery Services in hosting.config for mid-tier cache servers.

const ServiceCategoryHeader = "@CDN-SVC"

ServiceCategoryHeader is the internal service category header for logging the service category. Note this is internal, and will never be set in an HTTP Request or Response by ATS.

const StorageFileName = "storage.config"

StorageFileName is the ConfigFile of Parameters which, if found on a server's Profile, will affect the generation of its storage.config ATS configuration file.

const StrategyConfigUsePeering = "use_peering"

StrategyConfigUsePeering is the Name of a Parameter which, if it exists on a Delivery Service's Profile and has the Value of exactly "true", causes cache servers assigned to service that Delivery Service's content to use "peering" mode for secondary parent selection. Note that this is not (yet?) implemented in strategies.yaml generation.

const SysctlFileName = "sysctl.conf"

SysctlFileName is the ConfigFile of Parameters which, if found on a server's Profile, specify lines in the sysctl.conf ATS configuration file.

const SysctlSeparator = " = "

SysctlSeparator is the string used to separate Parameter Names from their Values on lines of a sysctl.conf ATS configuration file.

const TLSVersionInvalid = TLSVersion("")

TLSVersionInvalid is used to represent an unrecognized or unsupported TLS version.

const TsDefaultRequestHeaderMaxSize = 131072

TsDefaultRequestHeaderMaxSize is the default maximum request header size that will be allowed by ATS unless otherwise specified on a server's Profile.

For more information, refer to the ATS documentation for the reconds.config configuration option 'proxy.config.http.request_header_max_size'.

const VolumeFileName = StorageFileName

VolumeFileName is the ConfigFile of Parameters which can influence the generation of a volume.config ATS configuration file, if found on the Profile of the server for which generation is taking place.

const YAMLActionAllow = "allow"

YAMLActionAllow specifies that the block to which it belongs specifies that matching IP addresses should be explicitly allowed to use the associated HTTP request methods.

const YAMLActionDeny = "deny"

YAMLActionDeny specifies that the block to which it belongs specifies that matching IP addresses should be explicitly NOT allowed to use the associated HTTP request methods.

const YAMLDocumentEnd = "..."

YAMLDocumentEnd is the symbol used in the YAML grammar to indicate the end of the "document", which simultaneously constitutes the beginning of the zero or more "directives" (again).

const YAMLDocumentStart = "---"

YAMLDocumentStart is the symbol used in the YAML grammar to indicate the end of "directives", which simultaneously constitutes the beginning of the "document".

const YAMLMethodAll = "ALL"

YAMLMethodAll is a possible HTTP request method that may be given/denied to IP addresses in ipallow.yaml configuration files, which has the special meaning "all HTTP request methods".