Add ETSI SOL001 v2.5.1 model types to backend init
[sdc.git] / catalog-be / src / main / resources / import / tosca / models / init / etsi-SOL001-v2.5.1 / tosca / policy-types / policyTypes.yml
1 tosca.policies.Root:
2   description: The TOSCA Policy Type all other TOSCA Policy Types derive from
3
4 tosca.policies.Placement:
5   derived_from: tosca.policies.Root
6   description: The TOSCA Policy Type definition that is used to govern placement of TOSCA nodes or groups of nodes.
7
8 tosca.policies.nfv.InstantiationLevels:
9   derived_from: tosca.policies.Root
10   description: The InstantiationLevels type is a policy type representing all the instantiation levels of resources to be instantiated within a deployment flavour and including default instantiation level in term of the number of VNFC instances to be created as defined in ETSI GS NFV-IFA 011 [1].
11   properties:
12     levels:
13       type: map # key: levelId
14       description: Describes the various levels of resources that can be used to instantiate the VNF using this flavour.
15       required: true
16       entry_schema:
17         type: tosca.datatypes.nfv.InstantiationLevel
18     default_level:
19       type: string # levelId
20       description: The default instantiation level for this flavour.
21       required: false # required if multiple entries in levels
22
23 tosca.policies.nfv.VduInstantiationLevels:
24   derived_from: tosca.policies.Root
25   description: The VduInstantiationLevels type is a policy type representing all the instantiation levels of resources to be instantiated within a deployment flavour in term of the number of VNFC instances to be created from each vdu.Compute. as defined in ETSI GS NFV-IFA 011 [1]
26   properties:
27     levels:
28       type: map # key: levelId
29       description: Describes the Vdu.Compute levels of resources that can be used to instantiate the VNF using this flavour
30       required: true
31       entry_schema:
32         type: tosca.datatypes.nfv.VduLevel
33   targets: [ tosca.nodes.nfv.Vdu.Compute ]
34
35 tosca.policies.nfv.VirtualLinkInstantiationLevels:
36   derived_from: tosca.policies.Root
37   description: The VirtualLinkInstantiationLevels type is a policy type representing all the instantiation levels of virtual link resources to be instantiated within a deployment flavour as defined in ETSI GS NFV-IFA 011 [1].
38   properties:
39     levels:
40       type: map # key: levelId
41       description: Describes the virtual link levels of resources that can be used to instantiate the VNF using this flavour.
42       required: true
43       entry_schema:
44         type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
45   targets: [ tosca.nodes.nfv.VnfVirtualLink ]
46
47 tosca.policies.nfv.ScalingAspects:
48   derived_from: tosca.policies.Root
49   description: The ScalingAspects type is a policy type representing the scaling aspects used for horizontal scaling as defined in ETSI GS NFV-IFA 011 [1].
50   properties:
51     aspects:
52       type: map # key: aspectId
53       description: Describe maximum scale level for total number of scaling steps that can be applied to a particular aspect
54       required: true
55       entry_schema:
56         type: tosca.datatypes.nfv.ScalingAspect
57
58 tosca.policies.nfv.VduScalingAspectDeltas:
59   derived_from: tosca.policies.Root
60   description: The VduScalingAspectDeltas type is a policy type representing the Vdu.Compute detail of an aspect deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
61   properties:
62     aspect:
63       type: string
64       description: Represents the scaling aspect to which this policy applies
65       required: true
66     deltas:
67       type: map # key: scalingDeltaId
68       description: Describes the Vdu.Compute scaling deltas to be applied for every scaling steps of a particular aspect.
69       required: true
70       entry_schema:
71         type: tosca.datatypes.nfv.VduLevel
72   targets: [ tosca.nodes.nfv.Vdu.Compute ]
73
74 tosca.policies.nfv.VirtualLinkBitrateScalingAspectDeltas:
75   derived_from: tosca.policies.Root
76   description: The VirtualLinkBitrateScalingAspectDeltas type is a policy type representing the VnfVirtualLink detail of an aspect deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
77   properties:
78     aspect:
79       type: string
80       description: Represents the scaling aspect to which this policy applies.
81       required: true
82     deltas:
83       type: map # key: scalingDeltaId
84       description: Describes the VnfVirtualLink scaling deltas to be applied for every scaling steps of a particular aspect.
85       required: true
86       entry_schema:
87         type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
88   targets: [ tosca.nodes.nfv.VnfVirtualLink ]
89
90 tosca.policies.nfv.VduInitialDelta:
91   derived_from: tosca.policies.Root
92   description: The VduInitialDelta type is a policy type representing the Vdu.Compute detail of an initial delta used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
93   properties:
94     initial_delta:
95       type: tosca.datatypes.nfv.VduLevel
96       description: Represents the initial minimum size of the VNF.
97       required: true
98   targets: [ tosca.nodes.nfv.Vdu.Compute ]
99
100 tosca.policies.nfv.VirtualLinkBitrateInitialDelta:
101   derived_from: tosca.policies.Root
102   description: The VirtualLinkBitrateInitialDelta type is a policy type representing the VnfVirtualLink detail of an initial deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
103   properties:
104     initial_delta:
105       type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
106       description: Represents the initial minimum size of the VNF.
107       required: true
108   targets: [ tosca.nodes.nfv.VnfVirtualLink ]
109
110 tosca.policies.nfv.AffinityRule:
111   derived_from: tosca.policies.Placement
112   description: The AffinityRule describes the affinity rules applicable for the defined targets
113   properties:
114     scope:
115       type: string
116       description: scope of the rule is an NFVI_node, an NFVI_PoP, etc.
117       required: true
118       constraints:
119         - valid_values: [ nfvi_node, zone, zone_group, nfvi_pop ]
120   targets: [ tosca.nodes.nfv.Vdu.Compute, tosca.nodes.nfv.VnfVirtualLink, tosca.groups.nfv.PlacementGroup ]
121
122 tosca.policies.nfv.AntiAffinityRule:
123   derived_from: tosca.policies.Placement
124   description: The AntiAffinityRule describes the anti-affinity rules applicable for the defined targets
125   properties:
126     scope:
127       type: string
128       description: scope of the rule is an NFVI_node, an NFVI_PoP, etc.
129       required: true
130       constraints:
131         - valid_values: [ nfvi_node, zone, zone_group, nfvi_pop ]
132   targets: [ tosca.nodes.nfv.Vdu.Compute, tosca.nodes.nfv.VnfVirtualLink, tosca.groups.nfv.PlacementGroup ]
133
134 tosca.policies.nfv.SecurityGroupRule:
135   derived_from: tosca.policies.Root
136   description: The SecurityGroupRule type is a policy type specified the matching criteria for the ingress and/or egress traffic to/from visited connection points as defined in ETSI GS NFV-IFA 011 [1].
137   properties:
138     description:
139       type: string
140       description: Human readable description of the security group rule.
141       required: false
142     direction:
143       type: string
144       description: The direction in which the security group rule is applied. The direction of 'ingress' or 'egress' is specified against the associated CP. I.e., 'ingress' means the packets entering a CP, while 'egress' means the packets sent out of a CP.
145       required: false
146       constraints:
147         - valid_values: [ ingress, egress ]
148       default: ingress
149     ether_type:
150       type: string
151       description: Indicates the protocol carried over the Ethernet layer.
152       required: false
153       constraints:
154         - valid_values: [ ipv4, ipv6 ]
155       default: ipv4
156     protocol:
157       type: string
158       description: Indicates the protocol carried over the IP layer. Permitted values include any protocol defined in the IANA protocol registry, e.g. TCP, UDP, ICMP, etc.
159       required: false
160       constraints:
161         - valid_values: [ hopopt, icmp, igmp, ggp, ipv4, st, tcp, cbt, egp, igp, bbn_rcc_mon, nvp_ii, pup, argus, emcon, xnet, chaos, udp, mux, dcn_meas, hmp, prm, xns_idp, trunk_1, trunk_2, leaf_1, leaf_2, rdp, irtp, iso_tp4, netblt, mfe_nsp, merit_inp, dccp, 3pc, idpr, xtp, ddp, idpr_cmtp, tp++, il, ipv6, sdrp, ipv6_route, ipv6_frag, idrp, rsvp, gre, dsr, bna, esp, ah, i_nlsp, swipe, narp, mobile, tlsp, skip, ipv6_icmp, ipv6_no_nxt, ipv6_opts, cftp, sat_expak, kryptolan, rvd, ippc, sat_mon, visa, ipcv, cpnx, cphb, wsn, pvp, br_sat_mon, sun_nd, wb_mon, wb_expak, iso_ip, vmtp, secure_vmtp, vines, ttp, iptm, nsfnet_igp, dgp, tcf, eigrp, ospfigp, sprite_rpc, larp, mtp, ax.25, ipip, micp, scc_sp, etherip, encap, gmtp, ifmp, pnni, pim, aris, scps, qnx, a/n, ip_comp, snp, compaq_peer, ipx_in_ip, vrrp, pgm, l2tp, ddx, iatp, stp, srp, uti, smp, sm, ptp, isis, fire, crtp, crudp, sscopmce, iplt, sps, pipe, sctp, fc, rsvp_e2e_ignore, mobility, udp_lite, mpls_in_ip, manet, hip, shim6, wesp, rohc ]
162       default: tcp
163     port_range_min:
164       type: integer
165       description: Indicates minimum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints.
166       required: false
167       constraints:
168         - greater_or_equal: 0
169         - less_or_equal: 65535
170       default: 0
171     port_range_max:
172       type: integer
173       description: Indicates maximum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints.
174       required: false
175       constraints:
176         - greater_or_equal: 0
177         - less_or_equal: 65535
178       default: 65535
179   targets: [ tosca.nodes.nfv.VduCp, tosca.nodes.nfv.VnfExtCp ]
180
181 tosca.policies.nfv.SupportedVnfInterface:
182   derived_from: tosca.policies.Root
183   description: this policy type represents interfaces produced by a VNF, the details to access them and the applicable connection points to use to access these interfaces
184   properties:
185     interface_name:
186       type: string
187       description: Identifies an interface produced by the VNF.
188       required: true
189       constraints:
190         - valid_values: [ vnf_indicator, vnf_configuration ]
191     details:
192       type: tosca.datatypes.nfv.InterfaceDetails
193       description: Provide additional data to access the interface endpoint
194       required: false
195   targets: [ tosca.nodes.nfv.VnfExtCp, tosca.nodes.nfv.VduCp ]