PTP-only documentation improvements by alknopfler · Pull Request #1188 · suse-edge/suse-edge.github.io

alknopfler · 2026-07-15T11:06:37Z

Improvements for the following scenarios:

Scenario 2 - Ordinary Clock (PTP & SyncE) -> it will be filled in a separate PR

Scenario 3 - Boundary Clock (PTP-only) with Multiport Single NIC including propagation to Ordinary Clock server

Scenario 4 - Boundary Clock (PTP-only) Multi-NIC with internal timing module (DPLL GNR-D based)

Scenario 4 - Boundary Clock (PTP & SyncE) Multi-NIC with internal timing module (DPLL GNR-D based) - it will be filled in a separate PR

This commit introduces a new SVG file that visually represents the architecture of the Precision Time Protocol (PTP) with Synchronous Ethernet (SyncE). The diagram illustrates the flow of time and frequency distribution from a Grand Master clock to Boundary Clocks and Ordinary Clocks, highlighting the roles and connections involved in the process.

…ary Clock propagation

…C and on-board

ranjinimn

@alknopfler I had a few comments. please let me know if you have any questions.

ranjinimn · 2026-07-16T17:26:40Z

+Only the configuration files change between these PTP scenarios, so a single generic
+example is used here and each scenario provides its specific values.


Suggested change

Only the configuration files change between these PTP scenarios, so a single generic

example is used here and each scenario provides its specific values.

Since only the configuration files change between these PTP scenarios, this section provides a single generic template followed by the specific values for each scenario.

ranjinimn · 2026-07-16T17:30:38Z

+This approach is convenient only if the hardware in the cluster is uniform and the
+same PTP configuration is needed on all hosts, interface name included. The Boundary
+Clock scenarios that rely on `ts2phc` or on-board DPLL routing require additional
+files and services on top of this base example, described in the next section.


Suggested change

files and services on top of this base example, described in the next section.

files and services in addition to the base example, which are described in the next section.

ranjinimn · 2026-07-16T17:32:08Z

+add-in cards with `ts2phc`, wires the on-board DPLL at boot and forwards the Grand Master
+parameters periodically. The provisioning therefore extends the base example with several
+configuration files, scripts and `systemd` units, all deployed through the same
+`RKE2ControlPlane` Ignition block. The bodies of every file and unit are the ones listed in


Here, bodies refer to the contents?

Suggested change

`RKE2ControlPlane` Ignition block. The bodies of every file and unit are the ones listed in

`RKE2ControlPlane` Ignition block. The contents of every file and unit are the ones listed in

ranjinimn · 2026-07-16T17:34:46Z

+The GNR-D units are custom (a DPLL setup service, one templated `ptp4l` instance per PHC and
+a Grand Master forwarding timer), so they are both deployed and enabled through the Ignition
+block below rather than through the EIB `systemd.enable` list. The EIB image only needs the


Suggested change

The GNR-D units are custom (a DPLL setup service, one templated `ptp4l` instance per PHC and

a Grand Master forwarding timer), so they are both deployed and enabled through the Ignition

block below rather than through the EIB `systemd.enable` list. The EIB image only needs the

The GNR-D units require a custom setup: a DPLL service, one templated `ptp4l` instance per PHC, and a Grandmaster forwarding timer. Consequently, you must deploy and enable them via the Ignition block below instead of using the EIB `systemd.enable` list.The EIB image only needs the

ranjinimn · 2026-07-16T17:36:35Z

+*Deploy the files and units through Cluster API*
+
+The `RKE2ControlPlane` object below deploys the GNR-D files and units. It follows the same
+approach as the standard example: the file bodies are provided as placeholders and taken from


For my understanding, what are file bodies? Can we replace that with file contents?

ranjinimn · 2026-07-17T06:44:57Z

+. Align the add-in cards' PHCs with `ts2phc`.
 +
-Refer to <<gnrd-ptp4l-config-aics>> for the content of the configuration files.
+`ts2phc` ("time stamp to PHC") aligns the add-in cards' PHCs to a reference clock. Here the


Suggested change

`ts2phc` ("time stamp to PHC") aligns the add-in cards' PHCs to a reference clock. Here the

`ts2phc` ("time stamp to PHC") aligns the add-in cards' PHCs to a reference clock. Here, the

ranjinimn · 2026-07-17T06:45:49Z

