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/microservices/workflow.rst | |
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/microservices/workflow.rst')
-rw-r--r-- | docs/microservices/workflow.rst | 69 |
1 files changed, 0 insertions, 69 deletions
diff --git a/docs/microservices/workflow.rst b/docs/microservices/workflow.rst deleted file mode 100644 index 5a564870c..000000000 --- a/docs/microservices/workflow.rst +++ /dev/null @@ -1,69 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2019 IBM. - -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) - -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. - -A DG used as workflow for CDS is composed of multiple execute nodes; each individual execute node refers to a plugin, that is a node_template of type tosca.nodes.Component. - -Below the properties of a workflow: - - -Workflow Example ----------------- -.. code-block:: json - - { - "workflow": { - "resource-assignment": { <- workflow-name - "inputs": { - "vnf-id": { <- static inputs - "required": true, - "type": "string" - }, - "resource-assignment-properties": { <- dynamic inputs - "required": true, - "type": "dt-resource-assignment-properties" - } - }, - "steps": { - "call-resource-assignment": { <- step-name - "description": "Resource Assignment Workflow", - "target": "resource-assignment-process" <- node_template targeted by the step - } - }, - "outputs": { - "template-properties": { <- output - "type": "json", <- complex type - "value": { - "get_attribute": [ <- uses expression to retrieve attribute from context - "resource-assignment", - "assignment-params" - ] - } - } - } - } - } - } - - -TOSCA definition: http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.2/csd01/TOSCA-Simple-Profile-YAML-v1.2-csd01.html#_Toc494454203 |