diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/datadictionary/index.rst | 20 | ||||
-rw-r--r-- | docs/datadictionary/media/capabilitytable.JPG (renamed from docs/datadictionary/capabilitytable.JPG) | bin | 57448 -> 57448 bytes | |||
-rw-r--r-- | docs/datadictionary/media/image0.JPG (renamed from docs/datadictionary/image0.JPG) | bin | 48105 -> 48105 bytes | |||
-rw-r--r-- | docs/datadictionary/media/image1.JPG (renamed from docs/datadictionary/image1.JPG) | bin | 79730 -> 79730 bytes | |||
-rw-r--r-- | docs/datadictionary/media/resttable.JPG (renamed from docs/datadictionary/resttable.JPG) | bin | 79877 -> 79877 bytes | |||
-rw-r--r-- | docs/datadictionary/media/sqltable.JPG (renamed from docs/datadictionary/sqltable.JPG) | bin | 36259 -> 36259 bytes | |||
-rw-r--r-- | docs/microservices/bluePrintsProcessorMS.rst | 73 | ||||
-rw-r--r-- | docs/microservices/controllerBlueprintStudioProcessorMS.rst | 32 | ||||
-rw-r--r-- | docs/microservices/dynamicapi.rst (renamed from docs/dynamicapi.rst) | 0 |
9 files changed, 116 insertions, 9 deletions
diff --git a/docs/datadictionary/index.rst b/docs/datadictionary/index.rst index 64abdece0..88122b49f 100644 --- a/docs/datadictionary/index.rst +++ b/docs/datadictionary/index.rst @@ -21,9 +21,7 @@ As part of modelling a Resource definition entry, the following generic informat |image0| -.. |image0| image:: image0.jpg - :width: 7.88889in - :height: 4.43750in + Below are properties that all the resource source have will have @@ -31,9 +29,6 @@ The modeling does allow for data translation between external capability and CDS |image1| -.. |image1| image:: image1.jpg - :width: 7.88889in - :height: 4.43750in Example: ======== @@ -48,8 +43,6 @@ Here is how input-key-mapping, output-key-mapping and key-dependencies can be us resourceDefintionCode - - Resource source: ================ @@ -65,4 +58,13 @@ Also please click below for resource source available details resourcesource .. _TOSCA: http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/csprd01/TOSCA-Simple-Profile-YAML-v1.0-csprd01.html#DEFN_ENTITY_NODE_TYPE -.. _Resource: https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-NodeResourceSource
\ No newline at end of file +.. _Resource: https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-NodeResourceSource + + +.. |image0| image:: media/image0.jpg + :width: 7.88889in + :height: 4.43750in + +.. |image1| image:: media/image1.jpg + :width: 7.88889in + :height: 4.43750in
\ No newline at end of file diff --git a/docs/datadictionary/capabilitytable.JPG b/docs/datadictionary/media/capabilitytable.JPG Binary files differindex 7db4715ea..7db4715ea 100644 --- a/docs/datadictionary/capabilitytable.JPG +++ b/docs/datadictionary/media/capabilitytable.JPG diff --git a/docs/datadictionary/image0.JPG b/docs/datadictionary/media/image0.JPG Binary files differindex 074d20076..074d20076 100644 --- a/docs/datadictionary/image0.JPG +++ b/docs/datadictionary/media/image0.JPG diff --git a/docs/datadictionary/image1.JPG b/docs/datadictionary/media/image1.JPG Binary files differindex a27502a75..a27502a75 100644 --- a/docs/datadictionary/image1.JPG +++ b/docs/datadictionary/media/image1.JPG diff --git a/docs/datadictionary/resttable.JPG b/docs/datadictionary/media/resttable.JPG Binary files differindex 568ad0a9f..568ad0a9f 100644 --- a/docs/datadictionary/resttable.JPG +++ b/docs/datadictionary/media/resttable.JPG diff --git a/docs/datadictionary/sqltable.JPG b/docs/datadictionary/media/sqltable.JPG Binary files differindex 15d246743..15d246743 100644 --- a/docs/datadictionary/sqltable.JPG +++ b/docs/datadictionary/media/sqltable.JPG diff --git a/docs/microservices/bluePrintsProcessorMS.rst b/docs/microservices/bluePrintsProcessorMS.rst new file mode 100644 index 000000000..911f99945 --- /dev/null +++ b/docs/microservices/bluePrintsProcessorMS.rst @@ -0,0 +1,73 @@ +.. 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/microservices/controllerBlueprintStudioProcessorMS.rst b/docs/microservices/controllerBlueprintStudioProcessorMS.rst new file mode 100644 index 000000000..5c67d6c1d --- /dev/null +++ b/docs/microservices/controllerBlueprintStudioProcessorMS.rst @@ -0,0 +1,32 @@ +.. 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/dynamicapi.rst b/docs/microservices/dynamicapi.rst index eaf9987b7..eaf9987b7 100644 --- a/docs/dynamicapi.rst +++ b/docs/microservices/dynamicapi.rst |