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