From 8ef8e36b2c546d4bfe93a36ca76d1242720af69f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elisamara=20Aoki=20Gon=C3=A7alves?= Date: Fri, 6 Dec 2024 19:21:30 +0000 Subject: [PATCH] Doc updates for ptp-notification-v2 api format changes (r10) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Closes-bug: 2091176 Change-Id: Ib806f5b94578be79f607c1af8996d3794e25bc91 Signed-off-by: Elisamara Aoki Gonçalves --- .../admintasks/kubernetes/install-ptp-notifications.rst | 5 +++++ .../ptp-notification-status-conditions-6d6105fccf10.rst | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/doc/source/admintasks/kubernetes/install-ptp-notifications.rst b/doc/source/admintasks/kubernetes/install-ptp-notifications.rst index f76e06d98..cb3d9fcc7 100644 --- a/doc/source/admintasks/kubernetes/install-ptp-notifications.rst +++ b/doc/source/admintasks/kubernetes/install-ptp-notifications.rst @@ -188,6 +188,11 @@ For example, follow the steps below: ``logging_level: INFO`` Set the logging level. DEBUG can be used for additional logs. + ``notification_format: standard`` + Set the notification output format to standard formatting. The + value can be set to "legacy" for compatibility with older client + versions. + ``ptp4lClockClassLockedList`` Set the list of clock classes that will allow ``ptp-notification`` to report **Locked**. The clockClass for a monitored ptp4l instance 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 543bfbc40..26e880dfe 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 @@ -18,7 +18,7 @@ The |PTP| status notifications are derived based on the following conditions: | | | | | | | - If holdover time exceeds its provided value. | | | | | - | | | - If PMC, ptp4l.conf, ptp4l or phc2sys are not accessible. | + | | | - If PMC, ptp4l.conf, or ptp4l are not accessible. | +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Locked | Clock is in sync state | - If portState is "SECONDARY" and ClockClass value is "6", "7" or "135" and timeTraceable flag is TRUE and PMC, ptp4l.conf, ptp4l or phc2sys are accessible. | | | | |