From 319ee558e4d429f822ca46013bd29fc8051c168e Mon Sep 17 00:00:00 2001 From: Ngairangbam Mili Date: Mon, 5 May 2025 04:49:22 +0000 Subject: [PATCH] Unified PTP Notification Overall Sync State (dsr10) Story: 2011370 Task: 52128 Change-Id: Ieca9d8b3f408be3b03e467ac64d49ef121ce0ce1 Signed-off-by: Ngairangbam Mili --- ...ication-status-conditions-6d6105fccf10.rst | 55 ++++++++++++++----- 1 file changed, 42 insertions(+), 13 deletions(-) diff --git a/doc/source/guest_integration/kubernetes/ptp-notification-status-conditions-6d6105fccf10.rst b/doc/source/guest_integration/kubernetes/ptp-notification-status-conditions-6d6105fccf10.rst index 26e880dfe..97db5e98a 100644 --- a/doc/source/guest_integration/kubernetes/ptp-notification-status-conditions-6d6105fccf10.rst +++ b/doc/source/guest_integration/kubernetes/ptp-notification-status-conditions-6d6105fccf10.rst @@ -24,9 +24,9 @@ The |PTP| status notifications are derived based on the following conditions: | | | | | | | - Locked clockClass values can be changed using the ptp4lClockClassLockedList Helm override. See "Install PTP Notifications" document for instructions. | +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Holdover | Clock is in holdover state | * For NICs using the Intel ice driver: If the state is transitioned from ``Locked`` to ``Holdover`` AND phc2sys is accessible, and holdover time does not expire. | + | Holdover | Clock is in holdover state | * For |NICs| using the Intel ice driver: If the state is transitioned from ``Locked`` to ``Holdover`` AND phc2sys is accessible, and holdover time does not expire| | | | | - | | | * For other NIC types: If the state is transitioned from ``Locked`` to ``Freerun`` AND phc2sys is accessible, and holdover time does not expire. | + | | | * For other |NIC| types: If the state is transitioned from ``Locked`` to ``Freerun`` AND phc2sys is accessible, and holdover time does not expire. | +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **PTP Clock Class** | +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -49,7 +49,7 @@ The |PTP| status notifications are derived based on the following conditions: | **OS Clock State** | +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Locked | Clock is out of sync state | * phc2sys is running and disciplining the os clock | - | | | * OS clock is within 1000 ns of 37000000000 expected offset from PHC | + | | | * OS clock is within 1000 ns of 37000000000 expected offset from |PHC| | +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Holdover | Clock is in holdover state | * Holdover timer has not expired | | | | * phc2sys is not running and not disciplining the os clock | @@ -59,22 +59,51 @@ The |PTP| status notifications are derived based on the following conditions: +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **GNSS State** | +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | SYNCHRONIZED | GNSS data is present | * ts2phc is running and disciplining NIC PHC | - | | | * NIC driver DPLL reports GNSS state is locked | + | SYNCHRONIZED | GNSS data is present | * ts2phc is running and disciplining |NIC| |PHC| | + | | | * |NIC| driver DPLL reports GNSS state is locked | +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | FAILURE-NOFIX | GNSS data is not detected | * ts2phc is not running, NIC PHC is not being disciplined | - | | | * NIC driver DPLL reports status other than locked | + | FAILURE-NOFIX | GNSS data is not detected | * ts2phc is not running, |NIC| |PHC| is not being disciplined | + | | | * |NIC| driver DPLL reports status other than locked | +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Overall Sync State** | +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Locked | Overall state is locked | * All monitored services are Locked or Synchronized (excluding clockClass) | - | | | | + | Locked | Overall state is locked | * The components of the local timing chain necessary for accurately synced time on the local host are in a healthy state | + | | | * This means that a local |NIC| |PHC| is locked to an external timing source and the system clock is synchronized to it | + | | | * The ptp-notification container logs indicate which components are part of the local timing chain and affect this notification | +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **PTP Lock State** | - +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Holdover | Overall state is in holdover | * One or more monitored services are in a degraded state (holdover or freerun) | + | Holdover | Overall state is in holdover | | + | | | * One or more components in the local timing chain are in a degraded state (holdover or freerun) | | | | * Overall sync state holdover time has not expired | +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Freerun | Overall state is freerun | * One or more monitored services are in a degraded state (holdover or freerun) | + | Freerun | Overall state is freerun | | + | | | * One or more components in the local timing chain are in a degraded state (holdover or freerun) | | | | * Overall sync state holdover time has expired | +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------ +Overall Sync State Description +------------------------------ + +The overall sync state notification (`sync-state`) describes the health of the +timing chain on the local system. A locked state is reported when the system +has reference to an external time source (|GNSS| or |PTP|) and the system clock is +synchronized to that time source. + +This notification helps you to verify that the local system time is being +actively synchronized. If a component of the local timing chain enters a +degraded state, then a `sync-state` notification will be produced to indicate +that the local timing chain is unhealthy. + +The following is an example log output from the ptp-notification container that +indicates the components of the local timing chain: + +.. code-block:: none + + 2025-05-01 15:34:48 INFO Overall sync state chaining info: + os-clock-state = Locked + os-clock's source ptp-device = ptp0 + ptp-device's sync-source = PTP + (PTP source) ptp4l-instance-and-state = ('ptp1', 'Locked') + (GNSS source) ts2phc-instance-and-state = NA + Overall sync: previous-state = Freerun, new-state = Locked +