diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/bluePrintsProcessorMS.rst | 73 | ||||
-rw-r--r-- | docs/controllerBlueprintStudioProcessorMS.rst | 32 | ||||
-rw-r--r-- | docs/datadictionary/index.rst | 4 | ||||
-rw-r--r-- | docs/datadictionary/media/mandatory.JPG (renamed from docs/datadictionary/media/image0.JPG) | bin | 48105 -> 48105 bytes | |||
-rw-r--r-- | docs/datadictionary/media/optional.JPG (renamed from docs/datadictionary/media/image1.JPG) | bin | 79730 -> 79730 bytes | |||
-rw-r--r-- | docs/datadictionary/resourcesource.rst | 11 | ||||
-rw-r--r-- | docs/microservices/controllerBlueprintStudioProcessorMS.rst | 13 | ||||
-rw-r--r-- | docs/microservices/enrichment.rst | 36 | ||||
-rw-r--r-- | docs/microservices/images/blueprintprocessor.jpg (renamed from docs/media/blueprintprocessor.jpg) | bin | 47208 -> 47208 bytes | |||
-rw-r--r-- | docs/microservices/media/Enrichment-REST.png | bin | 0 -> 156586 bytes | |||
-rw-r--r-- | docs/microservices/media/Enrichment-UI1.png | bin | 0 -> 33981 bytes | |||
-rw-r--r-- | docs/microservices/media/Enrichment-UI2.png | bin | 0 -> 90202 bytes |
12 files changed, 52 insertions, 117 deletions
diff --git a/docs/bluePrintsProcessorMS.rst b/docs/bluePrintsProcessorMS.rst deleted file mode 100644 index 3f308138f..000000000 --- a/docs/bluePrintsProcessorMS.rst +++ /dev/null @@ -1,73 +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 - - 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: - - cd ms/blueprintsprocessor/distribution/ -Build it using the Maven profile called Docker: - - mvn clean install -Pdocker - -Start Docker containers using docker-composer: ----------------------------------------------- - -Navigate to the docker-compose file in the distribution module: - - cd src/main/dc/ - -From there, start the containers: - - 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: - - 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 ccsdkapps / ccsdkapps as login / password.
\ No newline at end of file diff --git a/docs/controllerBlueprintStudioProcessorMS.rst b/docs/controllerBlueprintStudioProcessorMS.rst deleted file mode 100644 index 6f3152d20..000000000 --- a/docs/controllerBlueprintStudioProcessorMS.rst +++ /dev/null @@ -1,32 +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. - -Dynamic API: ------------- - -The nature of the API request and response is meant to be model driven and dynamic. They both share the same definition. - -The actionName, under the actionIdentifiers refers to the name of a Workflow (see workflow) - -The content of the payload is what is fully dynamic / model driven. - -The first top level element will always be either $actionName-request for a request or $actionName-response for a response. - -Then the content within this element is fully based on the workflow input and output. - - -Enrichment: ------------ - -Helps to generate complete valid CBA file. - - -
\ No newline at end of file diff --git a/docs/datadictionary/index.rst b/docs/datadictionary/index.rst index 88122b49f..0d87158d9 100644 --- a/docs/datadictionary/index.rst +++ b/docs/datadictionary/index.rst @@ -61,10 +61,10 @@ Also please click below for resource source available details .. _Resource: https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-NodeResourceSource -.. |image0| image:: media/image0.jpg +.. |image0| image:: media/mandatory.jpg :width: 7.88889in :height: 4.43750in -.. |image1| image:: media/image1.jpg +.. |image1| image:: media/optional.jpg :width: 7.88889in :height: 4.43750in
\ No newline at end of file diff --git a/docs/datadictionary/media/image0.JPG b/docs/datadictionary/media/mandatory.JPG Binary files differindex 074d20076..074d20076 100644 --- a/docs/datadictionary/media/image0.JPG +++ b/docs/datadictionary/media/mandatory.JPG diff --git a/docs/datadictionary/media/image1.JPG b/docs/datadictionary/media/optional.JPG Binary files differindex a27502a75..a27502a75 100644 --- a/docs/datadictionary/media/image1.JPG +++ b/docs/datadictionary/media/optional.JPG diff --git a/docs/datadictionary/resourcesource.rst b/docs/datadictionary/resourcesource.rst index 1bc0de4f1..1a69fd63f 100644 --- a/docs/datadictionary/resourcesource.rst +++ b/docs/datadictionary/resourcesource.rst @@ -11,12 +11,10 @@ Expects the value to be provided as input to the request. source-input: -{ "description": "This is Input Resource Source Node Type", "version": "1.0.0", "properties": {}, "derived_from": "tosca.nodes.ResourceSource" -} Default: @@ -25,12 +23,11 @@ Expects the value to be defaulted in the model itself. source-default: -{ "description": "This is Default Resource Source Node Type", "version": "1.0.0", "properties": {}, "derived_from": "tosca.nodes.ResourceSource" -} + sql: @@ -42,7 +39,7 @@ CDS is currently deployed along the side of SDNC, hence the primary database con |image0| -.. |image0| image:: sqltable.jpg +.. |image0| image:: media/sqltable.jpg :width: 7.88889in :height: 4.43750in @@ -68,7 +65,7 @@ CDS is currently deployed along the side of SDNC, hence the default rest connect |image1| -.. |image1| image:: resttable.jpg +.. |image1| image:: media/resttable.jpg :width: 7.88889in :height: 4.43750in @@ -99,7 +96,7 @@ Expects a script to be provided. |image2| -.. |image2| image:: capabilitytable.jpg +.. |image2| image:: media/capabilitytable.jpg :width: 7.88889in :height: 4.43750in diff --git a/docs/microservices/controllerBlueprintStudioProcessorMS.rst b/docs/microservices/controllerBlueprintStudioProcessorMS.rst index 5c67d6c1d..683b6943d 100644 --- a/docs/microservices/controllerBlueprintStudioProcessorMS.rst +++ b/docs/microservices/controllerBlueprintStudioProcessorMS.rst @@ -10,7 +10,7 @@ The Controller Blueprint Archive is the overall service design, fully model-driv The CBA is .zip file which is saved in Controller Blueprint Database. Dynamic API: -=========== +------------ The nature of the API request and response is meant to be model driven and dynamic. They both share the same definition. @@ -22,11 +22,18 @@ The first top level element will always be either $actionName-request for a requ Then the content within this element is fully based on the workflow input and output. +.. toctree:: + :maxdepth: 1 + + dynamicapi Enrichment: -=========== +----------- Helps to generate complete valid CBA file. - +.. toctree:: + :maxdepth: 1 + + enrichment
\ No newline at end of file diff --git a/docs/microservices/enrichment.rst b/docs/microservices/enrichment.rst new file mode 100644 index 000000000..55984d77c --- /dev/null +++ b/docs/microservices/enrichment.rst @@ -0,0 +1,36 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2019 IBM. + + +Enrichment +========== +.. toctree:: + :maxdepth: 1 + +Once the base CBA zip file is done, the enrichment process will complete the design by providing all the definitions required for the self-service provisioning. + +The following shows 2 ways to run CBA enrichment + +*REST API request + +|image0| + +*CDS UI + +|image1| + + +|image2| + +.. |image0| image:: media/Enrichment-REST.png + :width: 7.88889in + :height: 4.43750in + +.. |image1| image:: media/Enrichment-UI1.png + :width: 7.88889in + :height: 4.43750in + +.. |image2| image:: media/Enrichment-UI2.png + :width: 7.88889in + :height: 4.43750in
\ No newline at end of file diff --git a/docs/media/blueprintprocessor.jpg b/docs/microservices/images/blueprintprocessor.jpg Binary files differindex c618e0e32..c618e0e32 100644 --- a/docs/media/blueprintprocessor.jpg +++ b/docs/microservices/images/blueprintprocessor.jpg diff --git a/docs/microservices/media/Enrichment-REST.png b/docs/microservices/media/Enrichment-REST.png Binary files differnew file mode 100644 index 000000000..005f7960b --- /dev/null +++ b/docs/microservices/media/Enrichment-REST.png diff --git a/docs/microservices/media/Enrichment-UI1.png b/docs/microservices/media/Enrichment-UI1.png Binary files differnew file mode 100644 index 000000000..62b870cab --- /dev/null +++ b/docs/microservices/media/Enrichment-UI1.png diff --git a/docs/microservices/media/Enrichment-UI2.png b/docs/microservices/media/Enrichment-UI2.png Binary files differnew file mode 100644 index 000000000..44497050a --- /dev/null +++ b/docs/microservices/media/Enrichment-UI2.png |