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/microservices/bluePrintsProcessorMS.rst | 87 --------------------- docs/microservices/blueprintsProcessorMS.rst | 86 ++++++++++++++++++++ docs/microservices/controllerBlueprintMS.rst | 20 +++++ .../controllerBlueprintStudioProcessorMS.rst | 20 ----- docs/microservices/dynamicapi.rst | 5 +- docs/microservices/enrichment.rst | 13 ++- docs/microservices/expression.rst | 45 ----------- docs/microservices/flexibleplugin.rst | 17 ---- docs/microservices/images/blueprintprocessor.jpg | Bin 47208 -> 0 bytes docs/microservices/media/Enrichment-UI1.png | Bin 33981 -> 42383 bytes docs/microservices/media/Enrichment-UI2.png | Bin 90202 -> 109402 bytes docs/microservices/media/blueprintprocessor.jpg | Bin 0 -> 63829 bytes docs/microservices/media/dyanmicapi.jpg | Bin 72238 -> 118101 bytes 13 files changed, 113 insertions(+), 180 deletions(-) delete mode 100644 docs/microservices/bluePrintsProcessorMS.rst create mode 100644 docs/microservices/blueprintsProcessorMS.rst create mode 100644 docs/microservices/controllerBlueprintMS.rst delete mode 100644 docs/microservices/controllerBlueprintStudioProcessorMS.rst delete mode 100644 docs/microservices/expression.rst delete mode 100644 docs/microservices/flexibleplugin.rst delete mode 100644 docs/microservices/images/blueprintprocessor.jpg create mode 100644 docs/microservices/media/blueprintprocessor.jpg (limited to 'docs/microservices') diff --git a/docs/microservices/bluePrintsProcessorMS.rst b/docs/microservices/bluePrintsProcessorMS.rst deleted file mode 100644 index 292f99e51..000000000 --- a/docs/microservices/bluePrintsProcessorMS.rst +++ /dev/null @@ -1,87 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons. -.. Copyright (C) 2019 IBM. - -Blueprints Processor -==================== - -.. toctree:: - :maxdepth: 1 - :titlesonly: - -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. - -This microservice is used to deploy Controller Blueprint Archive file in Run time database. This also helps to test the Valid Blueprint. - -Architecture: -------------- - -|image0| - -.. |image0| image:: images/blueprintprocessor.jpg - :height: 600px - :width: 800px - -Running Blueprints Processor Microservice Locally: --------------------------------------------------- - -The purpose of this page is to show how to run the Blueprints Processor microservice locally, using the docker-compose.yaml file provided in the project. - -Check out the CDS' code: - -Check out the latest code from Gerrit: https://gerrit.onap.org/r/#/admin/projects/ccsdk/cds - -Build CDS locally: -In the checked out directory, type - -.. code-block:: none - - mvn clean install -DskipTests=true -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -Dadditionalparam=-Xdoclint:none - -Create the needed Docker images: - -The Blueprints Processor microservice project has a module, called distribution, that provides a docker-compose.yaml file that can be used to spin up Docker containers to run this microservice. - -The first step is to create any custom image needed, by building the distribution module. From the CDS home directory (where the code was checked out), navigate to the module: - -.. code-block:: none - - cd ms/blueprintsprocessor/distribution/ - -Build it using the Maven profile called Docker: - -.. code-block:: none - - mvn clean install -Pdocker - -Start Docker containers using docker-composer: ----------------------------------------------- - -Navigate to the docker-compose file in the distribution module: - -.. code-block:: none - - cd src/main/dc/ - -From there, start the containers: - -.. code-block:: none - - docker-compose up -d - -This will spin the Docker containers declared inside the docker-compose.yaml file in the background. - - -To verify the logs generated by docker-composer, type: - -.. code-block:: none - - docker-compose logs -f - - -Testing the environment: ------------------------- - -Point your browser to http://localhost:8000/api/v1/execution-service/ping (please note that the port is 8000, not 8080) - -To authenticate, use login user id and password. \ No newline at end of file diff --git a/docs/microservices/blueprintsProcessorMS.rst b/docs/microservices/blueprintsProcessorMS.rst new file mode 100644 index 000000000..e447c3ff9 --- /dev/null +++ b/docs/microservices/blueprintsProcessorMS.rst @@ -0,0 +1,86 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons. +.. Copyright (C) 2019 IBM. + +Blueprints Processor +==================== + +.. toctree:: + :maxdepth: 1 + :titlesonly: + +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. + +This microservice is used to deploy Controller Blueprint Archive file in Run time database. This also helps to test the Valid Blueprint. + +Architecture: +------------- + +|image0| + +.. |image0| image:: media/blueprintprocessor.jpg + :width: 400pt + +Running Blueprints Processor Microservice Locally: +-------------------------------------------------- + +The purpose of this page is to show how to run the Blueprints Processor microservice locally, using the docker-compose.yaml file provided in the project. + +Check out the CDS' code: + +Check out the latest code from Gerrit: https://gerrit.onap.org/r/#/admin/projects/ccsdk/cds + +Build CDS locally: +In the checked out directory, type + +.. code-block:: none + + mvn clean install -DskipTests=true -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -Dadditionalparam=-Xdoclint:none + +Create the needed Docker images: + +The Blueprints Processor microservice project has a module, called distribution, that provides a docker-compose.yaml file that can be used to spin up Docker containers to run this microservice. + +The first step is to create any custom image needed, by building the distribution module. From the CDS home directory (where the code was checked out), navigate to the module: + +.. code-block:: none + + cd ms/blueprintsprocessor/distribution/ + +Build it using the Maven profile called Docker: + +.. code-block:: none + + mvn clean install -Pdocker + +Start Docker containers using docker-composer: +---------------------------------------------- + +Navigate to the docker-compose file in the distribution module: + +.. code-block:: none + + cd src/main/dc/ + +From there, start the containers: + +.. code-block:: none + + docker-compose up -d + +This will spin the Docker containers declared inside the docker-compose.yaml file in the background. + + +To verify the logs generated by docker-composer, type: + +.. code-block:: none + + docker-compose logs -f + + +Testing the environment: +------------------------ + +Point your browser to http://localhost:8000/api/v1/execution-service/ping (please note that the port is 8000, not 8080) + +To authenticate, use login user id and password. \ No newline at end of file diff --git a/docs/microservices/controllerBlueprintMS.rst b/docs/microservices/controllerBlueprintMS.rst new file mode 100644 index 000000000..2326e95c0 --- /dev/null +++ b/docs/microservices/controllerBlueprintMS.rst @@ -0,0 +1,20 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons. +.. Copyright (C) 2019 IBM. + +Controller Blueprints Studio Processor +====================================== + +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, which is saved in Controller Blueprint Database. + +Controller Blueprint Microservices: +----------------------------------- + +.. toctree:: + :maxdepth: 1 + + dynamicapi + enrichment diff --git a/docs/microservices/controllerBlueprintStudioProcessorMS.rst b/docs/microservices/controllerBlueprintStudioProcessorMS.rst deleted file mode 100644 index 9dcd31187..000000000 --- a/docs/microservices/controllerBlueprintStudioProcessorMS.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons. -.. Copyright (C) 2019 IBM. - -Controller Blueprints Studio Processor -====================================== - -The Controller Blueprint Archive 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 which is saved in Controller Blueprint Database. - -Controller Blueprint Microservices: ------------------------------------ - -.. toctree:: - :maxdepth: 1 - - dynamicapi - enrichment - \ No newline at end of file diff --git a/docs/microservices/dynamicapi.rst b/docs/microservices/dynamicapi.rst index c732bd09d..264dcc570 100644 --- a/docs/microservices/dynamicapi.rst +++ b/docs/microservices/dynamicapi.rst @@ -3,7 +3,7 @@ .. Copyright (C) 2019 IBM. Dynamic API ------------ +=========== The nature of the API request and response is meant to be model driven and dynamic. They both share the same definition. @@ -20,5 +20,4 @@ Here is how the a generic request and response look like. |image0| .. |image0| image:: media/dyanmicapi.jpg - :height: 4.43750in - :width: 7.88889in \ No newline at end of file + :width: 500pt \ No newline at end of file diff --git a/docs/microservices/enrichment.rst b/docs/microservices/enrichment.rst index 306cdbcc5..0f50beca4 100644 --- a/docs/microservices/enrichment.rst +++ b/docs/microservices/enrichment.rst @@ -27,13 +27,10 @@ CDS UI: |image2| .. |image0| image:: media/Enrichment-REST.png - :width: 7.88889in - :height: 4.43750in - + :width: 500pt + .. |image1| image:: media/Enrichment-UI1.png - :width: 7.88889in - :height: 4.43750in - + :width: 500pt + .. |image2| image:: media/Enrichment-UI2.png - :width: 7.88889in - :height: 4.43750in \ No newline at end of file + :width: 500pt \ No newline at end of file diff --git a/docs/microservices/expression.rst b/docs/microservices/expression.rst deleted file mode 100644 index 38a7d624c..000000000 --- a/docs/microservices/expression.rst +++ /dev/null @@ -1,45 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2019 IBM. - -Expression -========== - -TOSCA provides for a set of functions to reference elements within the template or to retrieve runtime values. - -Below is a list of supported expressions - -get_input ---------- - -The get_input function is used to retrieve the values of properties declared within the inputs section of a TOSCA Service Template. - -http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.2/csd01/TOSCA-Simple-Profile-YAML-v1.2-csd01.html#_Toc494454178 - -get_property ------------- - -The get_property function is used to retrieve property values between modelable entities defined in the same service template. - -http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.2/csd01/TOSCA-Simple-Profile-YAML-v1.2-csd01.html#_Toc494454178 - -get_attribute -------------- - -The get_attribute function is used to retrieve the values of named attributes declared by the referenced node or relationship template name. - -http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.2/csd01/TOSCA-Simple-Profile-YAML-v1.2-csd01.html#_Toc494454179 - -get_operation_output --------------------- - -The get_operation_output function is used to retrieve the values of variables exposed / exported from an interface operation. - -http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.2/csd01/TOSCA-Simple-Profile-YAML-v1.2-csd01.html#_Toc494454180 - -get_artifact ------------- - -The get_artifact function is used to retrieve artifact location between modelable entities defined in the same service template. - -http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.2/csd01/TOSCA-Simple-Profile-YAML-v1.2-csd01.html#_Toc494454182 diff --git a/docs/microservices/flexibleplugin.rst b/docs/microservices/flexibleplugin.rst deleted file mode 100644 index 5c83ac9b7..000000000 --- a/docs/microservices/flexibleplugin.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2019 IBM. - -Flexible Plug-in ----------------- - -Interaction with external systems is made plug-able, removing development cycle to support new endpoint. - -Currently, REST or SQL external systems are supported. - -An external system might be used by multiple resources, or by multiple scripts. - -In order to share the external system information, TOSCA provides a way to create macros using dsl_definitions: - -http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.2/csd01/TOSCA-Simple-Profile-YAML-v1.2-csd01.html#_Toc494454160 -http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.2/csd01/TOSCA-Simple-Profile-YAML-v1.2-csd01.html#_Toc494454173 diff --git a/docs/microservices/images/blueprintprocessor.jpg b/docs/microservices/images/blueprintprocessor.jpg deleted file mode 100644 index c618e0e32..000000000 Binary files a/docs/microservices/images/blueprintprocessor.jpg and /dev/null differ diff --git a/docs/microservices/media/Enrichment-UI1.png b/docs/microservices/media/Enrichment-UI1.png index 62b870cab..082af6128 100644 Binary files a/docs/microservices/media/Enrichment-UI1.png and b/docs/microservices/media/Enrichment-UI1.png differ diff --git a/docs/microservices/media/Enrichment-UI2.png b/docs/microservices/media/Enrichment-UI2.png index 44497050a..90be708b5 100644 Binary files a/docs/microservices/media/Enrichment-UI2.png and b/docs/microservices/media/Enrichment-UI2.png differ diff --git a/docs/microservices/media/blueprintprocessor.jpg b/docs/microservices/media/blueprintprocessor.jpg new file mode 100644 index 000000000..429876a13 Binary files /dev/null and b/docs/microservices/media/blueprintprocessor.jpg differ diff --git a/docs/microservices/media/dyanmicapi.jpg b/docs/microservices/media/dyanmicapi.jpg index 3e00da3e8..5cc1ae176 100644 Binary files a/docs/microservices/media/dyanmicapi.jpg and b/docs/microservices/media/dyanmicapi.jpg differ -- cgit