--- title: Configuring PTP devices --- # Configuring PTP devices {#configuring-ptp} The PTP Operator adds the `NodePtpDevice.ptp.openshift.io` custom resource definition (CRD) to OpenShift Container Platform. When installed, the PTP Operator searches your cluster for Precision Time Protocol (PTP) capable network devices on each node. The Operator creates and updates a `NodePtpDevice` custom resource (CR) object for each node that provides a compatible PTP-capable network device. Network interface controller (NIC) hardware with built-in PTP capabilities sometimes require a device-specific configuration. You can use hardware-specific NIC features for supported hardware with the PTP Operator by configuring a plugin in the `PtpConfig` custom resource (CR). The `linuxptp-daemon` service uses the named parameters in the `plugin` stanza to start `linuxptp` processes, `ptp4l` and `phc2sys`, based on the specific hardware configuration. > [!IMPORTANT] > In OpenShift Container Platform 4.22, supported `PtpConfig` plugins include Intel E810 hardware configuration, Intel Granite Rapids-D plugin configurations (`e830` and `e825`), and optional `ntpfailover` behavior. ## Installing the PTP Operator using the CLI {#install-ptp-operator-cli_configuring-ptp} As a cluster administrator, you can install the Operator by using the CLI. **Prerequisites** - A cluster installed on bare-metal hardware with nodes that have hardware that supports PTP. - Install the OpenShift CLI (`oc`). - Log in as a user with `cluster-admin` privileges. **Procedure** 1. Create a namespace for the PTP Operator. 1. Save the following YAML in the `ptp-namespace.yaml` file: ```yaml apiVersion: v1 kind: Namespace metadata: name: openshift-ptp annotations: workload.openshift.io/allowed: management labels: name: openshift-ptp openshift.io/cluster-monitoring: "true" ``` 2. Create the `Namespace` CR: ```terminal $ oc create -f ptp-namespace.yaml ``` 2. Create an Operator group for the PTP Operator. 1. Save the following YAML in the `ptp-operatorgroup.yaml` file: ```yaml apiVersion: operators.coreos.com/v1 kind: OperatorGroup metadata: name: ptp-operators namespace: openshift-ptp spec: targetNamespaces: - openshift-ptp ``` 2. Create the `OperatorGroup` CR: ```terminal $ oc create -f ptp-operatorgroup.yaml ``` 3. Subscribe to the PTP Operator. 1. Save the following YAML in the `ptp-sub.yaml` file: ```yaml apiVersion: operators.coreos.com/v1alpha1 kind: Subscription metadata: name: ptp-operator-subscription namespace: openshift-ptp spec: channel: "stable" name: ptp-operator source: redhat-operators sourceNamespace: openshift-marketplace ``` 2. Create the `Subscription` CR: ```terminal $ oc create -f ptp-sub.yaml ``` 4. To verify that the Operator is installed, enter the following command: ```terminal $ oc get csv -n openshift-ptp -o custom-columns=Name:.metadata.name,Phase:.status.phase ``` ```terminal {title="Example output"} Name Phase 4.22.0-202301261535 Succeeded ``` ## Installing the PTP Operator by using the web console {#install-ptp-operator-web-console_configuring-ptp} As a cluster administrator, you can install the PTP Operator by using the web console. > [!NOTE] > If you are installing by using the CLI, you must create the namespace and Operator group before installing the Operator. If you are installing by using the web console, the Operator Lifecycle Manager (OLM) automatically creates the namespace. **Procedure** 1. Install the PTP Operator using the OpenShift Container Platform web console: 1. In the OpenShift Container Platform web console, click **Ecosystem** → **Software Catalog**. 2. Type `ptp` in the **Filter by keyword** box to find the PTP Operator. 3. Click the **PTP Operator** tile, and then click **Install**. 4. On the **Install Operator** page, ensure that **A specific namespace on the cluster** is selected and the **Operator recommended Namespace** `openshift-ptp` is shown. Click **Install**. 5. Wait for the installation to complete and then click **View installed Operators**. 2. Optional: Verify that the PTP Operator installed successfully: 1. Navigate to **Ecosystem** → **Installed Operators**. 2. Ensure that **PTP Operator** is listed in the **openshift-ptp** project with a **Status** of **Succeeded**. > [!NOTE] > During installation an Operator might display a **Failed** status. If the installation later succeeds with an **Succeeded** message, you can ignore the **Failed** message. If the Operator does not appear as installed, to troubleshoot further: - Go to the **Ecosystem** → **Installed Operators** page and inspect the **Operator Subscriptions** and **Install Plans** tabs for any failure or errors under **Status**. - Go to the **Workloads** → **Pods** page and check the logs for pods in the `openshift-ptp` project. ## Discovering PTP-capable network devices in your cluster {#discover-ptp-devices_configuring-ptp} Identify PTP-capable network devices that exist in your cluster so that you can configure them **Prerequisites** - You installed the PTP Operator. **Procedure** - To return a complete list of PTP capable network devices in your cluster, run the following command: ```terminal $ oc get NodePtpDevice -n openshift-ptp -o yaml ``` ```terminal {title="Example output"} apiVersion: v1 items: - apiVersion: ptp.openshift.io/v1 kind: NodePtpDevice metadata: creationTimestamp: "2022-01-27T15:16:28Z" generation: 1 name: dev-worker-0 namespace: openshift-ptp resourceVersion: "6538103" uid: d42fc9ad-bcbf-4590-b6d8-b676c642781a spec: {} status: devices: - name: eno1 - name: eno2 - name: eno3 - name: eno4 - name: enp5s0f0 - name: enp5s0f1 ... ``` where: `-worker-0` : The value for the `name` parameter is the same as the name of the parent node. `devices` : The `devices` collection includes a list of the PTP capable devices that the PTP Operator discovers for the node. ## Configuring linuxptp services as a grandmaster clock {#configuring-linuxptp-services-as-grandmaster-clock_configuring-ptp} You can configure the `linuxptp` services (`ptp4l`, `phc2sys`, `ts2phc`) as grandmaster clock (T-GM) by creating a `PtpConfig` custom resource (CR) that configures the host NIC. The `ts2phc` utility allows you to synchronize the system clock with the PTP grandmaster clock so that the node can stream precision clock signal to downstream PTP ordinary clocks and boundary clocks. > [!NOTE] > Use the following example `PtpConfig` CR as the basis to configure `linuxptp` services as T-GM for an Intel Westport Channel E810-XXVDA4T network interface. > > To configure PTP fast events, set appropriate values for `ptp4lOpts`, `ptp4lConf`, and `ptpClockThreshold`. `ptpClockThreshold` is used only when events are enabled. See "Configuring the PTP fast event notifications publisher" for more information. > > **Prerequisites** > > - For T-GM clocks in production environments, install an Intel E810 Westport Channel NIC in the bare-metal cluster host. > - Install the OpenShift CLI (`oc`). > - Log in as a user with `cluster-admin` privileges. > - Install the PTP Operator. > > **Procedure** > > 1. Create the `PtpConfig` CR. For example: > > 1. Depending on your requirements, use one of the following T-GM configurations for your deployment. Save the YAML in the `grandmaster-clock-ptp-config.yaml` file: > > ```yaml > apiVersion: ptp.openshift.io/v1 > kind: PtpConfig > metadata: > name: grandmaster > namespace: openshift-ptp > annotations: {} > spec: > profile: > - name: "grandmaster" > ptp4lOpts: "-2 --summary_interval -4" > phc2sysOpts: -r -u 0 -m -N 8 -R 16 -s $iface_master -n 24 > ptpSchedulingPolicy: SCHED_FIFO > ptpSchedulingPriority: 10 > ptpSettings: > logReduce: "true" > plugins: > e810: > enableDefaultConfig: false > settings: > LocalMaxHoldoverOffSet: 1500 > LocalHoldoverTimeout: 14400 > MaxInSpecOffset: 1500 > pins: $e810_pins > # "$iface_master": > # "U.FL2": "0 2" > # "U.FL1": "0 1" > # "SMA2": "0 2" > # "SMA1": "0 1" > ublxCmds: > - args: #ubxtool -P 29.20 -z CFG-HW-ANT_CFG_VOLTCTRL,1 > - "-P" > - "29.20" > - "-z" > - "CFG-HW-ANT_CFG_VOLTCTRL,1" > reportOutput: false > - args: #ubxtool -P 29.20 -e GPS > - "-P" > - "29.20" > - "-e" > - "GPS" > reportOutput: false > - args: #ubxtool -P 29.20 -d Galileo > - "-P" > - "29.20" > - "-d" > - "Galileo" > reportOutput: false > - args: #ubxtool -P 29.20 -d GLONASS > - "-P" > - "29.20" > - "-d" > - "GLONASS" > reportOutput: false > - args: #ubxtool -P 29.20 -d BeiDou > - "-P" > - "29.20" > - "-d" > - "BeiDou" > reportOutput: false > - args: #ubxtool -P 29.20 -d SBAS > - "-P" > - "29.20" > - "-d" > - "SBAS" > reportOutput: false > - args: #ubxtool -P 29.20 -t -w 5 -v 1 -e SURVEYIN,600,50000 > - "-P" > - "29.20" > - "-t" > - "-w" > - "5" > - "-v" > - "1" > - "-e" > - "SURVEYIN,600,50000" > reportOutput: true > - args: #ubxtool -P 29.20 -p MON-HW > - "-P" > - "29.20" > - "-p" > - "MON-HW" > reportOutput: true > - args: #ubxtool -P 29.20 -p CFG-MSG,1,38,248 > - "-P" > - "29.20" > - "-p" > - "CFG-MSG,1,38,248" > reportOutput: true > ts2phcOpts: " " > ts2phcConf: | > [nmea] > ts2phc.master 1 > [global] > use_syslog 0 > verbose 1 > logging_level 7 > ts2phc.pulsewidth 100000000 > #cat /dev/GNSS to find available serial port > #example value of gnss_serialport is /dev/ttyGNSS_1700_0 > ts2phc.nmea_serialport $gnss_serialport > [$iface_master] > ts2phc.extts_polarity rising > ts2phc.extts_correction 0 > ptp4lConf: | > [$iface_master] > masterOnly 1 > [$iface_master_1] > masterOnly 1 > [$iface_master_2] > masterOnly 1 > [$iface_master_3] > masterOnly 1 > [global] > # > # Default Data Set > # > twoStepFlag 1 > priority1 128 > priority2 128 > domainNumber 24 > #utc_offset 37 > clockClass 6 > clockAccuracy 0x27 > offsetScaledLogVariance 0xFFFF > free_running 0 > freq_est_interval 1 > dscp_event 0 > dscp_general 0 > dataset_comparison G.8275.x > G.8275.defaultDS.localPriority 128 > # > # Port Data Set > # > logAnnounceInterval -3 > logSyncInterval -4 > logMinDelayReqInterval -4 > logMinPdelayReqInterval 0 > announceReceiptTimeout 3 > syncReceiptTimeout 0 > delayAsymmetry 0 > fault_reset_interval -4 > neighborPropDelayThresh 20000000 > masterOnly 0 > G.8275.portDS.localPriority 128 > # > # Run time options > # > assume_two_step 0 > logging_level 6 > path_trace_enabled 0 > follow_up_info 0 > hybrid_e2e 0 > inhibit_multicast_service 0 > net_sync_monitor 0 > tc_spanning_tree 0 > tx_timestamp_timeout 50 > unicast_listen 0 > unicast_master_table 0 > unicast_req_duration 3600 > use_syslog 1 > verbose 0 > summary_interval -4 > kernel_leap 1 > check_fup_sync 0 > clock_class_threshold 7 > # > # Servo Options > # > pi_proportional_const 0.0 > pi_integral_const 0.0 > pi_proportional_scale 0.0 > pi_proportional_exponent -0.3 > pi_proportional_norm_max 0.7 > pi_integral_scale 0.0 > pi_integral_exponent 0.4 > pi_integral_norm_max 0.3 > step_threshold 2.0 > first_step_threshold 0.00002 > clock_servo pi > sanity_freq_limit 200000000 > ntpshm_segment 0 > # > # Transport options > # > transportSpecific 0x0 > ptp_dst_mac 01:1B:19:00:00:00 > p2p_dst_mac 01:80:C2:00:00:0E > udp_ttl 1 > udp6_scope 0x0E > uds_address /var/run/ptp4l > # > # Default interface options > # > clock_type BC > network_transport L2 > delay_mechanism E2E > time_stamping hardware > tsproc_mode filter > delay_filter moving_median > delay_filter_length 10 > egressLatency 0 > ingressLatency 0 > boundary_clock_jbod 0 > # > # Clock description > # > productDescription ;; > revisionData ;; > manufacturerIdentity 00:00:00 > userDescription ; > timeSource 0x20 > recommend: > - profile: "grandmaster" > priority: 4 > match: > - nodeLabel: "node-role.kubernetes.io/$mcp" > ``` > > > [!NOTE] > > For E810 Westport Channel NICs, set the value for `ts2phc.nmea_serialport` to `/dev/gnss0`. > 2. Create the CR by running the following command: > > ```terminal > $ oc create -f grandmaster-clock-ptp-config.yaml > ``` > > **Verification** > > 1. Check that the `PtpConfig` profile is applied to the node. > > 1. Get the list of pods in the `openshift-ptp` namespace by running the following command: > > ```terminal > $ oc get pods -n openshift-ptp -o wide > ``` > > ```terminal {title="Example output"} > NAME READY STATUS RESTARTS AGE IP NODE > linuxptp-daemon-74m2g 3/3 Running 3 4d15h 10.16.230.7 compute-1.example.com > ptp-operator-5f4f48d7c-x7zkf 1/1 Running 1 4d15h 10.128.1.145 compute-1.example.com > ``` > 2. 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: > > ```terminal > $ oc logs linuxptp-daemon-74m2g -n openshift-ptp -c linuxptp-daemon-container > ``` > > ```terminal {title="Example output"} > ts2phc[94980.334]: [ts2phc.0.config] nmea delay: 98690975 ns > ts2phc[94980.334]: [ts2phc.0.config] ens3f0 extts index 0 at 1676577329.999999999 corr 0 src 1676577330.901342528 diff -1 > ts2phc[94980.334]: [ts2phc.0.config] ens3f0 master offset -1 s2 freq -1 > ts2phc[94980.441]: [ts2phc.0.config] nmea sentence: GNRMC,195453.00,A,4233.24427,N,07126.64420,W,0.008,,160223,,,A,V > phc2sys[94980.450]: [ptp4l.0.config] CLOCK_REALTIME phc offset 943 s2 freq -89604 delay 504 > phc2sys[94980.512]: [ptp4l.0.config] CLOCK_REALTIME phc offset 1000 s2 freq -89264 delay 474 > ``` > > ### Configuring linuxptp services as a grandmaster clock for 2 E810 NICs {#configuring-linuxptp-services-as-grandmaster-clock-dual-nic_configuring-ptp} > > You can configure the `linuxptp` services (`ptp4l`, `phc2sys`, `ts2phc`) as a grandmaster clock (T-GM) for 2 E810 NICs by creating a `PtpConfig` custom resource (CR) that configures the NICs. > > You can configure the `linuxptp` services as a T-GM for the following E810 NICs: > > - Intel E810-XXVDA4T Westport Channel NIC > - Intel E810-CQDA2T Logan Beach NIC > > For distributed RAN (D-RAN) use cases, you can configure PTP for 2 NICs as follows: > > - NIC 1 is synced to the global navigation satellite system (GNSS) time source. > - NIC 2 is synced to the 1PPS timing output provided by NIC one. This configuration is provided by the PTP hardware plugin in the `PtpConfig` CR. > > The 2-card PTP T-GM configuration uses one instance of `ptp4l` and one instance of `ts2phc`. The `ptp4l` and `ts2phc` programs are each configured to operate on two PTP hardware clocks (PHCs), one for each NIC. The host system clock is synchronized from the NIC that is connected to the GNSS time source. > > > [!NOTE] > > Use the following example `PtpConfig` CR as the basis to configure `linuxptp` services as T-GM for dual Intel E810 network interfaces. > > > > To configure PTP fast events, set appropriate values for `ptp4lOpts`, `ptp4lConf`, and `ptpClockThreshold`. `ptpClockThreshold` is used only when events are enabled. See "Configuring the PTP fast event notifications publisher" for more information. > > > > **Prerequisites** > > > > - For T-GM clocks in production environments, install two Intel E810 NICs in the bare-metal cluster host. > > - Install the OpenShift CLI (`oc`). > > - Log in as a user with `cluster-admin` privileges. > > - Install the PTP Operator. > > > > **Procedure** > > > > 1. Create the `PtpConfig` CR. For example: > > > > 1. Save the following YAML in the `grandmaster-clock-ptp-config-dual-nics.yaml` file: > > > > ```yaml > > # In this example two cards $iface_nic1 and $iface_nic2 are connected via > > # SMA1 ports by a cable and $iface_nic2 receives 1PPS signals from $iface_nic1 > > apiVersion: ptp.openshift.io/v1 > > kind: PtpConfig > > metadata: > > name: grandmaster > > namespace: openshift-ptp > > annotations: {} > > spec: > > profile: > > - name: "grandmaster" > > ptp4lOpts: "-2 --summary_interval -4" > > phc2sysOpts: -r -u 0 -m -N 8 -R 16 -s $iface_nic1 -n 24 > > ptpSchedulingPolicy: SCHED_FIFO > > ptpSchedulingPriority: 10 > > ptpSettings: > > logReduce: "true" > > plugins: > > e810: > > enableDefaultConfig: false > > settings: > > LocalMaxHoldoverOffSet: 1500 > > LocalHoldoverTimeout: 14400 > > MaxInSpecOffset: 1500 > > pins: $e810_pins > > # "$iface_nic1": > > # "U.FL2": "0 2" > > # "U.FL1": "0 1" > > # "SMA2": "0 2" > > # "SMA1": "2 1" > > # "$iface_nic2": > > # "U.FL2": "0 2" > > # "U.FL1": "0 1" > > # "SMA2": "0 2" > > # "SMA1": "1 1" > > ublxCmds: > > - args: #ubxtool -P 29.20 -z CFG-HW-ANT_CFG_VOLTCTRL,1 > > - "-P" > > - "29.20" > > - "-z" > > - "CFG-HW-ANT_CFG_VOLTCTRL,1" > > reportOutput: false > > - args: #ubxtool -P 29.20 -e GPS > > - "-P" > > - "29.20" > > - "-e" > > - "GPS" > > reportOutput: false > > - args: #ubxtool -P 29.20 -d Galileo > > - "-P" > > - "29.20" > > - "-d" > > - "Galileo" > > reportOutput: false > > - args: #ubxtool -P 29.20 -d GLONASS > > - "-P" > > - "29.20" > > - "-d" > > - "GLONASS" > > reportOutput: false > > - args: #ubxtool -P 29.20 -d BeiDou > > - "-P" > > - "29.20" > > - "-d" > > - "BeiDou" > > reportOutput: false > > - args: #ubxtool -P 29.20 -d SBAS > > - "-P" > > - "29.20" > > - "-d" > > - "SBAS" > > reportOutput: false > > - args: #ubxtool -P 29.20 -t -w 5 -v 1 -e SURVEYIN,600,50000 > > - "-P" > > - "29.20" > > - "-t" > > - "-w" > > - "5" > > - "-v" > > - "1" > > - "-e" > > - "SURVEYIN,600,50000" > > reportOutput: true > > - args: #ubxtool -P 29.20 -p MON-HW > > - "-P" > > - "29.20" > > - "-p" > > - "MON-HW" > > reportOutput: true > > - args: #ubxtool -P 29.20 -p CFG-MSG,1,38,248 > > - "-P" > > - "29.20" > > - "-p" > > - "CFG-MSG,1,38,248" > > reportOutput: true > > ts2phcOpts: " " > > ts2phcConf: | > > [nmea] > > ts2phc.master 1 > > [global] > > use_syslog 0 > > verbose 1 > > logging_level 7 > > ts2phc.pulsewidth 100000000 > > #cat /dev/GNSS to find available serial port > > #example value of gnss_serialport is /dev/ttyGNSS_1700_0 > > ts2phc.nmea_serialport $gnss_serialport > > [$iface_nic1] > > ts2phc.extts_polarity rising > > ts2phc.extts_correction 0 > > [$iface_nic2] > > ts2phc.master 0 > > ts2phc.extts_polarity rising > > #this is a measured value in nanoseconds to compensate for SMA cable delay > > ts2phc.extts_correction -10 > > ptp4lConf: | > > [$iface_nic1] > > masterOnly 1 > > [$iface_nic1_1] > > masterOnly 1 > > [$iface_nic1_2] > > masterOnly 1 > > [$iface_nic1_3] > > masterOnly 1 > > [$iface_nic2] > > masterOnly 1 > > [$iface_nic2_1] > > masterOnly 1 > > [$iface_nic2_2] > > masterOnly 1 > > [$iface_nic2_3] > > masterOnly 1 > > [global] > > # > > # Default Data Set > > # > > twoStepFlag 1 > > priority1 128 > > priority2 128 > > domainNumber 24 > > #utc_offset 37 > > clockClass 6 > > clockAccuracy 0x27 > > offsetScaledLogVariance 0xFFFF > > free_running 0 > > freq_est_interval 1 > > dscp_event 0 > > dscp_general 0 > > dataset_comparison G.8275.x > > G.8275.defaultDS.localPriority 128 > > # > > # Port Data Set > > # > > logAnnounceInterval -3 > > logSyncInterval -4 > > logMinDelayReqInterval -4 > > logMinPdelayReqInterval 0 > > announceReceiptTimeout 3 > > syncReceiptTimeout 0 > > delayAsymmetry 0 > > fault_reset_interval -4 > > neighborPropDelayThresh 20000000 > > masterOnly 0 > > G.8275.portDS.localPriority 128 > > # > > # Run time options > > # > > assume_two_step 0 > > logging_level 6 > > path_trace_enabled 0 > > follow_up_info 0 > > hybrid_e2e 0 > > inhibit_multicast_service 0 > > net_sync_monitor 0 > > tc_spanning_tree 0 > > tx_timestamp_timeout 50 > > unicast_listen 0 > > unicast_master_table 0 > > unicast_req_duration 3600 > > use_syslog 1 > > verbose 0 > > summary_interval -4 > > kernel_leap 1 > > check_fup_sync 0 > > clock_class_threshold 7 > > # > > # Servo Options > > # > > pi_proportional_const 0.0 > > pi_integral_const 0.0 > > pi_proportional_scale 0.0 > > pi_proportional_exponent -0.3 > > pi_proportional_norm_max 0.7 > > pi_integral_scale 0.0 > > pi_integral_exponent 0.4 > > pi_integral_norm_max 0.3 > > step_threshold 2.0 > > first_step_threshold 0.00002 > > clock_servo pi > > sanity_freq_limit 200000000 > > ntpshm_segment 0 > > # > > # Transport options > > # > > transportSpecific 0x0 > > ptp_dst_mac 01:1B:19:00:00:00 > > p2p_dst_mac 01:80:C2:00:00:0E > > udp_ttl 1 > > udp6_scope 0x0E > > uds_address /var/run/ptp4l > > # > > # Default interface options > > # > > clock_type BC > > network_transport L2 > > delay_mechanism E2E > > time_stamping hardware > > tsproc_mode filter > > delay_filter moving_median > > delay_filter_length 10 > > egressLatency 0 > > ingressLatency 0 > > boundary_clock_jbod 1 > > # > > # Clock description > > # > > productDescription ;; > > revisionData ;; > > manufacturerIdentity 00:00:00 > > userDescription ; > > timeSource 0x20 > > recommend: > > - profile: "grandmaster" > > priority: 4 > > match: > > - nodeLabel: "node-role.kubernetes.io/$mcp" > > ``` > > > > > [!NOTE] > > > Set the value for `ts2phc.nmea_serialport` to `/dev/gnss0`. > > 2. Create the CR by running the following command: > > > > ```terminal > > $ oc create -f grandmaster-clock-ptp-config-dual-nics.yaml > > ``` > > > > **Verification** > > > > 1. Check that the `PtpConfig` profile is applied to the node. > > > > 1. Get the list of pods in the `openshift-ptp` namespace by running the following command: > > > > ```terminal > > $ oc get pods -n openshift-ptp -o wide > > ``` > > > > ```terminal {title="Example output"} > > NAME READY STATUS RESTARTS AGE IP NODE > > linuxptp-daemon-74m2g 3/3 Running 3 4d15h 10.16.230.7 compute-1.example.com > > ptp-operator-5f4f48d7c-x7zkf 1/1 Running 1 4d15h 10.128.1.145 compute-1.example.com > > ``` > > 2. 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: > > > > ```terminal > > $ oc logs linuxptp-daemon-74m2g -n openshift-ptp -c linuxptp-daemon-container > > ``` > > > > ```terminal {title="Example output"} > > ts2phc[509863.660]: [ts2phc.0.config] nmea delay: 347527248 ns > > ts2phc[509863.660]: [ts2phc.0.config] ens2f0 extts index 0 at 1705516553.000000000 corr 0 src 1705516553.652499081 diff 0 > > ts2phc[509863.660]: [ts2phc.0.config] ens2f0 master offset 0 s2 freq -0 > > I0117 18:35:16.000146 1633226 stats.go:57] state updated for ts2phc =s2 > > I0117 18:35:16.000163 1633226 event.go:417] dpll State s2, gnss State s2, tsphc state s2, gm state s2, > > ts2phc[1705516516]:[ts2phc.0.config] ens2f0 nmea_status 1 offset 0 s2 > > GM[1705516516]:[ts2phc.0.config] ens2f0 T-GM-STATUS s2 > > ts2phc[509863.677]: [ts2phc.0.config] ens7f0 extts index 0 at 1705516553.000000010 corr -10 src 1705516553.652499081 diff 0 > > ts2phc[509863.677]: [ts2phc.0.config] ens7f0 master offset 0 s2 freq -0 > > I0117 18:35:16.016597 1633226 stats.go:57] state updated for ts2phc =s2 > > phc2sys[509863.719]: [ptp4l.0.config] CLOCK_REALTIME phc offset -6 s2 freq +15441 delay 510 > > phc2sys[509863.782]: [ptp4l.0.config] CLOCK_REALTIME phc offset -7 s2 freq +15438 delay 502 > > ``` > > > > ### Configuring linuxptp services as a grandmaster clock for 3 E810 NICs {#configuring-linuxptp-services-as-grandmaster-clock-three-nic_configuring-ptp} > > > > You can configure the `linuxptp` services (`ptp4l`, `phc2sys`, `ts2phc`) as a grandmaster clock (T-GM) for 3 E810 NICs by creating a `PtpConfig` custom resource (CR) that configures the NICs. > > > > You can configure the `linuxptp` services as a T-GM with 3 NICs for the following E810 NICs: > > > > - Intel E810-XXVDA4T Westport Channel NIC > > - Intel E810-CQDA2T Logan Beach NIC > > > > For distributed RAN (D-RAN) use cases, you can configure PTP for 3 NICs as follows: > > > > - NIC 1 is synced to the Global Navigation Satellite System (GNSS) > > - NICs 2 and 3 are synced to NIC 1 with 1PPS faceplate connections > > > > Use the following example `PtpConfig` CRs as the basis to configure `linuxptp` services as a 3-card Intel E810 T-GM. > > > > **Prerequisites** > > > > - For T-GM clocks in production environments, install 3 Intel E810 NICs in the bare-metal cluster host. > > - Install the OpenShift CLI (`oc`). > > - Log in as a user with `cluster-admin` privileges. > > - Install the PTP Operator. > > > > **Procedure** > > > > 1. Create the `PtpConfig` CR. For example: > > > > 1. Save the following YAML in the `three-nic-grandmaster-clock-ptp-config.yaml` file: > > > > ```yaml > > # In this example, the three cards are connected via SMA cables: > > # - $iface_timeTx1 has the GNSS signal input > > # - $iface_timeTx2 SMA1 is connected to $iface_timeTx1 SMA1 > > # - $iface_timeTx3 SMA1 is connected to $iface_timeTx1 SMA2 > > apiVersion: ptp.openshift.io/v1 > > kind: PtpConfig > > metadata: > > name: gm-3card > > namespace: openshift-ptp > > annotations: > > ran.openshift.io/ztp-deploy-wave: "10" > > spec: > > profile: > > - name: grandmaster > > ptp4lOpts: -2 --summary_interval -4 > > phc2sysOpts: -r -u 0 -m -N 8 -R 16 -s $iface_timeTx1 -n 24 > > ptpSchedulingPolicy: SCHED_FIFO > > ptpSchedulingPriority: 10 > > ptpSettings: > > logReduce: "true" > > plugins: > > e810: > > enableDefaultConfig: false > > settings: > > LocalHoldoverTimeout: 14400 > > LocalMaxHoldoverOffSet: 1500 > > MaxInSpecOffset: 1500 > > pins: > > # Syntax guide: > > # - The 1st number in each pair must be one of: > > # 0 - Disabled > > # 1 - RX > > # 2 - TX > > # - The 2nd number in each pair must match the channel number > > $iface_timeTx1: > > SMA1: 2 1 > > SMA2: 2 2 > > U.FL1: 0 1 > > U.FL2: 0 2 > > $iface_timeTx2: > > SMA1: 1 1 > > SMA2: 0 2 > > U.FL1: 0 1 > > U.FL2: 0 2 > > $iface_timeTx3: > > SMA1: 1 1 > > SMA2: 0 2 > > U.FL1: 0 1 > > U.FL2: 0 2 > > ublxCmds: > > - args: #ubxtool -P 29.20 -z CFG-HW-ANT_CFG_VOLTCTRL,1 > > - "-P" > > - "29.20" > > - "-z" > > - "CFG-HW-ANT_CFG_VOLTCTRL,1" > > reportOutput: false > > - args: #ubxtool -P 29.20 -e GPS > > - "-P" > > - "29.20" > > - "-e" > > - "GPS" > > reportOutput: false > > - args: #ubxtool -P 29.20 -d Galileo > > - "-P" > > - "29.20" > > - "-d" > > - "Galileo" > > reportOutput: false > > - args: #ubxtool -P 29.20 -d GLONASS > > - "-P" > > - "29.20" > > - "-d" > > - "GLONASS" > > reportOutput: false > > - args: #ubxtool -P 29.20 -d BeiDou > > - "-P" > > - "29.20" > > - "-d" > > - "BeiDou" > > reportOutput: false > > - args: #ubxtool -P 29.20 -d SBAS > > - "-P" > > - "29.20" > > - "-d" > > - "SBAS" > > reportOutput: false > > - args: #ubxtool -P 29.20 -t -w 5 -v 1 -e SURVEYIN,600,50000 > > - "-P" > > - "29.20" > > - "-t" > > - "-w" > > - "5" > > - "-v" > > - "1" > > - "-e" > > - "SURVEYIN,600,50000" > > reportOutput: true > > - args: #ubxtool -P 29.20 -p MON-HW > > - "-P" > > - "29.20" > > - "-p" > > - "MON-HW" > > reportOutput: true > > - args: #ubxtool -P 29.20 -p CFG-MSG,1,38,248 > > - "-P" > > - "29.20" > > - "-p" > > - "CFG-MSG,1,38,248" > > reportOutput: true > > ts2phcOpts: " " > > ts2phcConf: | > > [nmea] > > ts2phc.master 1 > > [global] > > use_syslog 0 > > verbose 1 > > logging_level 7 > > ts2phc.pulsewidth 100000000 > > #example value of nmea_serialport is /dev/gnss0 > > ts2phc.nmea_serialport (?[/\w\s/]+) > > leapfile /usr/share/zoneinfo/leap-seconds.list > > [$iface_timeTx1] > > ts2phc.extts_polarity rising > > ts2phc.extts_correction 0 > > [$iface_timeTx2] > > ts2phc.master 0 > > ts2phc.extts_polarity rising > > #this is a measured value in nanoseconds to compensate for SMA cable delay > > ts2phc.extts_correction -10 > > [$iface_timeTx3] > > ts2phc.master 0 > > ts2phc.extts_polarity rising > > #this is a measured value in nanoseconds to compensate for SMA cable delay > > ts2phc.extts_correction -10 > > ptp4lConf: | > > [$iface_timeTx1] > > masterOnly 1 > > [$iface_timeTx1_1] > > masterOnly 1 > > [$iface_timeTx1_2] > > masterOnly 1 > > [$iface_timeTx1_3] > > masterOnly 1 > > [$iface_timeTx2] > > masterOnly 1 > > [$iface_timeTx2_1] > > masterOnly 1 > > [$iface_timeTx2_2] > > masterOnly 1 > > [$iface_timeTx2_3] > > masterOnly 1 > > [$iface_timeTx3] > > masterOnly 1 > > [$iface_timeTx3_1] > > masterOnly 1 > > [$iface_timeTx3_2] > > masterOnly 1 > > [$iface_timeTx3_3] > > masterOnly 1 > > [global] > > # > > # Default Data Set > > # > > twoStepFlag 1 > > priority1 128 > > priority2 128 > > domainNumber 24 > > #utc_offset 37 > > clockClass 6 > > clockAccuracy 0x27 > > offsetScaledLogVariance 0xFFFF > > free_running 0 > > freq_est_interval 1 > > dscp_event 0 > > dscp_general 0 > > dataset_comparison G.8275.x > > G.8275.defaultDS.localPriority 128 > > # > > # Port Data Set > > # > > logAnnounceInterval -3 > > logSyncInterval -4 > > logMinDelayReqInterval -4 > > logMinPdelayReqInterval 0 > > announceReceiptTimeout 3 > > syncReceiptTimeout 0 > > delayAsymmetry 0 > > fault_reset_interval -4 > > neighborPropDelayThresh 20000000 > > masterOnly 0 > > G.8275.portDS.localPriority 128 > > # > > # Run time options > > # > > assume_two_step 0 > > logging_level 6 > > path_trace_enabled 0 > > follow_up_info 0 > > hybrid_e2e 0 > > inhibit_multicast_service 0 > > net_sync_monitor 0 > > tc_spanning_tree 0 > > tx_timestamp_timeout 50 > > unicast_listen 0 > > unicast_master_table 0 > > unicast_req_duration 3600 > > use_syslog 1 > > verbose 0 > > summary_interval -4 > > kernel_leap 1 > > check_fup_sync 0 > > clock_class_threshold 7 > > # > > # Servo Options > > # > > pi_proportional_const 0.0 > > pi_integral_const 0.0 > > pi_proportional_scale 0.0 > > pi_proportional_exponent -0.3 > > pi_proportional_norm_max 0.7 > > pi_integral_scale 0.0 > > pi_integral_exponent 0.4 > > pi_integral_norm_max 0.3 > > step_threshold 2.0 > > first_step_threshold 0.00002 > > clock_servo pi > > sanity_freq_limit 200000000 > > ntpshm_segment 0 > > # > > # Transport options > > # > > transportSpecific 0x0 > > ptp_dst_mac 01:1B:19:00:00:00 > > p2p_dst_mac 01:80:C2:00:00:0E > > udp_ttl 1 > > udp6_scope 0x0E > > uds_address /var/run/ptp4l > > # > > # Default interface options > > # > > clock_type BC > > network_transport L2 > > delay_mechanism E2E > > time_stamping hardware > > tsproc_mode filter > > delay_filter moving_median > > delay_filter_length 10 > > egressLatency 0 > > ingressLatency 0 > > boundary_clock_jbod 1 > > # > > # Clock description > > # > > productDescription ;; > > revisionData ;; > > manufacturerIdentity 00:00:00 > > userDescription ; > > timeSource 0x20 > > ptpClockThreshold: > > holdOverTimeout: 5 > > maxOffsetThreshold: 1500 > > minOffsetThreshold: -1500 > > recommend: > > - profile: grandmaster > > priority: 4 > > match: > > - nodeLabel: node-role.kubernetes.io/$mcp > > ``` > > > > > [!NOTE] > > > Set the value for `ts2phc.nmea_serialport` to `/dev/gnss0`. > > 2. Create the CR by running the following command: > > > > ```terminal > > $ oc create -f three-nic-grandmaster-clock-ptp-config.yaml > > ``` > > > > **Verification** > > > > 1. Check that the `PtpConfig` profile is applied to the node. > > > > 1. Get the list of pods in the `openshift-ptp` namespace by running the following command: > > > > ```terminal > > $ oc get pods -n openshift-ptp -o wide > > ``` > > > > ```terminal {title="Example output"} > > NAME READY STATUS RESTARTS AGE IP NODE > > linuxptp-daemon-74m3q 3/3 Running 3 4d15h 10.16.230.7 compute-1.example.com > > ptp-operator-5f4f48d7c-x6zkn 1/1 Running 1 4d15h 10.128.1.145 compute-1.example.com > > ``` > > 2. Check that the profile is correct. Run the following command, and examine the logs of the `linuxptp` daemon that corresponds to the node you specified in the `PtpConfig` profile: > > > > ```terminal > > $ oc logs linuxptp-daemon-74m3q -n openshift-ptp -c linuxptp-daemon-container > > ``` > > > > ```terminal {title="Example output"} > > ts2phc[2527.586]: [ts2phc.0.config:7] adding tstamp 1742826342.000000000 to clock /dev/ptp11 > > ts2phc[2527.586]: [ts2phc.0.config:7] adding tstamp 1742826342.000000000 to clock /dev/ptp7 > > ts2phc[2527.586]: [ts2phc.0.config:7] adding tstamp 1742826342.000000000 to clock /dev/ptp14 > > ts2phc[2527.586]: [ts2phc.0.config:7] nmea delay: 56308811 ns > > ts2phc[2527.586]: [ts2phc.0.config:6] /dev/ptp14 offset 0 s2 freq +0 > > ts2phc[2527.587]: [ts2phc.0.config:6] /dev/ptp7 offset 0 s2 freq +0 > > ts2phc[2527.587]: [ts2phc.0.config:6] /dev/ptp11 offset 0 s2 freq -0 > > I0324 14:25:05.000439 106907 stats.go:61] state updated for ts2phc =s2 > > I0324 14:25:05.000504 106907 event.go:419] dpll State s2, gnss State s2, tsphc state s2, gm state s2, > > I0324 14:25:05.000906 106907 stats.go:61] state updated for ts2phc =s2 > > I0324 14:25:05.001059 106907 stats.go:61] state updated for ts2phc =s2 > > ts2phc[1742826305]:[ts2phc.0.config] ens4f0 nmea_status 1 offset 0 s2 > > GM[1742826305]:[ts2phc.0.config] ens4f0 T-GM-STATUS s2 > > ``` > > > > where: > > > > `adding tstamp to clock /dev/ptp` > > : Indicates `ts2phc` is actively synchronizing the PTP hardware clock (PHC) by applying a specific timestamp. > > > > `/dev/ptp offset 0 s2 freq +0` > > : Displays the estimated offset between the PTP device and the reference; an offset of 0 and state `s2` signifies full synchronization. > > > > `T-GM-STATUS s2` > > : Confirms the Telecom Grandmaster (T-GM) is in a locked state (`s2`), providing a stable time reference for the network. > > > > ### Telecom Grandmaster clocks on Intel Granite Rapids-D hardware {#nw-ptp-granite-rapids-telecom-grandmaster-clock-overview_configuring-ptp} > > > > 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. 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. The associated procedure provides an example `PtpConfig` CR, `linuxptp` plugin expectations, and verification steps for Granite Rapids-D nodes. > > > > In addition to Telecom Grandmaster configurations, Intel Granite Rapids-D (GNR-D) hardware supports a Precision Time Protocol (PTP) boundary clock profile without holdover. For more information about boundary clock configuration on GNR-D hardware, see the Additional resources section. > > > > > [!IMPORTANT] > > > Telecom Grandmaster clocks on Intel Granite Rapids-D hardware is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. > > > > > > For more information about the support scope of Red Hat Technology Preview features, see [Technology Preview Features Support Scope](https://access.redhat.com/support/offerings/techpreview/). > [!NOTE] > 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). Intel does not plan to add interfaces that expose further follower DPLL lock accuracy in software or firmware. > > 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. Resolution of complex follower DPLL problems might require on-site hardware access and coordination with Intel rather than diagnosis inside OpenShift Container Platform. Physical architecture and timing paths : 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. 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. 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. Interface naming and the GNR-D MachineConfig : 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. 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. **Additional resources** {._additional-resources} - [Boundary clocks without holdover on Intel Granite Rapids-D hardware](/openshift-docs-markdown/networking/advanced_networking/ptp/configuring-ptp#nw-ptp-granite-rapids-boundary-clock-overview_configuring-ptp) - [Configuring linuxptp services as a boundary clock without holdover on Intel Granite Rapids-D hardware](/openshift-docs-markdown/networking/advanced_networking/ptp/configuring-ptp#ptp-configuring-linuxptp-services-as-boundary-clock-gnrd_configuring-ptp) - [Configuring GNR-D T-BC holdover on a GNR-D platform](/openshift-docs-markdown/networking/advanced_networking/ptp/configuring-ptp#nw-ptp-gnrd-t-bc-holdover_configuring-ptp) ### Configuring linuxptp services as a Telecom Grandmaster clock on Intel Granite Rapids-D hardware {#configuring-linuxptp-services-as-grandmaster-clock-gnrd_configuring-ptp} 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). 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. > [!IMPORTANT] > Telecom Grandmaster clock configuration on Intel Granite Rapids-D (GNR-D) hardware is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. > > For more information about the support scope of Red Hat Technology Preview features, see [Technology Preview Features Support Scope](https://access.redhat.com/support/offerings/techpreview/). **Prerequisites** - You have verified your qualified GNR-D hardware layout, including NAC ports, Carter Flat ports, and interface naming. - The OpenShift CLI (`oc`) is installed. - You are logged in as a user with `cluster-admin` privileges. - The PTP Operator is installed. - You have verified that interface names, GNSS serial paths, and plugin device entries are aligned with your qualified hardware layout. **Procedure** 1. Create a `PtpConfig` custom resource (CR) that matches your qualified GNR-D Telecom Grandmaster hardware layout: ```yaml # Example Telecom Grandmaster PtpConfig for Intel Granite Rapids-D (GNR-D). # # Note: This example configuration should be customized to match the desired # configuration For this GNR-D T-GM configuration, we support GNSS incoming to # the onboard connection, and up to 24 Time Transmitter ports including any NAC # ports and any additional Carter Flats ports. apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: gnrd-tgm namespace: openshift-ptp annotations: ran.openshift.io/ztp-deploy-wave: "10" spec: profile: - name: "grandmaster" ptp4lOpts: "-2 --summary_interval -4" phc2sysOpts: -r -u 0 -m -w -N 8 -R 16 -n 24 -s eno8703 ptpSchedulingPolicy: SCHED_FIFO ptpSchedulingPriority: 10 ptpSettings: logReduce: "true" plugins: e830: devices: - enp108s0f0 - enp110s0f0 e825: devices: - eno8703 settings: LocalMaxHoldoverOffSet: 1500 LocalHoldoverTimeout: 14400 MaxInSpecOffset: 100 ublxCmds: - args: #ubxtool -P 29.25 -z CFG-HW-ANT_CFG_VOLTCTRL,1 - "-P" - "29.25" - "-z" - "CFG-HW-ANT_CFG_VOLTCTRL,1" reportOutput: false - args: #ubxtool -P 29.25 -e GPS - "-P" - "29.25" - "-e" - "GPS" reportOutput: false - args: #ubxtool -P 29.25 -d Galileo - "-P" - "29.25" - "-d" - "Galileo" reportOutput: false - args: #ubxtool -P 29.25 -d GLONASS - "-P" - "29.25" - "-d" - "GLONASS" reportOutput: false - args: #ubxtool -P 29.25 -d BeiDou - "-P" - "29.25" - "-d" - "BeiDou" reportOutput: false - args: #ubxtool -P 29.25 -d SBAS - "-P" - "29.25" - "-d" - "SBAS" reportOutput: false - args: #ubxtool -P 29.25 -t -w 5 -v 1 -e SURVEYIN,600,50000 - "-P" - "29.25" - "-t" - "-w" - "5" - "-v" - "1" - "-e" - "SURVEYIN,600,50000" reportOutput: true - args: #ubxtool -P 29.25 -p MON-HW - "-P" - "29.25" - "-p" - "MON-HW" reportOutput: true - args: #ubxtool -P 29.25 -p CFG-MSG,1,38,300 - "-P" - "29.25" - "-p" - "CFG-MSG,1,38,248" reportOutput: true ts2phcOpts: "-m" ts2phcConf: | [nmea] ts2phc.master 1 [global] use_syslog 0 verbose 1 logging_level 7 ts2phc.pulsewidth 100000000 ts2phc.nmea_serialport /dev/ttyACM0 [eno8703] ts2phc.extts_polarity rising ts2phc.extts_correction 0 ts2phc.master 0 ts2phc.channel 0 ts2phc.pin_index 1 # This should be one section per Carter Flats (e830) card: [enp108s0f0] ts2phc.extts_polarity rising ts2phc.extts_correction 0 ts2phc.master 0 ts2phc.channel 0 ts2phc.pin_index 1 [enp110s0f0] ts2phc.extts_polarity rising ts2phc.extts_correction 0 ts2phc.master 0 ts2phc.channel 0 ts2phc.pin_index 1 ptp4lConf: | # All TimeTransmitter ports should be outlined here with 'masterOnly 1' #[eno8303] # ** Host management interface [eno8403] masterOnly 1 [eno8503] masterOnly 1 [eno8603] masterOnly 1 [eno8703] masterOnly 1 [eno8803] masterOnly 1 [eno8903] masterOnly 1 [eno9003] masterOnly 1 [enp108s0f0] masterOnly 1 [enp108s0f1] masterOnly 1 [enp108s0f2] masterOnly 1 [enp108s0f3] masterOnly 1 [enp108s0f4] masterOnly 1 [enp108s0f5] masterOnly 1 [enp108s0f6] masterOnly 1 [enp108s0f7] masterOnly 1 [enp110s0f0] masterOnly 1 [enp110s0f1] masterOnly 1 [enp110s0f2] masterOnly 1 [enp110s0f3] masterOnly 1 [enp110s0f4] masterOnly 1 [enp110s0f5] masterOnly 1 [enp110s0f6] masterOnly 1 [enp110s0f7] masterOnly 1 [global] # # Default Data Set # twoStepFlag 1 priority1 128 priority2 128 domainNumber 24 #utc_offset 37 clockClass 6 clockAccuracy 0x27 offsetScaledLogVariance 0xFFFF free_running 0 freq_est_interval 1 dscp_event 0 dscp_general 0 dataset_comparison G.8275.x G.8275.defaultDS.localPriority 128 # # Port Data Set # logAnnounceInterval -3 logSyncInterval -4 logMinDelayReqInterval -4 logMinPdelayReqInterval 0 announceReceiptTimeout 3 syncReceiptTimeout 0 delayAsymmetry 0 fault_reset_interval 4 neighborPropDelayThresh 20000000 masterOnly 0 G.8275.portDS.localPriority 128 # # Run time options # assume_two_step 0 logging_level 6 path_trace_enabled 0 follow_up_info 0 hybrid_e2e 0 inhibit_multicast_service 0 net_sync_monitor 0 tc_spanning_tree 0 tx_timestamp_timeout 50 unicast_listen 0 unicast_master_table 0 unicast_req_duration 3600 use_syslog 1 verbose 0 summary_interval -4 kernel_leap 1 check_fup_sync 0 # # Servo Options # pi_proportional_const 0.0 pi_integral_const 0.0 pi_proportional_scale 0.0 pi_proportional_exponent -0.3 pi_proportional_norm_max 0.7 pi_integral_scale 0.0 pi_integral_exponent 0.4 pi_integral_norm_max 0.3 step_threshold 0.0 first_step_threshold 0.00002 clock_servo pi sanity_freq_limit 200000000 ntpshm_segment 0 # # Transport options # transportSpecific 0x0 ptp_dst_mac 01:1B:19:00:00:00 p2p_dst_mac 01:80:C2:00:00:0E udp_ttl 1 udp6_scope 0x0E uds_address /var/run/ptp4l # # Default interface options # clock_type BC network_transport L2 delay_mechanism E2E time_stamping hardware tsproc_mode filter delay_filter moving_median delay_filter_length 10 egressLatency 0 ingressLatency 0 boundary_clock_jbod 1 # # Clock description # productDescription ;; revisionData ;; manufacturerIdentity 00:00:00 userDescription ; timeSource 0x20 recommend: - match: - nodeLabel: node-role.kubernetes.io/$mcp priority: 4 profile: grandmaster ``` where: - `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. - `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. - `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. - `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. 2. Customize interface names, the `plugins` device list, `ts2phcConf`, `ptp4lConf`, and the `recommend` stanza in the preceding example to match your qualified hardware layout. 3. Add or remove Carter Flat interface blocks in `ts2phcConf` and `ptp4lConf` to match the number of expansion cards on your server. 4. 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`. 5. Save the customized `PtpConfig` CR as `gnrd-grandmaster-clock-ptp-config.yaml`. 6. Verify that the `plugins` stanza lists the `e830` and `e825` device entries your qualified hardware layout requires. 7. Apply the `PtpConfig` CR by running the following command: ```terminal $ oc apply -f gnrd-grandmaster-clock-ptp-config.yaml ``` **Verification** 1. Verify that the `PtpConfig` profile is applied: 1. Retrieve the pods in the `openshift-ptp` namespace by running the following command: ```terminal $ oc get pods -n openshift-ptp -o wide ``` 2. Review `linuxptp` daemon logs for the pod on your Granite Rapids-D node by running the following command, replacing `` with the pod name that is scheduled on your target node: ```terminal $ oc logs -n openshift-ptp -c linuxptp-daemon-container ``` **Additional resources** {._additional-resources} - [Configuring the PTP fast event notifications publisher](/openshift-docs-markdown/networking/advanced_networking/ptp/ptp-cloud-events-consumer-dev-reference-v2#cnf-configuring-the-ptp-fast-event-publisher-v2_ptp-consumer) - [Boundary clocks without holdover on Intel Granite Rapids-D hardware](/openshift-docs-markdown/networking/advanced_networking/ptp/configuring-ptp#nw-ptp-granite-rapids-boundary-clock-overview_configuring-ptp) - [Configuring linuxptp services as a boundary clock without holdover on Intel Granite Rapids-D hardware](/openshift-docs-markdown/networking/advanced_networking/ptp/configuring-ptp#ptp-configuring-linuxptp-services-as-boundary-clock-gnrd_configuring-ptp) - [Configuring GNR-D T-BC holdover on a GNR-D platform](/openshift-docs-markdown/networking/advanced_networking/ptp/configuring-ptp#nw-ptp-gnrd-t-bc-holdover_configuring-ptp) ## Grandmaster clock PtpConfig configuration reference {#nw-ptp-grandmaster-clock-configuration-reference_configuring-ptp} The following reference information describes the configuration options for the `PtpConfig` custom resource (CR) that configures the `linuxptp` services (`ptp4l`, `phc2sys`, `ts2phc`) as a grandmaster clock. **PtpConfig configuration options for PTP Grandmaster clock**
PtpConfig CR field Description
plugins Specify an array of .exec.cmdline options that configure the NIC for grandmaster clock operation. Grandmaster clock configuration requires certain PTP pins to be disabled.

