diff options
Diffstat (limited to 'docs/resourcedefinition/index.rst')
| -rw-r--r-- | docs/resourcedefinition/index.rst | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/docs/resourcedefinition/index.rst b/docs/resourcedefinition/index.rst new file mode 100644 index 000000000..a91d5999f --- /dev/null +++ b/docs/resourcedefinition/index.rst @@ -0,0 +1,107 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2019 IBM. + +Resource Definition +------------------- +.. toctree:: + :maxdepth: 2 + +Introduction: +============= +A Resource definition models the how a specific resource can be resolved. + +A resource is a variable/parameter in the context of the service. It can be anything, but it should not be confused with SDC or Openstack resources. + +A Resource definition can have multiple sources to handle resolution in different ways. The main goal of Resource definition is to define re-usable entity that could be shared. + +Creation of Resource definition is a standalone activity, separated from the blueprint design. + +As part of modelling a Resource definition entry, the following generic information should be provided: + +|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. + +|image1| + + +Example: +======== + +vf-module-model-customization-uuid and vf-module-label are two data dictionaries. A SQL table, VF_MODULE_MODEL, exist to correlate them. + +Here is how input-key-mapping, output-key-mapping and key-dependencies can be used: + +.. 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: +================ + +Defines the contract to resolve a resource. + +A resource source is modeled, following TOSCA_ node type definition and derives from the Resource_ source. + +Also please click below for resource source available details + +.. toctree:: + :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 +.. _Resource: https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-NodeResourceSource + + +.. |image0| image:: media/mandatory.JPG + :width: 400pt + +.. |image1| image:: media/optional.JPG + :width: 400pt
\ No newline at end of file |