X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fuserguide%2Fapi-documentation.rst;h=166da6a0103b64c14f7c9135b6f12ae811f94724;hb=825ff565d9ebebe06f915c977bf8782fcc9de8fa;hp=d18d697e9e3530c6dfa8c0238684f0db22323b66;hpb=d9a5837b612db8eb8405e80f591ba3416b16f96a;p=domino.git diff --git a/docs/userguide/api-documentation.rst b/docs/userguide/api-documentation.rst index d18d697..166da6a 100755 --- a/docs/userguide/api-documentation.rst +++ b/docs/userguide/api-documentation.rst @@ -9,8 +9,12 @@ .. these two pipes are to seperate the logo from the first title | | +Domino API and Usage +==================== + Using domino-cli Client -======================= +----------------------- + Prerequisites: 1. Make sure that domino-cli.py is in +x mode. @@ -95,7 +99,7 @@ This message has the following fields that are automatically filled in. .. code-block:: bash Message Type (= SUBSCRIBE) - UDID (= Unique Domino IDassigned during registration) + UDID (= Unique Domino ID assigned during registration) Sequence Number (=incremented after each RPC call) Template Operation (= APPEND) Label Operation (= APPEND) @@ -110,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 subscribe -t hot * Template Publishing Command @@ -130,14 +138,15 @@ This message has the following fields that are automatically filled in. .. code-block:: bash Message Type (= SUBSCRIBE) - UDID (= Unique Domino IDassigned during registration) + UDID (= Unique Domino ID assigned during registration) Sequence Number (=incremented after each RPC call) Template Type (= TOSCA) Template File Interactive CLI mode -==================== +-------------------- + To enter this mode, start Domino Client with interactive console option set as true, i.e., --iac=true: .. code-block:: bash