diff options
| author |   Ulas Kozat <ulas.kozat@gmail.com> | 2016-07-19 15:48:51 -0700 |
|---|---|---|
| committer | Ulas Kozat <ulas.kozat@gmail.com> | 2016-07-19 15:49:28 -0700 |
| commit | b47e85e087a0c3ddd666e86d4952b746fbdc86fa (patch) | |
| tree | f40c6cec1be35090faa95bbc7c747885ce15a228 /docs/userguide | |
| parent | f24bc89f7554c20720d64ff745ab7a18c2f745bf (diff) | |
update userguide API and pipeline
Change-Id: I036fb8859c22ad5c278bd1a23ae3809efc616882
Signed-off-by: Ulas Kozat <ulas.kozat@gmail.com>
Diffstat (limited to 'docs/userguide')
| -rwxr-xr-x | docs/userguide/api-documentation.rst | 8 | ||||
| -rw-r--r-- | docs/userguide/overview.rst | 27 |
2 files changed, 31 insertions, 4 deletions
diff --git a/docs/userguide/api-documentation.rst b/docs/userguide/api-documentation.rst index 8ec28b6..166da6a 100755 --- a/docs/userguide/api-documentation.rst +++ b/docs/userguide/api-documentation.rst @@ -114,10 +114,14 @@ When unspecified, the default is APPEND. DELETE deletes existing labels (template types) specified in the current call via key -l/--label (-t/--ttype). OVERWRITE removes the current set of labels (template types) and sets it to the new set of values passed in the same RPC call. +By default, no translation service is provided. Currently, only TOSCA to Heat +Orchestration Template (HOT) translation is supported using OpenStack +heat-translator library. A domain that requires HOT files must subscribe HOT +template type using + .. code-block:: bash - Supported Template Types - Supported Labels + ./domino-cli.py <cli-portnumber> subscribe -t hot * Template Publishing Command diff --git a/docs/userguide/overview.rst b/docs/userguide/overview.rst index baa1444..f71147b 100644 --- a/docs/userguide/overview.rst +++ b/docs/userguide/overview.rst @@ -189,8 +189,31 @@ mapped onto site-3; Domino Server simply delivers the Tosca file to Domino Clien site-3. When TOSCA cannot be consumed by a particular site directly, Domino Server can utilize existing translators (e.g., heat-translator) to first translate the template before delivery. +Internal Processing Pipeline at Domino Server +--------------------------------------------- + +:numref:`fig-pipe` shows the block diagram for the processing stages of a published TOSCA template. +Domino Client issues an RPC call publish(tosca file). Domino Server passes the received tosca +file to Label Extractor that outputs resource labels. Domain Mapper uses the extracted labels +and tosca file to find mappings from resources to domains as well as the resource dependencies. +Resource to domain mappings and resource dependencies are utilized to partition the +orchestration template into individual resource orchestration templates (one for each domain). +If a translation is required (e.g., TOSCA to HOT), individual resource orchestration templates +are first translated and then placed on a template distribution workflow based on resource +dependencies. Message Sender block in the server takes one distribution task at a time from the +workflow generator and pushes the orchestration template to the corresponding Domino Client. + +.. _fig-pipe: + +.. figure:: ../etc/domino_server_processing.png + :width: 300px + :align: center + :height: 300px + :alt: alternate text + :figclass: align-center + + Domino Service Processing Pipeline + Typical Message Flow -------------------- -Internal Pipeline ------------------ |