Skip to content

Commit e8b8113

Browse files
slovernslovern
authored
Merge pull request #110859 from slovern/TELCODOCS-2483
TELCODOCS-2483: Support T-GM for NAC of Intel GNR-D platform
2 parents a89c44b + 0cf6c82 commit e8b8113

5 files changed

Lines changed: 428 additions & 3 deletions

‎modules/nw-ptp-configuring-linuxptp-services-as-grandmaster-clock-gnrd.adoc‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/advanced_networking/ptp/configuring-ptp.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="configuring-linuxptp-services-as-grandmaster-clock-gnrd_{context}"]
7+
= Configuring linuxptp services as a Telecom Grandmaster clock on Intel Granite Rapids-D hardware
8+
9+
[role="_abstract"]
10+
Use this procedure to configure the `linuxptp` services (`ptp4l`, `phc2sys`, `ts2phc`) as a Telecom Grandmaster (T-GM) on Intel Granite Rapids-D (GNR-D) hardware that uses onboard Network Acceleration Complex (NAC) ports and optional Carter Flat expansion network interface cards (NICs).
11+
In this deployment, GNSS input disciplines the platform clock and the example `PtpConfig` CR uses the `e830` and `e825` plugins for onboard NAC and optional Carter Flat ports.
12+
13+
:FeatureName: Telecom Grandmaster clock configuration on Intel Granite Rapids-D (GNR-D) hardware
14+
include::snippets/technology-preview.adoc[]
15+
16+
.Prerequisites
17+
18+
* You have verified your qualified GNR-D hardware layout, including NAC ports, Carter Flat ports, and interface naming.
19+
20+
* The {oc-first} is installed.
21+
22+
* You are logged in as a user with `cluster-admin` privileges.
23+
24+
* The PTP Operator is installed.
25+
26+
* You have verified that interface names, GNSS serial paths, and plugin device entries are aligned with your qualified hardware layout.
27+
28+
.Procedure
29+
30+
. Create a `PtpConfig` custom resource (CR) that matches your qualified GNR-D Telecom Grandmaster hardware layout:
31+
+
32+
[source,yaml]
33+
----
34+
include::snippets/ptp_PtpConfigGnrdTGM.yaml[]
35+
----
36+
+
37+
where:
38+
39+
* `eno8703` -- Specifies the example leading NAC interface name used in `phc2sysOpts`, `plugins.e825.devices`, and the primary `ts2phcConf` stanza. Replace this value with the NAC interface name from your qualified GNR-D hardware layout.
40+
* `enp108s0f0` and `enp110s0f0` -- Specify the example Carter Flat (E830) interface names listed in `plugins.e830.devices` and used as Carter Flat `ts2phcConf` stanzas. Replace these values with your Carter Flat interface names. Add or remove stanzas and `plugins` entries if you install fewer than two expansion cards.
41+
* `enp108s0f1` through `enp108s0f7` and `enp110s0f1` through `enp110s0f7` -- Specify additional example time transmitter interfaces on the two Carter Flat cards as `masterOnly 1` ports in `ptp4lConf`. Align or remove these stanzas to match your port count and naming.
42+
* `eno8403`, `eno8503`, `eno8603`, `eno8703`, `eno8803`, `eno8903`, and `eno9003` -- Specify example onboard NAC time transmitter interfaces as `masterOnly 1` ports in `ptp4lConf`. Replace these values with your NAC port names. Remove stanzas you do not use.
43+
44+
. Customize interface names, the `plugins` device list, `ts2phcConf`, `ptp4lConf`, and the `recommend` stanza in the preceding example to match your qualified hardware layout.
45+
46+
. Add or remove Carter Flat interface blocks in `ts2phcConf` and `ptp4lConf` to match the number of expansion cards on your server.
47+
48+
. In the `recommend` stanza, replace the `$mcp` placeholder with the machine config pool label for the nodes that run this PTP profile, for example, `worker`.
49+
50+
. Save the customized `PtpConfig` CR as `gnrd-grandmaster-clock-ptp-config.yaml`.
51+
52+
. Verify that the `plugins` stanza lists the `e830` and `e825` device entries your qualified hardware layout requires.
53+
54+
. Apply the `PtpConfig` CR by running the following command:
55+
+
56+
[source,terminal]
57+
----
58+
$ oc apply -f gnrd-grandmaster-clock-ptp-config.yaml
59+
----
60+
61+
.Verification
62+
63+
. Verify that the `PtpConfig` profile is applied:
64+
65+
.. Retrieve the pods in the `openshift-ptp` namespace by running the following command:
66+
+
67+
[source,terminal]
68+
----
69+
$ oc get pods -n openshift-ptp -o wide
70+
----
71+
72+
.. Review `linuxptp` daemon logs for the pod on your Granite Rapids-D node by running the following command, replacing `<linuxptp_daemon_pod>` with the pod name that is scheduled on your target node:
73+
+
74+
[source,terminal]
75+
----
76+
$ oc logs <linuxptp_daemon_pod> -n openshift-ptp -c linuxptp-daemon-container
77+
----

