aboutsummaryrefslogtreecommitdiffstats
path: root/docs/cba/cba-description.rst
blob: 08702fbce9196b5dd2637c5d0f0ff0d0477a73f3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
.. This work is licensed under a Creative Commons Attribution 4.0
.. International License. http://creativecommons.org/licenses/by/4.0
.. Copyright (C) 2019 IBM.


The **C**\ ontroller **B**\ lueprint **A**\ rchive is the overall service design, fully model-driven, intent based
**package** needed for SELF SERVICE provisioning and configuration management automation.

The CBA is **.zip** file, comprised of the following folder structure, the files may vary:

.. code-block language is required for ReadTheDocs to render code-blocks. Python set as default.

.. code-block:: python

    ├── Definitions
       ├── blueprint.json                          Overall TOSCA service template (workflow + node_template)
       ├── artifact_types.json                     (generated by enrichment)
       ├── data_types.json                         (generated by enrichment)
       ├── policy_types.json                       (generated by enrichment)
       ├── node_types.json                         (generated by enrichment)
       ├── relationship_types.json                 (generated by enrichment)
       ├── resources_definition_types.json         (generated by enrichment, based on Data Dictionaries)
       └── *-mapping.json                          One per Template
    
    ├── Environments                                Contains *.properties files as required by the service
    
    ├── Plans                                       Contains Directed Graph
    
    ├── Tests                                       Contains uat.yaml file for testing cba actions within a cba package
    
    ├── Scripts                                     Contains scripts
       ├── python                                  Python scripts
       └── kotlin                                  Kotlin scripts
    
    ├── TOSCA-Metadata
       └── TOSCA.meta                              Meta-data of overall package
    
    └── Templates                                   Contains combination of mapping and template

To process a CBA for any service we need to enrich it first. This will gather all the node- type, data-type,
artifact-type, data-dictionary definitions provided in the blueprint.json.