Add Tuned to configure NIC queues

[MarSik]

This file configures the number of NIC queues for kernel level networking.

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: MarSik

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [MarSik]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[imiller0]

In the reference configuration we also include the PerformanceProfile. We should explicitly align the names here along with a note (comment) that if you change one you need to change the other.

[MarSik]

Yep, we should, but the included profile also uses $name here https://github.com/openshift-kni/telco-reference/blob/main/telco-core/configuration/reference-crs/required/performance/PerformanceProfile.yaml#L7

[MarSik]

I could use lookupCR here to match the perf profile name, however it would not work when multiple profiles (and multiple MCPs) show up..

[lack]

I think this block is from the reference CR, not the cluster-compare template, so it may be good to hard-code some kind of reasonable default, and document when it needs to be changed.

But this is a general problem we seem to keep hitting. Is it worth opening an RFE against NTO that would allow some kind of tuned-template way to say "Include the right tuned performance profile based on this node's MCP pool name"?

[imiller0]

During discussion it was floated that 16 may be sufficient. Do we have data to back up either choice?

[MarSik]

Not really, this is a conservative recommendation. We can start with 16 as that is what we recommend as a starter point for schedulable control plane as well.

[MarSik]

@imiller0 I need a bit of a help with

./compare.sh reference-crs reference-crs-kube-compare reference-crs-kube-compare/compare_ignore
The following files exist in source-crs only, but not found in reference:
reference-crs/required/networking/tuned-queues.yaml

[lack]

You need to add another copy of the file in telco-core/configuration/reference-crs-kube-compare, and you'll need to decide which (if any) fields can be altered by an end-user and still be compliant with the RDS. Any of those user-settable values should be templated in the kube-compare reference copy.

[MarSik]

@imiller0 @lack Like this? Can you give it lgtm so I am not approving my own PR?

[lack]

Added some notes on how to describe the ways users will likely customize the values in the example object.

You will also need to add the tuned-queues.yaml to the metadata.yaml under reference-crs-kube-compare, and if you do use the capturegroup mechanism you will also need to declare the field that has the capturegroups to use that enhanced algorthm:

...
          - path: required/networking/tuned-queues.yaml
            config:
              perField:
                - pathToKey: spec.profile.0.data
                  inlineDiffFunc: capturegroups
...

[lack]

This will force the include to be include=openshift-node-performance-configuration-nic, which I'm not sure is right - It actually needs to be the name of the PerformanceProfile, not the name of this TuneD object, right?

If so, it's probably better to just use a capturegroup regex here (and also devices_udev_regex); something like this:

Suggested change

	include=openshift-node-performance-{{ .metadata.name }}
	include=openshift-node-performance-(?<performanceProfileName>[[:^space:]]+)

[imiller0]

@MarSik can we accept Jim's changes and re-validate?

[lack]

As above, if users are going to customize the regex part of the string, you should use something like this:

Suggested change

	devices_udev_regex=^INTERFACE=ens1f(0|1)
	devices_udev_regex=^INTERFACE=(?<ifaceRegex>[^\r\n]+)

Note: Depends on openshift/release#62113 to merge first so CI will pass (fixes a bug in the cluster-compare version used so it doesn't get confused by the trailing ) in the example CR)

[lack]

If users are allowed to change this number, consider:

Suggested change

	channels=combined 32
	channels=combined (?<channels>[0-9]+)

[lack]

Given that we want to template the MCP name here and it's inside a list, there's a little work that needs doing, something like this:

Suggested change

	recommend:
	- machineConfigLabels:
	machineconfiguration.openshift.io/role: "worker"
	priority: 19
	profile: configuration-nic
	recommend:
	{{- range .spec.recommend }}
	- machineConfigLabels:
	machineconfiguration.openshift.io/role: {{ .machineConfigLabels."machineconfiguration.openshift.io/role" }}
	priority: 19
	profile: configuration-nic
	{{- end }}

[MarSik]

It is a list, however only the profile created in the Tuned should be referenced here. So the name of the profile is static as well as the number of items.

[lack]

Will this always be "worker", or could this need to match different MCP pools?

[MarSik]

It can match various MCP pools indeed.