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/modelingconcepts | |
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/modelingconcepts')
-rw-r--r-- | docs/modelingconcepts/artifact-type.rst | 8 | ||||
-rw-r--r-- | docs/modelingconcepts/data-dictionary.rst | 3 | ||||
-rw-r--r-- | docs/modelingconcepts/data-type.rst | 58 | ||||
-rw-r--r-- | docs/modelingconcepts/enrichment.rst | 2 | ||||
-rw-r--r-- | docs/modelingconcepts/external-system.rst | 30 | ||||
-rw-r--r-- | docs/modelingconcepts/node-type.rst | 147 |
6 files changed, 124 insertions, 124 deletions
diff --git a/docs/modelingconcepts/artifact-type.rst b/docs/modelingconcepts/artifact-type.rst index 173f22bee..3dda2c4ed 100644 --- a/docs/modelingconcepts/artifact-type.rst +++ b/docs/modelingconcepts/artifact-type.rst @@ -15,7 +15,7 @@ Represents the **type of a artifact**, used to **identify** the This node was created, derived from ``tosca.artifacts.Root`` to be the root TOSCA node for all artifact. -.. code-block:: JSON +.. code-block:: json :caption: **tosca.artifacts.Implementation** { @@ -49,7 +49,7 @@ This node was created, derived from ``tosca.artifacts.Root`` to be the root TOSC `Here <https://github.com/onap/ccsdk-cds/blob/master/components/model-catalog/definition-type/starter-type/artifact_type/artifact-template-velocity.json>`_ is the TOSCA artifact type: - .. code-block:: JSON + .. code-block:: json :caption: **artifact-template-velocity** { @@ -78,7 +78,7 @@ This node was created, derived from ``tosca.artifacts.Root`` to be the root TOSC `Here <https://github.com/onap/ccsdk-cds/blob/master/components/model-catalog/definition-type/starter-type/artifact_type/artifact-template-jinja.json>`_ is the TOSCA artifact type: - .. code-block:: JSON + .. code-block:: json :caption: **artifact-template-jinja** { @@ -110,7 +110,7 @@ This node was created, derived from ``tosca.artifacts.Root`` to be the root TOSC `Here <https://github.com/onap/ccsdk-cds/blob/master/components/model-catalog/definition-type/starter-type/artifact_type/artifact-mapping-resource.json>`_ is the TOSCA artifact type: - .. code-block:: JSON + .. code-block:: json :caption: **artifact-mapping-resource** { diff --git a/docs/modelingconcepts/data-dictionary.rst b/docs/modelingconcepts/data-dictionary.rst index 1a5a41f44..bfc86d0c9 100644 --- a/docs/modelingconcepts/data-dictionary.rst +++ b/docs/modelingconcepts/data-dictionary.rst @@ -82,8 +82,7 @@ Here is how input-key-mapping, output-key-mapping and key-dependencies can be us :header-rows: 1 * - vf-module-label data dictionary - * - .. code-block:: JSON - + * - .. code-block:: json { "name" : "vf-module-label", diff --git a/docs/modelingconcepts/data-type.rst b/docs/modelingconcepts/data-type.rst index a231e5aa5..29143de80 100644 --- a/docs/modelingconcepts/data-type.rst +++ b/docs/modelingconcepts/data-type.rst @@ -45,20 +45,20 @@ Users can **create** as many **data type** as needed. :caption: **Payload:** { - "model-name": "<model-name>", - "derivedFrom": "tosca.datatypes.Root", - "definitionType": "data_type", - "definition": { + "model-name": "<model-name>", + "derivedFrom": "tosca.datatypes.Root", + "definitionType": "data_type", + "definition": { "description": "<description>", "version": "<version-number: eg 1.0.0>", "properties": {<add properties of your custom data type in JSON format>}, "derived_from": "tosca.datatypes.Root" - }, - "description": "<description", - "version": "<version>", - "tags": "<model-name>,datatypes.Root.data_type", - "creationDate": "<creation timestamp>", - "updatedBy": "<name>" + }, + "description": "<description", + "version": "<version>", + "tags": "<model-name>,datatypes.Root.data_type", + "creationDate": "<creation timestamp>", + "updatedBy": "<name>" } Data type are useful to manipulate data during resource resolution. @@ -108,7 +108,7 @@ List of existing data type: `<https://github.com/onap/ccsdk-cds/blob/master/components/model-catalog/definition-type/starter-type/data_type/datatype-resource-assignment.json>`_ - .. code-block:: JSON + .. code-block:: json :caption: **datatype-resource-assignment** { @@ -175,7 +175,7 @@ List of existing data type: `<https://github.com/onap/ccsdk-cds/blob/master/components/model-catalog/definition-type/starter-type/data_type/datatype-property.json>`_ - .. code-block:: JSON + .. code-block:: json :caption: **datatype-property** { @@ -183,35 +183,35 @@ List of existing data type: "description": "This is Resource Assignment Data Type", "properties": { "property": { - "required": true, - "type": "datatype-property" + "required": true, + "type": "datatype-property" }, "input-param": { - "required": true, - "type": "boolean" + "required": true, + "type": "boolean" }, "dictionary-name": { - "required": false, - "type": "string" + "required": false, + "type": "string" }, "dictionary-source": { - "required": false, - "type": "string" + "required": false, + "type": "string" }, "dependencies": { - "required": true, - "type": "list", - "entry_schema": { - "type": "string" - } + "required": true, + "type": "list", + "entry_schema": { + "type": "string" + } }, "updated-date": { - "required": false, - "type": "string" + "required": false, + "type": "string" }, "updated-by": { - "required": false, - "type": "string" + "required": false, + "type": "string" } }, "derived_from": "tosca.datatypes.Root" diff --git a/docs/modelingconcepts/enrichment.rst b/docs/modelingconcepts/enrichment.rst index 554517a7e..b88493448 100644 --- a/docs/modelingconcepts/enrichment.rst +++ b/docs/modelingconcepts/enrichment.rst @@ -46,7 +46,7 @@ The enrichment process will also, for all resources to be resolved as input and Example for workflow named *resource-assignment*: -.. code-block:: JSON +.. code-block:: json :caption: **dynamic input** { diff --git a/docs/modelingconcepts/external-system.rst b/docs/modelingconcepts/external-system.rst index c23d19f58..806600f4d 100644 --- a/docs/modelingconcepts/external-system.rst +++ b/docs/modelingconcepts/external-system.rst @@ -48,10 +48,10 @@ Here are some examples on how to populate the system information within the pack . . . "dsl_definitions": { "ipam-1": { - "type": "basic-auth", - "url": "http://localhost:8080", - "username": "bob", - "password": "marley" + "type": "basic-auth", + "url": "http://localhost:8080", + "username": "bob", + "password": "marley" } } . . . @@ -68,13 +68,13 @@ Here are some examples on how to populate the system information within the pack . . . "dsl_definitions": { "ipam-1": { - "type" : "ssl-basic-auth", - "url" : "http://localhost:32778", - "keyStoreInstance": "JKS or PKCS12", - "sslTrust": "trusture", - "sslTrustPassword": "trustore password", - "sslKey": "keystore", - "sslKeyPassword: "keystore password" + "type" : "ssl-basic-auth", + "url" : "http://localhost:32778", + "keyStoreInstance": "JKS or PKCS12", + "sslTrust": "trusture", + "sslTrustPassword": "trustore password", + "sslKey": "keystore", + "sslKeyPassword: "keystore password" } } . . . @@ -110,10 +110,10 @@ Here are some examples on how to populate the system information within the pack . . . "dsl_definitions": { "netprog-db": { - "type": "maria-db", - "url": "jdbc:mysql://10.195.196.123:32050/netprog", - "username": "netprog", - "password": "netprog" + "type": "maria-db", + "url": "jdbc:mysql://10.195.196.123:32050/netprog", + "username": "netprog", + "password": "netprog" } } . . . diff --git a/docs/modelingconcepts/node-type.rst b/docs/modelingconcepts/node-type.rst index b436ae553..070f6f65c 100644 --- a/docs/modelingconcepts/node-type.rst +++ b/docs/modelingconcepts/node-type.rst @@ -209,58 +209,58 @@ listed in the other section. .. code-block:: json :caption: **component-script-executor** - { - "description": "This is Netconf Transaction Configuration Component API", - "version": "1.0.0", - "interfaces": { - "ComponentScriptExecutor": { + { + "description": "This is Netconf Transaction Configuration Component API", + "version": "1.0.0", + "interfaces": { + "ComponentScriptExecutor": { "operations": { - "process": { - "inputs": { + "process": { + "inputs": { "script-type": { - "description": "Script type, kotlin type is supported", - "required": true, - "type": "string", - "default": "internal", - "constraints": [ - { + "description": "Script type, kotlin type is supported", + "required": true, + "type": "string", + "default": "internal", + "constraints": [ + { "valid_values": [ - "kotlin", - "jython", - "internal" + "kotlin", + "jython", + "internal" ] - } - ] + } + ] }, "script-class-reference": { - "description": "Kotlin Script class name with full package or jython script name.", - "required": true, - "type": "string" + "description": "Kotlin Script class name with full package or jython script name.", + "required": true, + "type": "string" }, "dynamic-properties": { - "description": "Dynamic Json Content or DSL Json reference.", - "required": false, - "type": "json" + "description": "Dynamic Json Content or DSL Json reference.", + "required": false, + "type": "json" } - }, - "outputs": { + }, + "outputs": { "response-data": { - "description": "Execution Response Data in JSON format.", - "required": false, - "type": "string" + "description": "Execution Response Data in JSON format.", + "required": false, + "type": "string" }, "status": { - "description": "Status of the Component Execution ( success or failure )", - "required": true, - "type": "string" + "description": "Status of the Component Execution ( success or failure )", + "required": true, + "type": "string" } - } - } + } + } } - } - }, - "derived_from": "tosca.nodes.Component" - } + } + }, + "derived_from": "tosca.nodes.Component" + } .. tab:: remote-script-executor @@ -292,18 +292,18 @@ listed in the other section. :caption: **Example** "packages": [ - { - "type": "pip", - "package": [ + { + "type": "pip", + "package": [ "requirements.txt" - ] - }, - { - "type": "ansible_galaxy", - "package": [ + ] + }, + { + "type": "ansible_galaxy", + "package": [ "juniper.junos" - ] - } + ] + } ] The `argument-properties` allows to specified input argument to the script to execute. They should be @@ -313,17 +313,17 @@ listed in the other section. :caption: **Example** "ansible-argument-properties": { - "arg0": "-i", - "arg1": "Scripts/ansible/inventory.yaml", - "arg2": "--extra-vars", - "arg3": { - "get_attribute": [ + "arg0": "-i", + "arg1": "Scripts/ansible/inventory.yaml", + "arg2": "--extra-vars", + "arg3": { + "get_attribute": [ "resolve-ansible-vars", "", "assignment-params", "ansible-vars" - ] - } + ] + } } The `dynamic-properties` can be anything that needs to be passed to the @@ -516,6 +516,7 @@ listed in the other section. **Bellow is a list of supported sources** .. tabs:: + .. tab:: input **Input:** @@ -916,24 +917,24 @@ listed in the other section. xsi:schemaLocation='http://www.onap.org/sdnc/svclogic ./svclogic.xsd' module='CONFIG' version='1.0.0'> <method rpc='ConfigDeploy' mode='sync'> <block atomic="true"> - <execute plugin="nf-account-collection" method="process"> - <outcome value='failure'> - <return status="failure"> - </return> - </outcome> - <outcome value='success'> - <execute plugin="execute" method="process"> - <outcome value='failure'> - <return status="failure"> - </return> - </outcome> - <outcome value='success'> - <return status='success'> - </return> - </outcome> - </execute> - </outcome> - </execute> + <execute plugin="nf-account-collection" method="process"> + <outcome value='failure'> + <return status="failure"> + </return> + </outcome> + <outcome value='success'> + <execute plugin="execute" method="process"> + <outcome value='failure'> + <return status="failure"> + </return> + </outcome> + <outcome value='success'> + <return status='success'> + </return> + </outcome> + </execute> + </outcome> + </execute> </block> </method> </service-logic> |