starlingx/docs
Code Issues Proposed changes

ptp-notification client images for v1 vs v2 API (r8, dsr8)

Browse Source 
Added a note to specify the v1 and v2 API images

Change-Id: I6b43c4f1913a403071d643e624b14d47efdf1d3f
Signed-off-by: Juanita Balaraj <juanita.balaraj@windriver.com>
This commit is contained in:
Juanita Balaraj 2023-09-28 20:40:05 +00:00
parent 5b9296ecbb
commit 4ecd638c8b
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/guest_integration/kubernetes/integrate-application-with-notification-client-sidecar.rst
View File

@ -15,10 +15,8 @@ Integrate the Application with Notification Client Sidecar
.. rubric:: |context|
This section provides an example of kubernetes deployment of the sidecar and a
simulated application. Users could replace the ``ptp-notification-demo-app``
container and related configurations with an application requiring |PTP| status
updates. The user application must support querying and handling responses
for either of the API definitions available at:
simulated application. The user application must support querying and handling
responses for either of the API definitions available at:
**See**:
@ -68,6 +66,12 @@ The config provided below is for illustrative purposes and is not validated.
A suitable user-supplied container would have to be run in the same pod and
configured to make API calls to the notificationclient-base container.
.. note::
The following example is for ``ptp-notification`` v2 API. To integrate
with ``ptp-notification`` v1 API, change the image from ``starlingx/notificationclient-base:stx.9.0-v2.1.1``
to ``starlingx/notificationclient-base:stx.5.0-v1.0.4``.
.. parsed-literal::
apiVersion: apps/v1