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
   6 .. _cba:
   7
   8 Controller Blueprint Archive (.cba)
   9 -------------------------------------
  10
  11 The **C**\ ontroller **B**\ lueprint **A**\ rchive is the overall service design, fully model-driven, intent based
  12 **package** needed for provisioning and configuration management automation.
  13
  14 The CBA is **.zip** file, comprised of the following folder structure, the files may vary:
  15
  16 .. code-block language is required for ReadTheDocs to render code-blocks. Python set as default.
  17
  18 .. code-block:: python
  19
  20    ├── Definitions
  21    │   ├── blueprint.json                   Overall TOSCA service template (worfklow + node_template)
  22    │   ├── artifact_types.json              (generated by enrichment)
  23    │   ├── data_types.json                  (generated by enrichment)
  24    │   ├── node_types.json                  (generated by enrichment)
  25    │   ├── relationship_types.json          (generated by enrichment)
  26    │   └── resources_definition_types.json  (generated by enrichment)
  27    ├── Environments                         Contains *.properties files as required by the service
  28    ├── Plans                                Contains Directed Graph
  29    ├── Tests                                Contains uat.yaml file for testing the cba actions within a cba **package
  30    ├── Scripts                              Contains scripts
  31    │   ├── python                           Python scripts
  32    │   └── kotlin                           Kotlin scripts
  33    ├── TOSCA-Metadata
  34    │   └── TOSCA.meta                       Meta-data of overall package
  35    └── Templates                            Contains combination of mapping and template
  36
  37 To process a CBA for any service we need to enrich it first. This will gather all the node- type, data-type,
  38 artifact-type, data-dictionary definitions provided in the blueprint.json.