summaryrefslogtreecommitdiffstats
path: root/docs/datadictionary
diff options
context:
space:
mode:
authorDan Timoney <dtimoney@att.com>2019-04-24 13:02:15 +0000
committerGerrit Code Review <gerrit@onap.org>2019-04-24 13:02:15 +0000
commit1463c5a8cafdc5c54d767935a736b06931969b35 (patch)
tree4ef1a5b09484859de6522df1442fba136c6481ff /docs/datadictionary
parentba036aa9232ec29852b86595fbebf64e9b6bcb5a (diff)
parent09af94b68c8e1b0f562cbb899c95c5385f37e406 (diff)
Merge "Resource defintion content"
Diffstat (limited to 'docs/datadictionary')
-rw-r--r--docs/datadictionary/index.rst46
-rw-r--r--docs/datadictionary/resourceDefinitionCode.rst48
2 files changed, 59 insertions, 35 deletions
diff --git a/docs/datadictionary/index.rst b/docs/datadictionary/index.rst
index 24050000e..64abdece0 100644
--- a/docs/datadictionary/index.rst
+++ b/docs/datadictionary/index.rst
@@ -13,12 +13,9 @@ 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 data dictionaries is a standalone activity, separated from the blueprint design.
+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:
@@ -28,7 +25,7 @@ As part of modelling a Resource definition entry, the following generic informat
:width: 7.88889in
:height: 4.43750in
-Bellow are properties that all the resource source have will have
+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.
@@ -45,33 +42,12 @@ 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:
-vf-module-label Resource definition
-
-{
- "name" : "vf-module-label",
- "tags" : "vf-module-label",
- "updated-by" : "adetalhouet",
- "property" : {
- "description" : "vf-module-label",
- "type" : "string"
- },
- "sources" : {
- "primary-db" : {
- "type" : "source-primary-db",
- "properties" : {
- "type" : "SQL",
- "query" : "select sdnctl.VF_MODULE_MODEL.vf_module_label as vf_module_label from sdnctl.VF_MODULE_MODEL where sdnctl.VF_MODULE_MODEL.customization_uuid=:customizationid",
- "input-key-mapping" : {
- "customizationid" : "vf-module-model-customization-uuid"
- },
- "output-key-mapping" : {
- "vf-module-label" : "vf_module_label"
- },
- "key-dependencies" : [ "vf-module-model-customization-uuid" ]
- }
- }
- }
-}
+.. toctree::
+ :maxdepth: 1
+
+resourceDefintionCode
+
+
Resource source:
@@ -81,7 +57,7 @@ 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 detailed resource source details
+Also please click below for resource source available details
.. toctree::
:maxdepth: 1
@@ -89,4 +65,4 @@ Also please click below for detailed resource source details
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 \ No newline at end of file
+.. _Resource: https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-NodeResourceSource \ No newline at end of file
diff --git a/docs/datadictionary/resourceDefinitionCode.rst b/docs/datadictionary/resourceDefinitionCode.rst
new file mode 100644
index 000000000..a91767678
--- /dev/null
+++ b/docs/datadictionary/resourceDefinitionCode.rst
@@ -0,0 +1,48 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2019 IBM.
+
+Source Capability Code
+======================
+
+{
+ "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"
+}