blob: 88122b49f90abc45a81d957f9309c96bbabfc911 [file] [log] [blame]
Ezhilarasi68f9fea2019-03-08 19:32:42 +05301.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3.. Copyright (C) 2019 IBM.
4
Ezhilarasid01a3ee2019-03-20 20:57:04 +05305Resource Definition
6-------------------
Ezhilarasi68f9fea2019-03-08 19:32:42 +05307.. toctree::
8 :maxdepth: 1
9
10Introduction:
11=============
Ezhilarasi12ee0602019-04-17 18:01:14 +053012A Resource definition models the how a specific resource can be resolved.
Ezhilarasi68f9fea2019-03-08 19:32:42 +053013
Ezhilarasife6afae2019-04-15 19:55:07 +053014A 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.
Ezhilarasi68f9fea2019-03-08 19:32:42 +053015
Ezhilarasi09af94b2019-04-22 19:16:44 +053016A 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.
Ezhilarasife6afae2019-04-15 19:55:07 +053017
Ezhilarasi09af94b2019-04-22 19:16:44 +053018Creation of Resource definition is a standalone activity, separated from the blueprint design.
Ezhilarasi68f9fea2019-03-08 19:32:42 +053019
Ezhilarasi12ee0602019-04-17 18:01:14 +053020As part of modelling a Resource definition entry, the following generic information should be provided:
Ezhilarasi68f9fea2019-03-08 19:32:42 +053021
Ezhilarasife6afae2019-04-15 19:55:07 +053022|image0|
Ezhilarasi68f9fea2019-03-08 19:32:42 +053023
Ezhilarasi807bab12019-07-05 13:47:24 +053024
Ezhilarasi68f9fea2019-03-08 19:32:42 +053025
Ezhilarasi09af94b2019-04-22 19:16:44 +053026Below are properties that all the resource source have will have
Ezhilarasi68f9fea2019-03-08 19:32:42 +053027
Ezhilarasife6afae2019-04-15 19:55:07 +053028The modeling does allow for data translation between external capability and CDS for both input and output key mapping.
Ezhilarasi68f9fea2019-03-08 19:32:42 +053029
Ezhilarasife6afae2019-04-15 19:55:07 +053030|image1|
31
Ezhilarasife6afae2019-04-15 19:55:07 +053032
33Example:
34========
35
36vf-module-model-customization-uuid and vf-module-label are two data dictionaries. A SQL table, VF_MODULE_MODEL, exist to correlate them.
37
38Here is how input-key-mapping, output-key-mapping and key-dependencies can be used:
39
Ezhilarasi09af94b2019-04-22 19:16:44 +053040.. toctree::
41 :maxdepth: 1
42
43resourceDefintionCode
Ezhilarasife6afae2019-04-15 19:55:07 +053044
Ezhilarasi09af94b2019-04-22 19:16:44 +053045
Ezhilarasife6afae2019-04-15 19:55:07 +053046Resource source:
47================
48
49Defines the contract to resolve a resource.
50
Ezhilarasi12ee0602019-04-17 18:01:14 +053051A resource source is modeled, following TOSCA_ node type definition and derives from the Resource_ source.
52
Ezhilarasi09af94b2019-04-22 19:16:44 +053053Also please click below for resource source available details
Ezhilarasi12ee0602019-04-17 18:01:14 +053054
55.. toctree::
56 :maxdepth: 1
57
58 resourcesource
59
60.. _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
Ezhilarasi807bab12019-07-05 13:47:24 +053061.. _Resource: https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-NodeResourceSource
62
63
64.. |image0| image:: media/image0.jpg
65 :width: 7.88889in
66 :height: 4.43750in
67
68.. |image1| image:: media/image1.jpg
69 :width: 7.88889in
70 :height: 4.43750in