Merge "Update index and architecture page"

4 files changed, 37 insertions, 8 deletions

diff --git a/docs/index.rst b/docs/index.rst
index 0d4c5c1..6448c1b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -23,6 +23,7 @@ CMSO also models interfacing an external ticket/change management system to crea
    ./sections/architecture.rst
    ./sections/offeredapis.rst
    ./sections/consumedapis.rst
+   ./sections/delivery.rst
    ./sections/logging.rst
    ./sections/installation.rst
    ./sections/configuration.rst
diff --git a/docs/sections/architecture.rst b/docs/sections/architecture.rst
index f982c39..95b634f 100644
--- a/docs/sections/architecture.rst
+++ b/docs/sections/architecture.rst
@@ -22,7 +22,7 @@ CMSO also models interfacing an external ticket/change management system to crea
 CMSO in Change Management Flow
 --------------------------------------------
 CMSO is designed to be agnostic of the type of change management work flow that is to be scheduled in SO. A 3rd party
-application will be responsible for preparing the change management request messages to be forwarded to SO. This data,
+client application will be responsible for preparing the change management request messages to be forwarded to SO. This data,
 along with the list of targeted VNFs and the scheduling requirements are used by CMSO to create and ultimately execute
 the schedule to dispathc the work to SO.
 
@@ -47,9 +47,37 @@ The information provided to CMSO to accomplish the scheduling of the changes:
 The design of CMSO is to ensure that the scheduling of the work flows will not conflict with other scheduled work.
 
  #. Ensure that asset(s) required to execute the work flow are available so that the work flow will be able to complete successfully
- #. Ensure that the execution of teh work flow does not cause a network outage.
+ #. Ensure that the execution of the work flow does not cause a network outage.
 
 Architectural Flow Diagram
----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. image:: ./diagrams/ONAP_CMSO_FLOW.png
+
+Scheduling Optimization and Confict Avoidance
+-----------------------------------------------
+
+The Casablanca implementation of CMSO does not attempt any conflict avoidance. It will assume that no
+conflicts exist and creates a achedule based upon the earliest start time, expected duration of each work flow,
+the number of concurrent workflows to be executed and the number of VNFs. The optimized schedule
+provides a start time for each VNF in the schedule.
+
+Conflict avoidance to achieve the goals of CMSO, successful completion of change requests  without incurring network outages,
+requires a system to track the availability (or rather unavailability) of assets required to determine an
+optimal time for exectution. No such system exists at this time within ONAP. CMSO itself can be used to track changes to VNFs and
+the initial optimization to be included in Dublin will be limited to ensuring that a VNF is not double booked within CMSO.
+
+SO Change Request Dispatching
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+CMSO does not serve as a throttling dispatcher to SO. Rather, the dispatching of work to SO is based solely on
+the start time assigned to each VNF. CMSO will dispatch a VNF change to SO regardless of how many outstanding
+change management requests there are to SO within CMSO.
+
+CMSO will expect that SO will throttle its own workload and reject requests that arrive when the system is busy.
+CMSO will not interpret these system busy rejections as "try again later" as the changes are assumed to be
+time sensitive based upon the conflict avoidance objectives of CMSO.
+
+
+
+
diff --git a/docs/sections/consumedapis.rst b/docs/sections/consumedapis.rst
index ce4a2fc..d8d6c6c 100644
--- a/docs/sections/consumedapis.rst
+++ b/docs/sections/consumedapis.rst
@@ -26,15 +26,15 @@ Conflict avoidance requires:
 
  * Horizontal topology assets ???
 
- * Availability of the VNFs and the availability of the assets identified in the previous items.
-   This generally requires a change management
-   tracking/ticketing system system that identifies scheduled changes to all assets that contribute to the
+ * Availability of the VNFs and of the assets identified in the previous items.
+   Knowing the availability of related assests generally requires a change management
+   tracking/ticketing system system that identifies scheduled changes (unavailaibility) to all assets that contribute to the
    functioning of the network.
 
    * There is no change management ticketing system within ONAP. CMSO itself may serve as such in a very limited capacity as it
      tracks scheduled changes to VNFs. It does not track changes the all network assets which is necessarilty required for full
      conflict avoidance. For ONAP Dublin, the conflict avoidance will necessarily be limited to VNF level conflict
-     checking using CMSO as the source of asset avaialability/unavailability.
+     checking using CMSO as the source of asset (VNF) avaialability/unavailability.
 
 
 Change Management Ticketing System (TBD)
diff --git a/docs/sections/delivery.rst b/docs/sections/delivery.rst
index 11759af..8b2c0d5 100644
--- a/docs/sections/delivery.rst
+++ b/docs/sections/delivery.rst
@@ -1,7 +1,7 @@
 OOF CMSO Delivery
 ======================
 
-OOF CMSO is made up of 3 docker containers
+OOF CMSO is made up of 3 docker containers depoloyed via OOM
 
  #. CMSO Service - Java server (Jersey)
  #. CMSO Database Initialization - Java wrapper invoking Liquibase schema management scripts