summaryrefslogtreecommitdiffstats
path: root/docs/CBA/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/CBA/index.rst')
-rw-r--r--docs/CBA/index.rst72
1 files changed, 50 insertions, 22 deletions
diff --git a/docs/CBA/index.rst b/docs/CBA/index.rst
index c29eca8d9..b9e31119c 100644
--- a/docs/CBA/index.rst
+++ b/docs/CBA/index.rst
@@ -4,28 +4,58 @@
.. _cds_cba-doc:
-Controller Blueprint Archived Designer Tool(CBA)
-================================================
+Controller Blueprint Archived Designer Tool (CBA)
+=================================================
.. toctree::
:maxdepth: 1
Introduction
------------
-The Controller Blueprint Archived is the overall service design, fully
-model-driven, package needed to automate the resolution of resources for
-instantiation and any config provisioning operation, such as day0,
-day1 or day2 configuration.
-
-The CBA is .zip file, comprised of the following folder structure, the
-files may vary:
-
-|image0|
+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.
Architecture
------------
+|image1|
-|image3|
+Data Flow
+---------
+|image2|
Installation
@@ -79,16 +109,14 @@ Steps
Functional Decomposition
------------------------
-|image2|
+|image3|
+
+.. |image1| image:: media/CDS_Architecture.jpg
+ :width: 500pt
-.. |image0| image:: media/image0.jpg
- :width: 7.88889in
- :height: 4.43750in
+.. |image2| image:: media/CDS_Data_Flow.jpg
+ :width: 500pt
-.. |image2| image:: media/image2.jpg
- :width: 7.88889in
- :height: 4.43750in
+.. |image3| image:: media/Functional_Decomposition.jpg
+ :width: 500pt
-.. |image3| image:: media/CDS_architecture.jpg
- :height: 4.43750in
- :width: 7.88889in