X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fresourcedefinition%2Findex.rst;fp=docs%2Fdatadictionary%2Findex.rst;h=a91d5999f74f835e8a2236550c30a794338fda00;hb=f1aafc40ad8f15b61faa3631e5a56fcf7c34bf49;hp=4039cca6d94e8b71016924155f8993df4b47a4a9;hpb=2b0442d1d2e721c4bf762bb2a3e75bc7606f9fcf;p=ccsdk%2Fcds.git diff --git a/docs/datadictionary/index.rst b/docs/resourcedefinition/index.rst similarity index 59% rename from docs/datadictionary/index.rst rename to docs/resourcedefinition/index.rst index 4039cca6d..a91d5999f 100644 --- a/docs/datadictionary/index.rst +++ b/docs/resourcedefinition/index.rst @@ -2,10 +2,10 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright (C) 2019 IBM. -Resource Definition +Resource Definition ------------------- .. toctree:: - :maxdepth: 1 + :maxdepth: 2 Introduction: ============= @@ -22,7 +22,6 @@ As part of modelling a Resource definition entry, the following generic informat |image0| - Below are properties that all the resource source have will have The modeling does allow for data translation between external capability and CDS for both input and output key mapping. @@ -37,10 +36,50 @@ vf-module-model-customization-uuid and vf-module-label are two data dictionaries Here is how input-key-mapping, output-key-mapping and key-dependencies can be used: -.. toctree:: - :maxdepth: 1 - - resourcedefinitioncodesnip +.. code-block:: json + :linenos: + + { + "description": "This is Component Resource Source Node Type", + "version": "1.0.0", + "properties": { + "script-type": { + "required": true, + "type": "string", + "default": "kotlin", + "constraints": [ + { + "valid_values": [ + "kotlin", + "jython" + ] + } + ] + }, + "script-class-reference": { + "description": "Capability reference name for internal and kotlin, for jython script file path", + "required": true, + "type": "string" + }, + "instance-dependencies": { + "required": false, + "description": "Instance dependency Names to Inject to Kotlin / Jython Script.", + "type": "list", + "entry_schema": { + "type": "string" + } + }, + "key-dependencies": { + "description": "Resource Resolution dependency dictionary names.", + "required": true, + "type": "list", + "entry_schema": { + "type": "string" + } + } + }, + "derived_from": "tosca.nodes.ResourceSource" + } Resource source: @@ -53,8 +92,8 @@ A resource source is modeled, following TOSCA_ node type definition and derives Also please click below for resource source available details .. toctree:: - :maxdepth: 1 - + :maxdepth: 4 + resourcesource .. _TOSCA: http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/csprd01/TOSCA-Simple-Profile-YAML-v1.0-csprd01.html#DEFN_ENTITY_NODE_TYPE @@ -62,9 +101,7 @@ Also please click below for resource source available details .. |image0| image:: media/mandatory.JPG - :width: 7.88889in - :height: 4.43750in - + :width: 400pt + .. |image1| image:: media/optional.JPG - :width: 7.88889in - :height: 4.43750in \ No newline at end of file + :width: 400pt \ No newline at end of file