Merge "Created media folders for ResourceDictionary"

[ccsdk/cds.git] / docs / datadictionary / index.rst

diff --git a/docs/datadictionary/index.rst b/docs/datadictionary/index.rst
index 83c6e47..88122b4 100644 (file)
--- a/docs/datadictionary/index.rst
+++ b/docs/datadictionary/index.rst
@@ -9,37 +9,62 @@ Resource Definition
 
 Introduction:
 =============
-A Resource Definition defines a specifc resource that can be resolved using the bellow supported sources.
+A Resource definition models the how a specific resource can be resolved.
 
-A Resource Definition can support multiple sources.
+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.
 
-The main goal of Resource Definition is to define generic entity that could be shared accross services.
+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.
 
-Resolution sources:
-===================
+As part of modelling a Resource definition entry, the following generic information should be provided:
 
-   * Input
-   * Default
-   * DB
-   * REST
-   * Capability
+|image0|
 
-Artifacts:
-==========
 
-   * artifact-mapping-resource
-   * artifact-template-velocity
-   * artifact-directed-graph
 
-Node type:
-==========
-       
-   * component-resource-resolution
-   * component-jython-executor
-   * component-netconf-executor
-   * component-restconf-executor
+Below are properties that all the resource source have will have
 
-Data type:
-==========
-   * vnf-netconf-device
\ No newline at end of file
+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:
+
+.. toctree::
+   :maxdepth: 1
+   
+resourceDefintionCode 
+
+
+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: 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
+
+
+.. |image0| image:: media/image0.jpg
+   :width: 7.88889in 
+   :height: 4.43750in
+   
+.. |image1| image:: media/image1.jpg
+   :width: 7.88889in 
+   :height: 4.43750in
\ No newline at end of file