diff --git a/modules/ptp-using-hardware-specific-nic-features.adoc b/modules/ptp-using-hardware-specific-nic-features.adoc new file mode 100644 index 000000000000..c965541d011d --- /dev/null +++ b/modules/ptp-using-hardware-specific-nic-features.adoc @@ -0,0 +1,46 @@ +// Module included in the following assemblies: +// +// * + +:_content-type: CONCEPT +[id="ptp-using-hardware-specific-nic-features_{context}"] += Using hardware-specific NIC features with the PTP Operator + +NIC hardware with built-in PTP capabilities sometimes requires device-specific configurations to be applied. +You can use hardware-specific NIC features with the PTP Operator by configuring a plugin in the `PtpConfig` custom resource (CR). +The `linuxptp-daemon` uses the named parameters in the `plugin` stanza to launch `linuxptp` processes (`ptp4l` and `phc2sys`) based on the specic hardware configuration. + +An example `PtpConfig` CR with a configured `plugin` stanza for the Intel E810 NIC is below: + +[source,yaml] +---- +apiVersion: ptp.openshift.io/v1 +kind: PtpConfig +metadata: + name: worker + namespace: openshift-ptp +spec: + profile: + - name: discovery-worker + interface: ens5f0 + #ptp4lOpts: "-2 -s" + phc2sysOpts: " -a -r -n 24 -u 8" + ptp4lConf: | + [global] + # + # Default Data Set + ptpSchedulingPolicy SCHED_FIFO + ptpSchedulingPriority 10 + plugin: + - deviceId: e810 + args: + U_FL2: 0,2 + U_FL1: 0,1 + SMA2: 1,1 + SMA1: 0,1 + recommend: + - profile: discovery-worker + priority: 4 + match: + - nodeLabel: node-role.kubernetes.io/master +---- diff --git a/networking/using-ptp.adoc b/networking/using-ptp.adoc index 0ddd6236ac53..103d1b26c2a3 100644 --- a/networking/using-ptp.adoc +++ b/networking/using-ptp.adoc @@ -47,6 +47,8 @@ When installed, the PTP Operator searches your cluster for PTP-capable network d include::modules/nw-ptp-device-discovery.adoc[leveloffset=+2] +include::modules/ptp-using-hardware-specific-nic-features.adoc[leveloffset=+2] + include::modules/nw-ptp-configuring-linuxptp-services-as-grandmaster-clock.adoc[leveloffset=+2] [role="_additional-resources"]