4 * Copyright 2017 RIFT.IO Inc
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
23 namespace "http://riftio.com/ns/riftware-1.0/nsd-base";
26 import ietf-inet-types {
40 "Initial revision. This YANG file defines
41 the Network Service Descriptor (NSD)
44 "Derived from earlier versions of base YANG files";
47 typedef scaling-trigger {
64 typedef scaling-criteria-operation {
75 grouping primitive-parameter {
78 "Name of the parameter.";
84 "Data type associated with the name.";
85 type manotypes:parameter-data-type;
89 description "Is this field mandatory";
95 description "The default value for this field";
100 description "NSD parameter pool name to use for this parameter";
105 grouping nsd-descriptor-common {
107 description "Identifier for the NSD.";
114 description "NSD name.";
120 description "Short name to appear as label in the UI";
125 description "Vendor of the NSD.";
131 "File path for the vendor specific logo. For example icons/mylogo.png.
132 The logo should be part of the network service";
137 description "Description of the NSD.";
142 description "Version of the NSD";
146 list connection-point {
148 "List for external connection points.
149 Each NS has one or more external connection
150 points. As the name implies that external
151 connection points are used for connecting
152 the NS to other NS or to external networks.
153 Each NS exposes these connection points to
154 the orchestrator. The orchestrator can
155 construct network service chains by
156 connecting the connection points between
162 "Name of the NS connection point.";
168 "Type of the connection point.";
169 type manotypes:connection-point-type;
172 leaf floating-ip-required {
174 "Boolean parameter to indicate whether the CP must be exposed.
175 A public IP address will be allocated to this CP if exposed is true.
176 The default is false meaning a floating IP address is not required.
177 It must be explicitly asked for a floating IP address to be allocated.";
182 description "Logical connection of the CP to a VLD or to a VNF CP";
188 "ID reference to a VLD in the NS";
196 case vnfd-connection-point-ref {
198 leaf member-vnf-index-ref {
199 description "Reference to member-vnf within constituent-vnfd";
201 path "../../constituent-vnfd/member-vnf-index";
207 "A reference to a vnfd. This is a leafref to path:
208 ../../nsd:constituent-vnfd
209 + [nsd:id = current()/../nsd:id-ref]
212 path "../../constituent-vnfd" +
213 "[member-vnf-index = current()/../member-vnf-index-ref]" +
218 leaf vnfd-connection-point-ref {
220 "A reference to a connection point name
221 in a vnfd. This is a leafref to path:
222 /vnfd:vnfd-catalog/vnfd:vnfd
223 + [vnfd:id = current()/../nsd:vnfd-id-ref]
224 + /vnfd:connection-point/vnfd:name";
226 path "/vnfd:vnfd-catalog/vnfd:vnfd" +
227 "[vnfd:id = current()/../vnfd-id-ref]" +
228 "/vnfd:connection-point/vnfd:name";
238 list scaling-group-descriptor {
240 "scaling group descriptor within this network service.
241 The scaling group defines a group of VNFs,
242 and the ratio of VNFs in the network service
243 that is used as target for scaling action";
248 description "Name of this scaling group.";
252 list scaling-policy {
258 "Name of the scaling policy";
264 "Specifies if the scaling policy can be applied";
269 leaf scale-in-operation-type {
271 "Operation to be applied to check between scaling criterias to
272 check if the scale in threshold condition has been met.
274 type scaling-criteria-operation;
278 leaf scale-out-operation-type {
280 "Operation to be applied to check between scaling criterias to
281 check if the scale out threshold condition has been met.
283 type scaling-criteria-operation;
287 leaf threshold-time {
289 "The duration for which the criteria must hold true";
296 "The duration after a scaling-in/scaling-out action has been
297 triggered, for which there will be no further optional";
302 list scaling-criteria {
304 "list of conditions to be met for generating scaling
312 leaf scale-in-threshold {
314 "Value below which scale-in requests are generated";
318 leaf scale-out-threshold {
320 "Value above which scale-out requests are generated";
324 leaf ns-monitoring-param-ref {
326 "Reference to the NS level monitoring parameter
329 path "../../../../monitoring-param/id";
336 description "List of VNFs in this scaling group";
337 key "member-vnf-index-ref";
339 leaf member-vnf-index-ref {
340 description "member VNF index of this member VNF";
342 path "../../../constituent-vnfd/member-vnf-index";
348 "count of this member VNF within this scaling group.
349 The count allows to define the number of instances
350 when a scaling action targets this scaling group";
356 leaf min-instance-count {
358 "Minimum instances of the scaling group which are allowed.
359 These instances are created by default when the network service
365 leaf max-instance-count {
367 "Maximum instances of this scaling group that are allowed
368 in a single network service. The network service scaling
369 will fail, when the number of service group instances
370 exceed the max-instance-count specified.";
375 list scaling-config-action {
376 description "List of scaling config actions";
380 description "scaling trigger";
381 type scaling-trigger;
384 leaf ns-service-primitive-name-ref {
385 description "Reference to the NS service primitive";
387 path "../../../service-primitive/name";
396 "List of VNF Forwarding Graph Descriptors (VNFFGD).";
402 "Identifier for the VNFFGD.";
414 "Short name to appear as label in the UI";
419 description "Provider of the VNFFGD.";
424 description "Description of the VNFFGD.";
429 description "Version of the VNFFGD";
435 "List of Rendered Service Paths (RSP).";
441 "Identifier for the RSP.";
451 list vnfd-connection-point-ref {
453 "A list of references to connection points.";
454 key "member-vnf-index-ref";
456 leaf member-vnf-index-ref {
457 description "Reference to member-vnf within constituent-vnfds";
459 path "../../../../constituent-vnfd/member-vnf-index";
466 "A number that denotes the order of a VNF in a chain";
471 "A reference to a vnfd. This is a
473 ../../../../nsd:constituent-vnfd
474 + [nsd:id = current()/../nsd:id-ref]
478 path "../../../../constituent-vnfd" +
479 "[member-vnf-index = current()/../member-vnf-index-ref]" +
484 leaf vnfd-connection-point-ref {
486 "A reference to a connection point name
487 in a vnfd. This is a leafref to path:
488 /vnfd:vnfd-catalog/vnfd:vnfd
489 + [vnfd:id = current()/../nsd:vnfd-id-ref]
490 + /vnfd:connection-point/vnfd:name
491 NOTE: An issue with confd is preventing the
492 use of xpath. Seems to be an issue with leafref
493 to leafref, whose target is in a different module.
494 Once that is resolved this will switched to use
496 // TODO: Keeping as string as this needs to be
497 // diffenent lvel based of if it is nsd-catalog or
500 // path "../../../../../../vnfd:vnfd-catalog/vnfd:vnfd" +
501 // "[vnfd:id = current()/../vnfd-id-ref]/" +
502 // "vnfd:connection-point/vnfd:name";
511 "List of classifier rules.";
517 "Identifier for the classifier rule.";
523 "Name of the classifier.";
529 "A reference to the RSP.";
535 leaf member-vnf-index-ref {
536 description "Reference to member-vnf within constituent-vnfds";
538 path "../../../constituent-vnfd/member-vnf-index";
544 "A reference to a vnfd. This is a
546 ../../../nsd:constituent-vnfd
547 + [nsd:id = current()/../nsd:id-ref]
551 path "../../../constituent-vnfd" +
552 "[member-vnf-index = current()/../member-vnf-index-ref]" +
557 leaf vnfd-connection-point-ref {
559 "A reference to a connection point name
560 in a vnfd. This is a leafref to path:
561 /vnfd:vnfd-catalog/vnfd:vnfd
562 + [vnfd:id = current()/../nsd:vnfd-id-ref]
563 + /vnfd:connection-point/vnfd:name
564 NOTE: An issue with confd is preventing the
565 use of xpath. Seems to be an issue with leafref
566 to leafref, whose target is in a different module.
567 Once that is resolved this will switched to use
569 // TODO: Keeping as string as this needs to be
570 // diffenent lvel based of if it is nsd-catalog or
573 // path "../../../../../vnfd:vnfd-catalog/vnfd:vnfd" +
574 // "[vnfd:id = current()/../vnfd-id-ref]/" +
575 // "vnfd:connection-point/vnfd:name";
580 list match-attributes {
582 "List of match attributes.";
588 "Identifier for the classifier match attribute rule.";
598 leaf source-ip-address {
600 "Source IP address.";
601 type inet:ip-address;
604 leaf destination-ip-address {
606 "Destination IP address.";
607 type inet:ip-address;
612 "Source port number.";
613 type inet:port-number;
616 leaf destination-port {
618 "Destination port number.";
619 type inet:port-number;
621 //TODO: Add more match criteria
626 uses manotypes:ip-profile-list;
628 list initial-service-primitive {
630 "Initial set of service primitives for NSD.";
633 uses manotypes:event-config;
636 list terminate-service-primitive {
638 "Set of service primitives during
639 termination for NSD.";
642 uses manotypes:event-config;
645 uses manotypes:input-parameter-xpath;
647 list parameter-pool {
649 "Pool of parameter values which must be
650 pulled from during configuration";
655 "Name of the configuration value pool";
661 "Create a range of values to populate the pool with";
665 "Generated pool values start at this value";
672 "Generated pool values stop at this value";
681 description "Used to configure the list of public keys to be injected as part
682 of ns instantiation";
685 description "Name of this key pair";
690 description "Key associated with this key pair";
697 description "List of users to be added through cloud-config";
700 description "Name of the user ";
705 description "The user name's real name";
711 description "Used to configure the list of public keys to be injected as part
712 of ns instantiation";
715 description "Name of this key pair";
720 description "Key associated with this key pair";
727 grouping nsd-vld-common {
728 /* Still having issues modelling this,
729 see the comments under vnfd-connection-point-ref
732 "List of Virtual Link Descriptors.";
736 "Identifier for the VLD.";
742 "Virtual Link Descriptor (VLD) name.";
748 "Short name to appear as label in the UI";
753 description "Provider of the VLD.";
758 description "Description of the VLD.";
763 description "Version of the VLD";
768 type manotypes:virtual-link-type;
771 leaf root-bandwidth {
773 "For ELAN this is the aggregate bandwidth.";
777 leaf leaf-bandwidth {
779 "For ELAN this is the bandwidth of branches.";
783 // replicate for pnfd container here
784 uses manotypes:provider-network;
787 description "Flag indicating whether this network is a VIM management network";
793 description "Extra parameters for VLD instantiation";
795 case vim-network-ref {
796 leaf vim-network-name {
798 "Name of network in VIM account. This is used to indicate
799 pre-provisioned network name in cloud account.";
804 case vim-network-profile {
805 leaf ip-profile-ref {
806 description "Named reference to IP-profile object";
808 path "../../ip-profiles/name";
816 grouping monitoring-param-common {
818 "List of monitoring parameters from VNF's that should be
819 propogated up into NSR";
829 uses manotypes:monitoring-param-value;
830 uses manotypes:monitoring-param-ui-data;
831 uses manotypes:monitoring-param-aggregation;