docs/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2019 IBM.
   4
   5 CONTROLLER DESIGN STUDIO (CDS)
   6 ------------------------------
   7 .. toctree::
   8    :maxdepth: 1
   9
  10 Introduction:
  11 =============
  12 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.
  13 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 its parameters and create a new service without writing a single line of code.
  14 This makes SERVICE PROVIDER(S) more responsive to its customers and able to deliver products that more closely match the needs of its customers.
  15
  16 Design tools:
  17 =============
  18 .. toctree::
  19    :maxdepth: 1
  20    :glob:
  21
  22    CBA/index
  23    datadictionary/index
  24
  25 MicroServices:
  26 ==============
  27 .. toctree::
  28    :maxdepth: 1
  29    :glob:
  30
  31         controllerBlueprintStudioProcessor
  32         bluePrintsProcessor
  33
  34 Architecture:
  35 =============
  36 The Controller Design Studio is composed of two major components:
  37         * The GUI (or frontend)
  38         * The Run Time (or backend)
  39 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.
  40
  41 Resource assignment:
  42 =====================
  43 .. toctree::
  44    :maxdepth: 1
  45    :glob:
  46
  47    resourceassignment
  48
  49 ResolutionHelper:
  50 =================
  51 When executing a component executor script, designer might want to perform resource resolution along with template meshing directly from the script itself.
  52
  53 The helper can be find here: https://github.com/onap/ccsdk-apps/blob/master/components/scripts/python/ccsdk_netconf/common.py