‎modules/nw-ptp-granite-rapids-telecom-grandmaster-clock-overview.adoc‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/advanced_networking/ptp/configuring-ptp.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="nw-ptp-granite-rapids-telecom-grandmaster-clock-overview_{context}"]
7+
= Telecom Grandmaster clocks on Intel Granite Rapids-D hardware
8+
9+
[role="_abstract"]
10+
Intel Granite Rapids-D (GNR-D) server platforms support Telecom Grandmaster (T-GM) clock deployments that use onboard Network Acceleration Complex (NAC) ports and optional Carter Flat expansion network interface cards (NICs) to share timing across a single GNSS feed.
11+
Before you configure a T-GM profile on GNR-D hardware, verify that your qualified hardware layout, cabling, port counts, and interface naming align with your deployment requirements.
12+
The associated procedure provides an example `PtpConfig` CR, `linuxptp` plugin expectations, and verification steps for Granite Rapids-D nodes.
13+
14+
In addition to Telecom Grandmaster configurations, Intel Granite Rapids-D (GNR-D) hardware supports a Precision Time Protocol (PTP) boundary clock profile without holdover.
15+
For more information about boundary clock configuration on GNR-D hardware, see the Additional resources section.
16+
17+
:FeatureName: Telecom Grandmaster clocks on Intel Granite Rapids-D hardware
18+
include::snippets/technology-preview.adoc[]
19+
20+
[NOTE]
21+
====
22+
Follower digital phase-locked loop (DPLL) behavior on GNR-D add-on network interface cards (NICs) such as Carter Flat cards is only partially visible through the Intel NIC driver: you can read high-level follower DPLL lock state (locked or not locked).
23+
Intel does not plan to add interfaces that expose further follower DPLL lock accuracy in software or firmware.
24+
25+
The PTP Operator can surface follower DPLL lock state when the Intel NIC driver exposes it, but it cannot report additional follower DPLL accuracy metrics or diagnose follower DPLL problems on add-on NICs beyond that driver data.
26+
Resolution of complex follower DPLL problems might require on-site hardware access and coordination with Intel rather than diagnosis inside {product-title}.
27+
====
28+
29+
[id="nw-ptp-granite-rapids-telecom-grandmaster-clock-overview-physical_{context}"]
30+
Physical architecture and timing paths::
31+
32+
GNSS receivers attach to the shared timing module on supported GNR-D systems so one antenna feed can discipline multiple time transmitters across NAC and Carter Flat ports.
33+
Compared with earlier Intel E810 Westport Channel layouts that relied on faceplate jumpers between cards, GNR-D routes synchronization between cards by using proprietary PCIe wiring instead of external jumper cables, which supports up to 24 time transmitter ports in the same server footprint when you combine onboard ports with two expansion cards.
34+
35+
On current Intel Granite Rapids-D platforms, a server can ship with zero, one, or two Carter Flat expansion cards. The example `PtpConfig` CR in the associated procedure reflects two cards.
36+
37+
[id="nw-ptp-granite-rapids-telecom-grandmaster-clock-overview-interfaces_{context}"]
38+
Interface naming and the GNR-D MachineConfig::
39+
40+
Onboard NAC ports and Carter Flat ports can appear in the same kernel namespace, which makes Precision Time Protocol (PTP) metrics ambiguous unless interfaces are renamed with distinct prefixes.
41+
A common layout applies the MachineConfig manifest `10-rename-gnrd-interfaces-master.yaml` so each card presents a unique interface prefix before you apply a Telecom Grandmaster `PtpConfig` CR.

‎modules/ztp-sno-du-configuring-ptp.adoc‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@
66
[id="ztp-sno-du-configuring-ptp_{context}"]
77
= PTP
88

9+
[role="_abstract"]
910
{sno-caps} clusters use Precision Time Protocol (PTP) for network time synchronization.
10-
The following example `PtpConfig` CRs illustrate the required PTP configurations for ordinary clocks, boundary clocks, and grandmaster clocks.
11-
The exact configuration you apply will depend on the node hardware and specific use case.
11+
The following example `PtpConfig` custom resources (CRs) illustrate configurations for ordinary clocks, boundary clocks, and Telecom Grandmaster clocks on supported Intel Ethernet hardware.
12+
You must select the profile that matches your qualified GNR-D hardware layout and complete interface renaming prerequisites before you apply Granite Rapids-D Telecom Grandmaster YAML on Intel Granite Rapids-D servers.
1213

