Code Review
/
transportpce.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Rationalize features
[transportpce.git]
/
docs
/
user-guide.rst
diff --git
a/docs/user-guide.rst
b/docs/user-guide.rst
index 6b691f56683fba69af24dee3153757ab4afe7daf..aba848f4052419585fe7ed74a60b9442a259b63d 100644
(file)
--- a/
docs/user-guide.rst
+++ b/
docs/user-guide.rst
@@
-41,26
+41,18
@@
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.
- 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.
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.
-
-- **bundle transportpce-tapimodels**
-
- - This bundle contains models coming from TAPI version 2.1.2.
+- **feature odl-transportpce-tapi**
-- **bundle transportpce-tapis**
+ - This feature provides transportPCE a limited support of TAPI version 2.1.2 Northbound interface.
- - This bundle contains limited support of TAPI version 2.1.2 Northbound interface.
+- **feature odl-transportpce-inventory**
+ - This feature provides transportPCE an external connector to a MariaDB inventory currently limited to openROADM 1.2.1 devices.
How To Start
------------
How To Start
------------
@@
-83,4
+75,12
@@
Run OpenDaylight and install TransportPCE Service *odl-transportpce* as below::
feature:install odl-transportpce
feature:install odl-transportpce
+if you need TAPI limited support, then run::
+
+ feature:install odl-transportpce-tapi
+
+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`.
For a more detailed overview of the TransportPCE, see the :ref:`transportpce-dev-guide`.