starlingx/docs
Code Issues Proposed changes

Doc updates for ptp-notification-v2 api format changes (r10)

Browse Source 
Closes-bug: 2091176

Change-Id: Ib806f5b94578be79f607c1af8996d3794e25bc91
Signed-off-by: Elisamara Aoki Gonçalves <elisamaraaoki.goncalves@windriver.com>
This commit is contained in:
Elisamara Aoki Gonçalves 2024-12-06 19:21:30 +00:00
parent d11ff2bb1e
commit 8ef8e36b2c
2 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/admintasks/kubernetes/install-ptp-notifications.rst
View File

@ -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

2
doc/source/guest_integration/kubernetes/ptp-notification-status-conditions-6d6105fccf10.rst
View File

@ -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. |
| | | |