starlingx/docs
Code Issues Proposed changes

Sidecar page

Browse Source 
Added notification client sidecar page and _includes dependency.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I7df696ea0e21831fc0fc4fc3e113f6bfbe69e4a6
This commit is contained in:
Ron Stone 2021-06-01 17:48:48 -04:00
parent 0cfef4fba1
commit f4155c4bb1
3 changed files with 54 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/_includes/integrate-application-with-notification-client-sidecar.rest Normal file
View File

@ -0,0 +1,7 @@
.. shortdesc-begin
.. shortdesc-end
.. note-begin
.. note-end

1
doc/source/guest_integration/kubernetes/index.rst
View File

@ -13,4 +13,5 @@ PTP Notification
install-ptp-notifications
remove-ptp-notifications
override-default-application-values
integrate-application-with-notification-client-sidecar

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

@ -0,0 +1,46 @@
.. yxg1614092306444
.. _integrate-the-application-with-notification-client-sidecar:
==========================================================
Integrate the Application with Notification Client Sidecar
==========================================================
.. only:: partner
.. include:: /_includes/integrate-application-with-notification-client-sidecar.rest
:start-after: shortdesc-begin
:end-before: shortdesc-end
.. rubric:: |context|
The integration between the application is done with the use of a Sidecar. The
Sidecar runs as a container along with the application in the same pod. The
application and the Sidecar communicate via a REST API. See the figure below.
.. only:: partner
.. include:: /_includes/integrate-application-with-notification-client-sidecar.rest
:start-after: note-begin
:end-before: note-end
.. rubric:: |prereq|
The following prerequisites are required before the integration:
.. _integrate-the-application-with-notification-client-sidecar-ul-iyd-mxf-t4b:
- The cloud is configured with a node that supports the Subordinate mode \(Slave mode\).
- The cloud is labeled with **ptp-registration=true**, and **ptp-notification=true**.
- The **ptp-notification-armada-app** application is installed successfully.
- The application supports the |PTP| Notifications API.
.. image:: figures/cak1614112389132.png
:width: 800