Boron update of SXP aDocs

[docs.git] / manuals / user-guide / src / main / asciidoc / sfc / odl-sfc-load-balance-user.adoc

diff --git a/manuals/user-guide/src/main/asciidoc/sfc/odl-sfc-load-balance-user.adoc b/manuals/user-guide/src/main/asciidoc/sfc/odl-sfc-load-balance-user.adoc
index fd64d48dbf42b159ba63f2bc339a90ac380ce8c8..9727c2e45644c86aab403c9e1de90249da5263cf 100644 (file)
--- a/manuals/user-guide/src/main/asciidoc/sfc/odl-sfc-load-balance-user.adoc
+++ b/manuals/user-guide/src/main/asciidoc/sfc/odl-sfc-load-balance-user.adoc
@@ -1,31 +1,92 @@
-=== Service Function Grouping and Load Balancing User Guide
-TBD
+=== Service Function Load Balancing User Guide
 
 ==== Overview
-TBD
+SFC Load-Balancing feature implements load balancing of Service Functions, rather than a one-to-one mapping between Service-Function-Forwarder and Service-Function. 
 
 ==== Load Balancing Architecture
-TBD
+Service Function Groups (SFG) can replace Service Functions (SF) in the Rendered Path model. 
+A Service Path can only be defined using SFGs or SFs, but not a combination of both.
 
-==== Configuring Load Balancing
+Relevant objects in the YANG model are as follows:
 
-TBD
+1. Service-Function-Group-Algorithm:
 
-==== Administering or Managing <feature>
-TBD
+       Service-Function-Group-Algorithms {
+               Service-Function-Group-Algorithm {
+                       String name
+                       String type
+               }
+       }
+       
+       Available types: ALL, SELECT, INDIRECT, FAST_FAILURE
+
+2. Service-Function-Group:
+
+       Service-Function-Groups {
+               Service-Function-Group {
+                       String name
+                       String serviceFunctionGroupAlgorithmName
+                       String type
+                       String groupId
+                       Service-Function-Group-Element {
+                               String service-function-name
+                               int index
+                       }
+               }
+       }
+
+3. ServiceFunctionHop: holds a reference to a name of SFG (or SF)
 
 ==== Tutorials
-TBD
+This tutorial will explain how to create a simple SFC configuration, with SFG instead of SF. In this example, the SFG will include two existing SF.
+
+===== Setup SFC
+For general SFC setup and scenarios, please see the SFC wiki page: https://wiki.opendaylight.org/view/Service_Function_Chaining:Main#SFC_101
+
+===== Create an algorithm
+POST - http://127.0.0.1:8181/restconf/config/service-function-group-algorithm:service-function-group-algorithms
+----
+{
+    "service-function-group-algorithm": [
+      {
+        "name": "alg1"
+        "type": "ALL"
+      }
+   ]
+}
+----
 
-====== Overview
-TBD
+(Header "content-type": application/json)
 
-====== Prerequisites
-TBD
+===== Verify: get all algorithms
+GET - http://127.0.0.1:8181/restconf/config/service-function-group-algorithm:service-function-group-algorithms
 
-====== Target Environment
-TBD
+In order to delete all algorithms:
+DELETE - http://127.0.0.1:8181/restconf/config/service-function-group-algorithm:service-function-group-algorithms
 
-====== Instructions
-TBD
+===== Create a group
+POST - http://127.0.0.1:8181/restconf/config/service-function-group:service-function-groups 
+----
+{
+    "service-function-group": [
+    {
+        "rest-uri": "http://localhost:10002",
+        "ip-mgmt-address": "10.3.1.103",
+        "algorithm": "alg1",
+        "name": "SFG1",
+        "type": "service-function-type:napt44",
+               "sfc-service-function": [
+                       {
+                               "name":"napt44-104"
+                       }, 
+                       {
+                               "name":"napt44-103-1"
+                       }
+               ]
+      }
+       ]
+}
+----
 
+===== Verify: get all SFG's
+GET - http://127.0.0.1:8181/restconf/config/service-function-group:service-function-groups 
\ No newline at end of file