From f1aafc40ad8f15b61faa3631e5a56fcf7c34bf49 Mon Sep 17 00:00:00 2001 From: "Singal, Kapil (ks220y)" Date: Thu, 24 Sep 2020 12:47:56 -0400 Subject: Refactoring Docs Issue-ID: CCSDK-2846 Signed-off-by: Singal, Kapil (ks220y) Change-Id: I34e469deb914fc4e452159a2c3419270f8eb97bc --- docs/CBA/index.rst | 72 +++++++++++++++++++--------- docs/CBA/media/CDS_Architecture.jpg | Bin 0 -> 290332 bytes docs/CBA/media/CDS_Data_Flow.jpg | Bin 0 -> 321865 bytes docs/CBA/media/CDS_architecture.jpg | Bin 102560 -> 0 bytes docs/CBA/media/Functional_Decomposition.jpg | Bin 0 -> 209297 bytes docs/CBA/media/image0.PNG | Bin 93418 -> 0 bytes docs/CBA/media/image0.jpg | Bin 150033 -> 0 bytes docs/CBA/media/image1.PNG | Bin 111684 -> 0 bytes docs/CBA/media/image1.jpg | Bin 167601 -> 0 bytes docs/CBA/media/image2.PNG | Bin 77925 -> 0 bytes docs/CBA/media/image2.jpg | Bin 114351 -> 0 bytes 11 files changed, 50 insertions(+), 22 deletions(-) create mode 100644 docs/CBA/media/CDS_Architecture.jpg create mode 100644 docs/CBA/media/CDS_Data_Flow.jpg delete mode 100644 docs/CBA/media/CDS_architecture.jpg create mode 100644 docs/CBA/media/Functional_Decomposition.jpg delete mode 100644 docs/CBA/media/image0.PNG delete mode 100644 docs/CBA/media/image0.jpg delete mode 100644 docs/CBA/media/image1.PNG delete mode 100644 docs/CBA/media/image1.jpg delete mode 100644 docs/CBA/media/image2.PNG delete mode 100644 docs/CBA/media/image2.jpg (limited to 'docs/CBA') 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 Binary files /dev/null and b/docs/CBA/media/CDS_Architecture.jpg 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 Binary files /dev/null and b/docs/CBA/media/CDS_Data_Flow.jpg differ diff --git a/docs/CBA/media/CDS_architecture.jpg b/docs/CBA/media/CDS_architecture.jpg deleted file mode 100644 index 6401e6bbd..000000000 Binary files a/docs/CBA/media/CDS_architecture.jpg and /dev/null differ diff --git a/docs/CBA/media/Functional_Decomposition.jpg b/docs/CBA/media/Functional_Decomposition.jpg new file mode 100644 index 000000000..2b8257474 Binary files /dev/null and b/docs/CBA/media/Functional_Decomposition.jpg differ diff --git a/docs/CBA/media/image0.PNG b/docs/CBA/media/image0.PNG deleted file mode 100644 index 1c5d8c5ff..000000000 Binary files a/docs/CBA/media/image0.PNG and /dev/null differ diff --git a/docs/CBA/media/image0.jpg b/docs/CBA/media/image0.jpg deleted file mode 100644 index 8e53a2d98..000000000 Binary files a/docs/CBA/media/image0.jpg and /dev/null differ diff --git a/docs/CBA/media/image1.PNG b/docs/CBA/media/image1.PNG deleted file mode 100644 index 7a4b96d5c..000000000 Binary files a/docs/CBA/media/image1.PNG and /dev/null differ diff --git a/docs/CBA/media/image1.jpg b/docs/CBA/media/image1.jpg deleted file mode 100644 index 9a5cd63e4..000000000 Binary files a/docs/CBA/media/image1.jpg and /dev/null differ diff --git a/docs/CBA/media/image2.PNG b/docs/CBA/media/image2.PNG deleted file mode 100644 index e6a0cf8d3..000000000 Binary files a/docs/CBA/media/image2.PNG and /dev/null differ diff --git a/docs/CBA/media/image2.jpg b/docs/CBA/media/image2.jpg deleted file mode 100644 index 20fc26250..000000000 Binary files a/docs/CBA/media/image2.jpg and /dev/null differ -- cgit 1.2.3-korg