diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/datadictionary/dbsystemcode.rst | 15 | ||||
| -rw-r--r-- | docs/datadictionary/image0.JPG (renamed from docs/datadictionary/media/image0.JPG) | bin | 48105 -> 48105 bytes | |||
| -rw-r--r-- | docs/datadictionary/image1.JPG (renamed from docs/datadictionary/media/image1.JPG) | bin | 79730 -> 79730 bytes | |||
| -rw-r--r-- | docs/datadictionary/index.rst | 26 | ||||
| -rw-r--r-- | docs/datadictionary/resourcesource.rst | 16 | ||||
| -rw-r--r-- | docs/datadictionary/restsourcecode.rst | 90 | ||||
| -rw-r--r-- | docs/datadictionary/sourcecapabilitycode.rst | 48 | ||||
| -rw-r--r-- | docs/datadictionary/sourceinputcode.rst | 13 | ||||
| -rw-r--r-- | docs/datadictionary/sourceprimarydbcode.rst | 54 | ||||
| -rw-r--r-- | docs/resourceassignment.rst | 2 |
10 files changed, 247 insertions, 17 deletions
diff --git a/docs/datadictionary/dbsystemcode.rst b/docs/datadictionary/dbsystemcode.rst new file mode 100644 index 000000000..5051d1e7d --- /dev/null +++ b/docs/datadictionary/dbsystemcode.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2019 IBM. + +Dbsystemcode +============ + +"dsl_definitions": { + "dynamic-db-source": { + "type": "maria-db", + "url": "jdbc:mysql://localhost:3306/sdnctl", + "username": "sdnctl", + "password": "sdnctl" + } +}
\ No newline at end of file diff --git a/docs/datadictionary/media/image0.JPG b/docs/datadictionary/image0.JPG Binary files differindex 074d20076..074d20076 100644 --- a/docs/datadictionary/media/image0.JPG +++ b/docs/datadictionary/image0.JPG diff --git a/docs/datadictionary/media/image1.JPG b/docs/datadictionary/image1.JPG Binary files differindex a27502a75..a27502a75 100644 --- a/docs/datadictionary/media/image1.JPG +++ b/docs/datadictionary/image1.JPG diff --git a/docs/datadictionary/index.rst b/docs/datadictionary/index.rst index a7e78564f..24050000e 100644 --- a/docs/datadictionary/index.rst +++ b/docs/datadictionary/index.rst @@ -9,22 +9,22 @@ Resource Definition Introduction: ============= -A data dictionary models the how a specific resource can be resolved. +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 data dictionary can have multiple sources to handle resolution in different ways. +A Resource definition can have multiple sources to handle resolution in different ways. -The main goal of data dictionary is to define re-usable entity that could be shared. +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. -As part of modelling a data dictionary entry, the following generic information should be provided: +As part of modelling a Resource definition entry, the following generic information should be provided: |image0| -.. |image0| image:: media/image0.jpg +.. |image0| image:: image0.jpg :width: 7.88889in :height: 4.43750in @@ -34,7 +34,7 @@ The modeling does allow for data translation between external capability and CDS |image1| -.. |image1| image:: media/image0.jpg +.. |image1| image:: image1.jpg :width: 7.88889in :height: 4.43750in @@ -45,7 +45,7 @@ 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 data dictionary +vf-module-label Resource definition { "name" : "vf-module-label", @@ -79,4 +79,14 @@ Resource source: Defines the contract to resolve a resource. -A resource source is modeled, following 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, and derives from the https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-NodeResourceSource
\ No newline at end of file +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 + +.. toctree:: + :maxdepth: 1 + + 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 diff --git a/docs/datadictionary/resourcesource.rst b/docs/datadictionary/resourcesource.rst index fffeec313..2b60990ec 100644 --- a/docs/datadictionary/resourcesource.rst +++ b/docs/datadictionary/resourcesource.rst @@ -42,21 +42,21 @@ CDS is currently deployed along the side of SDNC, hence the primary database con |image0| -.. |image0| image:: image0.jpg +.. |image0| image:: sqltable.jpg :width: 7.88889in :height: 4.43750in .. toctree:: :maxdepth: 1 - sourceprimarydb + sourceprimarydbcode Connection to a specific database can be expressed through the endpoint-selector property, which refers to a macro defining the information about the database the connect to. Understand TOSCA Macro in the context of CDS. .. toctree:: :maxdepth: 1 - dbsystem + dbsystemcode REST: @@ -68,14 +68,14 @@ CDS is currently deployed along the side of SDNC, hence the default rest connect |image1| -.. |image1| image:: image1.jpg +.. |image1| image:: resttable.jpg :width: 7.88889in :height: 4.43750in .. toctree:: :maxdepth: 1 - rest + restsourcecode Connection to a specific REST system can be expressed through the endpoint-selector property, which refers to a macro defining the information about the REST system the connect to. Understand TOSCA Macro in the context of CDS. @@ -90,7 +90,7 @@ For source code of Authentication click below link: .. toctree:: :maxdepth: 1 - auth + restauth Capability: =========== @@ -99,7 +99,7 @@ Expects a script to be provided. |image2| -.. |image2| image:: image2.jpg +.. |image2| image:: capabilitytable.jpg :width: 7.88889in :height: 4.43750in @@ -107,4 +107,4 @@ Expects a script to be provided. .. toctree:: :maxdepth: 1 - source-capability + sourcecapabilitycode diff --git a/docs/datadictionary/restsourcecode.rst b/docs/datadictionary/restsourcecode.rst new file mode 100644 index 000000000..90b02986a --- /dev/null +++ b/docs/datadictionary/restsourcecode.rst @@ -0,0 +1,90 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2019 IBM. + +Rest Source Code: +================= + +{ + "description": "This is Rest Resource Source Node Type", + "version": "1.0.0", + "properties": { + "type": { + "required": false, + "type": "string", + "default": "JSON", + "constraints": [ + { + "valid_values": [ + "JSON" + ] + } + ] + }, + "verb": { + "required": false, + "type": "string", + "default": "GET", + "constraints": [ + { + "valid_values": [ + "GET", "POST", "DELETE", "PUT" + ] + } + ] + }, + "payload": { + "required": false, + "type": "string", + "default": "" + }, + "endpoint-selector": { + "required": false, + "type": "string" + }, + "url-path": { + "required": true, + "type": "string" + }, + "path": { + "required": true, + "type": "string" + }, + "expression-type": { + "required": false, + "type": "string", + "default": "JSON_PATH", + "constraints": [ + { + "valid_values": [ + "JSON_PATH", + "JSON_POINTER" + ] + } + ] + }, + "input-key-mapping": { + "required": false, + "type": "map", + "entry_schema": { + "type": "string" + } + }, + "output-key-mapping": { + "required": false, + "type": "map", + "entry_schema": { + "type": "string" + } + }, + "key-dependencies": { + "required": true, + "type": "list", + "entry_schema": { + "type": "string" + } + } + }, + "derived_from": "tosca.nodes.ResourceSource" +} + diff --git a/docs/datadictionary/sourcecapabilitycode.rst b/docs/datadictionary/sourcecapabilitycode.rst new file mode 100644 index 000000000..a91767678 --- /dev/null +++ b/docs/datadictionary/sourcecapabilitycode.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" +} diff --git a/docs/datadictionary/sourceinputcode.rst b/docs/datadictionary/sourceinputcode.rst new file mode 100644 index 000000000..b859272ea --- /dev/null +++ b/docs/datadictionary/sourceinputcode.rst @@ -0,0 +1,13 @@ +.. 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 Input code +================= + +{ + "description": "This is Input Resource Source Node Type", + "version": "1.0.0", + "properties": {}, + "derived_from": "tosca.nodes.ResourceSource" +}
\ No newline at end of file diff --git a/docs/datadictionary/sourceprimarydbcode.rst b/docs/datadictionary/sourceprimarydbcode.rst new file mode 100644 index 000000000..e2e0b2d76 --- /dev/null +++ b/docs/datadictionary/sourceprimarydbcode.rst @@ -0,0 +1,54 @@ +.. 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 Primary DB Code: +======================= + +{ + "description": "This is Database Resource Source Node Type", + "version": "1.0.0", + "properties": { + "type": { + "required": true, + "type": "string", + "constraints": [ + { + "valid_values": [ + "SQL" + ] + } + ] + }, + "endpoint-selector": { + "required": false, + "type": "string" + }, + "query": { + "required": true, + "type": "string" + }, + "input-key-mapping": { + "required": false, + "type": "map", + "entry_schema": { + "type": "string" + } + }, + "output-key-mapping": { + "required": false, + "type": "map", + "entry_schema": { + "type": "string" + } + }, + "key-dependencies": { + "required": true, + "type": "list", + "entry_schema": { + "type": "string" + } + } + }, + "derived_from": "tosca.nodes.ResourceSource" +}
\ No newline at end of file diff --git a/docs/resourceassignment.rst b/docs/resourceassignment.rst index be8b08e25..f4fab4ee3 100644 --- a/docs/resourceassignment.rst +++ b/docs/resourceassignment.rst @@ -3,7 +3,7 @@ .. Copyright (C) 2019 IBM. Resource Assignment -=================== +------------------- .. toctree:: :maxdepth: 1 |
