PTP GNSS and SyncE Support (dsR6*)

Updates/additions to:
-System Config PTP section
-Guest Integration
-Admin Tasks
-Updates and Upgrades
Additional examples for T-BC
Incorporated patchset 3 review comments.
Added Limitations section.
Integrated patchset 5 comments.
Remove PTP Instance Removal - moved to RNs.

*Do not pick 100.019 alarm update to r6

Story: 2009130

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ibdf449fe1d7282302d9be6d90e1c1b6dd70456b4
This commit is contained in:
Ron Stone
2022-03-18 14:56:18 -04:00
parent a18b20c7fd
commit 3b8299cf2c
22 changed files with 1098 additions and 368 deletions

View File

@@ -60,3 +60,14 @@ Metrics Server
kubernetes-admin-tutorials-metrics-server
-----------------
PTP Notifications
-----------------
.. toctree::
:maxdepth: 1
install-ptp-notifications
remove-ptp-notifications
override-default-application-values

View File

@@ -0,0 +1,61 @@
.. xqd1614091832213
.. _install-ptp-notifications:
=========================
Install PTP Notifications
=========================
|PTP| notification is packaged as a system application and is managed
using the :command:`system application` and :command:`system-helm-override`
commands.
.. rubric:: |context|
|prod| provides the capability for application\(s\) to subscribe to
asynchronous |PTP| status notifications and pull for the |PTP| state on demand.
.. xbooklink :ref:`|prod-long| System Configuration
<system-configuration-management-overview>`:
.. rubric:: |proc|
You must provide helm override values indicating the ``ptp4l`` and ``phc2sys``
instances being tracked by ``ptp-notification``.
You must also remove your existing ``ptp-notification`` application and
upload/apply the new version. Because multiple ``ptp4l`` instances can be
supported on a node, you must specify which instance ``ptp-notification`` is
tracking.
For example:
#. Upload ``ptp-notification``.
.. code-block::
~(keystone_admin)]$ system application-upload <path to application>
#. Edit application overrides.
.. code-block::
cat ~/notification-override.yaml
ptptracking:
ptp4lSocket: /var/run/ptp4l-ptp1
ptp4lServiceName: ptp1
phc2sysServiceName: phc2sys1
#. Apply the overrides.
.. code-block::
~(keystone_admin)]$ system helm-override-update ptp-notification ptp-notification notification --values notification-override.yaml
#. Apply ``ptp-notification``.
.. code-block::
~(keystone_admin)]$ system application-apply ptp-notification

View File

@@ -0,0 +1,60 @@
.. bdx1614099833159
.. _override-default-application-values:
===================================
Override Default Application Values
===================================
You can override default application values using the commands described in this section.
.. rubric:: |proc|
#. View existing values.
.. code-block:: none
~(keystone_admin)]$ system helm-override-show ptp-notification
ptp-notification notification
#. Create a yaml file and update the fields that require Helm overrides.
.. code-block:: none
cat ~/override.yaml
ptptracking:
device:
holdover_seconds: 25
poll_freq_seconds: 2
#. Apply the values.
Application values can be added by the user and applied, using the following commands.
.. note::
The application could be in the "uploaded" or "applied" state.
.. code-block:: none
~(keystone_admin)]$ system helm-override-update ptp-notification ptp-notification notification -values <override.yaml>
.. code-block:: none
~(keystone_admin)]$ system application-apply ptp-notification
where the values are:
**simulated**
value must be 'false' for a normal operation \(used only for troubleshooting\).
**holdover_seconds**
value is the holdover time provided by the |NIC| specification. The default is 15 seconds.
**poll_freq_seconds**
is the frequency that the tracking function monitors the ``ptp4l`` to
derive the |PTP| sync state. The default is 2 seconds.

View File

@@ -0,0 +1,41 @@
.. nie1614092105640
.. _remove-ptp-notifications:
========================
Remove PTP Notifications
========================
You can remove all pods and Kubernetes resources created during the Armada
application deployment.
Use the following procedure to remove |PTP| notifications.
.. rubric:: |proc|
.. _remove-ptp-notifications-steps-klx-gnf-t4b:
#. Remove all pods and other Kubernetes resources created during the Armada
deployment, using the following command:
.. code-block:: none
~(keystone_admin)]$ system application-remove ptp-notification
#. Delete the ptp-notification from sysinv.
.. code-block:: none
~(keystone_admin)]$ system application-delete ptp-notification
#. Remove labels applied to controller-0, using the following commands, for example:
.. code-block:: none
~(keystone_admin)]$ system host-label-remove controller-0 ptp-notification
~(keystone_admin)]$ system host-label-remove controller-0 ptp-registration