Update release in docs/conf.yaml

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

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index 6567a889ca399e820920a0473b4e503f75bd9e83..0e1bc1ce0d5af06e55f727e40055b56001d2d660 100644 (file)
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -17,11 +17,11 @@ request coming from a higher layer controller and/or an orchestrator.
 This capability may rely on the controller only or it may be delegated to
 distributed (standardized) protocols.
 
-It provides basic alarm/fault and performance monitoring,
+For the time being, it provides very basic alarm/fault management and performance monitoring,
 but this function might be externalized to improve the scalability.
-A Graphical User Interface has been developped separately and is not proposed
-here since automated control does not imply user interactions at the transport
-controller level.
+A Graphical User Interface (`Transport PCE_GUI <https://gitlab.com/Orange-OpenSource/lfn/odl/tpce_gui>`__)
+has been developped separately and is not proposed here since automated control
+does not imply user interactions at the transport controller level.
 
 TransportPCE modular architecture is described on the next diagram. Each main
 function such as Topology management, Path Calculation Engine (PCE), Service
@@ -48,7 +48,7 @@ TransportPCE User-Facing Features
 
 -  **feature odl-transportpce-tapi**
 
-   -  This feature provides transportPCE a limited support of TAPI version 2.1.2 Northbound interface.
+   -  This feature provides transportPCE a limited support of TAPI version 2.1.1 Northbound interface.
 
 -  **feature odl-transportpce-inventory**
 
@@ -71,10 +71,11 @@ How To Start
 Preparing for Installation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-1. Devices must support the standard OpenROADM Models more precisely versions 1.2.1 and 2.2.1.
+1. Devices must support the standard OpenROADM Models more precisely versions 1.2.1, 2.2.1 or 7.1.0.
    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.
+   This has also been extended to be supported on 7.1 devices
 
 2. Devices must support configuration through NETCONF protocol/API.
 
@@ -83,6 +84,23 @@ Preparing for Installation
 Installation Feature
 ~~~~~~~~~~~~~~~~~~~~
 
+Creation of services with TransportPCE controller on real optical devices takes a rather long while,
+due to the fact that the output optical power level modification on interfaces requires time for stabilisation
+level. By default values of TransportPCE timers are those recommended by OpenROADM MSA, respectively 120 000
+and 20 000 seconds.
+When running TransportPCE controller with honeynode simulators, which is the case of all TransportPCE functional tests,
+we don't need so important timer values. You can considerably speed tests using respectively 3000 and 2000 seconds.
+To that end, before starting karaf of the OpenDaylight TransportPCE controller, set OLM_TIMER1 and OLM_TIMER2 as environment variables.
+For example::
+
+    export OLM_TIMER1=3000 OLM_TIMER2=2000
+
+To come back with per default values for these timers, just logout from OpenDaylight controller, unset your
+environment variables, and start again the controller::
+
+    unset OLM_TIMER1 OLM_TIMER2
+
+
 Run OpenDaylight and install TransportPCE Service *odl-transportpce* as below::
 
    feature:install odl-transportpce
@@ -98,16 +116,19 @@ For example by modifying the environment variables JAVA_MIN_MEM and JAVA_MAX_MEM
    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::
+In Chlorine, installation of odl-transportpce-tapi feature may cause some other transportpce OSGi bundle to be
+in failure. To restore the situation, just log out and log back in.
+
+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 Dmaap connector support, before running Opendaylight, set DMAAP_BASE_URL as environment variable.
+If you need the Dmaap connector support, before running Opendaylight, set DMAAP_BASE_URL as environment variable.
 For example, if the base url of your Dmaap server is "https://dmaap-mr:30226", then::
 
     export DMAAP_BASE_URL=https://dmaap-mr:30226
 
-if your Dmaap server provides https connection through a self-signed certificate, do not forget to add the certificate
+If your Dmaap server provides https connection through a self-signed certificate, do not forget to add the certificate
 to the JAVA truststore::
 
     echo -n | openssl s_client -showcerts -connect dmaap-mr:30226 | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > /tmp/dmaap.crt
@@ -135,4 +156,9 @@ After that, run in karaf::
 
    feature:install odl-transportpce-nbinotifications
 
+.. note::
+
+    In Chlorine release, the odl-transportpce-swagger feature is no longer functional. Issue still under investigation.
+
+
 For a more detailed overview of the TransportPCE, see the :ref:`transportpce-dev-guide`.