Component Documentation Template

Template Version: 1.0

Last updated: Mar-01-2021

Author(s):  list all the names of the contributors



---------------
Please note:
The page title should be updated per the example below once you have completed all the sections

ComponentName Documentation for Release-R#

Example:

CPS Documentation for the Honolulu-R8 Release

------------------

1- Overview

provide a high level description of the basic functionalities of this component and how it fits in the overall ONAP architecture

2- Architecture

Describe in detail the component architecture including but limited to the subsystems/sub-components, Databases, interfaces, etc...

3- Design

Describe software design that is the activity of taking the architecture (design principles & assumptions) and describing a software solution. Software design defines software solutions which are traceable to requirements (architecture), can be integrated, extensible, modular, fault tolerant,maintainable, reliable, reusable, secure, scalable, and robust.

4- Dependencies on other ONAP Components (new for R11)

List all critical  dependencies your component has on other ONAP components.

5- Modeling

Describe all the related Models that this component uses and any assumptions

6- Deployment

Describe how this component is deployed, how many Microservices are deployed, etc.. Also include any nuances specific to your component

6- User Guide

A brief description and a reference to any relevant and release specific documentations

7- Any other references to relevant documentations

Include references to any docs, presentations, wiki pages that are specific to the features being deployed for this release