docs/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2 .. International License. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2019 IBM.
   4 .. _master_index:
   5
   6 .. _cds_main-doc:
   7
   8 CONTROLLER DESIGN STUDIO (CDS)
   9 ==============================
  10 .. toctree::
  11    :maxdepth: 1
  12
  13 Introduction
  14 ------------
  15
  16 The system is designed to be self service, which means that users, not just
  17 programmers, can reconfigure the software system as needed to meet customer
  18 requirements. To accomplish this goal, the system is built around models that
  19 provide for real-time changes in how the system operates.  Users merely need
  20 to change a model to change how a service operates.
  21
  22 Self service is a completely new way of delivering services.  It removes the
  23 dependence on code releases and the delays they cause and puts the control of
  24 services into the hands of the service providers.  They can change a model and
  25 its parameters and create a new service without writing a single line of code.
  26 This makes SERVICE PROVIDER(S) more responsive to its customers and able to
  27 deliver products that more closely match the needs of its customers.
  28
  29 Architecture
  30 ------------
  31
  32 The Controller Design Studio is composed of two major components:
  33    * The GUI (or frontend)
  34    * The Run Time (or backend)
  35
  36 The GUI handles direct user input and allows for displaying both design time
  37 and run time activities. For design time, it allows for the creation of
  38 controller blueprint, from selecting the DGs to be included, to incorporating
  39 the artifact templates, to adding necessary components.  For run time, it
  40 allows the user to direct the system to resolve the unresolved elements of the
  41 controller blueprint and download the resulting configuration into a VNF.
  42
  43 At a more basic level, it allows for creation of data dictionaries,
  44 capabilities catalogs, and controller blueprint, the basic elements that are
  45 used to generate a configuration. The essential function of the Controller
  46 Design Studio is to create and populate a controller blueprint, create a
  47 configuration file from this Controller blueprint, and download this
  48 configuration file (configlet) to a VNF/PNF.
  49
  50 |cdsArchitectureImage|
  51
  52
  53 Modeling Concept
  54 ----------------
  55
  56 In Dublin release, the CDS community has contributed a framework to automate
  57 the resolution of resources for instantiation and any config provisioning
  58 operation, such as day0, day1 or day2 configuration.
  59
  60 The content of the CBA Package is driven from a catalog of reusable data
  61 dictionary, component and workflow, delivering a reusable and simplified
  62 self service experience.
  63
  64 TOSCA based JSON formatted model following standard:
  65 http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.2/csd01/TOSCA-Simple-Profile-YAML-v1.2-csd01.html
  66
  67 Most of the TOSCA modeled entity presented in the bellow documentation can
  68 be found here:
  69 https://github.com/onap/ccsdk-cds/tree/master/components/model-catalog/definition-type/starter-type
  70
  71 Tosca Model Reference:
  72
  73 |toscaModel|
  74
  75 Modeling Concept Links:
  76 ~~~~~~~~~~~~~~~~~~~~~~~
  77
  78 .. toctree::
  79    :maxdepth: 1
  80
  81    modelingconcepts/index
  82
  83 Scripts
  84 -------
  85
  86 Library
  87 ~~~~~~~
  88
  89 * NetconfClient
  90
  91     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.
  92
  93     The client can be find here: https://github.com/onap/ccsdk-cds/blob/master/components/scripts/python/ccsdk_netconf/netconfclient.py
  94
  95 * ResolutionHelper
  96
  97     When executing a component executor script, designer might want to perform
  98     resource resolution along with template meshing directly from the script
  99     itself.
 100
 101     The helper can be found in below link:
 102     https://github.com/onap/ccsdk-apps/blob/master/components/scripts/python/ccsdk_netconf/common.py
 103
 104 .. |toscaModel| image:: media/tosca_model.jpg
 105    :width: 500pt
 106
 107 .. |cdsArchitectureImage| image:: media/CDS_architecture.jpg
 108    :width: 500pt
 109
 110 User Guides
 111 ------------
 112
 113 .. toctree::
 114    :maxdepth: 3
 115
 116    userguides/developer-guide/index
 117    userguides/installation
 118    userguides/design-time-guide/designtime
 119
 120 Use Cases
 121 ---------
 122
 123 .. toctree::
 124    :maxdepth: 2
 125
 126    usecases/use-cases
 127
 128 CDS Designer UI
 129 ---------------
 130
 131 .. toctree::
 132    :maxdepth: 2
 133
 134    ui/designer-guide
 135    ui/hello-world-resource-resolution-cba
 136    ui/hello-world-script-executor-cba.rst
 137
 138
 139 Offered APIs
 140 ----------------------------------
 141
 142 .. toctree::
 143    :maxdepth: 3
 144
 145    api-reference/index
 146
 147
 148 Controller Design Studio Presentation
 149 -------------------------------------
 150
 151 Details about CDS Architecture and Design detail, Please click the link.
 152 :download:`CDS_Architecture_Design <media/CDS_Architecture_Design.pptx>`