diff --git a/doc/source/container_integration/kubernetes/integrate-the-application-with-notification-client-sidecar.rst b/doc/source/container_integration/kubernetes/integrate-the-application-with-notification-client-sidecar.rst deleted file mode 100644 index ca8a56434..000000000 --- a/doc/source/container_integration/kubernetes/integrate-the-application-with-notification-client-sidecar.rst +++ /dev/null @@ -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 diff --git a/doc/source/guest_integration/index.rst b/doc/source/guest_integration/index.rst new file mode 100644 index 000000000..653b5102d --- /dev/null +++ b/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 diff --git a/doc/source/container_integration/figures/cak1614112389132.png b/doc/source/guest_integration/kubernetes/figures/cak1614112389132.png similarity index 100% rename from doc/source/container_integration/figures/cak1614112389132.png rename to doc/source/guest_integration/kubernetes/figures/cak1614112389132.png diff --git a/doc/source/container_integration/figures/gvf1614702096862.png b/doc/source/guest_integration/kubernetes/figures/gvf1614702096862.png similarity index 100% rename from doc/source/container_integration/figures/gvf1614702096862.png rename to doc/source/guest_integration/kubernetes/figures/gvf1614702096862.png diff --git a/doc/source/container_integration/kubernetes/index.rst b/doc/source/guest_integration/kubernetes/index.rst similarity index 81% rename from doc/source/container_integration/kubernetes/index.rst rename to doc/source/guest_integration/kubernetes/index.rst index e60b7a7c9..61c7df0f6 100644 --- a/doc/source/container_integration/kubernetes/index.rst +++ b/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 + diff --git a/doc/source/container_integration/kubernetes/install-ptp-notifications.rst b/doc/source/guest_integration/kubernetes/install-ptp-notifications.rst similarity index 99% rename from doc/source/container_integration/kubernetes/install-ptp-notifications.rst rename to doc/source/guest_integration/kubernetes/install-ptp-notifications.rst index 9b68b54d7..6ffda21ac 100644 --- a/doc/source/container_integration/kubernetes/install-ptp-notifications.rst +++ b/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 ` - -.. rubric:: |context| +.. rubric:: |proc| Use the following steps to install the **ptp-notification** application. -.. rubric:: |proc| - - #. Label the controller\(s\). diff --git a/doc/source/container_integration/kubernetes/override-default-application-values.rst b/doc/source/guest_integration/kubernetes/override-default-application-values.rst similarity index 100% rename from doc/source/container_integration/kubernetes/override-default-application-values.rst rename to doc/source/guest_integration/kubernetes/override-default-application-values.rst diff --git a/doc/source/container_integration/kubernetes/ptp-notifications-overview.rst b/doc/source/guest_integration/kubernetes/ptp-notifications-overview.rst similarity index 91% rename from doc/source/container_integration/kubernetes/ptp-notifications-overview.rst rename to doc/source/guest_integration/kubernetes/ptp-notifications-overview.rst index 833ae9873..14fab8cdd 100644 --- a/doc/source/container_integration/kubernetes/ptp-notifications-overview.rst +++ b/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 - - - -For more information on |PTP| notifications, see: - - -.. _ptp-notifications-overview-ul-xqg-2wg-t4b: - -- :ref:`Install PTP Notifications ` - -- :ref:`Remove PTP Notifications ` - -- :ref:`Override Default Application Values ` - -- :ref:`Integrate the Application with Notification Client Sidecar ` - +.. image:: figures/gvf1614702096862.png diff --git a/doc/source/container_integration/kubernetes/remove-ptp-notifications.rst b/doc/source/guest_integration/kubernetes/remove-ptp-notifications.rst similarity index 100% rename from doc/source/container_integration/kubernetes/remove-ptp-notifications.rst rename to doc/source/guest_integration/kubernetes/remove-ptp-notifications.rst diff --git a/doc/source/vnf_integration/bootstrap-data.rst b/doc/source/guest_integration/openstack/bootstrap-data.rst similarity index 100% rename from doc/source/vnf_integration/bootstrap-data.rst rename to doc/source/guest_integration/openstack/bootstrap-data.rst diff --git a/doc/source/vnf_integration/configuration-using-metadata.rst b/doc/source/guest_integration/openstack/configuration-using-metadata.rst similarity index 100% rename from doc/source/vnf_integration/configuration-using-metadata.rst rename to doc/source/guest_integration/openstack/configuration-using-metadata.rst diff --git a/doc/source/vnf_integration/index.rst b/doc/source/guest_integration/openstack/index.rst similarity index 100% rename from doc/source/vnf_integration/index.rst rename to doc/source/guest_integration/openstack/index.rst diff --git a/doc/source/vnf_integration/overview-of-vnf-integration.rst b/doc/source/guest_integration/openstack/overview-of-vnf-integration.rst similarity index 90% rename from doc/source/vnf_integration/overview-of-vnf-integration.rst rename to doc/source/guest_integration/openstack/overview-of-vnf-integration.rst index 0354a2716..d78d8161a 100644 --- a/doc/source/vnf_integration/overview-of-vnf-integration.rst +++ b/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 diff --git a/doc/source/vnf_integration/standard-virtio-backed-with-vhost-support.rst b/doc/source/guest_integration/openstack/standard-virtio-backed-with-vhost-support.rst similarity index 86% rename from doc/source/vnf_integration/standard-virtio-backed-with-vhost-support.rst rename to doc/source/guest_integration/openstack/standard-virtio-backed-with-vhost-support.rst index 1ddef7d9d..5e43c9041 100644 --- a/doc/source/vnf_integration/standard-virtio-backed-with-vhost-support.rst +++ b/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 diff --git a/doc/source/vnf_integration/use-a-vif-model-when-creating-ports.rst b/doc/source/guest_integration/openstack/use-a-vif-model-when-creating-ports.rst similarity index 90% rename from doc/source/vnf_integration/use-a-vif-model-when-creating-ports.rst rename to doc/source/guest_integration/openstack/use-a-vif-model-when-creating-ports.rst index c314be0e5..86aa7eed4 100644 --- a/doc/source/vnf_integration/use-a-vif-model-when-creating-ports.rst +++ b/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 diff --git a/doc/source/index.rst b/doc/source/index.rst index b18793c37..d44fc11f6 100755 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -171,8 +171,7 @@ Guest integration .. toctree:: :maxdepth: 2 - vnf_integration/index - container_integration/kubernetes/index + guest_integration/index ---------