Add a checkbashisms tox profile

[transportpce.git] / docs / user-guide.rst

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index 6b691f56683fba69af24dee3153757ab4afe7daf..a68f749a4d4c85654b6c03113a3931c0979ee4e4 100644 (file)
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -29,7 +29,7 @@ handler, Renderer responsible for the path configuration through optical
 equipment and Optical Line Management (OLM) is associated with a generic block
 relying on open models, each of them communicating through published APIs.
 
-.. figure:: ./images/tpce_architecture.jpg
+.. figure:: ./images/TransportPCE-Diagramm-Magnesium.jpg
    :alt: TransportPCE architecture
 
    TransportPCE architecture
@@ -41,26 +41,19 @@ TransportPCE User-Facing Features
    -  This feature contains all other features/bundles of TransportPCE project.
       If you install it, it provides all functions that the TransportPCE project
       can support.
-
--  **odl-transportpce-api**
-
-   -  This feature contains all Transportpce project specific models defined in "Service-path".
+      It exposes all Transportpce project specific models defined in "Service-path".
       These models complement OpenROADM models describing South and Northbound APIs, and define the
       data structure used to interconnect the generic blocks/functions described on the previous
       diagram.
 
--  **odl-transportpce-ordmodels**
-
-   -  This feature contains all OpenROADM models : Common, Device, Network and Service models.
+-  **feature odl-transportpce-tapi**
 
--  **bundle transportpce-tapimodels**
+   -  This feature provides transportPCE a limited support of TAPI version 2.1.2 Northbound interface.
 
-   -  This bundle contains models coming from TAPI version 2.1.2.
-
--  **bundle transportpce-tapis**
-
-   -  This bundle contains limited support of TAPI version 2.1.2 Northbound interface.
+-  **feature odl-transportpce-inventory**
 
+   -  This feature is considered experimental. It provides transportPCE with an external connector to
+      a MariaDB inventory currently limited to OpenROADM 1.2.1 devices.
 
 How To Start
 ------------
@@ -68,9 +61,10 @@ How To Start
 Preparing for Installation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-1. Devices must support the standard OpenROADM Models more precisely versions
-   1.2.1 and 2.1. Limited support is provided for 2.2 and 2.2.1 devices.
-   If WDM is supported on them, the OTN support is considererd experimental at that date.
+1. Devices must support the standard OpenROADM Models more precisely versions 1.2.1 and 2.2.1.
+   Since Magnesium SR0, an OTN experimental support is provided for OpenROADM devices 2.2.1.
+   Magnesium SR2 is the first release managing end-to-end OTN services, as OCH-OTU4,
+   structured ODU4 or again 10GE-ODU2e services.
 
 2. Devices must support configuration through NETCONF protocol/API.
 
@@ -83,4 +77,19 @@ Run OpenDaylight and install TransportPCE Service *odl-transportpce* as below::
 
    feature:install odl-transportpce
 
+if you need TAPI limited support, then run::
+
+   feature:install odl-transportpce-tapi
+
+When installing the TAPI feature, you might encounter a heap memory size problem in Karaf.
+In that case, consider increasing Karaf heap memory size.
+For example by modifying the environment variables JAVA_MIN_MEM and JAVA_MAX_MEM before starting Karaf::
+
+   export JAVA_MIN_MEM=1024M
+   export JAVA_MAX_MEM=4069M
+
+if you need the inventory external connector support limited to 1.2.1 OpenROADM devices, then run::
+
+   feature:install odl-transportpce-inventory
+
 For a more detailed overview of the TransportPCE, see the :ref:`transportpce-dev-guide`.