OCPBUGS#2226: ptpSchedulingPriority value updated to 10

Author: amolnar-gh

modules/cnf-configuring-fifo-priority-scheduling-for-ptp.adoc

@@ -39,7 +39,7 @@ spec:
   - name: "profile1"
 ...
     ptpSchedulingPolicy: SCHED_FIFO <1>
-    ptpSchedulingPriority: 65 <2>
+    ptpSchedulingPriority: 10 <2>
 ----
 <1> Scheduling policy for `ptp4l` and `phc2sys` processes. Use `SCHED_FIFO` on systems that support FIFO scheduling.
 <2> Required. Sets the integer value 1-65 used to configure FIFO priority for `ptp4l` and `phc2sys` processes.

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

@@ -143,7 +143,7 @@ spec:
       timeSource                        0xA0
     phc2sysOpts:                        "-a -r -n 24" <10>
     ptpSchedulingPolicy:                SCHED_OTHER   <11>
-    ptpSchedulingPriority:              65            <12>
+    ptpSchedulingPriority:              10            <12>
   ptpClockThreshold:                                  <13>
     holdOverTimeout:                    5
     maxOffsetThreshold:                 100
@@ -166,7 +166,7 @@ spec:
 <9> For Intel Columbiaville 800 Series NICs, ensure `boundary_clock_jbod` is set to `0`. For Intel Fortville X710 Series NICs, ensure `boundary_clock_jbod` is set to `1`.
 <10> Specify system config options for the `phc2sys` service. If this field is empty the PTP Operator does not start the `phc2sys` service.
 <11> Scheduling policy for ptp4l and phc2sys processes. Default value is `SCHED_OTHER`. Use `SCHED_FIFO` on systems that support FIFO scheduling.
-<12> Integer value from 1-65 used to set FIFO priority for `ptp4l` and `phc2sys` processes. Required if `SCHED_FIFO` is set for `ptpSchedulingPolicy`.
+<12> Integer value from 1-65 used to set FIFO priority for `ptp4l` and `phc2sys` processes when `ptpSchedulingPolicy` is set to `SCHED_FIFO`. The `ptpSchedulingPriority` field is not used when `ptpSchedulingPolicy` is set to `SCHED_OTHER`.
 <13> Optional. If `ptpClockThreshold` stanza is not present, default values are used for `ptpClockThreshold` fields. Stanza shows default `ptpClockThreshold` values.
 <14> Specify an array of one or more `recommend` objects that define rules on how the `profile` should be applied to nodes.
 <15> Specify the `profile` object name defined in the `profile` section.

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

@@ -138,7 +138,7 @@ spec:
       userDescription                    ;
       timeSource                         0xA0
     ptpSchedulingPolicy:                 SCHED_OTHER    <10>
-    ptpSchedulingPriority:               65             <11>
+    ptpSchedulingPriority:               10             <11>
   ptpClockThreshold:                                    <12>
     holdOverTimeout:                     5
     maxOffsetThreshold:                  100
@@ -160,7 +160,7 @@ spec:
 <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`.
 <10> Scheduling policy for `ptp4l` and `phc2sys` processes. Default value is `SCHED_OTHER`. Use `SCHED_FIFO` on systems that support FIFO scheduling.
-<11> Integer value from 1-65 used to set FIFO priority for `ptp4l` and `phc2sys` processes. Required if `SCHED_FIFO` is set for `ptpSchedulingPolicy`.
+<11> Integer value from 1-65 used to set FIFO priority for `ptp4l` and `phc2sys` processes when `ptpSchedulingPolicy` is set to `SCHED_FIFO`. The `ptpSchedulingPriority` field is not used when `ptpSchedulingPolicy` is set to `SCHED_OTHER`.
 <12> Optional. If `ptpClockThreshold` stanza is not present, default values are used for `ptpClockThreshold` fields. Stanza shows default `ptpClockThreshold` values.
 <13> Specify an array of one or more `recommend` objects that define rules on how the `profile` should be applied to nodes.
 <14> Specify the `profile` object name defined in the `profile` section.

networking/using-ptp.adoc

@@ -47,8 +47,18 @@ include::modules/nw-ptp-device-discovery.adoc[leveloffset=+2]
 
 include::modules/nw-ptp-configuring-linuxptp-services-as-ordinary-clock.adoc[leveloffset=+2]
 
+[role="_additional-resources"]
+.Additional resources
+
+* For more information about FIFO priority scheduling on PTP hardware, see xref:../networking/using-ptp.adoc#cnf-configuring-fifo-priority-scheduling-for-ptp_using-ptp[Configuring FIFO priority scheduling for PTP hardware].
+
 include::modules/nw-ptp-configuring-linuxptp-services-as-boundary-clock.adoc[leveloffset=+2]
 
+[role="_additional-resources"]
+.Additional resources
+
+* For more information about FIFO priority scheduling on PTP hardware, see xref:../networking/using-ptp.adoc#cnf-configuring-fifo-priority-scheduling-for-ptp_using-ptp[Configuring FIFO priority scheduling for PTP hardware].
+
 include::modules/ptp-configuring-linuxptp-services-as-boundary-clock-dual-nic.adoc[leveloffset=+2]
 
 include::modules/nw-columbiaville-ptp-config-refererence.adoc[leveloffset=+2]