X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=9e226e537f45ae613cba8ac8b9e0a4e546397047;hb=97c07491d6dfb1fca6e4aeebaf7318324c1d3eb4;hp=183bbbf9fa2a33452201445f8cd7962700f207cd;hpb=891a22885bbf46d32a2b2dd3b0521c1768a943a5;p=ccsdk%2Fcds.git diff --git a/docs/index.rst b/docs/index.rst index 183bbbf9f..9e226e537 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright (C) 2019 IBM. +.. _master_index: .. _cds_main-doc: @@ -11,11 +12,13 @@ CONTROLLER DESIGN STUDIO (CDS) Introduction ------------ + The system is designed to be self service, which means that users, not just programmers, can reconfigure the software system as needed to meet customer requirements. To accomplish this goal, the system is built around models that provide for real-time changes in how the system operates. Users merely need to change a model to change how a service operates. + Self service is a completely new way of delivering services. It removes the dependence on code releases and the delays they cause and puts the control of services into the hands of the service providers. They can change a model and @@ -25,6 +28,7 @@ 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) @@ -35,6 +39,7 @@ 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 @@ -42,7 +47,7 @@ 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| +|cdsArchitectureImage| Modeling Concept @@ -65,7 +70,7 @@ https://github.com/onap/ccsdk-cds/tree/master/components/model-catalog/definitio Tosca Model Reference: -|image0| +|toscaModel| Modeling Concept Links: ~~~~~~~~~~~~~~~~~~~~~~~ @@ -73,21 +78,7 @@ Modeling Concept Links: .. toctree:: :maxdepth: 1 - microservices/controllerBlueprintStudioProcessorMS - microservices/bluePrintsProcessorMS - microservices/expression - microservices/dynamicapi - microservices/flexibleplugin - - -Design tools ------------- -.. toctree:: - :maxdepth: 1 - :glob: - - CBA/index - datadictionary/index + modelingconcepts/index Scripts ------- @@ -96,41 +87,66 @@ 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. + 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 + The client can be find here: https://github.com/onap/ccsdk-cds/blob/master/components/scripts/python/ccsdk_netconf/netconfclient.py * ResolutionHelper -~~~~~~~~~~~~~~~~~~ -When executing a component executor script, designer might want to perform -resource resolution along with template meshing directly from the script -itself. + When executing a component executor script, designer might want to perform + resource resolution along with template meshing directly from the script + itself. -The helper can be found in below link: -https://github.com/onap/ccsdk-apps/blob/master/components/scripts/python/ccsdk_netconf/common.py + The helper can be found in below link: + https://github.com/onap/ccsdk-apps/blob/master/components/scripts/python/ccsdk_netconf/common.py -.. |image0| image:: media/tosca_model.jpg - :width: 7.88889in - :height: 4.43750in +.. |toscaModel| image:: media/tosca_model.jpg + :width: 500pt -.. |image1| image:: media/CDS_architecture.jpg - :height: 4.43750in - :width: 7.88889in +.. |cdsArchitectureImage| image:: media/CDS_architecture.jpg + :width: 500pt -User Guide ----------- +User Guides +------------ .. toctree:: - :maxdepth: 1 + :maxdepth: 3 + + userguides/developer-guide/index + userguides/installation + userguides/design-time-guide/designtime + +Use Cases +--------- + +.. toctree:: + :maxdepth: 2 + + usecases/use-cases + +CDS Designer UI +--------------- + +.. toctree:: + :maxdepth: 2 + + ui/designer-guide + ui/hello-world-resource-resolution-cba + ui/hello-world-script-executor-cba.rst + + +Offered APIs +---------------------------------- + +.. toctree:: + :maxdepth: 3 + + api-reference/index - userguide - Controller Design Studio Presentation ------------------------------------- Details about CDS Architecture and Design detail, Please click the link. -:download:`CDS_Architecture_Design.pptx` +:download:`CDS_Architecture_Design `