Skip to content

Commit 42a2c64

Browse files
rohennesrohennes
committed
TELCODOCS-2099: Support for dual-port ordinary clock in PTP
1 parent 7e9ef0e commit 42a2c64

4 files changed

+132
-0
lines changed

‎modules/nw-ptp-configuring-linuxptp-services-dual-port-oc.adoc

+97
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/ptp/configuring-ptp.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="configuring-linuxptp-services-oc-dual-port_{context}"]
7+
= Configuring linuxptp services as an ordinary clock with dual-port NIC redundancy
8+
9+
You can configure `linuxptp` services (`ptp4l`, `phc2sys`) as an ordinary clock with dual-port NIC redundancy by creating a `PtpConfig` custom resource (CR) object.
10+
In a dual-port NIC configuration for an ordinary clock, if one port fails, the standby port takes over, maintaining PTP timing synchronization.
11+
12+
.Prerequisites
13+
14+
* Install the OpenShift CLI (`oc`).
15+
* Log in as a user with `cluster-admin` privileges.
16+
* Install the PTP Operator.
17+
* Check that {product-title} supports your dual-port NIC as an ordinary clock with added redundancy. For further information, see "Using dual-port NICs to improve redundancy for PTP ordinary clocks".
18+
19+
.Procedure
20+
21+
. Create the following `PtpConfig` CR, and then save the YAML in the `oc-dual-port-ptp-config.yaml` file.
22+
+
23+
.Example PTP ordinary clock dual-port configuration
24+
[source,yaml]
25+
----
26+
apiVersion: ptp.openshift.io/v1
27+
kind: PtpConfig
28+
metadata:
29+
name: ordinary-clock-1
30+
namespace: openshift-ptp
31+
spec:
32+
profile:
33+
- name: oc-dual-port
34+
phc2sysOpts: -a -r -n 24 -N 8 -R 16 -u 0 <1>
35+
ptp4lConf: |- <2>
36+
[ens3f2]
37+
masterOnly 0
38+
[ens3f3]
39+
masterOnly 0
40+
41+
[global]
42+
#
43+
# Default Data Set
44+
#
45+
slaveOnly 1 <3>
46+
#...
47+
----
48+
<1> Specify the system config options for the `ptp4l` service.
49+
<2> Specify the interface configuration for the `ptp4l` service. In this example, setting `masterOnly 0` for the `ens3f2` and `ens3f3` interfaces enables both ports on the `ens3` interface to run as leader or follower clocks. In combination with the `slaveOnly 1` specification, this configuration ensures one port operates as the active ordinary clock, and the other port operates as a standby ordinary clock in the `Listening` port state.
50+
<3> Configures `ptp4l` to run as an ordinary clock only.
51+
52+
. Create the `PtpConfig` CR by running the following command:
53+
+
54+
[source,terminal]
55+
----
56+
$ oc create -f oc-dual-port-ptp-config.yaml
57+
----
58+
59+
.Verification
60+
61+
. Check that the `PtpConfig` profile is applied to the node.
62+
63+
.. Get the list of pods in the `openshift-ptp` namespace by running the following command:
64+
+
65+
[source,terminal]
66+
----
67+
$ oc get pods -n openshift-ptp -o wide
68+
----
69+
+
70+
.Example output
71+
[source,terminal]
72+
----
73+
NAME READY STATUS RESTARTS AGE IP NODE
74+
linuxptp-daemon-4xkbb 1/1 Running 0 43m 10.1.196.24 compute-0.example.com
75+
linuxptp-daemon-tdspf 1/1 Running 0 43m 10.1.196.25 compute-1.example.com
76+
ptp-operator-657bbb64c8-2f8sj 1/1 Running 0 43m 10.129.0.61 control-plane-1.example.com
77+
----
78+
79+
.. Check that the profile is correct. Examine the logs of the `linuxptp` daemon that corresponds to the node you specified in the `PtpConfig` profile. Run the following command:
80+
+
81+
[source,terminal]
82+
----
83+
$ oc logs linuxptp-daemon-4xkbb -n openshift-ptp -c linuxptp-daemon-container
84+
----
85+
+
86+
.Example output
87+
[source,terminal]
88+
----
89+
I1115 09:41:17.117596 4143292 daemon.go:107] in applyNodePTPProfile
90+
I1115 09:41:17.117604 4143292 daemon.go:109] updating NodePTPProfile to:
91+
I1115 09:41:17.117607 4143292 daemon.go:110] ------------------------------------
92+
I1115 09:41:17.117612 4143292 daemon.go:102] Profile Name: oc-dual-port
93+
I1115 09:41:17.117616 4143292 daemon.go:102] Interface: ens787f1
94+
I1115 09:41:17.117620 4143292 daemon.go:102] Ptp4lOpts: -2 --summary_interval -4
95+
I1115 09:41:17.117623 4143292 daemon.go:102] Phc2sysOpts: -a -r -n 24 -N 8 -R 16 -u 0
96+
I1115 09:41:17.117626 4143292 daemon.go:116] ------------------------------------
97+
----

‎modules/ptp-dual-ports-oc.adoc

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/ptp/about-ptp.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="ptp-dual-ports-oc_{context}"]
7+
= Using dual-port NICs to improve redundancy for PTP ordinary clocks
8+
9+
{product-title} supports single and dual-port networking interface cards (NIC) as ordinary clocks for PTP timing. To improve redundancy, you can configure a dual-port NIC with one port as active and the other as standby.
10+
11+
In this configuration, the ports in a dual-port NIC operate as follows:
12+
13+
* The active port functions as an ordinary clock in the `Following` port state.
14+
15+
* The standby port functions as a standby port in the `Listening` state.
16+
17+
* If the active port fails, the standby port transitions to active to ensure continued PTP timing synchronization.
18+
19+
If both ports become faulty, the clock state moves to the `HOLDOVER` state, then the `FREERUN` state when the holdover timeout expires, before resyncing to a leader clock.
20+
21+
{product-title} supports PTP ordinary clocks on nodes with x86 or ARM architectures using the following dual-port NICs:
22+
23+
* NVIDIA ConnectX-7 series
24+
25+
* NVIDIA BlueField-3 series, in NIC mode
26+
+
27+
[NOTE]
28+
====
29+
You must configure the NVIDIA BlueField-3 series DPU in NIC mode before configuring the interface as an ordinary clock with improved redundancy. For further information about configuring NIC mode, see link:https://docs.nvidia.com/networking/display/bluefielddpubspv422/modes+of+operation#src-141856548_ModesofOperation-NICModeforBlueField-3[NIC Mode for BlueField-3] (NVIDIA documentation).
30+
====
31+

‎networking/ptp/about-ptp.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ Before enabling PTP, ensure that NTP is disabled for the required nodes. You can
3232

3333
include::modules/ptp-dual-nics.adoc[leveloffset=+1]
3434

35+
include::modules/ptp-dual-ports-oc.adoc[leveloffset=+1]
36+
3537
include::modules/ptp-linuxptp-introduction.adoc[leveloffset=+1]
3638

3739
include::modules/ptp-overview-of-gnss-grandmaster-clock.adoc[leveloffset=+1]

‎networking/ptp/configuring-ptp.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ include::modules/nw-ptp-configuring-linuxptp-services-as-ordinary-clock.adoc[lev
7373
7474
include::modules/nw-columbiaville-ptp-config-refererence.adoc[leveloffset=+2]
7575

76+
include::modules/nw-ptp-configuring-linuxptp-services-dual-port-oc.adoc[leveloffset=+2]
77+
7678
[role="_additional-resources"]
7779
.Additional resources
7880

0 commit comments

Comments
 (0)