The plugin mechanism allows the PTP Operator to do automated hardware configuration. For the Intel Westport Channel NIC or the Intel Logan Beach NIC, when the enableDefaultConfig field is set to true, the PTP Operator runs a hard-coded script to do the required configuration for the NIC.
ptp4lOpts Specify system configuration options for the ptp4l service. 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.
ptp4lConf Specify the required configuration to start ptp4l as a grandmaster clock. For example, the ens2f1 interface synchronizes downstream connected devices. For grandmaster clocks, set clockClass to 6 and set clockAccuracy to 0x27. Set timeSource to 0x20 for when receiving the timing signal from a Global navigation satellite system (GNSS).
tx_timestamp_timeout Specify the maximum amount of time to wait for the transmit (TX) timestamp from the sender before discarding the data.
boundary_clock_jbod Specify the JBOD boundary clock time delay value. This value is used to correct the time values that are passed between the network time devices.
phc2sysOpts Specify system config options for the phc2sys service. If this field is empty the PTP Operator does not start the phc2sys service.
Note
Ensure that the network interface listed here is configured as grandmaster and is referenced as required in the ts2phcConf and ptp4lConf fields.
ptpSchedulingPolicy Configure the scheduling policy for ptp4l and phc2sys processes. Default value is SCHED_OTHER. Use SCHED_FIFO on systems that support FIFO scheduling.
ptpSchedulingPriority Set an integer value from 1-65 to configure 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.
ptpClockThreshold Optional. If ptpClockThreshold stanza is not present, default values are used for ptpClockThreshold fields. Stanza shows default ptpClockThreshold values. ptpClockThreshold values configure how long after the PTP master clock is disconnected before PTP events are triggered. holdOverTimeout is the time value in seconds before the PTP clock event state changes to FREERUN when the PTP master clock is disconnected. The maxOffsetThreshold and minOffsetThreshold settings configure offset values in nanoseconds that compare against the values for CLOCK_REALTIME (phc2sys) or master offset (ptp4l). When the ptp4l or phc2sys offset value is outside this range, the PTP clock state is set to FREERUN. When the offset value is within this range, the PTP clock state is set to LOCKED.
ts2phcConf Sets the configuration for the ts2phc command.

