Update Boron documentation for ALTO

Revise the version in user guide and developer guide.
Introduce new feature for user guide.

Change-Id: Ib222678b800952f7371aac5f66240952f1e5e265
Signed-off-by: jensenzhang <jingxuan.n.zhang@gmail.com>
(cherry picked from commit fb063c37aa1d3fc6545c2d8110c340c769134331)

diff --git a/manuals/developer-guide/src/main/asciidoc/alto/alto-developer-guide.adoc b/manuals/developer-guide/src/main/asciidoc/alto/alto-developer-guide.adoc
index b97142fb5abb423614dd9ab5e9645a32d2a11d04..17457bc35118073d5339da1884e00806ccb68783 100644 (file)
--- a/manuals/developer-guide/src/main/asciidoc/alto/alto-developer-guide.adoc
+++ b/manuals/developer-guide/src/main/asciidoc/alto/alto-developer-guide.adoc
@@ -19,7 +19,7 @@ following code in the _pom.xml_ file.
         <version>${ALTO_VERSION}</version>
     </dependency>
 
-The current stable version for ALTO is `0.2.0-Beryllium`.
+The current stable version for ALTO is `0.3.0-Boron`.
 
 === Putting/Fetching data from ALTO ===
 

diff --git a/manuals/user-guide/src/main/asciidoc/alto/alto-user-guide.adoc b/manuals/user-guide/src/main/asciidoc/alto/alto-user-guide.adoc
index 046d9f8392f7b0872ab44d0ce567763be7a74ffa..a4f730ba9a3e5013fcbb7a2a0da304976cd70234 100644 (file)
--- a/manuals/user-guide/src/main/asciidoc/alto/alto-user-guide.adoc
+++ b/manuals/user-guide/src/main/asciidoc/alto/alto-user-guide.adoc
@@ -7,10 +7,13 @@ Traffic Optimization* services defined in
 https://tools.ietf.org/html/rfc7285[RFC 7285] in OpenDaylight.
 
 This user guide will introduce the three basic services (namely
-`simple-ird`, `manual-maps` and `host-tracker`) which are implemented in
+`simple-ird`, `manual-maps` and `host-tracker`) which are implemented since
 the Beryllium release, and give instructions on how to configure them to
 provide corresponding ALTO services.
 
+A new feature named `simple-pce` (**Simple Path Computation Engine**) is
+added into Boron release as an ALTO extension service.
+
 === How to Identify ALTO Resources ===
 
 Each ALTO resource can be uniquely identified by a tuple . For each
@@ -207,6 +210,23 @@ via RESTCONF API directly.
 The `resource-config` package also provides a query RPC to config the resources.
 You can CREATE, UPDATE and DELETE *network-maps* and *cost-maps* via query RPC.
 
+=== Simple Path Computation Engine ===
+
+The `simple-pce` module provides a simple path computation engine for ALTO and other
+projects. It supports basic CRUD (create, read, update, delete) operations to manage
+L2 and L3 routing with/without rate limitation. This module is an independent
+feature, so you can follow the instruction below to install it independently.
+
+[source,bash]
+karaf > feature:install odl-alto-extenstion
+
+NOTE: The rate limitation meter requires OpenFlow 1.3 support.
+
+==== Basic Usage with RESTCONF API ====
+
+You can use the simple path computation engine with RESTCONF API, which is defined
+in the YANG model https://git.opendaylight.org/gerrit/gitweb?p=alto.git;a=blob;f=alto-extensions/simple-pce/api/src/main/yang/alto-spce.yang;h=f5bbe6744f7dfba493edd275aa18114e363727ab;hb=refs/heads/stable/boron[here].
+
 === Use Case ===
 
 ==== Server Selection ====