diff options
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 106 |
1 files changed, 60 insertions, 46 deletions
diff --git a/docs/index.rst b/docs/index.rst index 794d87fb5..45b124f29 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,8 +23,32 @@ its parameters and create a new service without writing a single line of code. This makes SERVICE PROVIDER(S) more responsive to its customers and able to deliver products that more closely match the needs of its customers. +Architecture +------------ +The Controller Design Studio is composed of two major components: + * The GUI (or frontend) + * The Run Time (or backend) + +The GUI handles direct user input and allows for displaying both design time +and run time activities. For design time, it allows for the creation of +controller blueprint, from selecting the DGs to be included, to incorporating +the artifact templates, to adding necessary components. For run time, it +allows the user to direct the system to resolve the unresolved elements of the +controller blueprint and download the resulting configuration into a VNF. +At a more basic level, it allows for creation of data dictionaries, +capabilities catalogs, and controller blueprint, the basic elements that are +used to generate a configuration. The essential function of the Controller +Design Studio is to create and populate a controller blueprint, create a +configuration file from this Controller blueprint, and download this +configuration file (configlet) to a VNF/PNF. + +|image1| + + + Modeling Concept ----------------- +================ + In Dublin release, the CDS community has contributed a framework to automate the resolution of resources for instantiation and any config provisioning operation, such as day0, day1 or day2 configuration. @@ -44,68 +68,45 @@ Tosca Model Reference: |image0| -Design tools ------------- -.. toctree:: - :maxdepth: 1 - :glob: - - CBA/index - datadictionary/index +Modeling Concept Links: +----------------------- -MicroServices -------------- .. toctree:: :maxdepth: 1 microservices/controllerBlueprintStudioProcessorMS microservices/bluePrintsProcessorMS + microservices/expression + microservices/dynamicapi + microservices/flexibleplugin -Architecture ------------- -The Controller Design Studio is composed of two major components: - * The GUI (or frontend) - * The Run Time (or backend) - -The GUI handles direct user input and allows for displaying both design time -and run time activities. For design time, it allows for the creation of -controller blueprint, from selecting the DGs to be included, to incorporating -the artifact templates, to adding necessary components. For run time, it -allows the user to direct the system to resolve the unresolved elements of the -controller blueprint and download the resulting configuration into a VNF. -At a more basic level, it allows for creation of data dictionaries, -capabilities catalogs, and controller blueprint, the basic elements that are -used to generate a configuration. The essential function of the Controller -Design Studio is to create and populate a controller blueprint, create a -configuration file from this Controller blueprint, and download this -configuration file (configlet) to a VNF/PNF. - -|image1| - -User Guide ----------- +Design tools +============ .. toctree:: :maxdepth: 1 + :glob: - userguide + CBA/index + datadictionary/index -Dynamic API ------------ -.. toctree:: - :maxdepth: 1 - microservices/dynamicapi -Controller Design Studio Presentation -------------------------------------- +Scripts +======= -Details about CDS Architecture and Design detail, Please click the link. -:download:`CDS_Architecture_Design.pptx` +Library +------- + +*NetconfClient +-------------- +In order to facilitate NETCONF interaction within scripts, a python NetconfClient binded to our Kotlin implementation is made available. This NetconfClient can be used when using the component-netconf-executor. + +The client can be find here: https://github.com/onap/ccsdk-cds/blob/master/components/scripts/python/ccsdk_netconf/netconfclient.py -ResolutionHelper ----------------- +*ResolutionHelper +----------------- When executing a component executor script, designer might want to perform resource resolution along with template meshing directly from the script itself. @@ -120,4 +121,17 @@ The helper can be find here: https://github.com/onap/ccsdk-apps/blob/master/comp :height: 4.43750in :width: 7.88889in +User Guide +---------- + +.. toctree:: + :maxdepth: 1 + + userguide + + +Controller Design Studio Presentation +------------------------------------- +Details about CDS Architecture and Design detail, Please click the link. +:download:`CDS_Architecture_Design.pptx` |