docs/doc/source/admintasks/kubernetes/install-ptp-notifications.rst

Install PTP Notifications

notification is packaged as a system application and is managed using the system application and system-helm-override commands.

provides the capability for application(s) to subscribe to asynchronous status notifications and pull for the state on demand.

You must provide Helm override values indicating the ptp4l and phc2sys instances that you want tracked by your ptp-notification application.

Since multiple ptp4l instances can be supported on a node, you must specify the ServiceName of the instance that the ptp-notification application should track.

For example, follow the steps below:

1. Label the controller(s).

   1. Source the platform environment.

      $ source /etc/platform/openrc
      ~(keystone_admin)]$

   2. Assign the registration label to the controller(s).

      ~(keystone_admin)]$ system host-label-assign controller-0 ptp-registration=true
      ~(keystone_admin)]$ system host-label-assign controller-1 ptp-registration=true

   3. Assign the notification label to any node(s) configured for ptp4l clock synchronization. For example:

      ~(keystone_admin)]$ system host-label-assign controller-0 ptp-notification=true

2. Upload the ptp-notification application using the command below.

   ~(keystone_admin)]$ system application-upload <path to application>

3. Edit application overrides. The value for ptp4lSocket should be set to the socket path corresponding to the monitored ptp4l instance. Use the ls /var/run/ptp4l-* command to determine this path. The value for ptp4lServiceName should match the ptp4l instance name. The value for the phc2sysServiceName should match the phc2sys instance name. Use the system ptp-instance-list command to determine the values for ptp4lServiceName and phc2sysServiceName names.

   cat ~/notification-override.yaml
   ptptracking:
     ptp4lSocket: /var/run/ptp4l-ptp1
     ptp4lServiceName: ptp1
     phc2sysServiceName: phc2sys1

4. Apply the overrides using the command below.

   ~(keystone_admin)]$ system helm-override-update ptp-notification ptp-notification notification --values notification-override.yaml

5. Apply ptp-notification using the command below.

   ~(keystone_admin)]$ system application-apply ptp-notification

StarlingX supports applications that rely on PTP for synchronization. These applications are able to receive PTP status notifications from StarlingX hosting the application. For more information see:

• PTP Notifications Overview <ptp-notifications-overview>
• API PTP Notifications