-====
-To prevent conflicts and enable the next step, each of these instances must use different control and read-only sockets.
+[#gnrd-ts2phc-config]
+.`/etc/ts2phc-cf-all.cfg`


Is this a file? Can you please label the example more clearly?

ranjinimn · 2026-07-17T06:50:39Z

+integrated instance, `250` on the add-in cards) act as a G.8275.x BMCA tie-breaker: they are
+compared only after `clockClass`, `clockAccuracy`, variance and `priority2`, and a lower value
+is preferred. Keeping the default `128` on the integrated instance makes it outrank the add-in
+instances (`250`), which keeps the master/receiver ordering within the node deterministic and


Can master/received be changed to anything else? Just checking because master/slave is not used unless it is for legal protocol.

ranjinimn · 2026-07-17T06:52:59Z

+synchronized to a GM:
+
+[#gnrd-pmc-forward]
+.`04-ptp-forward-GM.sh`


Can you please label this example clearly?

ranjinimn · 2026-07-17T06:54:26Z

+The effect is visible by querying an add-in `ptp4l` instance on the BC: before the forwarding
+it advertises its file defaults, and after it advertises the grandmaster's real values (which


Suggested change

The effect is visible by querying an add-in `ptp4l` instance on the BC: before the forwarding

it advertises its file defaults, and after it advertises the grandmaster's real values (which

The effect is visible by querying an add-in `ptp4l` instance on the BC: Before forwarding, the node advertises its file defaults; after forwarding begins, it advertises the Grandmaster's actual values.(which

alknopfler force-pushed the ptp-improvements branch 4 times, most recently from 5a8a6f2 to 3a6131c Compare July 16, 2026 06:14

Add SVG diagram for Boundary Clock scenario with single NIC and Ordin…

6ba0e33

…ary Clock propagation

alknopfler force-pushed the ptp-improvements branch 5 times, most recently from ac1534a to e571ffd Compare July 16, 2026 09:36

Add SVG diagram and configs for Boundary Clock scenario with multi-NI…

f9b8eb1

…C and on-board

alknopfler force-pushed the ptp-improvements branch from e571ffd to f9b8eb1 Compare July 16, 2026 09:56

alknopfler changed the title ~~PTP documentation improvements~~ PTP-only documentation improvements Jul 16, 2026

alknopfler marked this pull request as ready for review July 16, 2026 10:19

alknopfler requested review from antaloala, hardys and ranjinimn July 16, 2026 10:19

ranjinimn reviewed Jul 17, 2026

View reviewed changes

hardys requested a review from timirnich July 17, 2026 08:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

PTP-only documentation improvements#1188

PTP-only documentation improvements#1188
alknopfler wants to merge 3 commits into
suse-edge:mainfrom
alknopfler:ptp-improvements

alknopfler commented Jul 15, 2026 •

edited

Loading

Uh oh!

ranjinimn left a comment

Uh oh!

ranjinimn Jul 16, 2026

Uh oh!

ranjinimn Jul 16, 2026

Uh oh!

ranjinimn Jul 16, 2026

Uh oh!

ranjinimn Jul 16, 2026

Uh oh!

ranjinimn Jul 16, 2026

Uh oh!

ranjinimn Jul 17, 2026

Uh oh!

ranjinimn Jul 17, 2026

Uh oh!

ranjinimn Jul 17, 2026

Uh oh!

ranjinimn Jul 17, 2026

Uh oh!

ranjinimn Jul 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		Only the configuration files change between these PTP scenarios, so a single generic
		example is used here and each scenario provides its specific values.

	Only the configuration files change between these PTP scenarios, so a single generic
	example is used here and each scenario provides its specific values.
	Since only the configuration files change between these PTP scenarios, this section provides a single generic template followed by the specific values for each scenario.

	files and services on top of this base example, described in the next section.
	files and services in addition to the base example, which are described in the next section.

	`RKE2ControlPlane` Ignition block. The bodies of every file and unit are the ones listed in
	`RKE2ControlPlane` Ignition block. The contents of every file and unit are the ones listed in

	`ts2phc` ("time stamp to PHC") aligns the add-in cards' PHCs to a reference clock. Here the
	`ts2phc` ("time stamp to PHC") aligns the add-in cards' PHCs to a reference clock. Here, the

		The effect is visible by querying an add-in `ptp4l` instance on the BC: before the forwarding
		it advertises its file defaults, and after it advertises the grandmaster's real values (which

Uh oh!

Conversation

alknopfler commented Jul 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ranjinimn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

alknopfler commented Jul 15, 2026 •

edited

Loading