diff options
author | KAPIL SINGAL <ks220y@att.com> | 2020-09-29 15:04:33 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@onap.org> | 2020-09-29 15:04:33 +0000 |
commit | 30d59d2339aed659540c7af63e0de7644df2c3e6 (patch) | |
tree | 78c5992c5790b8117d28aa3e150957b3423d0fd3 /docs/userguide | |
parent | 4726dfef46e024941f25be2c9d4ee66a5b1798ba (diff) | |
parent | 51e7c12ccd4889cea181d92b368e1b74622ac769 (diff) |
Merge "Refactoring and fixing Docs"
Diffstat (limited to 'docs/userguide')
-rw-r--r-- | docs/userguide/designtime.rst | 2 | ||||
-rw-r--r-- | docs/userguide/installation.rst | 1 | ||||
-rw-r--r-- | docs/userguide/resourceassignment.rst | 21 | ||||
-rw-r--r-- | docs/userguide/running-bp-processor-in-ide.rst | 46 |
4 files changed, 23 insertions, 47 deletions
diff --git a/docs/userguide/designtime.rst b/docs/userguide/designtime.rst index 3ec9ebf95..805cfa89c 100644 --- a/docs/userguide/designtime.rst +++ b/docs/userguide/designtime.rst @@ -45,6 +45,6 @@ Services: .. toctree:: :maxdepth: 2 - ../CBA/index + ../cba/index ../resourcedefinition/index resourceassignment diff --git a/docs/userguide/installation.rst b/docs/userguide/installation.rst index 4e15e980b..10997294c 100644 --- a/docs/userguide/installation.rst +++ b/docs/userguide/installation.rst @@ -84,7 +84,6 @@ Install Node.js and angularCLI. Refer https://angular.io/guide/quickstart npm install in the directory cds/cds-ui/client npm run build - to build UI module - Loopback Server: ~~~~~~~~~~~~~~~~ diff --git a/docs/userguide/resourceassignment.rst b/docs/userguide/resourceassignment.rst index f4fab4ee3..aa4f6b559 100644 --- a/docs/userguide/resourceassignment.rst +++ b/docs/userguide/resourceassignment.rst @@ -2,23 +2,23 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright (C) 2019 IBM. -Resource Assignment -------------------- +Resource Assignment +=================== .. toctree:: :maxdepth: 1 - - + + Component executor: -=================== +------------------- Workflow: -========= +~~~~~~~~~ A workflow defines an overall action to be taken for the service; it can be composed of a set of sub-actions to execute. Currently, workflows are backed by Directed Graph engine. A CBA can have as many workflow as needed. Template: -========= +~~~~~~~~~ A template is an artifact. @@ -34,7 +34,7 @@ ${artifact-prefix}-mapping A template can represent anything, such as device config, payload to interact with 3rd party systems, resource-accumulator template, etc... Mapping: -======== +~~~~~~~~ Defines the contract of each resource to be resolved. Each placeholder in the template must have a corresponding mapping definition. A mapping is comprised of: @@ -46,13 +46,14 @@ A mapping is comprised of: - dictionary-source Dependencies: -============= +~~~~~~~~~~~~~ This allows to make sure given resources get resolved prior the resolution of the resources defining the dependency. The dictionary fields reference to a specific data dictionary. + Resource accumulator: -===================== +--------------------- In order to resolve HEAT environment variables, resource accumulator templates are being in used for Dublin. diff --git a/docs/userguide/running-bp-processor-in-ide.rst b/docs/userguide/running-bp-processor-in-ide.rst index 1404c42b5..4a0cac58d 100644 --- a/docs/userguide/running-bp-processor-in-ide.rst +++ b/docs/userguide/running-bp-processor-in-ide.rst @@ -12,7 +12,6 @@ Objective Have the blueprint processor running locally is to use the IDE to run the code, while having the database running in a container. This way, code changes can be conveniently tested and debugged. - Check out the code ~~~~~~~~~~~~~~~~~~~ @@ -42,31 +41,9 @@ file present on the distribution module. This database will require a local dire Navigate to the docker-compose file in the distribution module: -.. tabs:: - - .. group-tab:: Latest - - .. code-block:: bash - - cd ms/blueprintsprocessor/application/src/main/dc - - .. group-tab:: Frankfurt - - .. code-block:: bash - - cd ms/blueprintsprocessor/application/src/main/dc - - .. group-tab:: El Alto - - .. code-block:: bash - - ms/blueprintsprocessor/distribution/src/main/dc - - .. group-tab:: Dublin - - .. code-block:: bash +.. code-block:: bash - ms/blueprintsprocessor/distribution/src/main/dc + ms/blueprintsprocessor/distribution/src/main/dc And run docker-composer: @@ -90,7 +67,6 @@ it can be started again by the command: docker start <id of mariadb container> - Set permissions on the local file system ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -121,7 +97,6 @@ Import the project into the IDE |imageReimportMaven| - **Override some application properties:** After the project is compiled, a Run Configuration profile overriding some application properties @@ -317,11 +292,11 @@ Import the project into the IDE .. code-block:: json { - "type": "kotlin", - "request": "launch", - "name": "Blueprint Processor", - "projectRoot": "${workspaceFolder}/ms/blueprintsprocessor/application", - "mainClass": "-Dspring.profiles.active=dev org.onap.ccsdk.cds.blueprintsprocessor.BlueprintProcessorApplicationKt" + "type": "kotlin", + "request": "launch", + "name": "Blueprint Processor", + "projectRoot": "${workspaceFolder}/ms/blueprintsprocessor/application", + "mainClass": "-Dspring.profiles.active=dev org.onap.ccsdk.cds.blueprintsprocessor.BlueprintProcessorApplicationKt" } .. warning:: The `projectRoot` path assumes that you created your Workspace in the main CDS repository folder. If not - please change the path accordingly @@ -376,7 +351,7 @@ Import the project into the IDE Testing the application -~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~ There are two main features of the Blueprints Processor that can be of interest of a developer: blueprint publish and blueprint process. @@ -390,8 +365,9 @@ them is present on https://www.getpostman.com/collections/b99863b0cde7565a32fc. A detailed description of the usage of different APIs of CDS will follow. + Possible Fixes -~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~ Imported packages or annotiations are not found, Run Config not available? ***************************************************************************** @@ -401,7 +377,7 @@ Imported packages or annotiations are not found, Run Config not available? 3. Maven reimport in IDE Compilation error? -******************** +******************* * Change Java Version to 11 |