diff options
author | Singal, Kapil (ks220y) <ks220y@att.com> | 2020-09-25 17:22:54 -0400 |
---|---|---|
committer | KAPIL SINGAL <ks220y@att.com> | 2020-09-28 16:08:21 +0000 |
commit | 51e7c12ccd4889cea181d92b368e1b74622ac769 (patch) | |
tree | ef505fab3c2b199da1eb4789ffcb646084462936 /docs/microservices | |
parent | 4218584b7cbfb512179735130bf0559028faea18 (diff) |
Refactoring and fixing Docs
Issue-ID: CCSDK-2846
Signed-off-by: Singal, Kapil (ks220y) <ks220y@att.com>
Change-Id: I67b3270a2052a7f6bc878ba010011f01cb348192
Diffstat (limited to 'docs/microservices')
-rw-r--r-- | docs/microservices/blueprintsProcessorMS.rst | 3 | ||||
-rw-r--r-- | docs/microservices/controllerBlueprintMS.rst | 1 | ||||
-rw-r--r-- | docs/microservices/enrichment.rst | 3 | ||||
-rw-r--r-- | docs/microservices/workflow.rst | 10 |
4 files changed, 7 insertions, 10 deletions
diff --git a/docs/microservices/blueprintsProcessorMS.rst b/docs/microservices/blueprintsProcessorMS.rst index e447c3ff9..9f13c0e5d 100644 --- a/docs/microservices/blueprintsProcessorMS.rst +++ b/docs/microservices/blueprintsProcessorMS.rst @@ -35,7 +35,7 @@ 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 + mvn clean install -Pq -Dadditionalparam=-Xdoclint:none Create the needed Docker images: @@ -53,6 +53,7 @@ Build it using the Maven profile called Docker: mvn clean install -Pdocker + Start Docker containers using docker-composer: ---------------------------------------------- diff --git a/docs/microservices/controllerBlueprintMS.rst b/docs/microservices/controllerBlueprintMS.rst index 2326e95c0..6b9fb49a2 100644 --- a/docs/microservices/controllerBlueprintMS.rst +++ b/docs/microservices/controllerBlueprintMS.rst @@ -10,6 +10,7 @@ The **C**\ ontroller **B**\ lueprint **A**\ rchive is the overall service design The CBA is .zip file, which is saved in Controller Blueprint Database. + Controller Blueprint Microservices: ----------------------------------- diff --git a/docs/microservices/enrichment.rst b/docs/microservices/enrichment.rst index 0f50beca4..5ddb23bb4 100644 --- a/docs/microservices/enrichment.rst +++ b/docs/microservices/enrichment.rst @@ -14,16 +14,13 @@ The following shows 2 ways to run CBA enrichment REST API request: ----------------- - |image0| CDS UI: ------- - |image1| - |image2| .. |image0| image:: media/Enrichment-REST.png diff --git a/docs/microservices/workflow.rst b/docs/microservices/workflow.rst index b6ea1e6fd..5a564870c 100644 --- a/docs/microservices/workflow.rst +++ b/docs/microservices/workflow.rst @@ -4,7 +4,6 @@ Workflow ======== - A workflow defines an overall action to be taken on the service, hence is an entry-point for the run-time execution of the CBA package. A workflow also defines inputs and outputs that will defined the payload contract of the request and response (see Dynamic API) @@ -13,11 +12,12 @@ A workflow can be composed of one or multiple sub-actions to execute. A CBA package can have as many workflows as needed. + Single action ------------- - The workflow is directly backed by a node_template of type tosca.nodes.Component + Multiple sub-actions -------------------- The workflow is backed by Directed Graph engine, node_template of type dg-generic, and are imperative workflows. @@ -27,11 +27,9 @@ A DG used as workflow for CDS is composed of multiple execute nodes; each indivi Below the properties of a workflow: - Workflow Example ---------------- - -:: +.. code-block:: json { "workflow": { @@ -41,7 +39,7 @@ Workflow Example "required": true, "type": "string" }, - "resource-assignment-properties": { <- dynamic inputs + "resource-assignment-properties": { <- dynamic inputs "required": true, "type": "dt-resource-assignment-properties" } |