Merge pull request #50901 from aireilly/td-935

TELCODOCS-960 - PTP config `phc2sysOpts` clarify use of the -m switch

Author: stevsmit

modules/cnf-configuring-cvl-nic-as-oc.adoc

@@ -53,16 +53,17 @@ spec:
   - name: "profile1"
     interface: "enp5s0f0"
     ptp4lOpts: "-2 -s --summary_interval -4" <1>
-    phc2sysOpts: "-a -r -m -n 24 -N 8 -R 16"
-    ptp4lConf: "" <2>
-  ptpClockThreshold: <3>
-    holdOverTimeout: 5 <4>
-    maxOffsetThreshold: 100 <5>
-    minOffsetThreshold: -100 <6>
+    phc2sysOpts: "-a -r -m -n 24 -N 8 -R 16" <2>
+    ptp4lConf: "" <3>
+  ptpClockThreshold: <4>
+    holdOverTimeout: 5 <5>
+    maxOffsetThreshold: 100 <6>
+    minOffsetThreshold: -100 <7>
 ----
 <1> Append `--summary_interval -4` to use PTP fast events.
-<2> Specify a string that contains the configuration to replace the default /etc/ptp4l.conf file. To use the default configuration, leave the field empty.
-<3> Optional. If `ptpClockThreshold` stanza is not present, default values are used for `ptpClockThreshold` fields. Stanza shows default `ptpClockThreshold` values.
-<4> Number of seconds to stay in the clock holdover state. Holdover state is the period between local and master clock synchronizations.
-<5> Maximum offset value in nanoseconds. Offset is the time difference between the local and master clock.
-<6> Minimum offset value in nanoseconds.
+<2> Required `phc2sysOpts` values. `-m` prints messages to `stdout`. The `linuxptp-daemon` `DaemonSet` parses the logs and generates Prometheus metrics.
+<3> Specify a string that contains the configuration to replace the default /etc/ptp4l.conf file. To use the default configuration, leave the field empty.
+<4> Optional. If `ptpClockThreshold` stanza is not present, default values are used for `ptpClockThreshold` fields. Stanza shows default `ptpClockThreshold` values.
+<5> Number of seconds to stay in the clock holdover state. Holdover state is the period between local and master clock synchronizations.
+<6> Maximum offset value in nanoseconds. Offset is the time difference between the local and master clock.
+<7> Minimum offset value in nanoseconds.

modules/cnf-configuring-the-ptp-fast-event-publisher.adoc

@@ -17,5 +17,10 @@ The following table describes the changes that you must make to the reference PT
 |`boundary_clock_jbod`|`0`
 |====
 
+[NOTE]
+====
+For `phc2sysOpts`, `-m` prints messages to `stdout`. The `linuxptp-daemon` `DaemonSet` parses the logs and generates Prometheus metrics.
+====
+
 
 

modules/nw-columbiaville-ptp-config-refererence.adoc

@@ -155,7 +155,7 @@ spec:
 <3> Specify a unique name for the profile object.
 <4> Specify the network interface to be used by the `ptp4l` service, for example `ens787f1`.
 <5> Specify system config options for the `ptp4l` service, for example `-2` to select the IEEE 802.3 network transport. The options should not include the network interface name `-i <interface>` and service config file `-f /etc/ptp4l.conf` because the network interface name and the service config file are automatically appended. Append `--summary_interval -4` to use PTP fast events with this interface.
-<6> Specify system config options for the `phc2sys` service. If this field is empty the PTP Operator does not start the `phc2sys` service. For Intel Columbiaville 800 Series NICs, set `phc2sysOpts` options to `-a -r -m -n 24 -N 8 -R 16`.
+<6> Specify system config options for the `phc2sys` service. If this field is empty the PTP Operator does not start the `phc2sys` service. For Intel Columbiaville 800 Series NICs, set `phc2sysOpts` options to `-a -r -m -n 24 -N 8 -R 16`. `-m` prints messages to `stdout`. The `linuxptp-daemon` `DaemonSet` parses the logs and generates Prometheus metrics.
 <7> Specify a string that contains the configuration to replace the default `/etc/ptp4l.conf` file. To use the default configuration, leave the field empty.
 <8> For Intel Columbiaville 800 Series NICs, set `tx_timestamp_timeout` to `50`.
 <9> For Intel Columbiaville 800 Series NICs, set `boundary_clock_jbod` to `0`.

modules/nw-ptp-configuring-linuxptp-services-as-ordinary-clock.adoc

@@ -44,9 +44,10 @@ spec:
       [ens5f0]
       masterOnly 0
     ...
-    phc2sysOpts: "-a -r -m -n 24 -N 8 -R 16"
+    phc2sysOpts: "-a -r -m -n 24 -N 8 -R 16" <2>
 ----
 <1> Specify the required interfaces to start `ptp4l` as a boundary clock. For example, `ens5f0` synchronizes from a grandmaster clock and `ens5f1` synchronizes connected devices.
+<2> Required `phc2sysOpts` values. `-m` prints messages to `stdout`. The `linuxptp-daemon` `DaemonSet` parses the logs and generates Prometheus metrics.
 
 .. Create `boundary-clock-ptp-config-nic2.yaml`, removing the `phc2sysOpts` field altogether to disable the `phc2sys` service for the second NIC:
 +

modules/ptp-configuring-linuxptp-services-as-boundary-clock-dual-nic.adoc

@@ -50,16 +50,17 @@ You can configure PTP fast events for vRAN clusters that are deployed using the
     - name: "slave"
       interface: "ens5f1" <2>
       ptp4lOpts: "-2 -s --summary_interval -4" <3>
-      phc2sysOpts: "-a -r -m -n 24 -N 8 -R 16"
-    ptpClockThreshold: <4>
+      phc2sysOpts: "-a -r -m -n 24 -N 8 -R 16" <4>
+    ptpClockThreshold: <5>
       holdOverTimeout: 30 #secs
       maxOffsetThreshold: 100  #nano secs
       minOffsetThreshold: -100 #nano secs
 ----
 <1> Can be one `PtpConfigMaster.yaml`, `PtpConfigSlave.yaml`, or `PtpConfigSlaveCvl.yaml` depending on your requirements. `PtpConfigSlaveCvl.yaml` configures `linuxptp` services for an Intel E810 Columbiaville NIC. For configurations based on `group-du-sno-ranGen.yaml` or `group-du-3node-ranGen.yaml`, use `PtpConfigSlave.yaml`.
 <2> Device specific interface name.
 <3> You must append the `--summary_interval -4` value to `ptp4lOpts` in `.spec.sourceFiles.spec.profile` to enable PTP fast events.
-<4> `ptpClockThreshold` configues how long the clock stays in clock holdover state. Holdover state is the period between local and master clock synchronizations. Offset is the time difference between the local and master clock.
+<4> Required `phc2sysOpts` values. `-m` prints messages to `stdout`. The `linuxptp-daemon` `DaemonSet` parses the logs and generates Prometheus metrics.
+<5> `ptpClockThreshold` configues how long the clock stays in clock holdover state. Holdover state is the period between local and master clock synchronizations. Offset is the time difference between the local and master clock.
 
 . Apply the following `PolicyGenTemplate` changes to your specific site YAML files, for example, `example-sno-site.yaml`: