Improve debug tools install

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

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index 6cb4eac7eaf5512791ac6b0cc4f36bc429a45180..a68f749a4d4c85654b6c03113a3931c0979ee4e4 100644 (file)
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -63,6 +63,8 @@ Preparing for Installation
 
 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.
 
 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.
 
 
 2. Devices must support configuration through NETCONF protocol/API.
 


@@ -79,6 +81,13 @@ if you need TAPI limited support, then run::
 
    feature:install odl-transportpce-tapi
 
 
    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
 if you need the inventory external connector support limited to 1.2.1 OpenROADM devices, then run::
 
    feature:install odl-transportpce-inventory