diff options
| author |   Singal, Kapil (ks220y) <ks220y@att.com> | 2020-10-19 10:00:59 -0400 |
|---|---|---|
| committer | Singal, Kapil (ks220y) <ks220y@att.com> | 2020-10-19 10:32:56 -0400 |
| commit | 83c0cd2c078f89a386701b7f8e680fd3fc70ecfd (patch) | |
| tree | b2805322de93e7ea4c6a2bbe911cf07678cf280b /docs/userguide | |
| parent | 75946c76fe61ff7f773288335eea314efa245fad (diff) | |
Refactoring docs
Issue-ID: CCSDK-2916
Signed-off-by: Singal, Kapil (ks220y) <ks220y@att.com>
Change-Id: Ide8d830bc5cfe223752f81b35d2f09a5759f5aa2
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/developer-guide.rst | 27 | ||||
| -rw-r--r-- | docs/userguide/media/blueprintprocessor.jpg | bin | 0 -> 63829 bytes | |||
| -rw-r--r-- | docs/userguide/running-bp-processor-in-ide.rst | 6 |
3 files changed, 27 insertions, 6 deletions
diff --git a/docs/userguide/developer-guide.rst b/docs/userguide/developer-guide.rst index 3f8112244..be73f59c7 100644 --- a/docs/userguide/developer-guide.rst +++ b/docs/userguide/developer-guide.rst @@ -1,4 +1,3 @@ -.. This work is a derivative of https://wiki.onap.org/display/DW/Running+Blueprints+Processor+Microservice+in+an+IDE .. This work is licensed under a Creative Commons Attribution 4.0 .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright (C) 2020 Deutsche Telekom AG. @@ -6,8 +5,30 @@ Developer Guide ================= +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. + +This microservice is used to deploy Controller Blueprint Archive file in Run time database. This also helps to test the Valid CBA. + .. toctree:: - :caption: Table of Contents :maxdepth: 1 - running-bp-processor-in-ide
\ No newline at end of file + running-bp-processor-in-ide + +Architecture: +~~~~~~~~~~~~~ + +|image0| + +.. |image0| image:: media/blueprintprocessor.jpg + :width: 400pt + + +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) + +To authenticate, use ccsdkapps/ccsdkapps login user id and password.
\ No newline at end of file diff --git a/docs/userguide/media/blueprintprocessor.jpg b/docs/userguide/media/blueprintprocessor.jpg Binary files differnew file mode 100644 index 000000000..429876a13 --- /dev/null +++ b/docs/userguide/media/blueprintprocessor.jpg diff --git a/docs/userguide/running-bp-processor-in-ide.rst b/docs/userguide/running-bp-processor-in-ide.rst index d27b9906a..e5ea2b09d 100644 --- a/docs/userguide/running-bp-processor-in-ide.rst +++ b/docs/userguide/running-bp-processor-in-ide.rst @@ -32,8 +32,8 @@ Spin up a Docker container with the database The Blueprints Processor project uses a database to store information about the blueprints and therefore it needs to be online before attempting to run it. -One way to create the database is by using the :file:`docker-compose.yaml` -file present on the distribution module. This database will require a local directory to mount a volume, before running docker-compose remember to create following directory: +One way to create the database is by using the :file:`docker-compose.yaml` file. +This database will require a local directory to mount a volume, before running docker-compose remember to create following directory: .. code-block:: bash @@ -123,7 +123,7 @@ Import the project into the IDE Right-click inside it, at any point, to load the context menu and select create BlueprintProcessorApplication configuration from context: - |imageCreateRunConfigkt| + |imageCreateRunConfigKt| **The following window will open:** |
