diff options
author | Jerry Flood <jflood@att.com> | 2018-11-08 12:25:29 -0500 |
---|---|---|
committer | Jerry Flood <jflood@att.com> | 2018-11-08 13:48:57 -0500 |
commit | 5b60091b06c7ba43700a44348ea0108213aa7d34 (patch) | |
tree | ad7e08af69b384df7f8addd72a6d31aedc17870a /docs/sections/architecture.rst | |
parent | 2fee92d507c77890b093ad76d693eebc1f06be65 (diff) |
Create docs outline for CMSO
Issue-ID: OPTFRA-394
Change-Id: I55e1738c3397c71d73399ebf78cb42a3b441afec
Signed-off-by: Jerry Flood <jflood@att.com>
Diffstat (limited to 'docs/sections/architecture.rst')
-rw-r--r-- | docs/sections/architecture.rst | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/sections/architecture.rst b/docs/sections/architecture.rst new file mode 100644 index 0000000..2c5a8c8 --- /dev/null +++ b/docs/sections/architecture.rst @@ -0,0 +1,53 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Architecture +============================================= + +Introduction +------------------ +OOF-CMSO is an optimizing service that allows for the scheduling of VNF change management +work flows to be executed at a time in the future. It enables a 3rd party client to provide +SO work flow requests for multiple VNFs to be executed within a provided change window. The schedule +optimizer is designed to determine a "conflict free" time within that change window that is suitable for +submitting the changes to SO. + +The initial release provides a skeletal implementation that runs in "standalone" mode, that is, the +intended interfaces are stubbed out (i,e, "loop-back mode"). + + * SO interface for dispatching the work flow and checking status + * Optimizer Interface for determining the "conflict free" change window (loop-back mode selects the start of change window provided the client) + +CMSO also models interfacing an external ticket/change management system to create, update, close/cancel tickets at relevant points in the CMSO flow. + +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, +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. + +The information provided to CMSO to accomplish the scheduling of the changes: + + * Work flow information + + * Name of the work flow + * Message(s) to be forwarded to SO to initiate the work flow + + * Schedule information + + * The list of targeted VNFs + * The desired change window + + * Earliest start date/time + * Latest end date/time + + * Expected duration of the work flow execution + * Number of concurrent work flows to be scheduled + +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. + +TBD +----
\ No newline at end of file |