docs/modelingconcepts/cba.rst

   1 .. This work is a derivative of https://wiki.onap.org/display/DW/Modeling+Concepts#Concepts-66498
   2 .. This work is licensed under a Creative Commons Attribution 4.0
   3 .. International License. http://creativecommons.org/licenses/by/4.0
   4 .. Copyright (C) 2020 Deutsche Telekom AG.
   5 .. Copyright (C) 2020 AT&T.
   6
   7 .. _cba:
   8
   9 Controller Blueprint Archive (.cba)
  10 -----------------------------------
  11
  12 The **C**\ ontroller **B**\ lueprint **A**\ rchive is the overall service design, fully model-driven, intent based
  13 **package** needed for SELF SERVICE provisioning and configuration management automation.
  14
  15 The CBA is **.zip** file, comprised of the following folder structure, the files may vary:
  16
  17 .. code-block language is required for ReadTheDocs to render code-blocks. Python set as default.
  18
  19 .. code-block:: python
  20
  21     ├── Definitions
  22     │   ├── blueprint.json                          Overall TOSCA service template (workflow + node_template)
  23     │   ├── artifact_types.json                     (generated by enrichment)
  24     │   ├── data_types.json                         (generated by enrichment)
  25     │   ├── policy_types.json                       (generated by enrichment)
  26     │   ├── node_types.json                         (generated by enrichment)
  27     │   ├── relationship_types.json                 (generated by enrichment)
  28     │   ├── resources_definition_types.json         (generated by enrichment, based on Data Dictionaries)
  29     │   └── *-mapping.json                          One per Template
  30     │
  31     ├── Environments                                Contains *.properties files as required by the service
  32     │
  33     ├── Plans                                       Contains Directed Graph
  34     │
  35     ├── Tests                                       Contains uat.yaml file for testing cba actions within a cba package
  36     │
  37     ├── Scripts                                     Contains scripts
  38     │   ├── python                                  Python scripts
  39     │   └── kotlin                                  Kotlin scripts
  40     │
  41     ├── TOSCA-Metadata
  42     │   └── TOSCA.meta                              Meta-data of overall package
  43     │
  44     └── Templates                                   Contains combination of mapping and template
  45
  46 To process a CBA for any service we need to enrich it first. This will gather all the node- type, data-type,
  47 artifact-type, data-dictionary definitions provided in the blueprint.json.