blob: 64abdece0281bd66e9223fc309613a07614e6379 [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
Ezhilarasi12ee0602019-04-17 18:01:14 +053024.. |image0| image:: image0.jpg
Ezhilarasife6afae2019-04-15 19:55:07 +053025 :width: 7.88889in
26 :height: 4.43750in
Ezhilarasi68f9fea2019-03-08 19:32:42 +053027
Ezhilarasi09af94b2019-04-22 19:16:44 +053028Below are properties that all the resource source have will have
Ezhilarasi68f9fea2019-03-08 19:32:42 +053029
Ezhilarasife6afae2019-04-15 19:55:07 +053030The modeling does allow for data translation between external capability and CDS for both input and output key mapping.
Ezhilarasi68f9fea2019-03-08 19:32:42 +053031
Ezhilarasife6afae2019-04-15 19:55:07 +053032|image1|
33
Ezhilarasi12ee0602019-04-17 18:01:14 +053034.. |image1| image:: image1.jpg
Ezhilarasife6afae2019-04-15 19:55:07 +053035 :width: 7.88889in
36 :height: 4.43750in
37
38Example:
39========
40
41vf-module-model-customization-uuid and vf-module-label are two data dictionaries. A SQL table, VF_MODULE_MODEL, exist to correlate them.
42
43Here is how input-key-mapping, output-key-mapping and key-dependencies can be used:
44
Ezhilarasi09af94b2019-04-22 19:16:44 +053045.. toctree::
46 :maxdepth: 1
47
48resourceDefintionCode
Ezhilarasife6afae2019-04-15 19:55:07 +053049
Ezhilarasi09af94b2019-04-22 19:16:44 +053050
Ezhilarasife6afae2019-04-15 19:55:07 +053051
52
53Resource source:
54================
55
56Defines the contract to resolve a resource.
57
Ezhilarasi12ee0602019-04-17 18:01:14 +053058A resource source is modeled, following TOSCA_ node type definition and derives from the Resource_ source.
59
Ezhilarasi09af94b2019-04-22 19:16:44 +053060Also please click below for resource source available details
Ezhilarasi12ee0602019-04-17 18:01:14 +053061
62.. toctree::
63 :maxdepth: 1
64
65 resourcesource
66
67.. _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
Ezhilarasi09af94b2019-04-22 19:16:44 +053068.. _Resource: https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-NodeResourceSource