.. 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:
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.
+
+|cdsArchitectureImage|
+
+
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.
|image0|
+Modeling Concept Links:
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. toctree::
+ :maxdepth: 1
+
+ modelingconcepts/overview
+ microservices/controllerBlueprintStudioProcessorMS
+ microservices/bluePrintsProcessorMS
+ microservices/expression
+ microservices/dynamicapi
+ microservices/flexibleplugin
+
+
Design tools
------------
.. toctree::
CBA/index
datadictionary/index
-MicroServices
--------------
-.. toctree::
- :maxdepth: 1
+Scripts
+-------
- controllerBlueprintStudioProcessorMS
- bluePrintsProcessorMS
+Library
+~~~~~~~
-Architecture
-------------
-The Controller Design Studio is composed of two major components:
- * The GUI (or frontend)
- * The Run Time (or backend)
+* NetconfClient
-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.
+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.
-|image1|
+The client can be find here: https://github.com/onap/ccsdk-cds/blob/master/components/scripts/python/ccsdk_netconf/netconfclient.py
-User Guide
+* ResolutionHelper
+
+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
+
+.. |image0| image:: media/tosca_model.jpg
+ :width: 7.88889in
+ :height: 4.43750in
+
+.. |cdsArchitectureImage| image:: media/CDS_architecture_latest.png
+ :scale: 30 %
+
+Developer Guide
----------
.. toctree::
- :maxdepth: 1
+ :maxdepth: 2
- userguide
+ developerguide/developer-guide
-Dynamic API
------------
+User Guide
+----------
.. toctree::
:maxdepth: 1
- dynamicapi
+ installation
+ designtime
-Controller Design Studio Presentation
--------------------------------------
+Use Cases
+----------
-Details about CDS Architecture and Design detail, Please click the link.
-:download:`CDS_Architecture_Design.pptx`
+.. toctree::
+ :maxdepth: 2
-ResolutionHelper
-----------------
-When executing a component executor script, designer might want to perform
-resource resolution along with template meshing directly from the script
-itself.
+ usecases/use-cases
-The helper can be find here: https://github.com/onap/ccsdk-apps/blob/master/components/scripts/python/ccsdk_netconf/common.py
+CDS Desginer UI
+---------------
-.. |image0| image:: media/tosca_model.jpg
- :width: 7.88889in
- :height: 4.43750in
+.. toctree::
+ :maxdepth: 1
-.. |image1| image:: media/CDS_architecture.jpg
- :height: 4.43750in
- :width: 7.88889in
+ CDS_Designer_Guide
+Controller Design Studio Presentation
+-------------------------------------
+
+Details about CDS Architecture and Design detail, Please click the link.
+:download:`CDS_Architecture_Design.pptx`
Code Review / ccsdk / cds.git / blobdiff