1314
.Recommended PTP ordinary clock configuration (`PtpConfigSlave.yaml`)
1415
[source,yaml]
@@ -29,10 +30,25 @@ include::snippets/ztp_PtpConfigBoundary.yaml[]
2930
include::snippets/ztp_PtpConfigGmWpc.yaml[]
3031
----
3132

33+
:FeatureName: Telecom Grandmaster clock configuration on Intel Granite Rapids-D (GNR-D) hardware
34+
include::snippets/technology-preview.adoc[]
35+
:!FeatureName:
36+
37+
.Recommended PTP Granite Rapids-D Telecom Grandmaster clock configuration (`PtpConfigGnrdTGM.yaml`)
38+
[source,yaml]
39+
----
40+
include::snippets/ptp_PtpConfigGnrdTGM.yaml[]
41+
----
42+
3243
The following optional `PtpOperatorConfig` CR configures PTP events reporting for the node.
3344

3445
.Recommended PTP events configuration (`PtpOperatorConfigForEvent.yaml`)
3546
[source,yaml]
3647
----
3748
include::snippets/ztp_PtpOperatorConfigForEvent.yaml[]
3849
----
50+
51+
[role="_additional-resources"]
52+
.Additional resources
53+
54+
* xref:../networking/advanced_networking/ptp/configuring-ptp.adoc#configuring-linuxptp-services-as-grandmaster-clock-gnrd_configuring-ptp[Configuring linuxptp services as a Telecom Grandmaster clock on Intel Granite Rapids-D hardware]

‎networking/advanced_networking/ptp/configuring-ptp.adoc‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Network interface controller (NIC) hardware with built-in PTP capabilities somet
1515

1616
[IMPORTANT]
1717
====
18-
In {product-title} {product-version}, the Intel E810 NIC is supported with a `PtpConfig` plugin.
18+
In {product-title} {product-version}, supported `PtpConfig` plugins include Intel E810 hardware configuration, Intel Granite Rapids-D plugin configurations (`e830` and `e825`), and optional `ntpfailover` behavior.
1919
====
2020

2121
include::modules/nw-ptp-installing-operator-cli.adoc[leveloffset=+1]
@@ -30,10 +30,25 @@ include::modules/nw-ptp-configuring-linuxptp-services-as-grandmaster-clock-dual-
3030

3131
include::modules/nw-ptp-configuring-linuxptp-services-as-grandmaster-clock-three-nic.adoc[leveloffset=+2]
3232

33+
include::modules/nw-ptp-granite-rapids-telecom-grandmaster-clock-overview.adoc[leveloffset=+2]
34+
35+
[role="_additional-resources"]
36+
.Additional resources
37+
38+
* xref:../../../networking/advanced_networking/ptp/configuring-ptp.adoc#nw-ptp-granite-rapids-boundary-clock-overview_configuring-ptp[Boundary clocks without holdover on Intel Granite Rapids-D hardware]
39+
* xref:../../../networking/advanced_networking/ptp/configuring-ptp.adoc#ptp-configuring-linuxptp-services-as-boundary-clock-gnrd_configuring-ptp[Configuring linuxptp services as a boundary clock without holdover on Intel Granite Rapids-D hardware]
40+
* xref:../../../networking/advanced_networking/ptp/configuring-ptp.adoc#nw-ptp-gnrd-t-bc-holdover_configuring-ptp[Configuring GNR-D T-BC holdover on a GNR-D platform]
41+
42+
43+
include::modules/nw-ptp-configuring-linuxptp-services-as-grandmaster-clock-gnrd.adoc[leveloffset=+2]
44+
3345
[role="_additional-resources"]
3446
.Additional resources
3547

3648
* xref:../../../networking/advanced_networking/ptp/ptp-cloud-events-consumer-dev-reference-v2.adoc#cnf-configuring-the-ptp-fast-event-publisher-v2_ptp-consumer[Configuring the PTP fast event notifications publisher]
49+
* xref:../../../networking/advanced_networking/ptp/configuring-ptp.adoc#nw-ptp-granite-rapids-boundary-clock-overview_configuring-ptp[Boundary clocks without holdover on Intel Granite Rapids-D hardware]
50+
* xref:../../../networking/advanced_networking/ptp/configuring-ptp.adoc#ptp-configuring-linuxptp-services-as-boundary-clock-gnrd_configuring-ptp[Configuring linuxptp services as a boundary clock without holdover on Intel Granite Rapids-D hardware]
51+
* xref:../../../networking/advanced_networking/ptp/configuring-ptp.adoc#nw-ptp-gnrd-t-bc-holdover_configuring-ptp[Configuring GNR-D T-BC holdover on a GNR-D platform]
3752
3853
include::modules/nw-ptp-grandmaster-clock-configuration-reference.adoc[leveloffset=+1]
3954

0 commit comments

Comments
 (0)