From f4155c4bb17794375214f20c19d6c338e285edb9 Mon Sep 17 00:00:00 2001 From: Ron Stone Date: Tue, 1 Jun 2021 17:48:48 -0400 Subject: [PATCH] Sidecar page Added notification client sidecar page and _includes dependency. Signed-off-by: Ron Stone Change-Id: I7df696ea0e21831fc0fc4fc3e113f6bfbe69e4a6 --- ...tion-with-notification-client-sidecar.rest | 7 +++ .../guest_integration/kubernetes/index.rst | 1 + ...ation-with-notification-client-sidecar.rst | 46 +++++++++++++++++++ 3 files changed, 54 insertions(+) create mode 100644 doc/source/_includes/integrate-application-with-notification-client-sidecar.rest create mode 100644 doc/source/guest_integration/kubernetes/integrate-application-with-notification-client-sidecar.rst diff --git a/doc/source/_includes/integrate-application-with-notification-client-sidecar.rest b/doc/source/_includes/integrate-application-with-notification-client-sidecar.rest new file mode 100644 index 000000000..f91e95e6e --- /dev/null +++ b/doc/source/_includes/integrate-application-with-notification-client-sidecar.rest @@ -0,0 +1,7 @@ +.. shortdesc-begin + +.. shortdesc-end + +.. note-begin + +.. note-end \ No newline at end of file diff --git a/doc/source/guest_integration/kubernetes/index.rst b/doc/source/guest_integration/kubernetes/index.rst index 61c7df0f6..39346f608 100644 --- a/doc/source/guest_integration/kubernetes/index.rst +++ b/doc/source/guest_integration/kubernetes/index.rst @@ -13,4 +13,5 @@ PTP Notification install-ptp-notifications remove-ptp-notifications override-default-application-values + integrate-application-with-notification-client-sidecar diff --git a/doc/source/guest_integration/kubernetes/integrate-application-with-notification-client-sidecar.rst b/doc/source/guest_integration/kubernetes/integrate-application-with-notification-client-sidecar.rst new file mode 100644 index 000000000..a30743e3d --- /dev/null +++ b/doc/source/guest_integration/kubernetes/integrate-application-with-notification-client-sidecar.rst @@ -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