leapfile is the default path to the current leap seconds definition file in the PTP Operator container image.

ts2phc.nmea_serialport is the serial port device that is connected to the NMEA GPS clock source. When configured, the GNSS receiver is accessible on /dev/gnss<id>. If the host has multiple GNSS receivers, you can find the correct device by enumerating either of the following devices:

  • /sys/class/net/<eth_port>/device/gnss/
  • /sys/class/gnss/gnss<id>/device/
ts2phcOpts Set options for the ts2phc command.
recommend Specify an array of one or more recommend objects that define rules on how the profile should be applied to nodes.
.recommend.profile Specify the .recommend.profile object name that is defined in the profile section.
.recommend.priority Specify the priority with an integer value between 0 and 99. A larger number gets lower priority, so a priority of 99 is lower than a priority of 10. If a node can be matched with multiple profiles according to rules defined in the match field, the profile with the higher priority is applied to that node.
.recommend.match Specify .recommend.match rules with nodeLabel or nodeName values.
.recommend.match.nodeLabel Set nodeLabel with the key of the node.Labels field from the node object by using the oc get nodes --show-labels command. For example, node-role.kubernetes.io/worker.
.recommend.match.nodeName Set nodeName with the value of the node.Name field from the node object by using the oc get nodes command. For example, compute-1.example.com.
### Grandmaster clock class sync state reference {#nw-ptp-grandmaster-clock-class-reference_configuring-ptp} The following table describes the PTP grandmaster clock (T-GM) `gm.ClockClass` states. Clock class states categorize T-GM clocks based on their accuracy and stability with regard to the Primary Reference Time Clock (PRTC) or other timing source. Holdover specification is the amount of time a PTP clock can maintain synchronization without receiving updates from the primary time source. **T-GM clock class states** | | | | --- | --- | | Clock class state | Description | | `gm.ClockClass 6` | T-GM clock is connected to a PRTC in `LOCKED` mode. For example, the PRTC is traceable to a GNSS time source. | | `gm.ClockClass 7` | T-GM clock is in `HOLDOVER` mode, and within holdover specification. The clock source might not be traceable to a category 1 frequency source. | | `gm.ClockClass 248` | T-GM clock is in `FREERUN` mode. | For more information, see ["Phase/time traceability information", ITU-T G.8275.1/Y.1369.1 Recommendations](https://www.itu.int/rec/T-REC-G.8275.1-202211-I/en). ### Intel E810 NIC hardware configuration reference {#nw-ptp-e810-hardware-pins-reference_configuring-ptp} Use this information to understand how to use the [Intel E810 hardware plugin](https://github.com/openshift/linuxptp-daemon/blob/release-4.16/addons/intel/e810.go) to configure the E810 network interface as PTP grandmaster clock. Hardware pin configuration determines how the network interface interacts with other components and devices in the system. The Intel E810 NIC has four connectors for external 1PPS signals: `SMA1`, `SMA2`, `U.FL1`, and `U.FL2`. **Intel E810 NIC hardware connectors configuration** | Hardware pin | Recommended setting | Description | | --- | --- | --- | | `U.FL1` | `0 1` | Disables the `U.FL1` connector input. The `U.FL1` connector is output-only. | | `U.FL2` | `0 2` | Disables the `U.FL2` connector output. The `U.FL2` connector is input-only. | | `SMA1` | `0 1` | Disables the `SMA1` connector input. The `SMA1` connector is bidirectional. | | `SMA2` | `0 2` | Disables the `SMA2` connector output. The `SMA2` connector is bidirectional. | You can set the pin configuration on the Intel E810 NIC by using the `spec.profile.plugins.e810.pins` parameters as shown in the following example: ```yaml pins: : : ``` Where: ``: Specifies the role of the pin. The following values are associated with the pin role: - `0`: Disabled - `1`: Rx (Receive timestamping) - `2`: Tx (Transmit timestamping) ``: A number associated with the physical connector. The following channel numbers are associated with the physical connectors: - `1`: `SMA1` or `U.FL1` - `2`: `SMA2` or `U.FL2` Examples: - `0 1`: Disables the pin mapped to `SMA1` or `U.FL1`. - `1 2`: Assigns the Rx function to `SMA2` or `U.FL2`. > [!NOTE] > `SMA1` and `U.FL1` connectors share channel one. `SMA2` and `U.FL2` connectors share channel two. Set `spec.profile.plugins.e810.ublxCmds` parameters to configure the GNSS clock in the `PtpConfig` custom resource (CR). > [!IMPORTANT] > You must configure an offset value to compensate for T-GM GPS antenna cable signal delay. To configure the optimal T-GM antenna offset value, make precise measurements of the GNSS antenna cable signal delay. Red Hat cannot assist in this measurement or provide any values for the required delay offsets. Each of these `ublxCmds` stanzas correspond to a configuration that is applied to the host NIC by using `ubxtool` commands. For example: ```yaml ublxCmds: - args: - "-P" - "29.20" - "-z" - "CFG-HW-ANT_CFG_VOLTCTRL,1" - "-z" - "CFG-TP-ANT_CABLEDELAY," reportOutput: false ``` where: `"CFG-TP-ANT_CABLEDELAY,"` : Measured T-GM antenna delay offset in nanoseconds. To get the required delay offset value, you must measure the cable delay using external test equipment. The following table describes the equivalent `ubxtool` commands: **Intel E810 ublxCmds configuration** | ubxtool command | Description | | --- | --- | | `ubxtool -P 29.20 -z CFG-HW-ANT_CFG_VOLTCTRL,1 -z CFG-TP-ANT_CABLEDELAY,` | Enables antenna voltage control, allows antenna status to be reported in the `UBX-MON-RF` and `UBX-INF-NOTICE` log messages, and sets a `` value in nanoseconds that offsets the GPS antenna cable signal delay. | | `ubxtool -P 29.20 -e GPS` | Enables the antenna to receive GPS signals. | | `ubxtool -P 29.20 -d Galileo` | Configures the antenna to receive signal from the Galileo GPS satellite. | | `ubxtool -P 29.20 -d GLONASS` | Disables the antenna from receiving signal from the GLONASS GPS satellite. | | `ubxtool -P 29.20 -d BeiDou` | Disables the antenna from receiving signal from the BeiDou GPS satellite. | | `ubxtool -P 29.20 -d SBAS` | Disables the antenna from receiving signal from the SBAS GPS satellite. | | `ubxtool -P 29.20 -t -w 5 -v 1 -e SURVEYIN,600,50000` | Configures the GNSS receiver survey-in process to improve its initial position estimate. This can take up to 24 hours to achieve an optimal result. | | `ubxtool -P 29.20 -p MON-HW` | Runs a single automated scan of the hardware and reports on the NIC state and configuration settings. | ### Dual E810 NIC configuration reference {#nw-ptp-dual-e810-hardware-config-reference_configuring-ptp} Use this information to understand how to use the [Intel E810 hardware plugin](https://github.com/openshift/linuxptp-daemon/blob/release-4.14/addons/intel/e810.go) to configure a pair of E810 network interfaces as PTP grandmaster clock (T-GM). Before you configure the dual-NIC cluster host, you must connect the two NICs with an SMA1 cable using the 1PPS faceplace connections. When you configure a dual-NIC T-GM, you need to compensate for the 1PPS signal delay that occurs when you connect the NICs using the SMA1 connection ports. Various factors such as cable length, ambient temperature, and component and manufacturing tolerances can affect the signal delay. To compensate for the delay, you must calculate the specific value that you use to offset the signal delay. **E810 dual-NIC T-GM PtpConfig CR reference**
PtpConfig field Description
spec.profile.plugins.e810.pins Configure the E810 hardware pins using the PTP Operator E810 hardware plugin.

  • Pin 2 1 enables the 1PPS OUT connection for SMA1 on NIC one.
  • Pin 1 1 enables the 1PPS IN connection for SMA1 on NIC two.
spec.profile.ts2phcConf Use the ts2phcConf field to configure parameters for NIC one and NIC two. Set ts2phc.master 0 for NIC two. This configures the timing source for NIC two from the 1PPS input, not GNSS. Configure the ts2phc.extts_correction value for NIC two to compensate for the delay that is incurred for the specific SMA cable and cable length that you use. The value that you configure depends on your specific measurements and SMA1 cable length.
spec.profile.ptp4lConf Set the value of boundary_clock_jbod to 1 to enable support for multiple NICs.
Each value in the `spec.profile.plugins.e810.pins` list follows the `` `` format. Where: ``: Specifies the pin role. The following values are associated with the pin role: - `0`: Disabled - `1`: Receive (Rx) – for 1PPS IN - `2`: Transmit (Tx) – for 1PPS OUT ``: A number associated with the physical connector. The following channel numbers are associated with the physical connectors: - `1`: `SMA1` or `U.FL1` - `2`: `SMA2` or `U.FL2` Examples: - `2 1`: Enables `1PPS OUT` (Tx) on `SMA1`. - `1 1`: Enables `1PPS IN` (Rx) on `SMA1`. The PTP Operator passes these values to the Intel E810 hardware plugin and writes them to the sysfs pin configuration interface on each NIC. ### 3-card E810 NIC configuration reference {#nw-ptp-three-nic-hardware-config-reference_configuring-ptp} Use this information to understand how to configure 3 E810 NICs as PTP grandmaster clock (T-GM). Before you configure the 3-card cluster host, you must connect the 3 NICs by using the 1PPS faceplate connections. The primary NIC `1PPS_out` outputs feed the other 2 NICs. When you configure a 3-card T-GM, you need to compensate for the 1PPS signal delay that occurs when you connect the NICs by using the SMA1 connection ports. Various factors such as cable length, ambient temperature, and component and manufacturing tolerances can affect the signal delay. To compensate for the delay, you must calculate the specific value that you use to offset the signal delay. **3-card E810 T-GM PtpConfig CR reference**
PtpConfig field Description
spec.profile.plugins.e810.pins Configure the E810 hardware pins with the PTP Operator E810 hardware plugin.

  • $iface_timeTx1.SMA1 enables the 1PPS OUT connection for SMA1 on NIC 1.
  • $iface_timeTx1.SMA2 enables the 1PPS OUT connection for SMA2 on NIC 1.
  • $iface_timeTx2.SMA1 and $iface_timeTx3.SMA1 enables the 1PPS IN connection for SMA1 on NIC 2 and NIC 3.
  • $iface_timeTx2.SMA2 and $iface_timeTx3.SMA2 disables the SMA2 connection on NIC 2 and NIC 3.
