From 098e11375d5a8be05865974b59afd7772c9dc852 Mon Sep 17 00:00:00 2001 From: "Bozawglanian, Hagop (hb755d)" Date: Tue, 3 Apr 2018 21:46:51 +0000 Subject: VNFRQTS - Use Case setup Manual Scale out use case first use case to be added. Change-Id: Iadebeee519c5c41af7d22b0522934e1237cedb37 Issue-ID: VNFRQTS-154 Signed-off-by: Bozawglanian, Hagop (hb755d) --- docs/Scale_Out_Workflow.png | Bin 0 -> 51735 bytes docs/index.rst | 7 +++++++ docs/manual_use_case.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++ docs/release-notes.rst | 39 +++++++++++++++++++++++++++++++++++++++ 4 files changed, 90 insertions(+) create mode 100755 docs/Scale_Out_Workflow.png create mode 100644 docs/index.rst create mode 100644 docs/manual_use_case.rst create mode 100644 docs/release-notes.rst (limited to 'docs') diff --git a/docs/Scale_Out_Workflow.png b/docs/Scale_Out_Workflow.png new file mode 100755 index 0000000..b1b985d Binary files /dev/null and b/docs/Scale_Out_Workflow.png differ diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..39a72f3 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,7 @@ +Manual Scale Out Use Case +-------------------------- + +.. toctree:: + :titlesonly: + + manual_use_case diff --git a/docs/manual_use_case.rst b/docs/manual_use_case.rst new file mode 100644 index 0000000..46e3b12 --- /dev/null +++ b/docs/manual_use_case.rst @@ -0,0 +1,44 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 ONAP + + +.. contents:: + :local: + +**Manual Scale Out Use Case** +================================== + +(VNF Perspective) + +In its Beijing Release, ONAP will support the ability to manually scale out VNF Components. Below is the Sequence Diagram for how Manual Scale Out will work in ONAP. + +|image0| + +Description of Workflow +--------------------------------------------- + +At a high level the way Manual Scale Out will work is: + 1. Using VID, the operator will choose to scale out a VNFC by picking a VF_Module to scale and choosing which controller is responsible for that VNF. + 2. VID sends the Scale Out Request to SO. + 3. When SO receives the Scaling request it will first send a request to the appropriate controller (APPC or SDNC) to execute a Healthcheck on the VNF. + 4. Once the Healthcheck has been run, SO executes the Heat Template associated with the VF Module requested by the VID Operator. + 5. After the new component(s) have been instantiated SO calls the responsible controller (via DMaaP) to configure the new instances. + 6. Finally a Healthcheck is run to ensure that the entire VNF is Operating as it should. + + +VNF Impacts +------------------------ + +For VNFs to make use of the Manual Scaling Capabilities of ONAP, they must support the following functionality: + 1. VNFs must support a Healthcheck as described in: `The Management Section of the ONAP VNF Guidelines `_. + a. R-31809 is the requirement dictating the need for VNF Healthchecks. + b. The Ansible Healthcheck Playbook description may be found in `The Ansible Standards and Capabilities Section `_. + 2. VNF Heat Templates must be built according the `VNF Modularity Rules `_. + a. The VF_Module to be scaled must be built according the VNF Modularity Rules for Incremental Modules. + 3. Configuration of the VNF must be done via NETCONF, Chef, or Ansible as described in `Configuration Management `_. + + +.. |image0| image:: Scale_Out_Workflow.png + :width: 7in + :height: 9in diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..2c6cfc4 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,39 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + + +VNF Use Case Release Notes +============================= + +Version: 1.0.0 +-------------- + + +:Release Date: 2018-03-29 + + + +**New Features** + Initial release of VNF Use Cases for Open Network Automation Platform (ONAP) + +**Bug Fixes** + - None + +**Known Issues** + - No known issues + +**Security Issues** + - No known security issues. + +**Upgrade Notes** + - Initial release - none + +**Deprecation Notes** + - Initial release - none + +**Other** + +=========== + +End of Release Notes -- cgit 1.2.3-korg