From: JakobKrieg Date: Tue, 1 Dec 2020 13:17:11 +0000 (+0100) Subject: CDS Read the Docs refactoring X-Git-Tag: 1.1.0~75 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=b7beaee4f6759c1c5997713901f6f5a1dfdb1d2d;p=ccsdk%2Fcds.git CDS Read the Docs refactoring Issue-ID: CCSDK-3011 Change-Id: Id8cff94b104bfa03643eb534e36c2bce8b0b4088 Signed-off-by: JakobKrieg --- diff --git a/docs/cba/cba-description.rst b/docs/cba/cba-description.rst new file mode 100644 index 000000000..08702fbce --- /dev/null +++ b/docs/cba/cba-description.rst @@ -0,0 +1,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. diff --git a/docs/cba/index.rst b/docs/cba/index.rst index 70ed2aef8..62eb92717 100644 --- a/docs/cba/index.rst +++ b/docs/cba/index.rst @@ -11,43 +11,8 @@ Controller Blueprint Archived Designer Tool (CBA) Introduction ------------ -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. +.. include:: cba-description.rst Architecture ------------ diff --git a/docs/index.rst b/docs/index.rst index af25a5940..ef2d94f91 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,13 +12,14 @@ CONTROLLER DESIGN STUDIO (CDS) Introduction ------------ - The system is designed to be self service, which means that users, not just + +The system is designed to be self service, which means that users, not just programmers, can reconfigure the software system as needed to meet customer requirements. To accomplish this goal, the system is built around models that provide for real-time changes in how the system operates. Users merely need to change a model to change how a service operates. - Self service is a completely new way of delivering services. It removes the +Self service is a completely new way of delivering services. It removes the dependence on code releases and the delays they cause and puts the control of services into the hands of the service providers. They can change a model and its parameters and create a new service without writing a single line of code. @@ -27,18 +28,19 @@ deliver products that more closely match the needs of its customers. Architecture ------------ + The Controller Design Studio is composed of two major components: * The GUI (or frontend) * The Run Time (or backend) - The GUI handles direct user input and allows for displaying both design time +The GUI handles direct user input and allows for displaying both design time and run time activities. For design time, it allows for the creation of controller blueprint, from selecting the DGs to be included, to incorporating the artifact templates, to adding necessary components. For run time, it allows the user to direct the system to resolve the unresolved elements of the controller blueprint and download the resulting configuration into a VNF. - At a more basic level, it allows for creation of data dictionaries, +At a more basic level, it allows for creation of data dictionaries, capabilities catalogs, and controller blueprint, the basic elements that are used to generate a configuration. The essential function of the Controller Design Studio is to create and populate a controller blueprint, create a @@ -51,11 +53,11 @@ configuration file (configlet) to a VNF/PNF. Modeling Concept ---------------- - In Dublin release, the CDS community has contributed a framework to automate +In Dublin release, the CDS community has contributed a framework to automate the resolution of resources for instantiation and any config provisioning operation, such as day0, day1 or day2 configuration. - The content of the CBA Package is driven from a catalog of reusable data +The content of the CBA Package is driven from a catalog of reusable data dictionary, component and workflow, delivering a reusable and simplified self service experience. @@ -105,15 +107,16 @@ Library .. |cdsArchitectureImage| image:: media/CDS_architecture.jpg :width: 500pt -User Guide ----------- +User Guides +------------ .. toctree:: :maxdepth: 3 - userguide/developer-guide - userguide/installation - userguide/designtime + userguides/developer-guide/index + userguides/installation + userguides/design-time-guide/designtime + userguides/resourceassignment Use Cases --------- diff --git a/docs/modelingconcepts/cba.rst b/docs/modelingconcepts/cba.rst index 41baa9924..a352e760a 100644 --- a/docs/modelingconcepts/cba.rst +++ b/docs/modelingconcepts/cba.rst @@ -9,39 +9,4 @@ Controller Blueprint Archive (.cba) ----------------------------------- -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. \ No newline at end of file +.. include:: ../cba/cba-description.rst \ No newline at end of file diff --git a/docs/modelingconcepts/index.rst b/docs/modelingconcepts/index.rst index d8ea3de4b..a7099954c 100644 --- a/docs/modelingconcepts/index.rst +++ b/docs/modelingconcepts/index.rst @@ -27,6 +27,8 @@ Most of the TOSCA modeled entity presented in the bellow documentation can be found `here `_. + + .. toctree:: :caption: Table of Contents :maxdepth: 1 diff --git a/docs/userguide/designtime.rst b/docs/userguides/design-time-guide/designtime.rst similarity index 96% rename from docs/userguide/designtime.rst rename to docs/userguides/design-time-guide/designtime.rst index 805cfa89c..52b6e55b9 100644 --- a/docs/userguide/designtime.rst +++ b/docs/userguides/design-time-guide/designtime.rst @@ -45,6 +45,6 @@ Services: .. toctree:: :maxdepth: 2 - ../cba/index - ../resourcedefinition/index + ../../cba/index + ../../resourcedefinition/index resourceassignment diff --git a/docs/userguide/resourceassignment.rst b/docs/userguides/design-time-guide/resourceassignment.rst similarity index 100% rename from docs/userguide/resourceassignment.rst rename to docs/userguides/design-time-guide/resourceassignment.rst diff --git a/docs/userguide/developer-guide.rst b/docs/userguides/developer-guide/index.rst similarity index 84% rename from docs/userguide/developer-guide.rst rename to docs/userguides/developer-guide/index.rst index be73f59c7..129ff7cd6 100644 --- a/docs/userguide/developer-guide.rst +++ b/docs/userguides/developer-guide/index.rst @@ -5,7 +5,7 @@ Developer Guide ================= -Blueprints Processor Microservice: +Blueprints Processor Microservice ---------------------------------- Micro service to Manage Controller Blueprint Models, such as Resource Dictionary, Service Models, Velocity Templates etc, which will serve service for Controller Design Studio and Controller runtimes. @@ -13,11 +13,12 @@ Micro service to Manage Controller Blueprint Models, such as Resource Dictionary This microservice is used to deploy Controller Blueprint Archive file in Run time database. This also helps to test the Valid CBA. .. toctree:: + :caption: Guide how to run Blueprint Processor in an IDE: :maxdepth: 1 running-bp-processor-in-ide -Architecture: +Architecture ~~~~~~~~~~~~~ |image0| @@ -26,8 +27,8 @@ Architecture: :width: 400pt -Testing in local environment: ------------------------------ +Testing in local environment +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Point your browser to http://localhost:8000/api/v1/execution-service/ping (please note that the port is 8000, not 8080) diff --git a/docs/userguide/media/blueprintprocessor.jpg b/docs/userguides/developer-guide/media/blueprintprocessor.jpg similarity index 100% rename from docs/userguide/media/blueprintprocessor.jpg rename to docs/userguides/developer-guide/media/blueprintprocessor.jpg diff --git a/docs/userguide/media/build_logs.png b/docs/userguides/developer-guide/media/build_logs.png similarity index 100% rename from docs/userguide/media/build_logs.png rename to docs/userguides/developer-guide/media/build_logs.png diff --git a/docs/userguide/media/create_run_config_java.png b/docs/userguides/developer-guide/media/create_run_config_java.png similarity index 100% rename from docs/userguide/media/create_run_config_java.png rename to docs/userguides/developer-guide/media/create_run_config_java.png diff --git a/docs/userguide/media/create_run_config_kt.png b/docs/userguides/developer-guide/media/create_run_config_kt.png similarity index 100% rename from docs/userguide/media/create_run_config_kt.png rename to docs/userguides/developer-guide/media/create_run_config_kt.png diff --git a/docs/userguide/media/expand_vm_options.PNG b/docs/userguides/developer-guide/media/expand_vm_options.PNG similarity index 100% rename from docs/userguide/media/expand_vm_options.PNG rename to docs/userguides/developer-guide/media/expand_vm_options.PNG diff --git a/docs/userguide/media/import_project.png b/docs/userguides/developer-guide/media/import_project.png similarity index 100% rename from docs/userguide/media/import_project.png rename to docs/userguides/developer-guide/media/import_project.png diff --git a/docs/userguide/media/reimport_maven.png b/docs/userguides/developer-guide/media/reimport_maven.png similarity index 100% rename from docs/userguide/media/reimport_maven.png rename to docs/userguides/developer-guide/media/reimport_maven.png diff --git a/docs/userguide/media/run_config_java.png b/docs/userguides/developer-guide/media/run_config_java.png similarity index 100% rename from docs/userguide/media/run_config_java.png rename to docs/userguides/developer-guide/media/run_config_java.png diff --git a/docs/userguide/media/run_config_kt.png b/docs/userguides/developer-guide/media/run_config_kt.png similarity index 100% rename from docs/userguide/media/run_config_kt.png rename to docs/userguides/developer-guide/media/run_config_kt.png diff --git a/docs/userguide/media/run-config-set-up.png b/docs/userguides/developer-guide/media/run_config_set_up.png similarity index 100% rename from docs/userguide/media/run-config-set-up.png rename to docs/userguides/developer-guide/media/run_config_set_up.png diff --git a/docs/userguide/media/run_debug.png b/docs/userguides/developer-guide/media/run_debug.png similarity index 100% rename from docs/userguide/media/run_debug.png rename to docs/userguides/developer-guide/media/run_debug.png diff --git a/docs/userguide/media/vsc_logs.png b/docs/userguides/developer-guide/media/vsc_logs.png similarity index 100% rename from docs/userguide/media/vsc_logs.png rename to docs/userguides/developer-guide/media/vsc_logs.png diff --git a/docs/userguide/running-bp-processor-in-ide.rst b/docs/userguides/developer-guide/running-bp-processor-in-ide.rst similarity index 98% rename from docs/userguide/running-bp-processor-in-ide.rst rename to docs/userguides/developer-guide/running-bp-processor-in-ide.rst index 3cbcc18b1..ab6ae2314 100644 --- a/docs/userguide/running-bp-processor-in-ide.rst +++ b/docs/userguides/developer-guide/running-bp-processor-in-ide.rst @@ -26,6 +26,10 @@ In the checked out directory, type mvn clean install -Pq -Dadditionalparam=-Xdoclint:none +.. note:: + If an error ``invalid flag: --release`` appears when executing the maven install command, you need to upgrade Java version of your local + Maven installation. Use something like ``export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64``. + Wait for the maven install command to finish until you go further. Spin up a Docker container with the database @@ -419,6 +423,6 @@ Compilation error? :width: 500pt :align: middle -.. |imageRunConfigSetUp| image:: media/run-config-set-up.png +.. |imageRunConfigSetUp| image:: media/run_config_set_up.png :width: 500pt :align: middle diff --git a/docs/userguide/installation.rst b/docs/userguides/installation.rst similarity index 100% rename from docs/userguide/installation.rst rename to docs/userguides/installation.rst