Create, Test, and Terminate a PTP Notification Demo

This section provides instructions on accessing, creating, testing and terminating a ptp-notification-demo.

About this task

Use the following procedure to copy the tarball from a StarlingX mirror, create, test, and terminate a ptp-notification-demo.


  1. Copy the ptp-notification-demo_v1.0.2.tgz file from StarlingX at to yor system, and extract its content.


    The tarball includes the docker file and code to build the reference API application, and the Helm chart to install the Sidecar along with the application.

    The following files are part of the tarball:

    • Helm charts

      • Chart.yaml

      • values.yaml

      • _helpers.tpl

      • configmap.yaml

      • deployment.yaml

      • .helmignore

      • ptp-notification-override.yaml



    • notification-docker

      • Dockerfile

      • api


    The demo uses the following images:

    • starlingx/notificationclient-base:stx.5.0-v1.0.3

    • ptp-base:1.0.1

  2. Build the ptp-base:1.0.1 image using the following commands.

    $ tar xvf ptp-notification-demo_<v1.0.2>.tgz
    $ cd ~/notification-dockers/ptp-base/
    $ sudo docker build . -t ptp-base:1.0.1
    $ sudo docker save ptp-base:1.0.1 -o ptp-base.1.0.1.tar
    $ sudo ctr -n image import ./ptp-base.1.0.1.tar
    $ cd ~/charts
    $ tar xvf ptp-notification-demo-1.tgz


    For AIO-SX and AIO-DX systems, ptp-base.1.0.1.tar should be copied to each node and the import command, sudo ctr -n image import ./ptp-base.1.0.1.tar should be run on each node.

  3. Install the demo’s pod using the following commands.


    This pod includes two containers, Sidecar and the referenced API application.

    $ kubectl create namespace ptpdemo
    $ helm install -n notification-demo ~/charts/ptp-notification-demo -f ~/charts/ptp-notification-demo/ptp-notification-override.yaml
    $ kubectl get pods -n ptpdemo
    NAME                                         READY   STATUS   RESTARTS AGE
    notification-demo-ptp-notification-demo-cf7b65c47-s5jk6 2/2     Running   0       5m50s
  4. Test the ptp-notification demo.

    1. Display the app logs using the following command.

      $ kubectl logs -f notification-demo-ptp-notification-demo-<xyz> -c ptp-notification-demo-app -n ptpdemo
  5. In another terminal, access the application container.

    $ kubectl exec -it notification-demo-ptp-notification-demo-<zyz> -c ptp-notification-demo-app -n ptpdemo -- bash
    1. Check if you can pull PTP status using the REST API.

      $ curl -v -H 'Content-Type: application/json'
    2. Subscribe to PTP notifications.

      $ curl -v -d '{"ResourceType": "PTP", "ResourceQualifier": {"NodeName": "controller-0"}, "EndpointUri": ""}' -H 'Content-Type: application/json' -X POST${SIDECAR_API_PORT}/ocloudNotifications/v1/subscriptions |python -m json.tool
    3. Retrieve a list of subscriptions.

      $ curl -v -H 'Content-Type: application/json'${SIDECAR_API_PORT}/ocloudNotifications/v1/subscriptions |python -m json.tool

      For example, to get a specific subscription, use the following command.

      $ curl -v -H 'Content-Type: application/json'${SIDECAR_API_PORT}/ocloudNotifications/v1/subscriptions/<subscriptionId>
    4. To delete a specific subscription with the subscription ID, run the following command.

      $ curl -X DELETE -v -H 'Content-Type: application/json'${SIDECAR_API_PORT}/ocloudNotifications/v1/subscriptions/<subscriptionId>
  6. Terminate the demo using the following command.

    $ helm del --purge notification-demo