summaryrefslogtreecommitdiffstats
path: root/docs/CBA
diff options
context:
space:
mode:
authorSingal, Kapil (ks220y) <ks220y@att.com>2020-09-24 12:47:56 -0400
committerSingal, Kapil (ks220y) <ks220y@att.com>2020-09-24 18:07:12 -0400
commitf1aafc40ad8f15b61faa3631e5a56fcf7c34bf49 (patch)
tree27b4a52b99472d4781814751f4c46343b82960a5 /docs/CBA
parent2b0442d1d2e721c4bf762bb2a3e75bc7606f9fcf (diff)
Refactoring Docs
Issue-ID: CCSDK-2846 Signed-off-by: Singal, Kapil (ks220y) <ks220y@att.com> Change-Id: I34e469deb914fc4e452159a2c3419270f8eb97bc
Diffstat (limited to 'docs/CBA')
-rw-r--r--docs/CBA/index.rst72
-rw-r--r--docs/CBA/media/CDS_Architecture.jpgbin0 -> 290332 bytes
-rw-r--r--docs/CBA/media/CDS_Data_Flow.jpgbin0 -> 321865 bytes
-rw-r--r--docs/CBA/media/CDS_architecture.jpgbin102560 -> 0 bytes
-rw-r--r--docs/CBA/media/Functional_Decomposition.jpgbin0 -> 209297 bytes
-rw-r--r--docs/CBA/media/image0.PNGbin93418 -> 0 bytes
-rw-r--r--docs/CBA/media/image0.jpgbin150033 -> 0 bytes
-rw-r--r--docs/CBA/media/image1.PNGbin111684 -> 0 bytes
-rw-r--r--docs/CBA/media/image1.jpgbin167601 -> 0 bytes
-rw-r--r--docs/CBA/media/image2.PNGbin77925 -> 0 bytes
-rw-r--r--docs/CBA/media/image2.jpgbin114351 -> 0 bytes
11 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
diff --git a/docs/CBA/media/CDS_Architecture.jpg b/docs/CBA/media/CDS_Architecture.jpg
new file mode 100644
index 000000000..720d29aa2
--- /dev/null
+++ b/docs/CBA/media/CDS_Architecture.jpg
Binary files differ
diff --git a/docs/CBA/media/CDS_Data_Flow.jpg b/docs/CBA/media/CDS_Data_Flow.jpg
new file mode 100644
index 000000000..59e144710
--- /dev/null
+++ b/docs/CBA/media/CDS_Data_Flow.jpg
Binary files differ
diff --git a/docs/CBA/media/CDS_architecture.jpg b/docs/CBA/media/CDS_architecture.jpg
deleted file mode 100644
index 6401e6bbd..000000000
--- a/docs/CBA/media/CDS_architecture.jpg
+++ /dev/null
Binary files differ
diff --git a/docs/CBA/media/Functional_Decomposition.jpg b/docs/CBA/media/Functional_Decomposition.jpg
new file mode 100644
index 000000000..2b8257474
--- /dev/null
+++ b/docs/CBA/media/Functional_Decomposition.jpg
Binary files differ
diff --git a/docs/CBA/media/image0.PNG b/docs/CBA/media/image0.PNG
deleted file mode 100644
index 1c5d8c5ff..000000000
--- a/docs/CBA/media/image0.PNG
+++ /dev/null
Binary files differ
diff --git a/docs/CBA/media/image0.jpg b/docs/CBA/media/image0.jpg
deleted file mode 100644
index 8e53a2d98..000000000
--- a/docs/CBA/media/image0.jpg
+++ /dev/null
Binary files differ
diff --git a/docs/CBA/media/image1.PNG b/docs/CBA/media/image1.PNG
deleted file mode 100644
index 7a4b96d5c..000000000
--- a/docs/CBA/media/image1.PNG
+++ /dev/null
Binary files differ
diff --git a/docs/CBA/media/image1.jpg b/docs/CBA/media/image1.jpg
deleted file mode 100644
index 9a5cd63e4..000000000
--- a/docs/CBA/media/image1.jpg
+++ /dev/null
Binary files differ
diff --git a/docs/CBA/media/image2.PNG b/docs/CBA/media/image2.PNG
deleted file mode 100644
index e6a0cf8d3..000000000
--- a/docs/CBA/media/image2.PNG
+++ /dev/null
Binary files differ
diff --git a/docs/CBA/media/image2.jpg b/docs/CBA/media/image2.jpg
deleted file mode 100644
index 20fc26250..000000000
--- a/docs/CBA/media/image2.jpg
+++ /dev/null
Binary files differ