spec.profile.ts2phcConf Use the ts2phcConf field to configure parameters for the NICs. Set ts2phc.master 0 for NIC 2 and NIC 3. This configures the timing source for NIC 2 and NIC 3 from the 1PPS input, not GNSS. Configure the ts2phc.extts_correction value for NIC 2 and NIC 3 to compensate for the delay that is incurred for the specific SMA cable and cable length that you use. The value that you configure depends on your specific measurements and SMA1 cable length.
spec.profile.ptp4lConf Set the value of boundary_clock_jbod to 1 to enable support for multiple NICs.
## Holdover in a grandmaster clock with GNSS as the source {#holdover-in-a-grandmaster-clock_configuring-ptp} Holdover allows the grandmaster (T-GM) clock to maintain synchronization performance when the global navigation satellite system (GNSS) source is unavailable. During this period, the T-GM clock relies on its internal oscillator and holdover parameters to reduce timing disruptions. You can define the holdover behavior by configuring the following holdover parameters in the `PTPConfig` custom resource (CR): `MaxInSpecOffset` : Specifies the maximum allowed offset in nanoseconds. If the T-GM clock exceeds the `MaxInSpecOffset` value, it transitions to the `FREERUN` state (clock class state `gm.ClockClass 248`). `LocalHoldoverTimeout` : Specifies the maximum duration, in seconds, for which the T-GM clock remains in the holdover state before transitioning to the `FREERUN` state. `LocalMaxHoldoverOffSet` : Specifies the maximum offset that the T-GM clock can reach during the holdover state in nanoseconds. If the `MaxInSpecOffset` value is less than the `LocalMaxHoldoverOffset` value, and the T-GM clock exceeds the maximum offset value, the T-GM clock transitions from the holdover state to the `FREERUN` state. > [!IMPORTANT] > If the `LocalMaxHoldoverOffSet` value is less than the `MaxInSpecOffset` value, the holdover timeout occurs before the clock reaches the maximum offset. To resolve this issue, set the `MaxInSpecOffset` field and the `LocalMaxHoldoverOffset` field to the same value. For information about clock class states, see "Grandmaster clock class sync state reference" document. The T-GM clock uses the holdover parameters `LocalMaxHoldoverOffSet` and `LocalHoldoverTimeout` to calculate the slope. Slope is the rate at which the phase offset changes over time. It is measured in nanoseconds per second, where the set value indicates how much the offset increases over a given time period. The T-GM clock uses the slope value to predict and compensate for time drift, so reducing timing disruptions during holdover. The T-GM clock uses the following formula to calculate the slope: - Slope = `localMaxHoldoverOffSet` / `localHoldoverTimeout` For example, if the `LocalHoldOverTimeout` parameter is set to 60 seconds, and the `LocalMaxHoldoverOffset` parameter is set to 3000 nanoseconds, the slope is calculated as follows: Slope = 3000 nanoseconds / 60 seconds = 50 nanoseconds per second The T-GM clock reaches the maximum offset in 60 seconds. > [!NOTE] > The phase offset is converted from picoseconds to nanoseconds. As a result, the calculated phase offset during holdover is expressed in nanoseconds, and the resulting slope is expressed in nanoseconds per second. The following figure illustrates the holdover behavior in a T-GM clock with GNSS as the source: **Figure 1. Holdover in a T-GM clock with GNSS as the source** ![Holdover in a T-GM clock with GNSS as the source](/openshift-docs-markdown/images/openshift-ptp-holdover-tgm-clock-with-gnss.png) 20 The GNSS signal is lost, causing the T-GM clock to enter the `HOLDOVER` mode. The T-GM clock maintains time accuracy by using its internal clock. 20 The GNSS signal is restored and the T-GM clock re-enters the `LOCKED` mode. When the GNSS signal is restored, the T-GM clock re-enters the `LOCKED` mode only after all dependent components in the synchronization chain, such as `ts2phc` offset, digital phase-locked loop (DPLL) phase offset, and GNSS offset, reach a stable `LOCKED` mode. 20 The GNSS signal is lost again, and the T-GM clock re-enters the `HOLDOVER` mode. The time error begins to increase. 20 The time error exceeds the `MaxInSpecOffset` threshold due to prolonged loss of traceability. 20 The GNSS signal is restored, and the T-GM clock resumes synchronization. The time error starts to decrease. 20 The time error decreases and falls back within the `MaxInSpecOffset` threshold. ## Applying unassisted holdover for boundary clocks and time synchronous clocks {#nw-ptp-t-bc-t-tsc-holdover_configuring-ptp} The unassisted holdover feature enables an Intel E810-XXVDA4T NIC, configured as a PTP boundary clock (T-BC) or telecom time synchronous clock (T-TSC), to maintain time synchronization when the upstream timing source becomes unavailable. When the upstream source degrades, disconnects, or fails, the NIC enters the holdover state. In this state, the NIC relies on its internal oscillator to maintain accurate time autonomously. On nodes with multiple NICs, one NIC acts as the leading NIC. Other NICs on the node synchronize to the leading NIC through SMA cable connections managed by the `ts2phc` service. In T-BC configurations, the time transmitter (TT) ports continue transmitting timing to downstream devices, signaling a degraded but usable clock quality. Timing remains stable on both the local node and the downstream network until the upstream source recovers or the holdover timeout expires. This example describes how to configure unassisted holdover for a multi-card T-BC configuration with three NICs. **Prerequisites** - Install the OpenShift CLI (`oc`). - Log in as a user with `cluster-admin` privileges. - Install the PTP Operator. - One or more Intel E810-XXVDA4T NICs. - For multi-card configurations, SMA cables connecting the NICs. **Procedure** 1. Create a `PtpConfig` CR with two profiles: one for time transmitter (TT) ports and one for the time receiver (TR) port with hardware configuration. 1. Define the TT profile that configures downstream-facing ports: ```yaml apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: t-bc namespace: openshift-ptp spec: profile: - name: 00-tbc-tt ptp4lConf: | [ens4f0] masterOnly 1 [ens8f0] masterOnly 1 [ens1f0] masterOnly 1 [global] # # Default Data Set # twoStepFlag 1 slaveOnly 0 priority1 128 priority2 128 domainNumber 25 clockClass 248 clockAccuracy 0xFE offsetScaledLogVariance 0xFFFF free_running 0 freq_est_interval 1 dscp_event 0 dscp_general 0 dataset_comparison G.8275.x G.8275.defaultDS.localPriority 128 # # Port Data Set # logAnnounceInterval -3 logSyncInterval -4 logMinDelayReqInterval -4 logMinPdelayReqInterval -4 announceReceiptTimeout 3 syncReceiptTimeout 0 delayAsymmetry 0 fault_reset_interval -4 neighborPropDelayThresh 20000000 masterOnly 0 G.8275.portDS.localPriority 128 # # Run time options # assume_two_step 0 logging_level 6 path_trace_enabled 0 follow_up_info 0 hybrid_e2e 0 inhibit_multicast_service 0 net_sync_monitor 0 tc_spanning_tree 0 tx_timestamp_timeout 50 unicast_listen 0 unicast_master_table 0 unicast_req_duration 3600 use_syslog 1 verbose 0 summary_interval 0 kernel_leap 1 check_fup_sync 0 clock_class_threshold 135 # # Servo Options # pi_proportional_const 0.60 pi_integral_const 0.001 pi_proportional_scale 0.0 pi_proportional_exponent -0.3 pi_proportional_norm_max 0.7 pi_integral_scale 0.0 pi_integral_exponent 0.4 pi_integral_norm_max 0.3 step_threshold 2.0 first_step_threshold 0.00002 max_frequency 900000000 clock_servo pi sanity_freq_limit 200000000 ntpshm_segment 0 # # Transport options # transportSpecific 0x0 ptp_dst_mac AA:BB:CC:DD:EE:FF p2p_dst_mac BB:CC:DD:EE:FF:GG udp_ttl 1 udp6_scope 0x0E uds_address /var/run/ptp4l # # Default interface options # clock_type BC network_transport L2 delay_mechanism E2E time_stamping hardware tsproc_mode filter delay_filter moving_median delay_filter_length 10 egressLatency 0 ingressLatency 0 boundary_clock_jbod 1 # # Clock description # productDescription ;; revisionData ;; manufacturerIdentity 00:00:00 userDescription ; timeSource 0xA0 ptp4lOpts: -2 --summary_interval -4 ptpSchedulingPolicy: SCHED_FIFO ptpSchedulingPriority: 10 ptpSettings: controllingProfile: 01-tbc-tr logReduce: "false" # ... ``` - `spec.profile[].ptp4lConf` defines the `ptp4l` configuration. In the `[ens4f0]` interface section, the `masterOnly 1` setting configures TT ports to transmit timing downstream. - `clock_type BC` sets the clock to boundary clock operation. - `boundary_clock_jbod 1` enables multi-NIC configurations. - `spec.profile[].ptpSettings.controllingProfile` references the TR profile that controls holdover behavior. 2. Define the TR profile with the hardware plugin configuration: ```yaml # ... - name: 01-tbc-tr phc2sysOpts: -r -n 25 -N 8 -R 16 -u 0 -m -s ens4f1 plugins: e810: enableDefaultConfig: false interconnections: - gnssInput: false id: ens4f0 part: E810-XXVDA4T phaseOutputConnectors: - SMA1 - SMA2 upstreamPort: ens4f1 - id: ens1f0 inputConnector: connector: SMA1 part: E810-XXVDA4T - id: ens8f0 inputConnector: connector: SMA1 part: E810-XXVDA4T pins: ens4f0: SMA1: 2 1 SMA2: 2 2 U.FL1: 0 1 U.FL2: 0 2 ens1f0: SMA1: 1 1 SMA2: 0 2 U.FL1: 0 1 U.FL2: 0 2 ens8f0: SMA1: 1 1 SMA2: 0 2 U.FL1: 0 1 U.FL2: 0 2 settings: LocalHoldoverTimeout: 14400 LocalMaxHoldoverOffSet: 1500 MaxInSpecOffset: 100 # ... ``` - `phc2sysOpts` specifies the upstream port (`ens4f1`) as the source for system clock synchronization. - `plugins.e810.interconnections` defines how NICs are connected. The leading NIC (`ens4f0`) outputs phase to other NICs through SMA cables. - `plugins.e810.interconnections[].phaseOutputConnectors` lists SMA connectors used for cable connections to downstream NICs. - `plugins.e810.interconnections[].upstreamPort` specifies the TR port that receives timing from upstream. Set this for both T-BC and T-TSC configurations. - `plugins.e810.pins` configures SMA and U.FL pin directions for each NIC. - `plugins.e810.settings` configures holdover behavior. For details about these parameters, see "Holdover in a grandmaster clock with GNSS as the source". 3. Configure the `ptp4lConf` for the TR port: ```yaml # ... ptp4lConf: | [ens4f1] masterOnly 0 [global] # # Default Data Set # twoStepFlag 1 slaveOnly 0 priority1 128 priority2 128 domainNumber 25 clockClass 248 clockAccuracy 0xFE offsetScaledLogVariance 0xFFFF free_running 0 freq_est_interval 1 dscp_event 0 dscp_general 0 dataset_comparison G.8275.x G.8275.defaultDS.localPriority 128 # # Port Data Set # logAnnounceInterval -3 logSyncInterval -4 logMinDelayReqInterval -4 logMinPdelayReqInterval -4 announceReceiptTimeout 3 syncReceiptTimeout 0 delayAsymmetry 0 fault_reset_interval -4 neighborPropDelayThresh 20000000 masterOnly 0 G.8275.portDS.localPriority 128 # # Run time options # assume_two_step 0 logging_level 6 path_trace_enabled 0 follow_up_info 0 hybrid_e2e 0 inhibit_multicast_service 0 net_sync_monitor 0 tc_spanning_tree 0 tx_timestamp_timeout 50 unicast_listen 0 unicast_master_table 0 unicast_req_duration 3600 use_syslog 1 verbose 0 summary_interval 0 kernel_leap 1 check_fup_sync 0 clock_class_threshold 135 # # Servo Options # pi_proportional_const 0.60 pi_integral_const 0.001 pi_proportional_scale 0.0 pi_proportional_exponent -0.3 pi_proportional_norm_max 0.7 pi_integral_scale 0.0 pi_integral_exponent 0.4 pi_integral_norm_max 0.3 step_threshold 2.0 first_step_threshold 0.00002 max_frequency 900000000 clock_servo pi sanity_freq_limit 200000000 ntpshm_segment 0 # # Transport options # transportSpecific 0x0 ptp_dst_mac AA:BB:CC:DD:EE:HH p2p_dst_mac BB:CC:DD:EE:FF:II udp_ttl 1 udp6_scope 0x0E uds_address /var/run/ptp4l # # Default interface options # clock_type OC network_transport L2 delay_mechanism E2E time_stamping hardware tsproc_mode filter delay_filter moving_median delay_filter_length 10 egressLatency 0 ingressLatency 0 boundary_clock_jbod 1 # # Clock description # productDescription ;; revisionData ;; manufacturerIdentity 00:00:00 userDescription ; timeSource 0xA0 ptp4lOpts: -2 --summary_interval -4 ptpSchedulingPolicy: SCHED_FIFO ptpSchedulingPriority: 10 ptpSettings: inSyncConditionThreshold: "10" inSyncConditionTimes: "12" logReduce: "false" # ... ``` - `spec.profile[].ptp4lConf` defines the `ptp4l` configuration. In the `[ens4f1]` interface section, the `masterOnly 0` setting configures the TR port to receive timing from upstream. - `clock_type OC` sets the TR profile to ordinary clock because it handles only the upstream-facing port. 4. Configure `ts2phc` for all participating NICs: ```yaml # ... ts2phcConf: | [global] use_syslog verbose 1 logging_level 7 ts2phc.pulsewidth 100000000 leapfile /usr/share/zoneinfo/leap-seconds.list domainNumber 25 uds_address /var/run/ptp4l.0.socket [ens4f0] ts2phc.extts_polarity rising ts2phc.extts_correction -10 ts2phc.master 0 [ens1f0] ts2phc.extts_polarity rising ts2phc.extts_correction -27 ts2phc.master 0 [ens8f0] ts2phc.extts_polarity rising ts2phc.extts_correction -27 ts2phc.master 0 ts2phcOpts: -s generic -a --ts2phc.rh_external_pps 1 # ... ``` - The `domainNumber` must match the upstream PTP domain. - Interface sections like `[ens4f0]` list all NICs participating in the configuration. The `ts2phc.extts_correction` values compensate for cable and hardware delays. 5. Define the `recommend` section to apply profiles to nodes: ```yaml # ... recommend: - match: - nodeLabel: node-role.kubernetes.io/master priority: 4 profile: 00-tbc-tt - match: - nodeLabel: node-role.kubernetes.io/master priority: 4 profile: 01-tbc-tr ``` 2. Review the full configuration: ```yaml apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: t-bc namespace: openshift-ptp spec: profile: - name: 00-tbc-tt ptp4lConf: | [ens4f0] masterOnly 1 [ens8f0] masterOnly 1 [ens1f0] masterOnly 1 [global] # # Default Data Set # twoStepFlag 1 slaveOnly 0 priority1 128 priority2 128 domainNumber 25 clockClass 248 clockAccuracy 0xFE offsetScaledLogVariance 0xFFFF free_running 0 freq_est_interval 1 dscp_event 0 dscp_general 0 dataset_comparison G.8275.x G.8275.defaultDS.localPriority 128 # # Port Data Set # logAnnounceInterval -3 logSyncInterval -4 logMinDelayReqInterval -4 logMinPdelayReqInterval -4 announceReceiptTimeout 3 syncReceiptTimeout 0 delayAsymmetry 0 fault_reset_interval -4 neighborPropDelayThresh 20000000 masterOnly 0 G.8275.portDS.localPriority 128 # # Run time options # assume_two_step 0 logging_level 6 path_trace_enabled 0 follow_up_info 0 hybrid_e2e 0 inhibit_multicast_service 0 net_sync_monitor 0 tc_spanning_tree 0 tx_timestamp_timeout 50 unicast_listen 0 unicast_master_table 0 unicast_req_duration 3600 use_syslog 1 verbose 0 summary_interval 0 kernel_leap 1 check_fup_sync 0 clock_class_threshold 135 # # Servo Options # pi_proportional_const 0.60 pi_integral_const 0.001 pi_proportional_scale 0.0 pi_proportional_exponent -0.3 pi_proportional_norm_max 0.7 pi_integral_scale 0.0 pi_integral_exponent 0.4 pi_integral_norm_max 0.3 step_threshold 2.0 first_step_threshold 0.00002 max_frequency 900000000 clock_servo pi sanity_freq_limit 200000000 ntpshm_segment 0 # # Transport options # transportSpecific 0x0 ptp_dst_mac AA:BB:CC:DD:EE:FF p2p_dst_mac BB:CC:DD:EE:FF:GG udp_ttl 1 udp6_scope 0x0E uds_address /var/run/ptp4l # # Default interface options # clock_type BC network_transport L2 delay_mechanism E2E time_stamping hardware tsproc_mode filter delay_filter moving_median delay_filter_length 10 egressLatency 0 ingressLatency 0 boundary_clock_jbod 1 # # Clock description # productDescription ;; revisionData ;; manufacturerIdentity 00:00:00 userDescription ; timeSource 0xA0 ptp4lOpts: -2 --summary_interval -4 ptpSchedulingPolicy: SCHED_FIFO ptpSchedulingPriority: 10 ptpSettings: controllingProfile: 01-tbc-tr logReduce: "false" - name: 01-tbc-tr phc2sysOpts: -r -n 25 -N 8 -R 16 -u 0 -m -s ens4f1 plugins: e810: enableDefaultConfig: false interconnections: - gnssInput: false id: ens4f0 part: E810-XXVDA4T phaseOutputConnectors: - SMA1 - SMA2 upstreamPort: ens4f1 - id: ens1f0 inputConnector: connector: SMA1 part: E810-XXVDA4T - id: ens8f0 inputConnector: connector: SMA1 part: E810-XXVDA4T pins: ens4f0: SMA1: 2 1 SMA2: 2 2 U.FL1: 0 1 U.FL2: 0 2 ens1f0: SMA1: 1 1 SMA2: 0 2 U.FL1: 0 1 U.FL2: 0 2 ens8f0: SMA1: 1 1 SMA2: 0 2 U.FL1: 0 1 U.FL2: 0 2 settings: LocalHoldoverTimeout: 14400 LocalMaxHoldoverOffSet: 1500 MaxInSpecOffset: 100 ptp4lConf: | [ens4f1] masterOnly 0 [global] # # Default Data Set # twoStepFlag 1 slaveOnly 0 priority1 128 priority2 128 domainNumber 25 clockClass 248 clockAccuracy 0xFE offsetScaledLogVariance 0xFFFF free_running 0 freq_est_interval 1 dscp_event 0 dscp_general 0 dataset_comparison G.8275.x G.8275.defaultDS.localPriority 128 # # Port Data Set # logAnnounceInterval -3 logSyncInterval -4 logMinDelayReqInterval -4 logMinPdelayReqInterval -4 announceReceiptTimeout 3 syncReceiptTimeout 0 delayAsymmetry 0 fault_reset_interval -4 neighborPropDelayThresh 20000000 masterOnly 0 G.8275.portDS.localPriority 128 # # Run time options # assume_two_step 0 logging_level 6 path_trace_enabled 0 follow_up_info 0 hybrid_e2e 0 inhibit_multicast_service 0 net_sync_monitor 0 tc_spanning_tree 0 tx_timestamp_timeout 50 unicast_listen 0 unicast_master_table 0 unicast_req_duration 3600 use_syslog 1 verbose 0 summary_interval 0 kernel_leap 1 check_fup_sync 0 clock_class_threshold 135 # # Servo Options # pi_proportional_const 0.60 pi_integral_const 0.001 pi_proportional_scale 0.0 pi_proportional_exponent -0.3 pi_proportional_norm_max 0.7 pi_integral_scale 0.0 pi_integral_exponent 0.4 pi_integral_norm_max 0.3 step_threshold 2.0 first_step_threshold 0.00002 max_frequency 900000000 clock_servo pi sanity_freq_limit 200000000 ntpshm_segment 0 # # Transport options # transportSpecific 0x0 ptp_dst_mac AA:BB:CC:DD:EE:HH p2p_dst_mac BB:CC:DD:EE:FF:II udp_ttl 1 udp6_scope 0x0E uds_address /var/run/ptp4l # # Default interface options # clock_type OC network_transport L2 delay_mechanism E2E time_stamping hardware tsproc_mode filter delay_filter moving_median delay_filter_length 10 egressLatency 0 ingressLatency 0 boundary_clock_jbod 1 # # Clock description # productDescription ;; revisionData ;; manufacturerIdentity 00:00:00 userDescription ; timeSource 0xA0 ptp4lOpts: -2 --summary_interval -4 ptpSchedulingPolicy: SCHED_FIFO ptpSchedulingPriority: 10 ptpSettings: inSyncConditionThreshold: "10" inSyncConditionTimes: "12" logReduce: "false" ts2phcConf: | [global] use_syslog 0 verbose 1 logging_level 7 ts2phc.pulsewidth 100000000 leapfile /usr/share/zoneinfo/leap-seconds.list domainNumber 25 uds_address /var/run/ptp4l.0.socket [ens4f0] ts2phc.extts_polarity rising ts2phc.extts_correction -10 ts2phc.master 0 [ens1f0] ts2phc.extts_polarity rising ts2phc.extts_correction -27 ts2phc.master 0 [ens8f0] ts2phc.extts_polarity rising ts2phc.extts_correction -27 ts2phc.master 0 ts2phcOpts: -s generic -a --ts2phc.rh_external_pps 1 recommend: - match: - nodeLabel: node-role.kubernetes.io/master priority: 4 profile: 00-tbc-tt - match: - nodeLabel: node-role.kubernetes.io/master priority: 4 profile: 01-tbc-tr ``` > [!NOTE] > This example shows a multi-card T-BC configuration with three NICs. To adapt for other scenarios: > > T-TSC: > > - Remove the `00-tbc-tt` profile entirely > - Set `clock_type` to `OC` in the TR profile > - In `ts2phcConf`, list only the TR NIC > > Single-card T-BC: > > - In the TT profile, list only ports from the same NIC as the TR port > - Remove additional NIC entries from the `interconnections` and `pins` sections > - In `ts2phcConf`, list only the single NIC > - Set `phaseOutputConnectors` to an empty array or disable all pins if not using SMA outputs 3. Save the configuration to a file, for example `t-bc-holdover-config.yaml`, and apply it: ```terminal $ oc apply -f t-bc-holdover-config.yaml ``` **Verification** - Get the status of the T-BC by running the following command: ```terminal $ oc logs ds/linuxptp-daemon -n openshift-ptp -c linuxptp-daemon-container --since=1s -f | grep T-BC ``` ```terminal {title="Example output"} T-BC[1760525446]:[ts2phc.1.config] ens4f0 offset 1 T-BC-STATUS s2 T-BC[1760525447]:[ts2phc.1.config] ens4f0 offset 1 T-BC-STATUS s2 T-BC[1760525448]:[ts2phc.1.config] ens4f0 offset -1 T-BC-STATUS s2 ``` The status is reported every second: - `s2`: Locked - synchronized with the upstream clock - `s1`: Holdover - upstream source lost, internal oscillator maintaining timing - `s0`: Unlocked - holdover limits exceeded or no valid holdover data **Additional resources** {._additional-resources} - [Grandmaster clock class sync state reference](/openshift-docs-markdown/networking/advanced_networking/ptp/configuring-ptp#nw-ptp-grandmaster-clock-class-reference_configuring-ptp) ## Configuring GNR-D T-BC holdover on a GNR-D platform {#nw-ptp-gnrd-t-bc-holdover_configuring-ptp} You can configure an Intel® Granite Rapids-D (GNR-D) platform device as telecom boundary clock (T-BC) with holdover support by using the PTP Operator. > [!IMPORTANT] > Configuring GNR-D T-BC holdover on a GNR-D platform is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. > > For more information about the support scope of Red Hat Technology Preview features, see [Technology Preview Features Support Scope](https://access.redhat.com/support/offerings/techpreview/). In this configuration, one time receiver (TR) port synchronizes to an upstream telecom grandmaster clock, while time transmitter (TT) ports distribute synchronized time to downstream devices. If the upstream timing source degrades, disconnects, or becomes unavailable, the system enters holdover mode and maintains timing by using configured digital phase-locked loop (DPLL) devices. This configuration requires path-based network interface naming so that the system can consistently identify NAC and Carter Flat interfaces across the deployment. The configuration uses the following custom resources: - `MachineConfig`: Configures path-based network interface naming for NAC and Carter Flat devices. - `PtpConfig`: Configures the PTP boundary clock profile and timing behavior. - `HardwareConfig`: Configures supported hardware-specific timing and synchronization settings. For more information about `MachineConfig` custom resource, see *Additional resources*. **Prerequisites** - Install the OpenShift CLI (`oc`). - Log in as a user with `cluster-admin` privileges. - Install the PTP Operator. - Deploy a GNR-D platform with supported NIC hardware. - Identify the TR and TT interfaces for your hardware layout. **Procedure** 1. Configure path-based network interface naming for the GNR-D platform: ```yaml apiVersion: machineconfiguration.openshift.io/v1 kind: MachineConfig metadata: name: 10-rename-gnrd-interfaces-master labels: machineconfiguration.openshift.io/role: master spec: config: ignition: version: 3.2.0 storage: files: - path: /etc/systemd/network/10-interface-8086-12d3.link # [Match] # Property=ID_VENDOR_ID=0x8086 # Property=ID_MODEL_ID=0x12d3 # [Link] # NamePolicy=path mode: 420 overwrite: true contents: source: data:text/plain,%5BMatch%5D%0AProperty%3DID_VENDOR_ID%3D0x8086%0AProperty%3DID_MODEL_ID%3D0x12d3%0A%0A%5BLink%5D%0ANamePolicy%3Dpath%0A ``` - This configuration sets `NamePolicy=path` so that network interfaces use stable path-based names. 2. Apply the `MachineConfig` CR by running the following command: ```terminal $ oc apply -f gnrd-interface-names.yaml ``` 3. Create a `PtpConfig` CR with separate TT and TR profiles: ```yaml apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: t-bc namespace: openshift-ptp spec: profile: - name: 00-tbc-tt ptp4lConf: | [eno8803] masterOnly 1 [eno8903] masterOnly 1 [eno9003] masterOnly 1 [eno8303] masterOnly 1 [eno8403] masterOnly 1 [eno8503] masterOnly 1 [eno8603] masterOnly 1 [enp108s0f0] masterOnly 1 [enp108s0f1] masterOnly 1 [enp108s0f2] masterOnly 1 [enp108s0f3] masterOnly 1 [enp108s0f4] masterOnly 1 [enp108s0f5] masterOnly 1 [enp108s0f6] masterOnly 1 [enp108s0f7] masterOnly 1 [enp109s0f0] masterOnly 1 [enp109s0f1] masterOnly 1 [enp109s0f2] masterOnly 1 [enp109s0f3] masterOnly 1 [enp109s0f4] masterOnly 1 [enp109s0f5] masterOnly 1 [enp109s0f6] masterOnly 1 [enp109s0f7] masterOnly 1 [global] # # Default Data Set # twoStepFlag 1 slaveOnly 0 priority1 128 priority2 128 domainNumber 24 #utc_offset 37 clockClass 248 clockAccuracy 0xFE offsetScaledLogVariance 0xFFFF free_running 0 freq_est_interval 1 dscp_event 0 dscp_general 0 dataset_comparison G.8275.x G.8275.defaultDS.localPriority 128 # # Port Data Set # logAnnounceInterval -3 logSyncInterval -4 logMinDelayReqInterval -4 logMinPdelayReqInterval -4 announceReceiptTimeout 3 syncReceiptTimeout 0 delayAsymmetry 0 fault_reset_interval -4 neighborPropDelayThresh 20000000 masterOnly 0 G.8275.portDS.localPriority 128 # # Run time options # assume_two_step 0 logging_level 6 path_trace_enabled 0 follow_up_info 0 hybrid_e2e 0 inhibit_multicast_service 0 net_sync_monitor 0 tc_spanning_tree 0 tx_timestamp_timeout 50 unicast_listen 0 unicast_master_table 0 unicast_req_duration 3600 use_syslog 1 verbose 0 summary_interval 0 kernel_leap 1 check_fup_sync 0 clock_class_threshold 135 # # Servo Options # pi_proportional_const 0.60 pi_integral_const 0.001 pi_proportional_scale 0.0 pi_proportional_exponent -0.3 pi_proportional_norm_max 0.7 pi_integral_scale 0.0 pi_integral_exponent 0.4 pi_integral_norm_max 0.3 step_threshold 2.0 first_step_threshold 0.00002 max_frequency 900000000 clock_servo pi sanity_freq_limit 200000000 ntpshm_segment 0 # # Transport options # transportSpecific 0x0 ptp_dst_mac 01:1B:19:00:00:00 p2p_dst_mac 01:80:C2:00:00:0E udp_ttl 1 udp6_scope 0x0E uds_address /var/run/ptp4l # # Default interface options # clock_type BC network_transport L2 delay_mechanism E2E time_stamping hardware tsproc_mode filter delay_filter moving_median delay_filter_length 10 egressLatency 0 ingressLatency 0 boundary_clock_jbod 1 # # Clock description # productDescription ;; revisionData ;; manufacturerIdentity 00:00:00 userDescription ; timeSource 0xA0 ptp4lOpts: -2 --summary_interval -4 ptpSchedulingPolicy: SCHED_FIFO ptpSchedulingPriority: 10 ptpSettings: controllingProfile: 01-tbc-tr logReduce: "false" - name: 01-tbc-tr phc2sysOpts: -r -n 24 -N 8 -R 16 -u 0 -m -s eno8703 ptp4lConf: | # The interface name is hardware-specific [eno8703] masterOnly 0 [global] # # Default Data Set # twoStepFlag 1 slaveOnly 0 priority1 128 priority2 128 domainNumber 24 #utc_offset 37 clockClass 248 clockAccuracy 0xFE offsetScaledLogVariance 0xFFFF free_running 0 freq_est_interval 1 dscp_event 0 dscp_general 0 dataset_comparison G.8275.x G.8275.defaultDS.localPriority 128 # # Port Data Set # logAnnounceInterval -3 logSyncInterval -4 logMinDelayReqInterval -4 logMinPdelayReqInterval -4 announceReceiptTimeout 3 syncReceiptTimeout 0 delayAsymmetry 0 fault_reset_interval -4 neighborPropDelayThresh 20000000 masterOnly 0 G.8275.portDS.localPriority 128 # # Run time options # assume_two_step 0 logging_level 6 path_trace_enabled 0 follow_up_info 0 hybrid_e2e 0 inhibit_multicast_service 0 net_sync_monitor 0 tc_spanning_tree 0 tx_timestamp_timeout 50 unicast_listen 0 unicast_master_table 0 unicast_req_duration 3600 use_syslog 1 verbose 0 summary_interval 0 kernel_leap 1 check_fup_sync 0 clock_class_threshold 135 # # Servo Options # pi_proportional_const 0.60 pi_integral_const 0.001 pi_proportional_scale 0.0 pi_proportional_exponent -0.3 pi_proportional_norm_max 0.7 pi_integral_scale 0.0 pi_integral_exponent 0.4 pi_integral_norm_max 0.3 step_threshold 2.0 first_step_threshold 0.00002 max_frequency 900000000 clock_servo pi sanity_freq_limit 200000000 ntpshm_segment 0 # # Transport options # transportSpecific 0x0 ptp_dst_mac 01:1B:19:00:00:00 p2p_dst_mac 01:80:C2:00:00:0E udp_ttl 1 udp6_scope 0x0E uds_address /var/run/ptp4l # # Default interface options # clock_type OC network_transport L2 delay_mechanism E2E time_stamping hardware tsproc_mode filter delay_filter moving_median delay_filter_length 10 egressLatency 0 ingressLatency 0 boundary_clock_jbod 1 # # Clock description # productDescription ;; revisionData ;; manufacturerIdentity 00:00:00 userDescription ; timeSource 0xA0 ptp4lOpts: -2 --summary_interval -4 ptpSchedulingPolicy: SCHED_FIFO ptpSchedulingPriority: 10 ptpSettings: clockType: T-BC inSyncConditionThreshold: "10" inSyncConditionTimes: "12" logReduce: "false" ts2phcConf: | [global] use_syslog 0 verbose 1 logging_level 7 ts2phc.pulsewidth 500000000 leapfile /usr/share/zoneinfo/leap-seconds.list domainNumber 24 uds_address /var/run/ptp4l.1.socket [eno8703] ts2phc.extts_correction 0 ts2phc.master 0 ts2phc.channel 0 ts2phc.pin_index 1 [enp108s0f0] ts2phc.extts_correction 0 ts2phc.master 0 ts2phc.channel 0 ts2phc.pin_index 1 [enp109s0f0] ts2phc.extts_polarity rising ts2phc.extts_correction 0 ts2phc.master 0 ts2phc.channel 0 ts2phc.pin_index 1 ts2phcOpts: -s generic -a --ts2phc.rh_external_pps 1 recommend: - match: - nodeLabel: node-role.kubernetes.io/master priority: 4 profile: 00-tbc-tt - match: - nodeLabel: node-role.kubernetes.io/master priority: 4 profile: 01-tbc-tr ``` - The TT profile configures downstream-facing ports. - The TR profile configures the upstream-facing port, `phc2sys`, and `ts2phc`. - `controllingProfile` links the TT profile to the TR profile. - `clockType: T-BC` enables telecom boundary clock behavior. 4. Apply the `PtpConfig` CR by running the following command: ```terminal $ oc apply -f t-bc-config.yaml ``` 5. Create a `HardwareConfig` CR to configure holdover thresholds: ```yaml apiVersion: ptp.openshift.io/v2alpha1 kind: HardwareConfig metadata: name: t-bc spec: profile: name: GNR-D-T-BC clockType: T-BC clockChain: structure: - name: leader hardwareSpecificDefinitions: dpll: holdoverParameters: maxInSpecOffset: 40 localMaxHoldoverOffset: 1500 localHoldoverTimeout: 14400 relatedPtpProfileName: 01-tbc-tr ``` - `hardwareSpecificDefinitions: ` applies hardware-specific behavior of the GNR-D platform. Replace `` with the GNR-D platform on which you want to configure T-BC holdover. The supported GNR-D platforms are `dell/XR8720t` and `hpe/EL140-Gen12`. - `holdoverParameters` configure DPLL holdover thresholds. - `relatedPtpProfileName` links the hardware profile to the TR profile. 6. Apply the `HardwareConfig` CR by running the following command: ```terminal $ oc apply -f hardwareconfig.yaml ``` **Verification** - Verify that the `PtpConfig` and `HardwareConfig` resources are deployed: ```terminal $ oc get ptpconfig -n openshift-ptp $ oc get hardwareconfig ``` - Check the `linuxptp-daemon` logs: ```terminal $ oc logs ds/linuxptp-daemon -n openshift-ptp -c linuxptp-daemon-container --since=1s -f | grep T-BC ``` ```terminal {title="Example output"} T-BC[1760525446]:[ts2phc.1.config] eno8703 offset 1 T-BC-STATUS s2 T-BC[1760525447]:[ts2phc.1.config] eno8703 offset 1 T-BC-STATUS s1 ``` The status is reported every second: - `s2`: Locked - synchronized with the upstream clock - `s1`: Holdover - upstream source lost, internal oscillator maintaining timing - `s0`: Unlocked - holdover limits exceeded or no valid holdover data **Additional resources** {._additional-resources} - [Machine Configuration documentation](/openshift-docs-markdown/machine_configuration/index#machine-config-index) ## Configuring dynamic leap seconds handling for PTP grandmaster clocks {#ptp-configuring-dynamic-leap-seconds-handling-for-tgm_configuring-ptp} The PTP Operator container image includes the latest `leap-seconds.list` file that is available at the time of release. You can configure the PTP Operator to automatically update the leap second file by using Global Positioning System (GPS) announcements. Leap second information is stored in an automatically generated `ConfigMap` resource named `leap-configmap` in the `openshift-ptp` namespace. The PTP Operator mounts the `leap-configmap` resource as a volume in the `linuxptp-daemon` pod that is accessible by the `ts2phc` process. If the GPS satellite broadcasts new leap second data, the PTP Operator updates the `leap-configmap` resource with the new data. The `ts2phc` process picks up the changes automatically. > [!NOTE] > The following procedure is provided as reference. The 4.22 version of the PTP Operator enables automatic leap second management by default. **Prerequisites** - You have installed the OpenShift CLI (`oc`). - You have logged in as a user with `cluster-admin` privileges. - You have installed the PTP Operator and configured a PTP grandmaster clock (T-GM) in the cluster. **Procedure** 1. Configure automatic leap second handling in the `phc2sysOpts` section of the `PtpConfig` CR. Set the following options: ```yaml phc2sysOpts: -r -u 0 -m -N 8 -R 16 -S 2 -s ens2f0 -n 24 ``` > [!NOTE] > Previously, the T-GM required an offset adjustment in the `phc2sys` configuration (`-O -37`) to account for historical leap seconds. This is no longer needed. 2. Configure the Intel e810 NIC to enable periodical reporting of `NAV-TIMELS` messages by the GPS receiver in the `spec.profile.plugins.e810.ublxCmds` section of the `PtpConfig` CR. For example: ```yaml - args: #ubxtool -P 29.20 -p CFG-MSG,1,38,248 - "-P" - "29.20" - "-p" - "CFG-MSG,1,38,248" ``` **Verification** 1. Validate that the configured T-GM is receiving `NAV-TIMELS` messages from the connected GPS. Run the following command: ```terminal $ oc -n openshift-ptp -c linuxptp-daemon-container exec -it $(oc -n openshift-ptp get pods -o name | grep daemon) -- ubxtool -t -p NAV-TIMELS -P 29.20 ``` ```terminal {title="Example output"} 1722509534.4417 UBX-NAV-STATUS: iTOW 384752000 gpsFix 5 flags 0xdd fixStat 0x0 flags2 0x8 ttff 18261, msss 1367642864 1722509534.4419 UBX-NAV-TIMELS: iTOW 384752000 version 0 reserved2 0 0 0 srcOfCurrLs 2 currLs 18 srcOfLsChange 2 lsChange 0 timeToLsEvent 70376866 dateOfLsGpsWn 2441 dateOfLsGpsDn 7 reserved2 0 0 0 valid x3 1722509534.4421 UBX-NAV-CLOCK: iTOW 384752000 clkB 784281 clkD 435 tAcc 3 fAcc 215 1722509535.4477 UBX-NAV-STATUS: iTOW 384753000 gpsFix 5 flags 0xdd fixStat 0x0 flags2 0x8 ttff 18261, msss 1367643864 1722509535.4479 UBX-NAV-CLOCK: iTOW 384753000 clkB 784716 clkD 435 tAcc 3 fAcc 218 ``` 2. Validate that the `leap-configmap` resource has been successfully generated by the PTP Operator and is up to date with the latest version of the [leap-seconds.list](https://hpiers.obspm.fr/iers/bul/bulc/ntp/leap-seconds.list). Run the following command: ```terminal $ oc -n openshift-ptp get configmap leap-configmap -o jsonpath='{.data.}' ``` Replace `` with the node where you have installed and configured the PTP T-GM clock with automatic leap second management. Escape special characters in the node name. For example, `node-1\.example\.com`. ```terminal {title="Example output"} # Do not edit # This file is generated automatically by linuxptp-daemon #$ 3913697179 #@ 4291747200 2272060800 10 # 1 Jan 1972 2287785600 11 # 1 Jul 1972 2303683200 12 # 1 Jan 1973 2335219200 13 # 1 Jan 1974 2366755200 14 # 1 Jan 1975 2398291200 15 # 1 Jan 1976 2429913600 16 # 1 Jan 1977 2461449600 17 # 1 Jan 1978 2492985600 18 # 1 Jan 1979 2524521600 19 # 1 Jan 1980 2571782400 20 # 1 Jul 1981 2603318400 21 # 1 Jul 1982 2634854400 22 # 1 Jul 1983 2698012800 23 # 1 Jul 1985 2776982400 24 # 1 Jan 1988 2840140800 25 # 1 Jan 1990 2871676800 26 # 1 Jan 1991 2918937600 27 # 1 Jul 1992 2950473600 28 # 1 Jul 1993 2982009600 29 # 1 Jul 1994 3029443200 30 # 1 Jan 1996 3076704000 31 # 1 Jul 1997 3124137600 32 # 1 Jan 1999 3345062400 33 # 1 Jan 2006 3439756800 34 # 1 Jan 2009 3550089600 35 # 1 Jul 2012 3644697600 36 # 1 Jul 2015 3692217600 37 # 1 Jan 2017 #h e65754d4 8f39962b aa854a61 661ef546 d2af0bfa ``` ## Configuring linuxptp services as a boundary clock {#configuring-linuxptp-services-as-boundary-clock_configuring-ptp} You can configure the `linuxptp` services (`ptp4l`, `phc2sys`) as boundary clock by creating a `PtpConfig` custom resource (CR) object. > [!NOTE] > Use the following example `PtpConfig` CR as the basis to configure `linuxptp` services as the boundary clock for your particular hardware and environment. This example CR does not configure PTP fast events. To configure PTP fast events, set appropriate values for `ptp4lOpts`, `ptp4lConf`, and `ptpClockThreshold`. `ptpClockThreshold` is used only when events are enabled. See "Configuring the PTP fast event notifications publisher" for more information. **Prerequisites** - Install the OpenShift CLI (`oc`). - Log in as a user with `cluster-admin` privileges. - Install the PTP Operator. **Procedure** 1. Create the following `PtpConfig` CR, and then save the YAML in the `boundary-clock-ptp-config.yaml` file. ```yaml {title="Example PTP boundary clock configuration"} apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: boundary-clock namespace: openshift-ptp annotations: {} spec: profile: - name: boundary-clock ptp4lOpts: "-2" phc2sysOpts: "-a -r -n 24" ptpSchedulingPolicy: SCHED_FIFO ptpSchedulingPriority: 10 ptpSettings: logReduce: "true" ptp4lConf: | # The interface name is hardware-specific [$iface_slave] masterOnly 0 [$iface_master_1] masterOnly 1 [$iface_master_2] masterOnly 1 [$iface_master_3] masterOnly 1 [global] # # Default Data Set # twoStepFlag 1 slaveOnly 0 priority1 128 priority2 128 domainNumber 24 #utc_offset 37 clockClass 248 clockAccuracy 0xFE offsetScaledLogVariance 0xFFFF free_running 0 freq_est_interval 1 dscp_event 0 dscp_general 0 dataset_comparison G.8275.x G.8275.defaultDS.localPriority 128 # # Port Data Set # logAnnounceInterval -3 logSyncInterval -4 logMinDelayReqInterval -4 logMinPdelayReqInterval -4 announceReceiptTimeout 3 syncReceiptTimeout 0 delayAsymmetry 0 fault_reset_interval -4 neighborPropDelayThresh 20000000 masterOnly 0 G.8275.portDS.localPriority 128 # # Run time options # assume_two_step 0 logging_level 6 path_trace_enabled 0 follow_up_info 0 hybrid_e2e 0 inhibit_multicast_service 0 net_sync_monitor 0 tc_spanning_tree 0 tx_timestamp_timeout 50 unicast_listen 0 unicast_master_table 0 unicast_req_duration 3600 use_syslog 1 verbose 0 summary_interval 0 kernel_leap 1 check_fup_sync 0 clock_class_threshold 135 # # Servo Options # pi_proportional_const 0.0 pi_integral_const 0.0 pi_proportional_scale 0.0 pi_proportional_exponent -0.3 pi_proportional_norm_max 0.7 pi_integral_scale 0.0 pi_integral_exponent 0.4 pi_integral_norm_max 0.3 step_threshold 2.0 first_step_threshold 0.00002 max_frequency 900000000 clock_servo pi sanity_freq_limit 200000000 ntpshm_segment 0 # # Transport options # transportSpecific 0x0 ptp_dst_mac 01:1B:19:00:00:00 p2p_dst_mac 01:80:C2:00:00:0E udp_ttl 1 udp6_scope 0x0E uds_address /var/run/ptp4l # # Default interface options # clock_type BC network_transport L2 delay_mechanism E2E time_stamping hardware tsproc_mode filter delay_filter moving_median delay_filter_length 10 egressLatency 0 ingressLatency 0 boundary_clock_jbod 0 # # Clock description # productDescription ;; revisionData ;; manufacturerIdentity 00:00:00 userDescription ; timeSource 0xA0 recommend: - profile: boundary-clock priority: 4 match: - nodeLabel: "node-role.kubernetes.io/$mcp" ``` **PTP boundary clock CR configuration options** | | | | --- | --- | | CR field | Description | | `name` | The name of the `PtpConfig` CR. | | `profile` | Specify an array of one or more `profile` objects. | | `name` | Specify the name of a profile object which uniquely identifies a profile object. | | `ptp4lOpts` | Specify system config options for the `ptp4l` service. The options should not include the network interface name `-i ` and service config file `-f /etc/ptp4l.conf` because the network interface name and the service config file are automatically appended. | | `ptp4lConf` | Specify the required configuration to start `ptp4l` as boundary clock. For example, `ens1f0` synchronizes from a grandmaster clock and `ens1f3` synchronizes connected devices. | | `` | The interface that receives the synchronization clock. | | `` | The interface that sends the synchronization clock. | | `tx_timestamp_timeout` | For Intel Columbiaville 800 Series NICs, set `tx_timestamp_timeout` to `50`. | | `boundary_clock_jbod` | 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`. | | `phc2sysOpts` | Specify system config options for the `phc2sys` service. If this field is empty, the PTP Operator does not start the `phc2sys` service. | | `ptpSchedulingPolicy` | Scheduling policy for ptp4l and phc2sys processes. Default value is `SCHED_OTHER`. Use `SCHED_FIFO` on systems that support FIFO scheduling. | | `ptpSchedulingPriority` | 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`. | | `ptpClockThreshold` | Optional. If `ptpClockThreshold` is not present, default values are used for the `ptpClockThreshold` fields. `ptpClockThreshold` configures how long after the PTP master clock is disconnected before PTP events are triggered. `holdOverTimeout` is the time value in seconds before the PTP clock event state changes to `FREERUN` when the PTP master clock is disconnected. The `maxOffsetThreshold` and `minOffsetThreshold` settings configure offset values in nanoseconds that compare against the values for `CLOCK_REALTIME` (`phc2sys`) or master offset (`ptp4l`). When the `ptp4l` or `phc2sys` offset value is outside this range, the PTP clock state is set to `FREERUN`. When the offset value is within this range, the PTP clock state is set to `LOCKED`. | | `recommend` | Specify an array of one or more `recommend` objects that define rules on how the `profile` should be applied to nodes. | | `.recommend.profile` | Specify the `.recommend.profile` object name defined in the `profile` section. | | `.recommend.priority` | Specify the `priority` with an integer value between `0` and `99`. A larger number gets lower priority, so a priority of `99` is lower than a priority of `10`. If a node can be matched with multiple profiles according to rules defined in the `match` field, the profile with the higher priority is applied to that node. | | `.recommend.match` | Specify `.recommend.match` rules with `nodeLabel` or `nodeName` values. | | `.recommend.match.nodeLabel` | Set `nodeLabel` with the `key` of the `node.Labels` field from the node object by using the `oc get nodes --show-labels` command. For example, `node-role.kubernetes.io/worker`. | | `.recommend.match.nodeName` | Set `nodeName` with the value of the `node.Name` field from the node object by using the `oc get nodes` command. For example, `compute-1.example.com`. | 2. Create the CR by running the following command: ```terminal $ oc create -f boundary-clock-ptp-config.yaml ``` **Verification** 1. Check that the `PtpConfig` profile is applied to the node. 1. Get the list of pods in the `openshift-ptp` namespace by running the following command: ```terminal $ oc get pods -n openshift-ptp -o wide ``` ```terminal {title="Example output"} NAME READY STATUS RESTARTS AGE IP NODE linuxptp-daemon-4xkbb 1/1 Running 0 43m 10.1.196.24 compute-0.example.com linuxptp-daemon-tdspf 1/1 Running 0 43m 10.1.196.25 compute-1.example.com ptp-operator-657bbb64c8-2f8sj 1/1 Running 0 43m 10.129.0.61 control-plane-1.example.com ``` 2. 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: ```terminal $ oc logs linuxptp-daemon-4xkbb -n openshift-ptp -c linuxptp-daemon-container ``` ```terminal {title="Example output"} I1115 09:41:17.117596 4143292 daemon.go:107] in applyNodePTPProfile I1115 09:41:17.117604 4143292 daemon.go:109] updating NodePTPProfile to: I1115 09:41:17.117607 4143292 daemon.go:110] ------------------------------------ I1115 09:41:17.117612 4143292 daemon.go:102] Profile Name: profile1 I1115 09:41:17.117616 4143292 daemon.go:102] Interface: I1115 09:41:17.117620 4143292 daemon.go:102] Ptp4lOpts: -2 I1115 09:41:17.117623 4143292 daemon.go:102] Phc2sysOpts: -a -r -n 24 I1115 09:41:17.117626 4143292 daemon.go:116] ------------------------------------ ``` **Additional resources** {._additional-resources} - [Configuring FIFO priority scheduling for PTP hardware](/openshift-docs-markdown/networking/advanced_networking/ptp/configuring-ptp#cnf-configuring-fifo-priority-scheduling-for-ptp_configuring-ptp) - [Configuring the PTP fast event notifications publisher](/openshift-docs-markdown/networking/advanced_networking/ptp/ptp-cloud-events-consumer-dev-reference-v2#cnf-configuring-the-ptp-fast-event-publisher-v2_ptp-consumer) ### Configuring linuxptp services as boundary clocks for dual-NIC hardware {#ptp-configuring-linuxptp-services-as-bc-for-dual-nic_configuring-ptp} You can configure the `linuxptp` services (`ptp4l`, `phc2sys`) as boundary clocks for dual-NIC hardware by creating a `PtpConfig` custom resource (CR) object for each NIC. Dual NIC hardware allows you to connect each NIC to the same upstream leader clock with separate `ptp4l` instances for each NIC feeding the downstream clocks. **Prerequisites** - Install the OpenShift CLI (`oc`). - Log in as a user with `cluster-admin` privileges. - Install the PTP Operator. **Procedure** 1. Create two separate `PtpConfig` CRs, one for each NIC, using the reference CR in "Configuring linuxptp services as a boundary clock" as the basis for each CR. For example: 1. Create `boundary-clock-ptp-config-nic1.yaml`, specifying values for `phc2sysOpts`: ```yaml apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: boundary-clock-ptp-config-nic1 namespace: openshift-ptp spec: profile: - name: "profile1" ptp4lOpts: "-2 --summary_interval -4" ptp4lConf: | [ens5f1] masterOnly 1 [ens5f0] masterOnly 0 ... phc2sysOpts: "-a -r -m -n 24 -N 8 -R 16" ``` where: `ptp4lConf` : Specifies the required interfaces to start `ptp4l` as a boundary clock. For example, `ens5f0` synchronizes from a grandmaster clock and `ens5f1` synchronizes connected devices. `phc2sysOpts: "-a -r -m -n 24 -N 8 -R 16"` : Sets the required `phc2sysOpts` values. `-m` prints messages to `stdout`. The `linuxptp-daemon` `DaemonSet` parses the logs and generates Prometheus metrics. 2. Create `boundary-clock-ptp-config-nic2.yaml`, removing the `phc2sysOpts` field altogether to disable the `phc2sys` service for the second NIC: ```yaml apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: boundary-clock-ptp-config-nic2 namespace: openshift-ptp spec: profile: - name: "profile2" ptp4lOpts: "-2 --summary_interval -4" ptp4lConf: | [ens7f1] masterOnly 1 [ens7f0] masterOnly 0 ... ``` Specify the required interfaces to start `ptp4l` as a boundary clock on the second NIC. > [!NOTE] > You must completely remove the `phc2sysOpts` field from the second `PtpConfig` CR to disable the `phc2sys` service on the second NIC. 2. Create the dual-NIC `PtpConfig` CRs by running the following commands: 1. Create the CR that configures PTP for the first NIC: ```terminal $ oc create -f boundary-clock-ptp-config-nic1.yaml ``` 2. Create the CR that configures PTP for the second NIC: ```terminal $ oc create -f boundary-clock-ptp-config-nic2.yaml ``` **Verification** - Check that the PTP Operator has applied the `PtpConfig` CRs for both NICs. Examine the logs for the `linuxptp` daemon corresponding to the node that has the dual-NIC hardware installed. For example, run the following command: ```terminal $ oc logs linuxptp-daemon-cvgr6 -n openshift-ptp -c linuxptp-daemon-container ``` ```terminal {title="Example output"} ptp4l[80828.335]: [ptp4l.1.config] master offset 5 s2 freq -5727 path delay 519 ptp4l[80828.343]: [ptp4l.0.config] master offset -5 s2 freq -10607 path delay 533 phc2sys[80828.390]: [ptp4l.0.config] CLOCK_REALTIME phc offset 1 s2 freq -87239 delay 539 ``` ### Configuring linuxptp as a highly available system clock for dual-NIC Intel E810 PTP boundary clocks {#ptp-configuring-linuxptp-services-as-ha-bc-for-dual-nic_configuring-ptp} You can configure the `linuxptp` services `ptp4l` and `phc2sys` as a highly available (HA) system clock for dual PTP boundary clocks (T-BC). The highly available system clock uses multiple time sources from dual-NIC Intel E810 Salem channel hardware configured as two boundary clocks. Two boundary clocks instances participate in the HA setup, each with its own configuration profile. You connect each NIC to the same upstream leader clock with separate `ptp4l` instances for each NIC feeding the downstream clocks. Create two `PtpConfig` custom resource (CR) objects that configure the NICs as T-BC and a third `PtpConfig` CR that configures high availability between the two NICs. > [!IMPORTANT] > You set `phc2SysOpts` options once in the `PtpConfig` CR that configures HA. Set the `phc2sysOpts` field to an empty string in the `PtpConfig` CRs that configure the two NICs. This prevents individual `phc2sys` processes from being set up for the two profiles. The third `PtpConfig` CR configures a highly available system clock service. The CR sets the `ptp4lOpts` field to an empty string to prevent the `ptp4l` process from running. The CR adds profiles for the `ptp4l` configurations under the `spec.profile.ptpSettings.haProfiles` key and passes the kernel socket path of those profiles to the `phc2sys` service. When a `ptp4l` failure occurs, the `phc2sys` service switches to the backup `ptp4l` configuration. When the primary profile becomes active again, the `phc2sys` service reverts to the original state. > [!IMPORTANT] > Ensure that you set `spec.recommend.priority` to the same value for all three `PtpConfig` CRs that you use to configure HA. **Prerequisites** - Install the OpenShift CLI (`oc`). - Log in as a user with `cluster-admin` privileges. - Install the PTP Operator. - Configure a cluster node with Intel E810 Salem channel dual-NIC. **Procedure** 1. Create two separate `PtpConfig` CRs, one for each NIC, using the CRs in "Configuring linuxptp services as boundary clocks for dual-NIC hardware" as a reference for each CR. 1. Create the `ha-ptp-config-nic1.yaml` file, specifying an empty string for the `phc2sysOpts` field. For example: ```yaml apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: ha-ptp-config-nic1 namespace: openshift-ptp spec: profile: - name: "ha-ptp-config-profile1" ptp4lOpts: "-2 --summary_interval -4" ptp4lConf: | [ens5f1] masterOnly 1 [ens5f0] masterOnly 0 #... phc2sysOpts: "" ``` where: `ptp4lConf` : Specifies the required interfaces to start `ptp4l` as a boundary clock. For example, `ens5f0` synchronizes from a grandmaster clock and `ens5f1` synchronizes connected devices. `phc2sysOpts: ""` : Sets `phc2sysOpts` with an empty string. These values are populated from the `spec.profile.ptpSettings.haProfiles` field of the `PtpConfig` CR that configures high availability. 2. Apply the `PtpConfig` CR for NIC 1 by running the following command: ```terminal $ oc create -f ha-ptp-config-nic1.yaml ``` 3. Create the `ha-ptp-config-nic2.yaml` file, specifying an empty string for the `phc2sysOpts` field. For example: ```yaml apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: ha-ptp-config-nic2 namespace: openshift-ptp spec: profile: - name: "ha-ptp-config-profile2" ptp4lOpts: "-2 --summary_interval -4" ptp4lConf: | [ens7f1] masterOnly 1 [ens7f0] masterOnly 0 #... phc2sysOpts: "" ``` 4. Apply the `PtpConfig` CR for NIC 2 by running the following command: ```terminal $ oc create -f ha-ptp-config-nic2.yaml ``` 2. Create the `PtpConfig` CR that configures the HA system clock. For example: 1. Create the `ptp-config-for-ha.yaml` file. Set `haProfiles` to match the `metadata.name` fields that are set in the `PtpConfig` CRs that configure the two NICs. For example: `haProfiles: ha-ptp-config-nic1,ha-ptp-config-nic2` ```yaml apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: boundary-ha namespace: openshift-ptp annotations: {} spec: profile: - name: "boundary-ha" ptp4lOpts: "" phc2sysOpts: "-a -r -n 24" ptpSchedulingPolicy: SCHED_FIFO ptpSchedulingPriority: 10 ptpSettings: logReduce: "true" haProfiles: "$profile1,$profile2" recommend: - profile: "boundary-ha" priority: 4 match: - nodeLabel: "node-role.kubernetes.io/$mcp" ``` Set the `ptp4lOpts` field to an empty string. If it is not empty, the `p4ptl` process starts with a critical error. > [!IMPORTANT] > Do not apply the high availability `PtpConfig` CR before the `PtpConfig` CRs that configure the individual NICs. 2. Apply the HA `PtpConfig` CR by running the following command: ```terminal $ oc create -f ptp-config-for-ha.yaml ``` **Verification** - Verify that the PTP Operator has applied the `PtpConfig` CRs correctly. Perform the following steps: 1. Get the list of pods in the `openshift-ptp` namespace by running the following command: ```terminal $ oc get pods -n openshift-ptp -o wide ``` ```terminal {title="Example output"} NAME READY STATUS RESTARTS AGE IP NODE linuxptp-daemon-4xkrb 1/1 Running 0 43m 10.1.196.24 compute-0.example.com ptp-operator-657bbq64c8-2f8sj 1/1 Running 0 43m 10.129.0.61 control-plane-1.example.com ``` > [!NOTE] > There should be only one `linuxptp-daemon` pod. 2. Check that the profile is correct by running the following command. Examine the logs of the `linuxptp` daemon that corresponds to the node you specified in the `PtpConfig` profile. ```terminal $ oc logs linuxptp-daemon-4xkrb -n openshift-ptp -c linuxptp-daemon-container ``` ```terminal {title="Example output"} I1115 09:41:17.117596 4143292 daemon.go:107] in applyNodePTPProfile I1115 09:41:17.117604 4143292 daemon.go:109] updating NodePTPProfile to: I1115 09:41:17.117607 4143292 daemon.go:110] ------------------------------------ I1115 09:41:17.117612 4143292 daemon.go:102] Profile Name: ha-ptp-config-profile1 I1115 09:41:17.117616 4143292 daemon.go:102] Interface: I1115 09:41:17.117620 4143292 daemon.go:102] Ptp4lOpts: -2 I1115 09:41:17.117623 4143292 daemon.go:102] Phc2sysOpts: -a -r -n 24 I1115 09:41:17.117626 4143292 daemon.go:116] ------------------------------------ ``` ### Boundary clocks without holdover on Intel Granite Rapids-D hardware {#nw-ptp-granite-rapids-boundary-clock-overview_configuring-ptp} Intel Granite Rapids-D (GNR-D) server platforms support Precision Time Protocol (PTP) boundary clock (BC) deployments without holdover for high-density Radio Access Network (RAN) sites that use onboard Network Acceleration Complex (NAC) ports and optional Carter Flat expansion network interface cards (NICs). In a BC deployment, one time receiver (TR) port synchronizes to an upstream timing source while time transmitter (TT) ports distribute synchronized time to downstream devices. GNR-D platforms use platform-specific `PtpConfig` plugin configurations and internal timing paths. Before you configure a BC profile on GNR-D hardware, verify that your qualified hardware layout, interface naming, and plugin configuration align with your deployment requirements. GNR-D BC deployments use onboard NAC ports as the primary timing controller and can extend timing distribution by using optional Carter Flat expansion NICs. GNR-D platforms route synchronization internally instead of using external timing cabling. Your qualified hardware layout determines the available TR and TT port roles across NAC ports and optional Carter Flat expansion cards. #### Boundary clock without holdover behavior {#nw-ptp-granite-rapids-boundary-clock-overview-without-holdover_configuring-ptp} GNR-D boundary clock deployments on Carter Flat hardware do not maintain time synchronization if the upstream timing source becomes unavailable. This deployment model operates without monitored holdover because Carter Flat hardware does not expose sufficient follower digital phase-locked loop (DPLL) accuracy information for holdover support. To maintain synchronization, keep a continuous connection to a qualified upstream PTP source. Red Hat tools can detect follower DPLL lock state, but they cannot monitor the detailed follower DPLL accuracy that holdover support requires. When you configure a BC profile on GNR-D hardware that uses Carter Flat NICs, disable holdover. ### Configuring linuxptp services as a boundary clock without holdover on Intel Granite Rapids-D hardware {#ptp-configuring-linuxptp-services-as-boundary-clock-gnrd_configuring-ptp} Use this procedure to configure a Precision Time Protocol (PTP) boundary clock (BC) profile without holdover 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). In this deployment, one time receiver (TR) port synchronizes to an upstream timing source and time transmitter (TT) ports distribute synchronized time downstream. > [!IMPORTANT] > GNR-D BC deployments that use Carter Flat NICs operate without monitored holdover. Disable holdover in your `PtpConfig` profile. **Prerequisites** - You have installed the OpenShift CLI (`oc`). - You are logged in as a user with `cluster-admin` privileges. - You have installed the PTP Operator. - You have verified your qualified GNR-D hardware layout, including NAC ports, Carter Flat ports, and TR/TT role assignments. - You have verified interface naming and plugin device alignment for your hardware layout. **Procedure** 1. Create a `PtpConfig` custom resource (CR) that matches your qualified GNR-D BC without holdover hardware layout: ```yaml apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: gnrd-bc namespace: openshift-ptp annotations: ran.openshift.io/ztp-deploy-wave: "10" spec: profile: - name: 00-bc-tt ptp4lConf: | # All TimeTransmitter ports should be outlined here with 'masterOnly 1' #[eno8303] # ** Host management interface [eno8403] masterOnly 1 #[eno8503] # ** TR port (see 01-bc-tr profile) [eno8603] masterOnly 1 [eno8703] masterOnly 1 [eno8803] masterOnly 1 [eno8903] masterOnly 1 [eno9003] masterOnly 1 [enp108s0f0] masterOnly 1 [enp108s0f1] masterOnly 1 [enp108s0f2] masterOnly 1 [enp108s0f3] masterOnly 1 [enp108s0f4] masterOnly 1 [enp108s0f5] masterOnly 1 [enp108s0f6] masterOnly 1 [enp108s0f7] masterOnly 1 [enp110s0f0] masterOnly 1 [enp110s0f1] masterOnly 1 [enp110s0f2] masterOnly 1 [enp110s0f3] masterOnly 1 [enp110s0f4] masterOnly 1 [enp110s0f5] masterOnly 1 [enp110s0f6] masterOnly 1 [enp110s0f7] masterOnly 1 [global] # # Default Data Set # twoStepFlag 1 slaveOnly 0 priority1 128 priority2 128 domainNumber 24 #utc_offset 37 clockClass 248 clockAccuracy 0xFE offsetScaledLogVariance 0xFFFF free_running 0 freq_est_interval 1 dscp_event 0 dscp_general 0 dataset_comparison G.8275.x G.8275.defaultDS.localPriority 128 # # Port Data Set # logAnnounceInterval -3 logSyncInterval -4 logMinDelayReqInterval -4 logMinPdelayReqInterval -4 announceReceiptTimeout 3 syncReceiptTimeout 0 delayAsymmetry 0 fault_reset_interval -4 neighborPropDelayThresh 20000000 masterOnly 0 G.8275.portDS.localPriority 128 # # Run time options # assume_two_step 0 logging_level 6 path_trace_enabled 0 follow_up_info 0 hybrid_e2e 0 inhibit_multicast_service 0 net_sync_monitor 0 tc_spanning_tree 0 tx_timestamp_timeout 50 unicast_listen 0 unicast_master_table 0 unicast_req_duration 3600 use_syslog 1 verbose 0 summary_interval 0 kernel_leap 1 check_fup_sync 0 clock_class_threshold 135 # # Servo Options # # NGEN TEST MODIFIED # New: # pi_proportional_const 0.60 # pi_integral_const 0.0003 # Old: # pi_proportional_const 0.0 # pi_integral_const 0.0 # END TEST MOD pi_proportional_const 0.60 pi_integral_const 0.001 pi_proportional_scale 0.0 pi_proportional_exponent -0.3 pi_proportional_norm_max 0.7 pi_integral_scale 0.0 pi_integral_exponent 0.4 pi_integral_norm_max 0.3 step_threshold 2.0 # end T-BC experiment first_step_threshold 0.00002 max_frequency 900000000 clock_servo pi sanity_freq_limit 200000000 ntpshm_segment 0 # # Transport options # transportSpecific 0x0 ptp_dst_mac 01:1B:19:00:00:00 p2p_dst_mac 01:80:C2:00:00:0E udp_ttl 1 udp6_scope 0x0E uds_address /var/run/ptp4l # # Default interface options # clock_type BC network_transport L2 delay_mechanism E2E time_stamping hardware tsproc_mode filter delay_filter moving_median delay_filter_length 10 egressLatency 0 ingressLatency 0 boundary_clock_jbod 1 # # Clock description # productDescription ;; revisionData ;; manufacturerIdentity 00:00:00 userDescription ; timeSource 0xA0 ptp4lOpts: -2 --summary_interval -4 ptpSchedulingPolicy: SCHED_FIFO ptpSchedulingPriority: 10 ptpSettings: controllingProfile: 01-bc-tr logReduce: "true" - name: 01-bc-tr phc2sysOpts: -r -n 24 -N 8 -R 16 -u 0 -m -s $upstreamInterface ptp4lConf: | [$upstreamInterface] masterOnly 0 [global] # # Default Data Set # twoStepFlag 1 slaveOnly 0 priority1 128 priority2 128 domainNumber 24 #utc_offset 37 clockClass 248 clockAccuracy 0xFE offsetScaledLogVariance 0xFFFF free_running 0 freq_est_interval 1 dscp_event 0 dscp_general 0 dataset_comparison G.8275.x G.8275.defaultDS.localPriority 128 # # Port Data Set # logAnnounceInterval -3 logSyncInterval -4 logMinDelayReqInterval -4 logMinPdelayReqInterval -4 announceReceiptTimeout 3 syncReceiptTimeout 0 delayAsymmetry 0 fault_reset_interval -4 neighborPropDelayThresh 20000000 masterOnly 0 G.8275.portDS.localPriority 128 # # Run time options # assume_two_step 0 logging_level 6 path_trace_enabled 0 follow_up_info 0 hybrid_e2e 0 inhibit_multicast_service 0 net_sync_monitor 0 tc_spanning_tree 0 tx_timestamp_timeout 50 unicast_listen 0 unicast_master_table 0 unicast_req_duration 3600 use_syslog 1 verbose 0 summary_interval 0 kernel_leap 1 check_fup_sync 0 clock_class_threshold 135 # # Servo Options # # NGEN TEST MODIFIED # New: # pi_proportional_const 0.60 # pi_integral_const 0.0003 # Old: # pi_proportional_const 0.0 # pi_integral_const 0.0 # END TEST MOD pi_proportional_const 0.60 pi_integral_const 0.001 pi_proportional_scale 0.0 pi_proportional_exponent -0.3 pi_proportional_norm_max 0.7 pi_integral_scale 0.0 pi_integral_exponent 0.4 pi_integral_norm_max 0.3 step_threshold 2.0 # end T-BC experiment first_step_threshold 0.00002 max_frequency 900000000 clock_servo pi sanity_freq_limit 200000000 ntpshm_segment 0 # # Transport options # transportSpecific 0x0 ptp_dst_mac 01:1B:19:00:00:00 p2p_dst_mac 01:80:C2:00:00:0E udp_ttl 1 udp6_scope 0x0E uds_address /var/run/ptp4l # # Default interface options # clock_type OC network_transport L2 delay_mechanism E2E time_stamping hardware tsproc_mode filter delay_filter moving_median delay_filter_length 10 egressLatency 0 ingressLatency 0 boundary_clock_jbod 1 # # Clock description # productDescription ;; revisionData ;; manufacturerIdentity 00:00:00 userDescription ; timeSource 0xA0 ptp4lOpts: -2 --summary_interval -4 ptpSchedulingPolicy: SCHED_FIFO ptpSchedulingPriority: 10 ptpSettings: clockType: T-BC inSyncConditionThreshold: "10" inSyncConditionTimes: "12" logReduce: "true" leadingInterface: eno8703 upstreamPort: $upstreamInterface plugins: e825: devices: - eno8703 settings: LocalMaxHoldoverOffSet: 500 LocalHoldoverTimeout: 0 MaxInSpecOffset: 100 e830: devices: - enp108s0f0 - enp110s0f0 ts2phcConf: | [global] use_syslog 0 verbose 1 logging_level 7 ts2phc.pulsewidth 500000000 leapfile /usr/share/zoneinfo/leap-seconds.list domainNumber 24 uds_address /var/run/ptp4l.1.socket [eno8703] ts2phc.extts_correction 0 ts2phc.master 0 ts2phc.channel 0 ts2phc.pin_index 1 # This should be one section per Carter Flats (e830) card: [enp108s0f0] ts2phc.extts_polarity rising ts2phc.extts_correction 0 ts2phc.master 0 ts2phc.channel 0 ts2phc.pin_index 1 [enp110s0f0] ts2phc.extts_polarity rising ts2phc.extts_correction 0 ts2phc.master 0 ts2phc.channel 0 ts2phc.pin_index 1 ts2phcOpts: -s generic -a --ts2phc.rh_external_pps 1 recommend: - match: - nodeLabel: node-role.kubernetes.io/$mcp priority: 4 profile: 00-bc-tt - match: - nodeLabel: node-role.kubernetes.io/$mcp priority: 4 profile: 01-bc-tr ``` where: TR interface : Specifies the interface that synchronizes to the upstream timing source. Replace this value with the qualified TR interface from your site bill of materials. TT interfaces : Specify the interfaces that distribute synchronized time downstream. Replace these values with the qualified TT interfaces for your deployment. `plugins.e825.devices` : Specifies the qualified NAC interfaces for your hardware layout. `plugins.e830.devices` : Specifies the qualified Carter Flat interfaces for your hardware layout, if installed. `ptp4lConf` : Defines BC timing behavior, including TR and TT interface roles. `ts2phcConf` : Defines timing synchronization behavior for qualified hardware devices. `recommend` : Specifies the machine config pool that selects the target DU nodes. Replace placeholder values with the machine config pool label for your deployment. 1. Apply the `PtpConfig` CR: ```terminal $ oc apply -f ``` **Verification** 1. Verify that the `PtpConfig` profile is applied: ```terminal $ oc get ptpconfig -n openshift-ptp ``` 2. Verify that the `linuxptp` daemon is running on the target node: ```terminal $ oc get pods -n openshift-ptp -o wide ``` 3. Review `linuxptp` daemon logs for BC status: ```terminal $ oc logs -n openshift-ptp -c linuxptp-daemon-container ``` 4. Verify the following: - The TR port synchronizes successfully to the upstream timing source. - TT ports distribute timing downstream. - The deployed BC profile operates without holdover. ## Configuring linuxptp services as an ordinary clock {#configuring-linuxptp-services-as-ordinary-clock_configuring-ptp} You can configure `linuxptp` services (`ptp4l`, `phc2sys`) as ordinary clock by creating a `PtpConfig` custom resource (CR) object. > [!NOTE] > Use the following example `PtpConfig` CR as the basis to configure `linuxptp` services as an ordinary clock for your particular hardware and environment. This example CR does not configure PTP fast events. To configure PTP fast events, set appropriate values for `ptp4lOpts`, `ptp4lConf`, and `ptpClockThreshold`. `ptpClockThreshold` is required only when events are enabled. See "Configuring the PTP fast event notifications publisher" for more information. **Prerequisites** - Install the OpenShift CLI (`oc`). - Log in as a user with `cluster-admin` privileges. - Install the PTP Operator. **Procedure** 1. Create the following `PtpConfig` CR, and then save the YAML in the `ordinary-clock-ptp-config.yaml` file. ```yaml {title="Example PTP ordinary clock configuration"} apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: ordinary-clock namespace: openshift-ptp annotations: {} spec: profile: - name: ordinary-clock # The interface name is hardware-specific interface: $interface ptp4lOpts: "-2 -s" phc2sysOpts: "-a -r -n 24" ptpSchedulingPolicy: SCHED_FIFO ptpSchedulingPriority: 10 ptpSettings: logReduce: "true" ptp4lConf: | [global] # # Default Data Set # twoStepFlag 1 slaveOnly 1 priority1 128 priority2 128 domainNumber 24 #utc_offset 37 clockClass 255 clockAccuracy 0xFE offsetScaledLogVariance 0xFFFF free_running 0 freq_est_interval 1 dscp_event 0 dscp_general 0 dataset_comparison G.8275.x G.8275.defaultDS.localPriority 128 # # Port Data Set # logAnnounceInterval -3 logSyncInterval -4 logMinDelayReqInterval -4 logMinPdelayReqInterval -4 announceReceiptTimeout 3 syncReceiptTimeout 0 delayAsymmetry 0 fault_reset_interval -4 neighborPropDelayThresh 20000000 masterOnly 0 G.8275.portDS.localPriority 128 # # Run time options # assume_two_step 0 logging_level 6 path_trace_enabled 0 follow_up_info 0 hybrid_e2e 0 inhibit_multicast_service 0 net_sync_monitor 0 tc_spanning_tree 0 tx_timestamp_timeout 50 unicast_listen 0 unicast_master_table 0 unicast_req_duration 3600 use_syslog 1 verbose 0 summary_interval 0 kernel_leap 1 check_fup_sync 0 clock_class_threshold 7 # # Servo Options # pi_proportional_const 0.0 pi_integral_const 0.0 pi_proportional_scale 0.0 pi_proportional_exponent -0.3 pi_proportional_norm_max 0.7 pi_integral_scale 0.0 pi_integral_exponent 0.4 pi_integral_norm_max 0.3 step_threshold 2.0 first_step_threshold 0.00002 max_frequency 900000000 clock_servo pi sanity_freq_limit 200000000 ntpshm_segment 0 # # Transport options # transportSpecific 0x0 ptp_dst_mac 01:1B:19:00:00:00 p2p_dst_mac 01:80:C2:00:00:0E udp_ttl 1 udp6_scope 0x0E uds_address /var/run/ptp4l # # Default interface options # clock_type OC network_transport L2 delay_mechanism E2E time_stamping hardware tsproc_mode filter delay_filter moving_median delay_filter_length 10 egressLatency 0 ingressLatency 0 boundary_clock_jbod 0 # # Clock description # productDescription ;; revisionData ;; manufacturerIdentity 00:00:00 userDescription ; timeSource 0xA0 recommend: - profile: ordinary-clock priority: 4 match: - nodeLabel: "node-role.kubernetes.io/$mcp" ``` **PTP ordinary clock CR configuration options** | | | | --- | --- | | CR field | Description | | `name` | The name of the `PtpConfig` CR. | | `profile` | Specify an array of one or more `profile` objects. Each profile must be uniquely named. | | `interface` | Specify the network interface to be used by the `ptp4l` service, for example `ens787f1`. | | `ptp4lOpts` | 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 ` 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. | | `phc2sysOpts` | 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. | | `ptp4lConf` | Specify a string that contains the configuration to replace the default `/etc/ptp4l.conf` file. To use the default configuration, leave the field empty. | | `tx_timestamp_timeout` | For Intel Columbiaville 800 Series NICs, set `tx_timestamp_timeout` to `50`. | | `boundary_clock_jbod` | For Intel Columbiaville 800 Series NICs, set `boundary_clock_jbod` to `0`. | | `ptpSchedulingPolicy` | Scheduling policy for `ptp4l` and `phc2sys` processes. Default value is `SCHED_OTHER`. Use `SCHED_FIFO` on systems that support FIFO scheduling. | | `ptpSchedulingPriority` | 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`. | | `ptpClockThreshold` | Optional. If `ptpClockThreshold` is not present, default values are used for the `ptpClockThreshold` fields. `ptpClockThreshold` configures how long after the PTP master clock is disconnected before PTP events are triggered. `holdOverTimeout` is the time value in seconds before the PTP clock event state changes to `FREERUN` when the PTP master clock is disconnected. The `maxOffsetThreshold` and `minOffsetThreshold` settings configure offset values in nanoseconds that compare against the values for `CLOCK_REALTIME` (`phc2sys`) or master offset (`ptp4l`). When the `ptp4l` or `phc2sys` offset value is outside this range, the PTP clock state is set to `FREERUN`. When the offset value is within this range, the PTP clock state is set to `LOCKED`. | | `recommend` | Specify an array of one or more `recommend` objects that define rules on how the `profile` should be applied to nodes. | | `.recommend.profile` | Specify the `.recommend.profile` object name defined in the `profile` section. | | `.recommend.priority` | Set `.recommend.priority` to `0` for ordinary clock. | | `.recommend.match` | Specify `.recommend.match` rules with `nodeLabel` or `nodeName` values. | | `.recommend.match.nodeLabel` | Set `nodeLabel` with the `key` of the `node.Labels` field from the node object by using the `oc get nodes --show-labels` command. For example, `node-role.kubernetes.io/worker`. | | `.recommend.match.nodeName` | Set `nodeName` with the value of the `node.Name` field from the node object by using the `oc get nodes` command. For example, `compute-1.example.com`. | 2. Create the `PtpConfig` CR by running the following command: ```terminal $ oc create -f ordinary-clock-ptp-config.yaml ``` **Verification** 1. Check that the `PtpConfig` profile is applied to the node. 1. Get the list of pods in the `openshift-ptp` namespace by running the following command: ```terminal $ oc get pods -n openshift-ptp -o wide ``` ```terminal {title="Example output"} NAME READY STATUS RESTARTS AGE IP NODE linuxptp-daemon-4xkbb 1/1 Running 0 43m 10.1.196.24 compute-0.example.com linuxptp-daemon-tdspf 1/1 Running 0 43m 10.1.196.25 compute-1.example.com ptp-operator-657bbb64c8-2f8sj 1/1 Running 0 43m 10.129.0.61 control-plane-1.example.com ``` 2. 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: ```terminal $ oc logs linuxptp-daemon-4xkbb -n openshift-ptp -c linuxptp-daemon-container ``` ```terminal {title="Example output"} I1115 09:41:17.117596 4143292 daemon.go:107] in applyNodePTPProfile I1115 09:41:17.117604 4143292 daemon.go:109] updating NodePTPProfile to: I1115 09:41:17.117607 4143292 daemon.go:110] ------------------------------------ I1115 09:41:17.117612 4143292 daemon.go:102] Profile Name: profile1 I1115 09:41:17.117616 4143292 daemon.go:102] Interface: ens787f1 I1115 09:41:17.117620 4143292 daemon.go:102] Ptp4lOpts: -2 -s I1115 09:41:17.117623 4143292 daemon.go:102] Phc2sysOpts: -a -r -n 24 I1115 09:41:17.117626 4143292 daemon.go:116] ------------------------------------ ``` **Additional resources** {._additional-resources} - [Configuring FIFO priority scheduling for PTP hardware](/openshift-docs-markdown/networking/advanced_networking/ptp/configuring-ptp#cnf-configuring-fifo-priority-scheduling-for-ptp_configuring-ptp) - [Configuring the PTP fast event notifications publisher](/openshift-docs-markdown/networking/advanced_networking/ptp/ptp-cloud-events-consumer-dev-reference-v2#cnf-configuring-the-ptp-fast-event-publisher-v2_ptp-consumer) ### Intel Columbiaville E800 series NIC as PTP ordinary clock reference {#nw-columbiaville-ptp-config-refererence_configuring-ptp} The following table describes the changes that you must make to the reference PTP configuration to use Intel Columbiaville E800 series NICs as ordinary clocks. Make the changes in a `PtpConfig` custom resource (CR) that you apply to the cluster. **Recommended PTP settings for Intel Columbiaville NIC** | PTP configuration | Recommended setting | | --- | --- | | `phc2sysOpts` | `-a -r -m -n 24 -N 8 -R 16` | | `tx_timestamp_timeout` | `50` | | `boundary_clock_jbod` | `0` | > [!NOTE] > For `phc2sysOpts`, `-m` prints messages to `stdout`. The `linuxptp-daemon` `DaemonSet` parses the logs and generates Prometheus metrics. ### Configuring linuxptp services as an ordinary clock with dual-port NIC redundancy {#configuring-linuxptp-services-oc-dual-port_configuring-ptp} You can configure `linuxptp` services (`ptp4l`, `phc2sys`) as an ordinary clock with dual-port NIC redundancy by creating a `PtpConfig` custom resource (CR) object. In a dual-port NIC configuration for an ordinary clock, if one port fails, the standby port takes over, maintaining PTP timing synchronization. > [!IMPORTANT] > Configuring linuxptp services as an ordinary clock with dual-port NIC redundancy is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. > > For more information about the support scope of Red Hat Technology Preview features, see [Technology Preview Features Support Scope](https://access.redhat.com/support/offerings/techpreview/). **Prerequisites** - Install the OpenShift CLI (`oc`). - Log in as a user with `cluster-admin` privileges. - Install the PTP Operator. - Check the hardware requirements for using 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". **Procedure** 1. Create the following `PtpConfig` CR, and then save the YAML in the `oc-dual-port-ptp-config.yaml` file. ```yaml {title="Example PTP ordinary clock dual-port configuration"} apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: ordinary-clock-1 namespace: openshift-ptp spec: profile: - name: oc-dual-port phc2sysOpts: -a -r -n 24 -N 8 -R 16 -u 0 ptp4lConf: |- [ens3f2] masterOnly 0 [ens3f3] masterOnly 0 [global] # # Default Data Set # slaveOnly 1 #... ``` where: `phc2sysOpts: -a -r -n 24 -N 8 -R 16 -u 0` : Specifies the system config options for the `phc2sys` service. `ptp4lConf` : Specifies 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. `slaveOnly 1` : Configures `ptp4l` to run as an ordinary clock only. 2. Create the `PtpConfig` CR by running the following command: ```terminal $ oc create -f oc-dual-port-ptp-config.yaml ``` **Verification** 1. Check that the `PtpConfig` profile is applied to the node. 1. Get the list of pods in the `openshift-ptp` namespace by running the following command: ```terminal $ oc get pods -n openshift-ptp -o wide ``` ```terminal {title="Example output"} NAME READY STATUS RESTARTS AGE IP NODE linuxptp-daemon-4xkbb 1/1 Running 0 43m 10.1.196.24 compute-0.example.com linuxptp-daemon-tdspf 1/1 Running 0 43m 10.1.196.25 compute-1.example.com ptp-operator-657bbb64c8-2f8sj 1/1 Running 0 43m 10.129.0.61 control-plane-1.example.com ``` 2. 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: ```terminal $ oc logs linuxptp-daemon-4xkbb -n openshift-ptp -c linuxptp-daemon-container ``` ```terminal {title="Example output"} I1115 09:41:17.117596 4143292 daemon.go:107] in applyNodePTPProfile I1115 09:41:17.117604 4143292 daemon.go:109] updating NodePTPProfile to: I1115 09:41:17.117607 4143292 daemon.go:110] ------------------------------------ I1115 09:41:17.117612 4143292 daemon.go:102] Profile Name: oc-dual-port I1115 09:41:17.117616 4143292 daemon.go:102] Interface: ens787f1 I1115 09:41:17.117620 4143292 daemon.go:102] Ptp4lOpts: -2 --summary_interval -4 I1115 09:41:17.117623 4143292 daemon.go:102] Phc2sysOpts: -a -r -n 24 -N 8 -R 16 -u 0 I1115 09:41:17.117626 4143292 daemon.go:116] ------------------------------------ ``` **Additional resources** {._additional-resources} - [Configuring linuxptp services as ordinary clock](/openshift-docs-markdown/networking/advanced_networking/ptp/configuring-ptp#configuring-linuxptp-services-as-ordinary-clock_configuring-ptp) - [Using dual-port NICs to improve redundancy for PTP ordinary clocks](/openshift-docs-markdown/networking/advanced_networking/ptp/about-ptp#ptp-dual-ports-oc_about-ptp) ## Configuring FIFO priority scheduling for PTP hardware {#cnf-configuring-fifo-priority-scheduling-for-ptp_configuring-ptp} In telco or other deployment types that require low latency performance, PTP daemon threads run in a constrained CPU footprint alongside the rest of the infrastructure components. By default, PTP threads run with the `SCHED_OTHER` policy. Under high load, these threads might not get the scheduling latency they require for error-free operation. To mitigate against potential scheduling latency errors, you can configure the PTP Operator `linuxptp` services to allow threads to run with a `SCHED_FIFO` policy. If `SCHED_FIFO` is set for a `PtpConfig` CR, then `ptp4l` and `phc2sys` will run in the parent container under `chrt` with a priority set by the `ptpSchedulingPriority` field of the `PtpConfig` CR. > [!NOTE] > Setting `ptpSchedulingPolicy` is optional, and is only required if you are experiencing latency errors. **Procedure** 1. Edit the `PtpConfig` CR profile: ```terminal $ oc edit PtpConfig -n openshift-ptp ``` 2. Change the `ptpSchedulingPolicy` and `ptpSchedulingPriority` fields: ```yaml apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: namespace: openshift-ptp ... spec: profile: - name: "profile1" ... ptpSchedulingPolicy: SCHED_FIFO ptpSchedulingPriority: 10 ``` where: `ptpSchedulingPolicy: SCHED_FIFO` : Sets the scheduling policy for `ptp4l` and `phc2sys` processes. Use `SCHED_FIFO` on systems that support FIFO scheduling. `ptpSchedulingPriority: 10` : Sets the integer value 1-65 used to configure FIFO priority for `ptp4l` and `phc2sys` processes. 3. Save and exit to apply the changes to the `PtpConfig` CR. **Verification** 1. Get the name of the `linuxptp-daemon` pod and corresponding node where the `PtpConfig` CR has been applied: ```terminal $ oc get pods -n openshift-ptp -o wide ``` ```terminal {title="Example output"} NAME READY STATUS RESTARTS AGE IP NODE linuxptp-daemon-gmv2n 3/3 Running 0 1d17h 10.1.196.24 compute-0.example.com linuxptp-daemon-lgm55 3/3 Running 0 1d17h 10.1.196.25 compute-1.example.com ptp-operator-3r4dcvf7f4-zndk7 1/1 Running 0 1d7h 10.129.0.61 control-plane-1.example.com ``` 2. Check that the `ptp4l` process is running with the updated `chrt` FIFO priority: ```terminal $ oc -n openshift-ptp logs linuxptp-daemon-lgm55 -c linuxptp-daemon-container|grep chrt ``` ```terminal {title="Example output"} I1216 19:24:57.091872 1600715 daemon.go:285] /bin/chrt -f 65 /usr/sbin/ptp4l -f /var/run/ptp4l.0.config -2 --summary_interval -4 -m ``` ## Configuring PTP log reduction {#cnf-configuring-log-reduction-for-linuxptp_configuring-ptp} The `linuxptp-daemon` generates logs that you can use for debugging purposes. In telco or other deployment types that feature a limited storage capacity, these logs can add to the storage demand. Currently, the default logging rate is high, causing logs to rotate out in under 24 hours, which makes it difficult to track changes and identify problems. You can achieve basic log reduction by configuring the `PtpConfig` custom resource (CR) to exclude log messages that report the master offset value. The master offset log message reports the difference between the clock of the current node and the master clock in nanoseconds. However, with this method, there is no summary status of filtered logs. The enhanced log reduction feature allows you to configure the logging rate of PTP logs. You can set a specific logging rate, which can help reduce the volume of logs generated by the `linuxptp-daemon` while still retaining essential information for troubleshooting. With the enhanced log reduction feature, you can also specify a threshold that still displays the offset logs if the offset is higher than that threshold. ### Configuring log filtering for PTP {#cnf-configuring-log-filtering-for-linuxptp_configuring-ptp} Modify the `PtpConfig` custom resource (CR) to configure basic log filtering and exclude log messages that report the master offset value. **Prerequisites** - Install the OpenShift CLI (`oc`). - Log in as a user with `cluster-admin` privileges. - Install the PTP Operator. **Procedure** 1. Edit the `PtpConfig` CR: ```terminal $ oc edit PtpConfig -n openshift-ptp ``` 2. In `spec.profile`, add the `ptpSettings.logReduce` specification and set the value to `true`: ```yaml apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: namespace: openshift-ptp ... spec: profile: - name: "profile1" ... ptpSettings: logReduce: "true" ``` > [!NOTE] > For debugging purposes, you can revert this specification to `False` to include the master offset messages. 3. Save and exit to apply the changes to the `PtpConfig` CR. **Verification** 1. Get the name of the `linuxptp-daemon` pod and corresponding node where the `PtpConfig` CR has been applied: ```terminal $ oc get pods -n openshift-ptp -o wide ``` ```terminal {title="Example output"} NAME READY STATUS RESTARTS AGE IP NODE linuxptp-daemon-gmv2n 3/3 Running 0 1d17h 10.1.196.24 compute-0.example.com linuxptp-daemon-lgm55 3/3 Running 0 1d17h 10.1.196.25 compute-1.example.com ptp-operator-3r4dcvf7f4-zndk7 1/1 Running 0 1d7h 10.129.0.61 control-plane-1.example.com ``` 2. Verify that master offset messages are excluded from the logs by running the following command: ```terminal $ oc -n openshift-ptp logs -c linuxptp-daemon-container | grep "master offset" ``` - `` is the name of the `linuxptp-daemon` pod, for example `linuxptp-daemon-gmv2n`. When you configure the `logReduce` specification, this command does not report any instances of `master offset` in the logs of the `linuxptp` daemon. ### Configuring enhanced PTP log reduction {#cnf-configuring-enhanced-log-reduction-for-linuxptp_configuring-ptp} Basic log reduction effectively filters out frequent logs. However, if you want a periodic summary of the filtered logs, use the enhanced log reduction feature. **Prerequisites** - Install the OpenShift CLI (`oc`). - Log in as a user with `cluster-admin` privileges. - Install the PTP Operator. **Procedure** 1. Edit the `PtpConfig` custom resource (CR): ```terminal $ oc edit PtpConfig -n openshift-ptp ``` 2. Add the `ptpSettings.logReduce` specification in the `spec.profile` section, and set the value to `enhanced`: ```yaml apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: namespace: openshift-ptp ... spec: profile: - name: "profile1" ... ptpSettings: logReduce: "enhanced" ``` 3. Optional: Configure the interval for summary logs and a threshold in nanoseconds for the master offset logs. For example, to set the interval to 60 seconds and the threshold to 100 nanoseconds, add the `ptpSettings.logReduce` specification in the `spec.profile` section and set the value to `enhanced 60s 100`. ```yaml apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: namespace: openshift-ptp spec: profile: - name: "profile1" ptpSettings: logReduce: "enhanced 60s 100" ``` - By default, the `linuxptp-daemon` is configured to generate summary logs every 30 seconds if no value is specified. In the example configuration, the daemon generates summary logs every 60 seconds and a threshold of 100 nanoseconds for the master offset logs is set. This means the daemon only produces summary logs at the specified interval. However, if your clock’s offset from the master exceeds plus or minus 100 nanoseconds, that specific log entry is recorded. 4. Optional: To set the interval without a master offset threshold, configure the `logReduce` field to `enhanced 60s` in the YAML. ```yaml apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: namespace: openshift-ptp spec: profile: - name: "profile1" ptpSettings: logReduce: "enhanced 60s" ``` 5. Save and exit to apply the changes to the `PtpConfig` CR. **Verification** 1. Get the name of the `linuxptp-daemon` pod and the corresponding node where the `PtpConfig` CR is applied by running the following command ```terminal $ oc get pods -n openshift-ptp -o wide ``` ```terminal {title="Example output"} NAME READY STATUS RESTARTS AGE IP NODE linuxptp-daemon-gmv2n 3/3 Running 0 1d17h 10.1.196.24 compute-0.example.com linuxptp-daemon-lgm55 3/3 Running 0 1d17h 10.1.196.25 compute-1.example.com ptp-operator-3r4dcvf7f4-zndk7 1/1 Running 0 1d7h 10.129.0.61 control-plane-1.example.com ``` 2. Verify that master offset messages are excluded from the logs by running the following command: ```terminal $ oc -n openshift-ptp logs -c linuxptp-daemon-container | grep "master offset" ``` - `` is the name of the `linuxptp-daemon` pod, for example, `linuxptp-daemon-gmv2n`. ## Configuring GNSS failover to NTP for time synchronization continuity {#cnf-configuring-gnss-ntp-failover_configuring-ptp} Automatic failover from global navigation satellite system (GNSS) to Network Time Protocol (NTP) maintains time synchronization continuity when the primary signal is lost, ensuring system stability for telco operations. Telco operators require time source redundancy to ensure time synchronization continuity and system stability. OpenShift Container Platform provides automatic failover capabilities to maintain synchronization. The system utilizes GNSS (delivered by `phc2sys`) as the primary time source. To protect against primary signal loss, such as jamming or antenna failure, the system automatically transitions to the secondary time source, NTP delivered by `chronyd`. Upon signal recovery, the system automatically switches back to and resumes synchronization with `phc2sys`. You can control the resilience of the time synchronization by setting the `ts2phc.holdover` parameter in seconds. This value dictates the maximum time the internal control algorithm can continue synchronizing the PHC after the main time of day (ToD) source such as a GNSS receiver is lost. The algorithm can only continue if it remains in a stable state (SERVO_LOCKED_STABLE). When the process exits this configured holdover period, it signifies an unrecoverable primary signal loss. The system then allows failover to a secondary source such as NTP. ### Creating a PTP Grandmaster configuration with GNSS failover {#configuring-gnss-to-ntp-failover_configuring-ptp} Configure a Precision Time Protocol (PTP) Telecom Grandmaster clock with automatic failover from global navigation satellite system (GNSS) to Network Time Protocol (NTP) when satellite signals are unavailable. This procedure configures a T-GM (Telecom Grandmaster) clock that uses an Intel E810 Westport Channel NIC as the PTP grandmaster clock with GNSS to NTP failover capabilities. **Prerequisites** - For T-GM clocks in production environments, install an Intel E810 Westport Channel NIC in the bare-metal cluster host. - Install the OpenShift CLI (`oc`). - Log in as a user with `cluster-admin` privileges. - Install the PTP Operator. **Procedure** 1. Verify the PTP Operator installation by running the following command: ```terminal $ oc get pods -n openshift-ptp -o wide ``` The output is similar to the following listing the PTP Operator pod and the `linuxptp-daemon` pods: ```terminal NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES linuxptp-daemon-4xk9m 2/2 Running 0 15m 192.168.1.101 worker-0.cluster.local linuxptp-daemon-7bv2n 2/2 Running 0 15m 192.168.1.102 worker-1.cluster.local linuxptp-daemon-9cp4r 2/2 Running 0 15m 192.168.1.103 worker-2.cluster.local linuxptp-daemon-kw8h5 2/2 Running 0 15m 192.168.1.104 worker-3.cluster.local linuxptp-daemon-m3j7t 2/2 Running 0 15m 192.168.1.105 worker-4.cluster.local ptp-operator-75c77dbf86-xm9kl 1/1 Running 0 20m 10.129.0.45 master-1.cluster.local ``` - `ptp-operator-*`: The PTP Operator pod (one instance in the cluster) - `linuxptp-daemon-*`: The linuxptp daemon pods. A daemon pod runs on each node that matches the PtpConfig profile. Each daemon pod should show `2/2` in the READY column, indicating both containers (`linuxptp-daemon-container` and `kube-rbac-proxy`) are running. > [!NOTE] > The number of `linuxptp-daemon` pods is determined by the node labels defined in the `PtpOperatorConfig` which controls the DaemonSet deployment. The PtpConfig profile matching, as shown in Step 4, only determines which specific PTP settings are applied on the running daemons. In this example, the operator configuration targets all 5 worker nodes. For single-node OpenShift clusters, you will see only one `linuxptp-daemon` pod, as the configuration targets only the control plane node which acts as the worker. 2. Check which network interfaces support hardware timestamping by running the following command: ```terminal $ oc get NodePtpDevice -n openshift-ptp -o yaml ``` The output is similar to the following showing NodePtpDevice resources for nodes with PTP-capable network interfaces: ```yaml apiVersion: v1 items: - apiVersion: ptp.openshift.io/v1 kind: NodePtpDevice metadata: name: worker-0.cluster.local namespace: openshift-ptp spec: {} status: devices: - name: ens7f0 hwConfig: phcIndex: 0 - name: ens7f1 hwConfig: phcIndex: 1 - apiVersion: ptp.openshift.io/v1 kind: NodePtpDevice metadata: name: worker-1.cluster.local namespace: openshift-ptp spec: {} status: devices: - name: ens7f0 hwConfig: phcIndex: 0 - name: ens7f1 hwConfig: phcIndex: 1 kind: List metadata: resourceVersion: "" ``` In this example output: - `ens7f0` and `ens7f1` are PTP-capable interfaces (Intel E810 NIC ports). - `phcIndex` indicates the PTP Hardware Clock number (maps to `/dev/ptp0`, `/dev/ptp1`, and so on). > [!NOTE] > The output shows one NodePtpDevice resource for each node with PTP-capable interfaces. In this example, five worker nodes have Intel E810 NICs. For single-node OpenShift clusters, you would see only one NodePtpDevice resource. 3. The PTP profile uses node labels for matching. Check your machine config pool (MCP) to find the node labels by running the following command: ```terminal $ oc get mcp ``` The output is similar to the following: ```terminal NAME CONFIG UPDATED UPDATING DEGRADED MACHINECOUNT READYMACHINECOUNT UPDATEDMACHINECOUNT DEGRADEDMACHINECOUNT AGE master rendered-master-a1b1** True False False 3 3 3 0 45d worker rendered-worker-f6e5** True False False 5 5 5 0 45d ``` > [!NOTE] > The CONFIG column shows a truncated hash of the rendered MachineConfig. In actual output, this will be a full 64-character hash such as `rendered-master-a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6`. - In this example, the `` is `worker` for worker nodes and `master` for control plane nodes. Most T-GM deployments use worker nodes, so you would use `worker` as the ``. - For single-node OpenShift clusters, the `` is `master` (the worker MCP will show `MACHINECOUNT` of 0). 4. Create a `PtpConfig` custom resource (CR) that configures the T-GM clock with GNSS to NTP failover. Save the following YAML configuration to a file named `ptp-config-gnss-ntp-failover.yaml`, replacing `` with the name of your machine config pool from the previous step. ```yaml # The grandmaster profile is provided for testing only # It is not installed on production clusters apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: grandmaster namespace: openshift-ptp annotations: ran.openshift.io/ztp-deploy-wave: "10" spec: profile: - name: "grandmaster" ptp4lOpts: "-2 --summary_interval -4" phc2sysOpts: -r -u 0 -m -N 8 -R 16 -s ens7f0 -n 24 ptpSchedulingPolicy: SCHED_FIFO ptpSchedulingPriority: 10 ptpSettings: logReduce: "true" # --- FAILOVER CONFIGURATION --- # Holdover time: 14400 seconds (4 hours) before switching to NTP ts2phcOpts: "--ts2phc.holdover 14400" # Configure Chronyd (Secondary Time Source) chronydOpts: "-d" chronydConf: | server time.nist.gov iburst makestep 1.0 -1 pidfile /var/run/chronyd.pid plugins: # E810 Hardware-Specific Configuration e810: enableDefaultConfig: false settings: LocalHoldoverTimeout: 14400 LocalMaxHoldoverOffSet: 1500 MaxInSpecOffset: 1500 pins: # Syntax guide: # - The 1st number in each pair must be one of: # 0 - Disabled # 1 - RX # 2 - TX # - The 2nd number in each pair must match the channel number ens7f0: SMA1: 0 1 SMA2: 0 2 U.FL1: 0 1 U.FL2: 0 2 ublxCmds: - args: #ubxtool -P 29.20 -z CFG-HW-ANT_CFG_VOLTCTRL,1 - "-P" - "29.20" - "-z" - "CFG-HW-ANT_CFG_VOLTCTRL,1" reportOutput: false - args: #ubxtool -P 29.20 -e GPS - "-P" - "29.20" - "-e" - "GPS" reportOutput: false - args: #ubxtool -P 29.20 -d Galileo - "-P" - "29.20" - "-d" - "Galileo" reportOutput: false - args: #ubxtool -P 29.20 -d GLONASS - "-P" - "29.20" - "-d" - "GLONASS" reportOutput: false - args: #ubxtool -P 29.20 -d BeiDou - "-P" - "29.20" - "-d" - "BeiDou" reportOutput: false - args: #ubxtool -P 29.20 -d SBAS - "-P" - "29.20" - "-d" - "SBAS" reportOutput: false - args: #ubxtool -P 29.20 -t -w 5 -v 1 -e SURVEYIN,600,50000 - "-P" - "29.20" - "-t" - "-w" - "5" - "-v" - "1" - "-e" - "SURVEYIN,600,50000" reportOutput: true - args: #ubxtool -P 29.20 -p MON-HW - "-P" - "29.20" - "-p" - "MON-HW" reportOutput: true - args: #ubxtool -P 29.20 -p CFG-MSG,1,38,248 - "-P" - "29.20" - "-p" - "CFG-MSG,1,38,248" reportOutput: true # NTP Failover Plugin ntpfailover: gnssFailover: true # --- GNSS (ts2phc) CONFIGURATION (Primary Source) --- ts2phcConf: | [nmea] ts2phc.master 1 [global] use_syslog 0 verbose 1 logging_level 7 ts2phc.pulsewidth 100000000 ts2phc.nmea_serialport /dev/ttyGNSS_1700_0 leapfile /usr/share/zoneinfo/leap-seconds.list [ens7f0] ts2phc.extts_polarity rising ts2phc.extts_correction 0 # --- PTP4L CONFIGURATION (Grandmaster Role) --- ptp4lConf: | [ens7f0] masterOnly 1 [ens7f1] masterOnly 1 [global] # # Default Data Set # twoStepFlag 1 priority1 128 priority2 128 domainNumber 24 #utc_offset 37 clockClass 6 clockAccuracy 0x27 offsetScaledLogVariance 0xFFFF free_running 0 freq_est_interval 1 dscp_event 0 dscp_general 0 dataset_comparison G.8275.x G.8275.defaultDS.localPriority 128 # # Port Data Set # logAnnounceInterval -3 logSyncInterval -4 logMinDelayReqInterval -4 logMinPdelayReqInterval 0 announceReceiptTimeout 3 syncReceiptTimeout 0 delayAsymmetry 0 fault_reset_interval -4 neighborPropDelayThresh 20000000 masterOnly 0 G.8275.portDS.localPriority 128 # # Run time options # assume_two_step 0 logging_level 6 path_trace_enabled 0 follow_up_info 0 hybrid_e2e 0 inhibit_multicast_service 0 net_sync_monitor 0 tc_spanning_tree 0 tx_timestamp_timeout 50 unicast_listen 0 unicast_master_table 0 unicast_req_duration 3600 use_syslog 1 verbose 0 summary_interval -4 kernel_leap 1 check_fup_sync 0 clock_class_threshold 7 # # Servo Options # pi_proportional_const 0.0 pi_integral_const 0.0 pi_proportional_scale 0.0 pi_proportional_exponent -0.3 pi_proportional_norm_max 0.7 pi_integral_scale 0.0 pi_integral_exponent 0.4 pi_integral_norm_max 0.3 step_threshold 2.0 first_step_threshold 0.00002 clock_servo pi sanity_freq_limit 200000000 ntpshm_segment 0 # # Transport options # transportSpecific 0x0 ptp_dst_mac 01:1B:19:00:00:00 p2p_dst_mac 01:80:C2:00:00:0E udp_ttl 1 udp6_scope 0x0E uds_address /var/run/ptp4l # # Default interface options # clock_type BC network_transport L2 delay_mechanism E2E time_stamping hardware tsproc_mode filter delay_filter moving_median delay_filter_length 10 egressLatency 0 ingressLatency 0 boundary_clock_jbod 0 # # Clock description # productDescription ;; revisionData ;; manufacturerIdentity 00:00:00 userDescription ; timeSource 0x20 ptpClockThreshold: holdOverTimeout: 5 maxOffsetThreshold: 100 minOffsetThreshold: -100 recommend: - profile: "grandmaster" priority: 4 match: - nodeLabel: node-role.kubernetes.io/ ``` > [!IMPORTANT] > Replace the example interface names (`ens7f0`, `ens7f1`) with your actual E810 NIC interface names found in step 2. Common E810 interface naming patterns include `ens7f0`, `ens8f0`, `eth0`, `enp2s0f0`, and so on. The exact name depends on your system firmware settings and Linux network device naming conventions. Also replace `/dev/ttyGNSS_1700_0` with your actual GNSS serial port device path. For single-node OpenShift clusters, replace `` with `master` in the nodeLabel match. For multi-node clusters using worker nodes as T-GM, use `worker`. The configuration includes the following components: - **PTP4L options:** - `-2`: Use PTP version 2 - `--summary_interval -4`: Log summary every 2^(-4) = 0.0625 seconds - **PHC2SYS options:** - `-r`: Synchronize system clock from PTP hardware clock - `-u 0`: Update rate multiplier - `-m`: Print messages to stdout - `-N 8`: Domain number for ptp4l - `-R 16`: Update rate - `-s ens7f0`: Source interface (replace with your E810 interface name) - `-n 24`: Domain number - **Failover configuration:** - `ts2phcOpts --ts2phc.holdover 14400`: 4-hour holdover before switching to NTP - `chronydConf`: NTP server configuration for failover replace `time.nist.gov` with your preferred NTP server - `ntpfailover plugin`: Enables automatic GNSS-to-NTP switching with `gnssFailover: true` - **E810 plugin configuration:** - `LocalHoldoverTimeout: 14400`: E810 hardware holdover timeout (4 hours) - `pins`: Configuration for 1PPS input on E810 physical pins (U.FL2, SMA1, SMA2, U.FL1) - `ublxCmds`: Commands to configure u-blox GNSS receiver (enable GPS, disable other constellations, set survey-in mode) - **GNSS (ts2phc) configuration:** - `ts2phc.nmea_serialport /dev/ttyGNSS_1700_0`: GNSS serial port device path (replace with your actual GNSS device) - `ts2phc.extts_polarity rising`: 1PPS signal on rising edge - `ts2phc.pulsewidth 100000000`: 1PPS pulse width in nanoseconds - **PTP4L configuration:** - `masterOnly 1`: Interface acts only as PTP master - `clockClass 6`: GPS-synchronized quality level - `domainNumber 24`: PTP domain - `clock_type BC`: Boundary Clock mode - `time_stamping hardware`: Use hardware timestamps from E810 NIC 5. Apply the `PtpConfig` CR by running the following command: ```terminal $ oc apply -f ptp-config-gnss-ntp-failover.yaml ``` The output is similar to the following: ```terminal ptpconfig.ptp.openshift.io/grandmaster created ``` **Verification** 1. The PTP daemon checks for profile updates every 30 seconds. Wait approximately 30 seconds, then verify by running the following command: ```terminal $ oc get ptpconfig -n openshift-ptp ``` The output is similar to the following: ```terminal NAME AGE grandmaster 2m ``` 2. Check the NodePtpDevice to see if the profile is applied by running the following command, replacing `` with your node hostname: ```terminal $ oc describe nodeptpdevice -n openshift-ptp ``` For example, on a multi-node cluster with worker nodes: `worker-0.cluster.local` For single-node OpenShift clusters, use the control plane node name, which you can find by running: ```terminal $ oc get nodes ``` 3. Check if the profile is being loaded by monitoring the daemon logs: ```terminal $ oc get pods -n openshift-ptp | grep linuxptp-daemon ``` Then check the logs, replacing `` with the actual pod name from the previous command: ```terminal $ oc logs -n openshift-ptp -c linuxptp-daemon-container --tail=100 ``` Success indicators in the logs are: - `load profiles` - Profile is being loaded - `in applyNodePTPProfiles` - Profile is being applied - No `ptp profile doesn't exist for node` errors 4. Check `chronyd` status to verify NTP is running as the secondary time source by running the following command: ```terminal $ oc logs -n openshift-ptp -c linuxptp-daemon-container | grep chronyd ``` The output is similar to the following: ```terminal chronyd version 4.5 starting Added source ID#0000000001 (time.nist.gov) ``` 5. Check GNSS/gpsd by running the following command: ```terminal $ oc logs -n openshift-ptp -c linuxptp-daemon-container | grep gpsd ``` The output shows the following when GNSS is functioning correctly: - `gpsd` starting successfully - No `No such file or directory` errors exist 6. Check `ts2phc` (GNSS synchronization) status by running the following command: ```terminal $ oc logs -n openshift-ptp -c linuxptp-daemon-container | grep ts2phc ``` 7. Check `phc2sys` (system clock sync) status by running the following command: ```terminal $ oc logs -n openshift-ptp -c linuxptp-daemon-container | grep phc2sys ``` The output shows synchronization status messages for `phc2sys`. ```terminal phc2sys[xxx]: CLOCK_REALTIME phc offset -17 s2 freq -13865 delay 2305 ``` ### Creating a PTP Grandmaster configuration with GNSS failover on Single Node OpenShift {#configuring-gnss-to-ntp-failover-sno_configuring-ptp} This procedure configures a T-GM (Telecom Grandmaster) clock on single-node OpenShift that uses an Intel E810 Westport Channel NIC as the PTP grandmaster clock with GNSS to NTP failover capabilities. **Prerequisites** - For T-GM clocks in production environments, install an Intel E810 Westport Channel NIC in the bare metal single-node OpenShift host. - Install the OpenShift CLI (`oc`). - Log in as a user with `cluster-admin` privileges. - Install the PTP Operator. **Procedure** 1. Verify the PTP Operator installation by running the following command: ```terminal $ oc get pods -n openshift-ptp -o wide ``` The output is similar to the following listing the PTP Operator pod and the single `linuxptp-daemon` pod: ```terminal NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES linuxptp-daemon-xz8km 2/2 Running 0 15m 192.168.1.50 mysno-sno.demo.lab ptp-operator-75c77dbf86-xm9kl 1/1 Running 0 20m 10.129.0.45 mysno-sno.demo.lab ``` - `ptp-operator-*`: The PTP Operator pod (one instance in the cluster). - `linuxptp-daemon-*`: The linuxptp daemon pod. On single-node OpenShift, there is only one daemon pod running on the master node. The daemon pod should show `2/2` in the READY column, indicating both containers (`linuxptp-daemon-container` and `kube-rbac-proxy`) are running. 2. Check which network interfaces support hardware timestamping by running the following command: ```terminal $ oc get NodePtpDevice -n openshift-ptp -o yaml ``` The output is similar to the following one, showing the NodePtpDevice resource for the single-node OpenShift node with PTP-capable network interfaces: ```yaml apiVersion: v1 items: - apiVersion: ptp.openshift.io/v1 kind: NodePtpDevice metadata: name: mysno-sno.demo.lab namespace: openshift-ptp spec: {} status: devices: - name: ens7f0 hwConfig: phcIndex: 0 - name: ens7f1 hwConfig: phcIndex: 1 kind: List metadata: resourceVersion: "" ``` In this example output: - `ens7f0` and `ens7f1` are PTP-capable interfaces (Intel E810 NIC ports). - `phcIndex` indicates the PTP Hardware Clock number (maps to `/dev/ptp0`, `/dev/ptp1`, etc.) > [!NOTE] > On single-node OpenShift clusters, you will see only one NodePtpDevice resource for the single master node. 3. The PTP profile uses node labels for matching. Check your machine config pool (MCP) to verify the master MCP by running the following command: ```terminal $ oc get mcp ``` The output is similar to the following: ```terminal NAME CONFIG UPDATED UPDATING DEGRADED MACHINECOUNT READYMACHINECOUNT UPDATEDMACHINECOUNT DEGRADEDMACHINECOUNT AGE master rendered-master-a1b1* True False False 1 1 1 0 45d worker rendered-worker-f6e5* True False False 0 0 0 0 45d ``` > [!NOTE] > The CONFIG column shows a truncated hash of the rendered MachineConfig. In actual output, this will be a full 64-character hash like `rendered-master-a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6`. On single-node OpenShift clusters, the master MCP shows `MACHINECOUNT` of 1 (the single node), and the worker MCP shows `MACHINECOUNT` of 0. The PTP profile must target the `master` node label. 4. Create a `PtpConfig` custom resource (CR) that configures the T-GM clock with GNSS to NTP failover. Save the following YAML configuration to a file named `ptp-config-gnss-ntp-failover-sno.yaml`. ```yaml # The grandmaster profile is provided for testing only # It is not installed on production clusters apiVersion: ptp.openshift.io/v1 kind: PtpConfig metadata: name: grandmaster namespace: openshift-ptp annotations: ran.openshift.io/ztp-deploy-wave: "10" spec: profile: - name: "grandmaster" ptp4lOpts: "-2 --summary_interval -4" phc2sysOpts: -r -u 0 -m -N 8 -R 16 -s ens7f0 -n 24 ptpSchedulingPolicy: SCHED_FIFO ptpSchedulingPriority: 10 ptpSettings: logReduce: "true" # --- FAILOVER CONFIGURATION --- # Holdover time: 14400 seconds (4 hours) before switching to NTP ts2phcOpts: "--ts2phc.holdover 14400" # Configure Chronyd (Secondary Time Source) chronydOpts: "-d" chronydConf: | server time.nist.gov iburst makestep 1.0 -1 pidfile /var/run/chronyd.pid plugins: # E810 Hardware-Specific Configuration e810: enableDefaultConfig: false settings: LocalHoldoverTimeout: 14400 LocalMaxHoldoverOffSet: 1500 MaxInSpecOffset: 1500 pins: # Syntax guide: # - The 1st number in each pair must be one of: # 0 - Disabled # 1 - RX # 2 - TX # - The 2nd number in each pair must match the channel number ens7f0: SMA1: 0 1 SMA2: 0 2 U.FL1: 0 1 U.FL2: 0 2 ublxCmds: - args: #ubxtool -P 29.20 -z CFG-HW-ANT_CFG_VOLTCTRL,1 - "-P" - "29.20" - "-z" - "CFG-HW-ANT_CFG_VOLTCTRL,1" reportOutput: false - args: #ubxtool -P 29.20 -e GPS - "-P" - "29.20" - "-e" - "GPS" reportOutput: false - args: #ubxtool -P 29.20 -d Galileo - "-P" - "29.20" - "-d" - "Galileo" reportOutput: false - args: #ubxtool -P 29.20 -d GLONASS - "-P" - "29.20" - "-d" - "GLONASS" reportOutput: false - args: #ubxtool -P 29.20 -d BeiDou - "-P" - "29.20" - "-d" - "BeiDou" reportOutput: false - args: #ubxtool -P 29.20 -d SBAS - "-P" - "29.20" - "-d" - "SBAS" reportOutput: false - args: #ubxtool -P 29.20 -t -w 5 -v 1 -e SURVEYIN,600,50000 - "-P" - "29.20" - "-t" - "-w" - "5" - "-v" - "1" - "-e" - "SURVEYIN,600,50000" reportOutput: true - args: #ubxtool -P 29.20 -p MON-HW - "-P" - "29.20" - "-p" - "MON-HW" reportOutput: true - args: #ubxtool -P 29.20 -p CFG-MSG,1,38,248 - "-P" - "29.20" - "-p" - "CFG-MSG,1,38,248" reportOutput: true # NTP Failover Plugin ntpfailover: gnssFailover: true # --- GNSS (ts2phc) CONFIGURATION (Primary Source) --- ts2phcConf: | [nmea] ts2phc.master 1 [global] use_syslog 0 verbose 1 logging_level 7 ts2phc.pulsewidth 100000000 ts2phc.nmea_serialport /dev/ttyGNSS_1700_0 leapfile /usr/share/zoneinfo/leap-seconds.list [ens7f0] ts2phc.extts_polarity rising ts2phc.extts_correction 0 # --- PTP4L CONFIGURATION (Grandmaster Role) --- ptp4lConf: | [ens7f0] masterOnly 1 [ens7f1] masterOnly 1 [global] # # Default Data Set # twoStepFlag 1 priority1 128 priority2 128 domainNumber 24 #utc_offset 37 clockClass 6 clockAccuracy 0x27 offsetScaledLogVariance 0xFFFF free_running 0 freq_est_interval 1 dscp_event 0 dscp_general 0 dataset_comparison G.8275.x G.8275.defaultDS.localPriority 128 # # Port Data Set # logAnnounceInterval -3 logSyncInterval -4 logMinDelayReqInterval -4 logMinPdelayReqInterval 0 announceReceiptTimeout 3 syncReceiptTimeout 0 delayAsymmetry 0 fault_reset_interval -4 neighborPropDelayThresh 20000000 masterOnly 0 G.8275.portDS.localPriority 128 # # Run time options # assume_two_step 0 logging_level 6 path_trace_enabled 0 follow_up_info 0 hybrid_e2e 0 inhibit_multicast_service 0 net_sync_monitor 0 tc_spanning_tree 0 tx_timestamp_timeout 50 unicast_listen 0 unicast_master_table 0 unicast_req_duration 3600 use_syslog 1 verbose 0 summary_interval -4 kernel_leap 1 check_fup_sync 0 clock_class_threshold 7 # # Servo Options # pi_proportional_const 0.0 pi_integral_const 0.0 pi_proportional_scale 0.0 pi_proportional_exponent -0.3 pi_proportional_norm_max 0.7 pi_integral_scale 0.0 pi_integral_exponent 0.4 pi_integral_norm_max 0.3 step_threshold 2.0 first_step_threshold 0.00002 clock_servo pi sanity_freq_limit 200000000 ntpshm_segment 0 # # Transport options # transportSpecific 0x0 ptp_dst_mac 01:1B:19:00:00:00 p2p_dst_mac 01:80:C2:00:00:0E udp_ttl 1 udp6_scope 0x0E uds_address /var/run/ptp4l # # Default interface options # clock_type BC network_transport L2 delay_mechanism E2E time_stamping hardware tsproc_mode filter delay_filter moving_median delay_filter_length 10 egressLatency 0 ingressLatency 0 boundary_clock_jbod 0 # # Clock description # productDescription ;; revisionData ;; manufacturerIdentity 00:00:00 userDescription ; timeSource 0x20 ptpClockThreshold: holdOverTimeout: 5 maxOffsetThreshold: 100 minOffsetThreshold: -100 recommend: - profile: "grandmaster" priority: 4 match: - nodeLabel: node-role.kubernetes.io/master ``` > [!IMPORTANT] > Replace the example interface names (`ens7f0`, `ens7f1`) with your actual E810 NIC interface names found in step 2. Common E810 interface naming patterns include `ens7f0`, `ens8f0`, `eth0`, `enp2s0f0`, and so on. The exact name depends on your system BIOS settings and Linux network device naming conventions. Also, replace `/dev/ttyGNSS_1700_0` with your actual GNSS serial port device path. The `nodeLabel` is set to `node-role.kubernetes.io/master` to target the single-node OpenShift master node which serves all roles. The configuration includes the following components: - **PTP4L options**: - `-2`: Use PTP version 2 - `--summary_interval -4`: Log summary every 2^(-4) = 0.0625 seconds - **PHC2SYS options:** - `-r`: Synchronize system clock from PTP hardware clock - `-u 0`: Update rate multiplier - `-m`: Print messages to stdout - `-N 8`: Domain number for ptp4l - `-R 16`: Update rate - `-s ens7f0`: Source interface (replace with your E810 interface name) - `-n 24`: Domain number - **Failover configuration:** - `ts2phcOpts --ts2phc.holdover 14400`: 4-hour holdover before switching to NTP - `chronydConf`: NTP server configuration for failover replace `time.nist.gov` with your preferred NTP server - `ntpfailover plugin`: Enables automatic GNSS-to-NTP switching with `gnssFailover: true`. - **E810 plugin configuration:** - `LocalHoldoverTimeout: 14400`: E810 hardware holdover timeout (4 hours) - `pins`: Configuration for 1PPS input on E810 physical pins (U.FL2, SMA1, SMA2, U.FL1) - `ublxCmds`: Commands to configure u-blox GNSS receiver (enable GPS, disable other constellations, set survey-in mode) - **GNSS (ts2phc) configuration:** - `ts2phc.nmea_serialport /dev/ttyGNSS_1700_0`: GNSS serial port device path (replace with your actual GNSS device) - `ts2phc.extts_polarity rising`: 1PPS signal on rising edge - `ts2phc.pulsewidth 100000000`: 1PPS pulse width in nanoseconds - **PTP4L configuration:** - `masterOnly 1`: Interface acts only as PTP master - `clockClass 6`: GPS-synchronized quality level - `domainNumber 24`: PTP domain - `clock_type BC`: Boundary Clock mode - `time_stamping hardware`: Use hardware timestamps from E810 NIC 5. Apply the `PtpConfig` CR by running the following command: ```terminal $ oc apply -f ptp-config-gnss-ntp-failover-sno.yaml ``` The output is similar to the following: ```terminal ptpconfig.ptp.openshift.io/grandmaster created ``` **Verification** 1. The PTP daemon checks for profile updates every 30 seconds. Wait approximately 30 seconds, then verify by running the following command: ```terminal $ oc get ptpconfig -n openshift-ptp ``` The output is similar to the following: ```terminal NAME AGE grandmaster 2m ``` 2. Check the NodePtpDevice to see if the profile is applied. First, get your single-node OpenShift node name: ```terminal $ oc get nodes ``` The output is similar to the following: ```terminal NAME STATUS ROLES AGE VERSION mysno-sno.demo.lab Ready control-plane,master,worker 4h19m v1.35.4 ``` Then describe the NodePtpDevice using your node name: ```terminal $ oc describe nodeptpdevice mysno-sno.demo.lab -n openshift-ptp ``` 3. Check if the profile is being loaded by monitoring the daemon logs. First, get the daemon pod name: ```terminal $ oc get pods -n openshift-ptp | grep linuxptp-daemon ``` The output shows the single linuxptp-daemon pod: ```terminal linuxptp-daemon-xz8km 2/2 Running 0 15m ``` Then check the logs using the pod name: ```terminal $ oc logs -n openshift-ptp linuxptp-daemon-xz8km -c linuxptp-daemon-container --tail=100 ``` Success indicators in the logs are: - `load profiles` - Profile is being loaded - `in applyNodePTPProfiles` - Profile is being applied - No `ptp profile doesn't exist for node` errors 4. Check `chronyd` status to verify NTP is running as the secondary time source by running the following command: ```terminal $ oc logs -n openshift-ptp linuxptp-daemon-xz8km -c linuxptp-daemon-container | grep chronyd ``` The output is similar to the following: ```terminal chronyd version 4.5 starting Added source ID#0000000001 (time.nist.gov) ``` 5. Check GNSS/gpsd by running the following command: ```terminal $ oc logs -n openshift-ptp linuxptp-daemon-xz8km -c linuxptp-daemon-container | grep gpsd ``` The output shows the following when GNSS is functioning correctly: - `gpsd` starting successfully - No `No such file or directory` errors exist 6. Check `ts2phc` (GNSS synchronization) status by running the following command: ```terminal $ oc logs -n openshift-ptp linuxptp-daemon-xz8km -c linuxptp-daemon-container | grep ts2phc ``` 7. Check `phc2sys` (system clock sync) status by running the following command: ```terminal $ oc logs -n openshift-ptp linuxptp-daemon-xz8km -c linuxptp-daemon-container | grep phc2sys ``` The output shows synchronization status messages for `phc2sys`. ```terminal phc2sys[xxx]: CLOCK_REALTIME phc offset -17 s2 freq -13865 delay 2305 ``` ## Troubleshooting common PTP Operator issues {#cnf-troubleshooting-common-ptp-operator-issues_configuring-ptp} Troubleshoot common problems with the PTP Operator by performing the following steps. **Prerequisites** - Install the OpenShift Container Platform CLI (`oc`). - Log in as a user with `cluster-admin` privileges. - Install the PTP Operator on a bare-metal cluster with hosts that support PTP. **Procedure** 1. Check the Operator and operands are successfully deployed in the cluster for the configured nodes. ```terminal $ oc get pods -n openshift-ptp -o wide ``` ```terminal {title="Example output"} NAME READY STATUS RESTARTS AGE IP NODE linuxptp-daemon-lmvgn 3/3 Running 0 4d17h 10.1.196.24 compute-0.example.com linuxptp-daemon-qhfg7 3/3 Running 0 4d17h 10.1.196.25 compute-1.example.com ptp-operator-6b8dcbf7f4-zndk7 1/1 Running 0 5d7h 10.129.0.61 control-plane-1.example.com ``` > [!NOTE] > When the PTP fast event bus is enabled, the number of ready `linuxptp-daemon` pods is `3/3`. If the PTP fast event bus is not enabled, `2/2` is displayed. 2. Check that supported hardware is found in the cluster. ```terminal $ oc -n openshift-ptp get nodeptpdevices.ptp.openshift.io ``` ```terminal {title="Example output"} NAME AGE control-plane-0.example.com 10d control-plane-1.example.com 10d compute-0.example.com 10d compute-1.example.com 10d compute-2.example.com 10d ``` 3. Check the available PTP network interfaces for a node: ```terminal $ oc -n openshift-ptp get nodeptpdevices.ptp.openshift.io -o yaml ``` where: : Specifies the node you want to query, for example, `compute-0.example.com`. ```yaml {title="Example output"} apiVersion: ptp.openshift.io/v1 kind: NodePtpDevice metadata: creationTimestamp: "2021-09-14T16:52:33Z" generation: 1 name: compute-0.example.com namespace: openshift-ptp resourceVersion: "177400" uid: 30413db0-4d8d-46da-9bef-737bacd548fd spec: {} status: devices: - name: eno1 - name: eno2 - name: eno3 - name: eno4 - name: enp5s0f0 - name: enp5s0f1 ``` 4. Check that the PTP interface is successfully synchronized to the primary clock by accessing the `linuxptp-daemon` pod for the corresponding node. 1. Get the name of the `linuxptp-daemon` pod and corresponding node you want to troubleshoot by running the following command: ```terminal $ oc get pods -n openshift-ptp -o wide ``` ```terminal {title="Example output"} NAME READY STATUS RESTARTS AGE IP NODE linuxptp-daemon-lmvgn 3/3 Running 0 4d17h 10.1.196.24 compute-0.example.com linuxptp-daemon-qhfg7 3/3 Running 0 4d17h 10.1.196.25 compute-1.example.com ptp-operator-6b8dcbf7f4-zndk7 1/1 Running 0 5d7h 10.129.0.61 control-plane-1.example.com ``` 2. Remote shell into the required `linuxptp-daemon` container: ```terminal $ oc rsh -n openshift-ptp -c linuxptp-daemon-container ``` where: : is the container you want to diagnose, for example `linuxptp-daemon-lmvgn`. 3. In the remote shell connection to the `linuxptp-daemon` container, use the PTP Management Client (`pmc`) tool to diagnose the network interface. Run the following `pmc` command to check the sync status of the PTP device, for example `ptp4l`. ```terminal # pmc -u -f /var/run/ptp4l.0.config -b 0 'GET PORT_DATA_SET' ``` ```terminal {title="Example output when the node is successfully synced to the primary clock"} sending: GET PORT_DATA_SET 40a6b7.fffe.166ef0-1 seq 0 RESPONSE MANAGEMENT PORT_DATA_SET portIdentity 40a6b7.fffe.166ef0-1 portState SLAVE logMinDelayReqInterval -4 peerMeanPathDelay 0 logAnnounceInterval -3 announceReceiptTimeout 3 logSyncInterval -4 delayMechanism 1 logMinPdelayReqInterval -4 versionNumber 2 ``` 5. For GNSS-sourced grandmaster clocks, verify that the in-tree NIC ice driver is correct by running the following command, for example: ```terminal $ oc rsh -n openshift-ptp -c linuxptp-daemon-container linuxptp-daemon-74m2g ethtool -i ens7f0 ``` ```terminal {title="Example output"} driver: ice version: 5.14.0-356.bz2232515.el9.x86_64 firmware-version: 4.22 0x8001778b 1.3346.0 ``` 6. For GNSS-sourced grandmaster clocks, verify that the `linuxptp-daemon` container is receiving signal from the GNSS antenna. If the container is not receiving the GNSS signal, the `/dev/gnss0` file is not populated. To verify, run the following command: ```terminal $ oc rsh -n openshift-ptp -c linuxptp-daemon-container linuxptp-daemon-jnz6r cat /dev/gnss0 ``` ```terminal {title="Example output"} $GNRMC,125223.00,A,4233.24463,N,07126.64561,W,0.000,,300823,,,A,V*0A $GNVTG,,T,,M,0.000,N,0.000,K,A*3D $GNGGA,125223.00,4233.24463,N,07126.64561,W,1,12,99.99,98.6,M,-33.1,M,,*7E $GNGSA,A,3,25,17,19,11,12,06,05,04,09,20,,,99.99,99.99,99.99,1*37 $GPGSV,3,1,10,04,12,039,41,05,31,222,46,06,50,064,48,09,28,064,42,1*62 ``` ## Getting the DPLL firmware version for the CGU in an Intel 800 series NIC {#cnf-getting-the-dpll-firmware-version-for-intel-800-series-nics_configuring-ptp} You can get the digital phase-locked loop (DPLL) firmware version for the Clock Generation Unit (CGU) in an Intel 800 series NIC by opening a debug shell to the cluster node and querying the NIC hardware. **Prerequisites** - You have installed the OpenShift CLI (`oc`). - You have logged in as a user with `cluster-admin` privileges. - You have installed an Intel 800 series NIC in the cluster host. - You have installed the PTP Operator on a bare-metal cluster with hosts that support PTP. **Procedure** 1. Start a debug pod by running the following command: ```terminal $ oc debug node/ ``` where: : Is the node where you have installed the Intel 800 series NIC. 2. Check the CGU firmware version in the NIC by using the `devlink` tool and the bus and device name where the NIC is installed. For example, run the following command: ```terminal sh-4.4# devlink dev info / | grep cgu ``` where: : Is the bus where the NIC is installed. For example, `pci`. : Is the NIC device name. For example, `0000:51:00.0`. ```terminal {title="Example output"} cgu.id 36 fw.cgu 8032.16973825.6021 ``` where: `cgu.id 36` : CGU hardware revision number. `fw.cgu 8032.16973825.6021` : DPLL firmware version running in the CGU, where the DPLL firmware version is `6201`, and the DPLL model is `8032`. The string `16973825` is a shorthand representation of the binary version of the DPLL firmware version (`1.3.0.1`). > [!NOTE] > The firmware version has a leading nibble and 3 octets for each part of the version number. The number `16973825` in binary is `0001 0000 0011 0000 0000 0000 0001`. Use the binary value to decode the firmware version. For example: > > **DPLL firmware version** > > | Binary part | Decimal value | > | --- | --- | > | `0001` | 1 | > | `0000 0011` | 3 | > | `0000 0000` | 0 | > | `0000 0001` | 1 | ## Collecting PTP Operator data {#cnf-about-collecting-nro-data_configuring-ptp} You can use the `oc adm must-gather` command to collect information about your cluster, including features and objects associated with PTP Operator. **Prerequisites** - You have access to the cluster as a user with the `cluster-admin` role. - You have installed the OpenShift CLI (`oc`). - You have installed the PTP Operator. **Procedure** - To collect PTP Operator data with `must-gather`, you must specify the PTP Operator `must-gather` image. ```terminal $ oc adm must-gather --image=registry.redhat.io/openshift4/ptp-must-gather-rhel9:v4.22 ```