CiaB produces invalid configuration/required parameter is undocumented

[ocket8888]

I'm submitting a ...

• bug report

Traffic Control components affected ...

• CDN in a Box
• Documentation
• Traffic Ops ORT

Current behavior:

CDN-in-a-Box's cache server Profiles are missing the required Parameter:

{
	"name": "trafficserver",
	"config_file": "package",
	"value": "{{version}}-{{patch}}.{{commit hash}}.{{Enterprise Linux release}}.{{distro}}.{{CPU arch}}"
}

Which is also not present anywhere in documentation. If this Parameter is not present, atstccfg will assume that the server is using the unsupported ATS version 5.0, and will generate its configuration appropriately. This means that it will possibly generate configuration that the cache servers can't actually understand.

Expected behavior:

atstccfg should be aware of the actual ATS version installed on the CiaB cache servers.

Minimal reproduction of the problem with instructions:

Check the ORT logs for CiaB cache servers, notice that they note the ATS version as 5

[ocket8888]

These exist now, but have Values that are just (unchanged). If that's handled specially, I think it's undocumented. If it isn't, then a reasonable feature request would be that it isn't required (which is covered by #6205) or that the Value be valid and correct somehow.

[zrhoffman]

These exist now, but have Values that are just (unchanged). If that's handled specially, I think it's undocumented.

CDN in a Box changes it to a valid value:

trafficcontrol/infrastructure/cdn-in-a-box/cache/run.sh

Line 45 in 497b885

trafficserver_version="$(rpm -q --qf '%{version}-%{release}.%{arch}\n' trafficserver)"

trafficcontrol/infrastructure/cdn-in-a-box/cache/run.sh

Line 52 in 497b885

set_profile_parameter "$ats_profile" package trafficserver "$trafficserver_version" 'trafficserver RPM version'

But yeah, we should document it. Note that our site's downloadable profiles
already have it:

    {
      "configFile": "package",
      "name": "trafficserver",
      "value": "8.1.1-59.673d979d0.el8.centos.x86_64"
    },

[mitchell852]

can this be closed @ocket8888 @zrhoffman

[ocket8888]

No, the parameter is still undocumented

[zrhoffman]

This is it, right?

trafficcontrol/docs/source/overview/profiles_and_parameters.rst

Lines 465 to 469 in 743f1d4

	package
	'''''''
	This is a special, reserved Config File that isn't a file at all. When a Parameter's Config File is ``package``, then its name is interpreted as the name of a package. :term:`ORT` on the server using the :ref:`Profile <profiles>` that has this Parameter will attempt to install a package by that name, interpreting the Parameter's Value_ as a version string if it is not empty. The package manager used will be :manpage:`yum(8)`, regardless of system (though the Python version of :term:`ORT` will attempt to use the host system's package manager - :manpage:`yum(8)`, :manpage:`apt(8)` and ``pacman`` are supported) but that shouldn't be a problem because only Rocky Linux 8 and CentOS 7 are supported.
	The current implementation of :term:`ORT` will expect Parameters to exist on a :term:`cache server`'s :ref:`Profile <profiles>` with the :ref:`Names <parameter-name>` ``astats_over_http`` and ``trafficserver`` before being run the first time, as both of these are required for a :term:`cache server` to operate within a Traffic Control CDN. It is possible to install these outside of :term:`ORT` - and indeed even outside of :manpage:`yum(8)` - but such configuration is not officially supported.

It could still use an example IMO

[ocket8888]

Huh, yeah, I guess it is.