fa4d5b7671ea1d9c6c4a253997fe1fd94184a989
[sdc.git] / catalog-be / src / main / resources / import / tosca / relationship-types / relationshipTypes.yml
1   tosca.relationships.Root:
2     description: This is the default (root) TOSCA Relationship Type definition that all other TOSCA Relationship Types derive from.
3     attributes:
4       tosca_id:
5         description: A unique identifier of the realized instance of a Relationship Template that derives from any TOSCA normative type.
6         type: string
7       tosca_name:
8         description: This attribute reflects the name of the Relationship Template as defined in the TOSCA service template. This name is not unique to the realized instance model of corresponding deployed application as each template in the model can result in one or more instances (e.g., scaled) when orchestrated to a provider environment.
9         type: string
10       state:
11         description: The state of the relationship instance.
12         type: string
13         default: initial
14     interfaces:
15       Configure:
16         type: tosca.interfaces.relationship.Configure        
17
18   tosca.relationships.RoutesTo:
19     derived_from: tosca.relationships.ConnectsTo
20     description: This type represents an intentional network routing between two Endpoints in different networks.
21     valid_target_types:
22     - tosca.capabilities.Endpoint
23
24   tosca.relationships.network.LinksTo:
25     derived_from: tosca.relationships.DependsOn
26     description: This relationship type represents an association relationship between Port and Network node types.
27     valid_target_types:
28     - tosca.capabilities.network.Linkable
29
30   tosca.relationships.AttachesTo:
31     derived_from: tosca.relationships.Root
32     description: This type represents an attachment relationship between two nodes. For example, an AttachesTo relationship type would be used for attaching a storage node to a Compute node.
33     valid_target_types:
34     - tosca.capabilities.Attachment
35     properties:
36       location:
37         description: 'The relative location (e.g., path on the file system), which
38           provides the root location to address an attached node. e.g., a mount point
39           / path such as ''/usr/data''. Note: The user must provide it and it cannot
40           be "root".'
41         type: string
42         constraints:
43         - min_length: 1
44       device:
45         description: The logical device name which for the attached device (which is represented by the target node in the model). e.g., '/dev/hda1'.
46         type: string
47         required: false
48     attributes:
49       device:
50         description: 'The logical name of the device as exposed to the instance. Note:
51           A runtime property that gets set when the model gets instantiated by the
52           orchestrator.'
53         type: string
54
55   tosca.relationships.network.BindsTo:
56     derived_from: tosca.relationships.DependsOn
57     description: This type represents a network association relationship between Port and Compute node types.
58     valid_target_types:
59     - tosca.capabilities.network.Bindable
60
61   tosca.relationships.HostedOn:
62     derived_from: tosca.relationships.Root
63     description: This type represents a hosting relationship between two nodes.
64     valid_target_types:
65     - tosca.capabilities.Container
66
67   tosca.relationships.DependsOn:
68     derived_from: tosca.relationships.Root
69     description: This type represents a general dependency relationship between two nodes.
70     valid_target_types:
71     - tosca.capabilities.Node
72
73   tosca.relationships.ConnectsTo:
74     derived_from: tosca.relationships.Root
75     description: This type represents a network connection relationship between two nodes.
76     valid_target_types:
77     - tosca.capabilities.Endpoint
78     properties:
79       credential:
80         type: tosca.datatypes.Credential
81         required: false
82
83   org.openecomp.relationships.VolumeAttachesTo:
84     derived_from: org.openecomp.relationships.AttachesTo
85     description: This type represents an attachment relationship for associating volume
86     properties:
87       volume_id:
88         description: The ID of the volume to be attached
89         type: string
90         status: SUPPORTED
91         required: true
92       instance_uuid:
93         description: The ID of the server to which the volume attaches
94         type: string
95         status: SUPPORTED
96         required: true
97     attributes:
98       show:
99         description: Detailed information about resource
100         type: string
101         status: SUPPORTED
102
103   org.openecomp.relationships.AttachesTo:
104     derived_from: tosca.relationships.AttachesTo
105     description: This type represents an attachment relationship
106     properties:
107       location:
108         description: The relative location (e.g., path on the file system), which provides the root location to address an attached node.
109         type: string
110         status: SUPPORTED
111         required: false
112   org.openecomp.relationships.ForwardsTo:
113     derived_from: tosca.relationships.Root
114     valid_target_types:
115     - org.openecomp.capabilities.Forwarder
116     
117   tosca.relationships.nfv.VirtualBindsTo:
118     derived_from: tosca.relationships.DependsOn
119     valid_target_types:
120     - tosca.capabilities.nfv.VirtualBindable
121
122   tosca.relationships.nfv.VirtualLinksTo:
123     derived_from: tosca.relationships.DependsOn
124     valid_target_types:
125     - tosca.capabilities.nfv.VirtualLinkable