Merge "Guest integration reorganization"

doc/source/container_integration/kubernetes/integrate-the-application-with-notification-client-sidecar.rst

@@ -1,43 +0,0 @@
-
-.. yxg1614092306444
-.. _integrate-the-application-with-notification-client-sidecar:
-
-==========================================================
-Integrate the Application with Notification Client Sidecar
-==========================================================
-
-This section describes the **ptp-notification-demo**, and provides instructions
-for enabling communication between the Sidecar and the application via a REST
-API.
-
-
-.. 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.
-
-.. note::
-    In this demo, we provide a referenced API application.
-
-
-.. 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

doc/source/guest_integration/index.rst

@@ -0,0 +1,34 @@
+.. Fault Management file, created by
+   sphinx-quickstart on Thu Sep  3 15:14:59 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+=================
+Guest Integration
+=================
+
+--------------------------------
+Kubernetes container integration
+--------------------------------
+
+|prod-long| supports applications that rely on |PTP| for synchronization. These
+applications are able to receive |PTP| status notifications from
+|prod-long| hosting the application.
+
+.. toctree::
+    :maxdepth: 2
+
+    kubernetes/index
+
+-------------------------
+OpenStack VNF integration
+-------------------------
+
+The |VNF| Integration document contains information specific to |VNF| or
+|VM| application writers that assists them with integrating their
+application on |prod-os|.
+
+.. toctree::
+    :maxdepth: 2
+
+    openstack/index

doc/source/guest_integration/kubernetes/index.rst

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

doc/source/guest_integration/kubernetes/install-ptp-notifications.rst

@@ -34,16 +34,12 @@ asynchronous |PTP| status notifications and pull for the |PTP| state on demand.
 -   :ref:`Configuring PTP Service Using the CLI <configuring-ptp-service-using-the-cli>`
 
 
-
+.. rubric:: |proc|
-.. rubric:: |context|
 
 
 Use the following steps to install the **ptp-notification** application.
 
 
-.. rubric:: |proc|
-
-
 #.  Label the controller\(s\).
 
 

doc/source/guest_integration/kubernetes/ptp-notifications-overview.rst

@@ -72,21 +72,5 @@ same pod and communicates with the application via a REST API.
 
 The figure below describes the subscription framework for |PTP| notifications.
 
-.. image:: ../figures/gvf1614702096862.png
+.. image:: figures/gvf1614702096862.png
-
-
-
-For more information on |PTP| notifications, see:
-
-
-.. _ptp-notifications-overview-ul-xqg-2wg-t4b:
-
--   :ref:`Install PTP Notifications <install-ptp-notifications>`
-
--   :ref:`Remove PTP Notifications <remove-ptp-notifications>`
-
--   :ref:`Override Default Application Values <override-default-application-values>`
-
--   :ref:`Integrate the Application with Notification Client Sidecar <integrate-the-application-with-notification-client-sidecar>`
-
 

doc/source/guest_integration/openstack/overview-of-vnf-integration.rst

@@ -31,7 +31,7 @@ The following |VNF|-related integration topics are included in this document:
 
 .. only:: partner
 
-   .. include:: ../_includes/overview-of-vnf-integration.rest
+   .. include:: /_includes/overview-of-vnf-integration.rest
 
 
 

doc/source/guest_integration/openstack/standard-virtio-backed-with-vhost-support.rst

@@ -14,7 +14,7 @@ For virtio interfaces, |prod-os| supports vhost-user transparently by default.
 
 .. only:: partner
 
-   .. include:: ../_includes/standard-virtio-backed-with-vhost-support.rest
+   .. include:: /_includes/standard-virtio-backed-with-vhost-support.rest
 
 
 

doc/source/guest_integration/openstack/use-a-vif-model-when-creating-ports.rst

@@ -23,4 +23,4 @@ port.html>`__.
 
 .. only:: partner
 
-   .. include:: ../_includes/use-a-vif-model-when-creating-ports.rest
+   .. include:: /_includes/use-a-vif-model-when-creating-ports.rest

doc/source/index.rst

@@ -171,8 +171,7 @@ Guest integration
 .. toctree::
    :maxdepth: 2
 
-   vnf_integration/index
+   guest_integration/index
-   container_integration/kubernetes/index
 
 
 ---------