etsi-nfv-vnf.yang 139 KB
Newer Older
        }

        list vdu-cpu-requirements {
          key "key";
          leaf key {
            type string;
          }
          description
            "Array of key-value pair requirements on the compute
             (CPU) for the VDU.";
          reference
            "GS NFV IFA011: Section 7.1.9.3.2, VirtualCpuData
             information element.";
        }

        container pinning {
          presence "Set to specify CPU pinning.";

          leaf policy {
            default "dynamic";
            type enumeration {
              enum "static";
              enum "dynamic";
            }
            description
              "Indicates the policy for CPU pinning.
               Values:
                 • static
                 • dynamic
               In case of 'static' the virtual CPU cores are
               requested to be allocated to logical CPU cores
               according to the rules defined in
               virtualCpuPinningRules. In case of 'dynamic' the
               allocation of virtual CPU cores to logical CPU cores
               is decided by the VIM. (e.g. SMT (Simultaneous
               MultiThreading) requirements).";
              "GS NFV IFA011: Section 7.1.9.2.4,
               VirtualCpuPinningData information element.";

          list rule {
            when "../policy = 'static'";
            key "key";
            leaf key {
              type string;
            }
            leaf value {
              type string;
            }
            description
              "List of rules that should be considered during the
               allocation of the virtual CPUs to logical CPUs in case
               of 'static' virtualCpuPinningPolicy.";
              "GS NFV IFA011: Section 7.1.9.2.4,
               VirtualCpuPinningData information element.";
          description
            "The virtual CPU pinning configuration for the
             virtualised compute resource.";
          reference
            "GS NFV IFA011: Section 7.1.9.2.3,
             VirtualCpuData information element.";
        }
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed

      list virtual-disk {
	key "id";

        description
          "The local or ephemeral disk(s) of the virtualised compute.";
        reference
          "GS NFV IFA011: Section 7.1.9.2.2, VirtualComputeDesc
           Information element.";

	leaf id {
	  type string;
	  description
	    "Unique identifier for the list of virtual disks.";
	}

        uses block-storage-data;
      }
    list virtual-storage-desc {
      key "id";
      description
        "Storage requirements for a Virtual Storage instance
         attached to the VNFC created from this VDU";
      leaf id {
        type string;
        description
          "Unique identifier of this VirtualStorageDesc in the
           VNFD.";
        reference
          "GS NFV IFA011: Section 7.1.9.4, Information elements
           related to Virtual Storage.";
      }

      leaf type-of-storage {
        // Needed to be able to onboard images
        type identityref {
          base storage-type;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
        default "nfv:block";
        description
          "Type of virtualised storage resource
           Values:
             • BLOCK
             • OBJECT
             • FILE.";
        reference
          "GS NFV IFA011: Section 7.1.9.4, Information elements
           related to Virtual Storage.";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
      choice storage {
	container block-storage-data {
	  when '../type-of-storage = "nfv:block"';
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
	  description
            "Specifies the details of block storage. It shall
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
             be present when the 'typeOfStorage' attribute is set to
             'BLOCK'. It shall be absent otherwise.";
	  reference
	    "GS NFV IFA011: Section 7.1.9.4, Information elements
             related to Virtual Storage.";

	  uses block-storage-data;
	}

	container object-storage-data {
	  when '../type-of-storage = "nfv:object"';
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
	  description
	    "Specifies the details of object storage. It shall be
             present when the 'typeOfStorage' attribute is set to
             'OBJECT'. It shall be absent otherwise.";
	  reference
	    "GS NFV IFA011: Section 7.1.9.4, Information elements
             related to Virtual Storage.";

	  leaf max-size-of-storage {
	    type uint64;
	    units "GB";
	    default 0;
	    description
	      "Max size of virtualised storage resource in GB.";
	    reference
	      "GS NFV IFA011: Section 7.1.9.4.4, ObjectStorage Information
               element.";
	  }
	}

	container file-storage-data {
	  when '../type-of-storage = "nfv:file"';
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
	  description
	    "Specifies the details of file storage. It shall be present
             when the 'typeOfStorage' attribute is set to 'FILE'. It
             shall be absent otherwise.";
	  reference
	    "GS NFV IFA011: Section 7.1.9.4, Information elements
             related to Virtual Storage.";

	  leaf size-of-storage {
	    type uint64;
	    units "GB";
	    default 0;
	    description
	      "Size of virtualised storage resource in GB.";
	    reference
	      "GS NFV IFA011: Section 7.1.9.4.5, FileStorageData
               Information element.";
	  }

	  leaf file-system-protocol {
	    type string;
	    default "cifs";
	    description
	      "The shared file system protocol (e.g. NFS, CIFS).";
	    reference
	      "GS NFV IFA011: Section 7.1.9.4.5, FileStorageData
               Information element.";
	  }

	  leaf int-virtual-link-desc {
	    type leafref {
	      path "../../../sw-image-desc/id";
	    }
	    mandatory true;
	    description
	      "Reference of the internal VLD which this file storage
               connects to. The attached VDUs shall connect to the
               same internal VLD.";
	    reference
	      "GS NFV IFA011: Section 7.1.9.4.5, FileStorageData
               Information element.";
	  }
	}
    list os-container-desc {
      key "id";
      description
        "Defines descriptors of container compute resources to be used
         by the VNF when the VDUs of the VNF are realized by a set of
         OS Containers sharing the same host and same networking namespace.";
      reference
        "GS NFV IFA011: Section 7.1.2, VNFD Information element.";

      leaf id {
        type string;
        description
          "Unique identifier of this OsContainerDesc in the VNFD.";
        reference
          "GS NFV IFA011: Section 7.1.6.13, OsContainerDesc
          information element.";
      }

      leaf name {
        type string;
        description
          "Human readable name of this OS container.";
        reference
          "GS NFV IFA011: Section 7.1.6.13, OsContainerDesc
          information element.";
      }

      leaf description {
        type string;
        description
          "Human readable description of this OS container.";
        reference
          "GS NFV IFA011: Section 7.1.6.13, OsContainerDesc
           information element.";
      }

      leaf requested-cpu-resources {
        type uint32;
        description
          "Number of CPU resources requested for the container
           (e.g. in milli-CPU-s).";
        reference
          "GS NFV IFA011: Section 7.1.6.13, OsContainerDesc
           information element.";
      }

      leaf requested-memory-resources {
        type uint64;
        description
          "Amount of memory resources requested for the container
           (e.g. in MB).";
        reference
          "GS NFV IFA011: Section 7.1.6.13, OsContainerDesc
           information element.";
      }

      leaf requested-ephemeral-storage-resources {
        type uint64;
        units "GB";
        description
          "Size of ephemeral storage resources requested for the container
           (e.g. in GB).";
        reference
          "GS NFV IFA011: Section 7.1.6.13, OsContainerDesc
           information element.";
      }

      list extended-resource-requests {
        key "extended-resource amount";
        leaf extended-resource{
          description
            "The hardware platform specific extended resource.";
        leaf amount {
          type uint32;
          description
            "Requested amount of the indicated extended resource.";
        }
        description
          "An array of key-value pairs of extended resources
           required by the container.";
        reference
          "GS NFV IFA011: Section 7.1.6.13, OsContainerDesc
           information element.";
      }

      leaf cpu-resource-limit {
        type uint32;
        description
          "Number of CPU resources the container can maximally use
           (e.g. in milli-CPU).";
        reference
          "GS NFV IFA011: Section 7.1.6.13, OsContainerDesc
           information element.";
      }

      leaf memory-resource-limit {
        type uint64;
        description
          "Amount of memory resources the container can maximally
           use(e.g. in MB).";
        reference
          "GS NFV IFA011: Section 7.1.6.13, OsContainerDesc
          information element.";
      }

      leaf ephemeral-storage-resource-limit {
        type uint64;
        units "GB";
        description
          "Size of ephemeral storage resources the container can
           maximally use(e.g. in GB).";
        reference
          "GS NFV IFA011: Section 7.1.6.13, OsContainerDesc
           information element.";
      }

      list huge-page-resources {

        leaf hugepage-size{
          type uint32;
          description
            "Specifies the size of the hugepage.";
        leaf requested-size {
          type uint32;
          description
            "Specifies the total size required for all the
             hugepages of the size indicated by hugepage-size.";
        leaf size-unit {
          type scaler-units-size;
          description
            "Specifies the unit used for both hugepage-size
             and requested-size";
		    }
        description
          "An array of key-value pairs of HugePages resources
           requested for the container, which the container
           can maximally use (e.g., \"hugepages-2Mi: 100Mi\").";
        reference
          "GS NFV IFA011: Section 7.1.6.13, OsContainerDesc
           information element.";
      }

      leaf sw-image-desc {
        type leafref {
          path "../../sw-image-desc/id";
        }
        description
          "Describes the software image realizing this OS container.";
        reference
          "GS NFV IFA011: Section 7.1.6.13, OsContainerDesc
           information element.";
      }

      leaf boot-data {
        type string;
        description
          "Contains a string or a URL to a file contained in the VNF
           package used to customize a container resource at boot time.
           The bootData may contain variable parts that are replaced
           by deployment specific values before being sent.";
        reference
          "GS NFV IFA011: Section 7.1.6.13, OsContainerDesc
           information element.";
      }

      list monitoring-parameter {
        key "id";
        leaf id {
          type string;
          description
            "Unique identifier of the monitoring parameter.";
          reference
            "GS NFV IFA011: Section 7.1.11.3, MonitoringParameter
             information element.";
        }
        uses monitoring-parameter;
        description
          "Specifies the virtualised resource related performance
           metrics on the OsContainerDesc level to be tracked by
           the VNFM.";
        reference
          "GS NFV IFA011: Section 7.1.6.13, OsContainerDesc
           information element.";
      }
    }

    list sw-image-desc {
      key "id";
      description
        "Defines descriptors of software images to be used by the
         VNF.";
      reference
        "GS NFV IFA011: Section 7.1.2, VNFD Information element.";

      leaf id {
        type string;
        description
          "The identifier of this software image.";
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc information
           element";
      }

      leaf name {
        mandatory true;
        type string;
        description
          "The name of this software image.";
        reference
          "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
           information element.";
      }

      leaf version {
        mandatory true;
        type string;
        description
          "The version of this software image.";
        reference
          "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
           information element.";
      }

      leaf provider {
        type string;
        description
          "The provider of this software image. If not present the
           provider of the software image is assumed to be same as
           the VNF provider.";
        reference
          "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
           information element.";
      }

      container checksum {

        leaf algorithm {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
          mandatory true;
          type identityref {
            base checksum-algorithm;
          }
          description
            "Species the algorithm used to obtain the checksum
             value.";
            "GS NFV IFA011: Section 7.1.6.10 ChecksumData
             information element.";
        }
        leaf hash {
          mandatory true;
          type string;
          description
            "Contains the result of applying the algorithm
             indicated by the algorithm attribute to the data to
             which this ChecksumData refers.";
            "GS NFV IFA011: Section 7.1.6.10 ChecksumData
             information element.";
        }
        description
          "The checksum of the software image file.";
        reference
          "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
           information element.";
      }
      leaf container-format {
        default "bare";
        type enumeration {
          enum "aki" {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
            description
              "An Amazon kernel image.";
          }
          enum "ami" {
            description
              "An Amazon machine image.";
          }
          enum "ari" {
            description
              "An Amazon ramdisk image.";
          }
          enum "bare" {
            description
              "The image does not have a container or metadata
               envelope.";
          }
          enum "docker" {
            description
              "A docker container format.";
          }
          enum "ova" {
            description
              "An OVF package in a tarfile.";
          }
          enum "ovf" {
            description
              "The OVF container format.";
        description
          "The container format describes the container file
           format in which software image is provided.";
        reference
          "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
           information element.";
      }
      leaf disk-format {
        default "qcow2";
        type enumeration {
          enum "aki" {
            description
              "An Amazon kernel image.";
          }
          enum "ami" {
            description
              "An Amazon machine image.";
          }
          enum "ari" {
            description
              "An Amazon ramdisk image.";
          }
          enum "iso" {
            description
              "An archive format for the data contents of an
               disk, such as CD-ROM.";
          }
          enum "qcow2" {
            description
              "Supported by the QEMU emulator that can expand
               dynamically and supports Copy on Write.";
          }
          enum "raw" {
            description
              "An unstructured disk image format; if you have a
               file without an extension it is possibly a raw
               format.";
          }
          enum "vdi" {
            description
              "Supported by VirtualBox virtual machine monitor
               and the QEMU emulator.";
          }
          enum "vhd" {
            description
              "The VHD disk format, a common disk format used by
               virtual machine monitors from VMware, Xen,
               Microsoft, VirtualBox, and others.";
          }
          enum "vhdx" {
            description
              "The VHDX disk format, an enhanced version of the
               VHD format, which supports larger disk sizes among
               other features.";
          }
          enum "vmdk" {
            description
              "Common disk format supported by many common virtual
               machine monitors.";
        description
          "The disk format of a software image is the format of
           the underlying disk image.";
      }
        leaf min-disk {
          type uint64;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
          units "GB";
          description
            "The minimal disk size requirement for this software
             image. The value of the 'size of storage' attribute
             of the VirtualStorageDesc referencing this
             SwImageDesc shall not be smaller than the value of
             minDisk.";
          reference
            "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
             information element.";
        }
      leaf min-ram {
        type decimal64 {
          fraction-digits 1;
          range "0..max";
        units "GB";
        default 0;
        description
          "The minimal RAM requirement for this software image.
           The value of the 'size' attribute of
           VirtualMemoryData of the Vdu referencing this
           SwImageDesc shall not be smaller than the value of
           minRam.";
        reference
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
           information element.";
      }
      leaf size {
        type uint64;
        units "GB";
        description
          "The size of this software image.";
        reference
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
           information element.";
      }
      leaf image {
        default ".";
        type inet:uri;
        description
          "This is a reference to the actual software image.
           The reference can be relative to the root of the VNF
           Package or can be a URL";
        reference
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
           information element.";
      }
      leaf operating-system {
        type string;
        description
          "Identifies the operating system used in the software
           image. This attribute may also identify if a 32 bit
           or 64 bit software image is used.";
        reference
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
           information element.";
      }
      leaf-list supported-virtualization-environment {
        type string;
        description
          "Identifies the virtualisation environments
           (e.g. hypervisor) compatible with this software
           image.";
        reference
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
           information element.";
    }

    list int-virtual-link-desc {
      key "id";
      description
        "Represents the type of network connectivity mandated by the
         VNF provider between two or more CPs which includes at
         least one internal CP.";
      reference
        "GS NFV IFA011: Section 7.1.2, Vnfd information element.";
      leaf id {
        type string;
        description
          "Unique identifier of this internal VLD in VNFD.";
        reference
          "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
           Information elements.";
      }

      list flavour {
        key "id";
        description
          "Describes a specific flavour of the VL with specific
             bitrate requirements.";
          "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
           Information elements.";

        leaf id {
          type string;
          description
            "Identifies a flavour within a VnfVirtualLinkDesc.";
            "GS NFV IFA011: Section 7.1.8.5, VirtualLinkDescFlavour
             information element.";
        container qos {
          presence "VL QoS parameters";
          description
            "QoS of the VL.";
            "GS NFV IFA011: Section 7.1.8.5, VirtualLinkDescFlavour
             information element.";
          leaf latency {
            type uint32;
            units "ms";
            mandatory true;
            description
              "Specifies the maximum latency in ms.";
              "GS NFV IFA011: Section 7.1.8.10, QoS information
               element.";

          leaf packet-delay-variation {
            type uint32;
            units "ms";
            mandatory true;
            description
              "Specifies the maximum jitter in ms.";
              "GS NFV IFA011: Section 7.1.8.10, QoS information
               element.";
          leaf packet-loss-ratio {
            type decimal64 {
              fraction-digits "2";
              range "0..1.00";
            }
            description
              "Specifies the maximum packet loss ratio.";
            reference
              "GS NFV IFA011: Section 7.1.8.10, QoS information
               element.";
      uses connectivity-type;
      leaf-list test-access {
        type string;
        description
          "Specifies test access facilities expected on the VL
           (e.g. none, passive monitoring, or active (intrusive)
           loopbacks at endpoints.";
          "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
           information element.";
      leaf description {
        type string;
        description
          "Provides human-readable information on the purpose of
           the VL (e.g. control plane traffic).";
          "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
           information element.";
      }

      list monitoring-parameters {
        key "id";

        leaf id {
          type string;
          description
            "Unique identifier of the monitoring parameter.";
            "GS NFV IFA011: Section 7.1.11.3, MonitoringParameter
             information element.";
        uses monitoring-parameter;
      }

      uses nfvi-maintenance-info {
        description
          "When present, provides information on the rules to be
           observed when an instance based on this
           VnfVirtualLinkDesc is impacted during NFVI operation and
           maintenance (e.g. NFVI resource upgrades).";
        reference
          "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
           information element.";
      }

      leaf externally-managed {
        type enumeration {
          enum required;
          enum allowed;
          }
        description
          "Specifies the intent of the VNF designer w.r.t. the
           internal VL instances created from this descriptor being
           externally managed.
           Values:
            REQUIRED
            ALLOWED
           Default: ALLOWED

           If the VNFD does not reference any LCM script and if the
           'vnfmInfo' attribute in the 'Vnfd' information element
           indicates that the VNF can be managed by any ETSI NFV
           compliant VNFM, this attribute shall not be present.";
        reference
          "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
           information element.";
      }
    uses security-group-rule;
    list ext-cpd {
      key "id";
      min-elements 1;
      description
        "Describes an external interface exposed by this VNF enabling
         connection with a Virual Link";
      reference
        "GS NFV IFA011: Section 7.1.2, VNFD information element.";
      choice cp-connection {
        leaf int-virtual-link-desc {
          description
            "Reference to the internal Virtual Link Descriptor (VLD)
             to which CPs instantiated from this external CP
             Descriptor (CPD) connect.";
          type leafref {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
            path "/nfv:nfv/nfv:vnfd/nfv:int-virtual-link-desc/nfv:id";
        container int-cpd {
          leaf vdu-id {
            type leafref {
              path "../../../vdu/id";
          leaf cpd {
            type leafref {
              path "deref(../vdu-id)/../int-cpd/id";

        leaf vip-cpd {
          type leafref {
            path "../../vip-cpd/id";
          }
          description
            "Reference to the VIP CPD which is used to instantiate CPs
             to hold virtual IP addresses. These CPs are, in turn,
             exposed as external CPs defined by this external CPD.";
          reference
            "GS NFV-IFA011: Section 7.1.3.2, VnfExtCpd information
             element";
        }
        leaf virtual-cpd {
          type leafref {
            path "../../virtual-cpd/id";
          }
          description
            "References the Virtual CPD which is used to describe a
             virtual connection point allowing to access a set of
             VNFC instances (based on their respective VDUs).";
          reference
            "GS NFV-IFA011: Section 7.1.3.2, VnfExtCpd information
            element";
        }
      uses virtual-network-interface-requirements;
      leaf nicio-requirements {
        type leafref {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
          path "/nfv:nfv/nfv:vnfd/nfv:virtual-compute-desc/nfv:id";
        }
        description
          "This references (couples) the CPD with any logical node I/O
           requirements (for network devices) that may have been
           created. Linking these attributes is necessary so that so
           that I/O requirements that need to be articulated at the
           logical node level can be associated with the network
           interface requirements associated with the CPD.";
        reference
          "GS NFV-IFA011: Section 7.1.6.6,
           VirtualNetworkInterfaceRequirements information element";
      }
      uses cpd;
      leaf security-group-rule-id {
        type leafref {
          path "../../security-group-rule/id";
        }
        description
          "Reference of the security group rules bound to this
           CPD.";
        reference
          "GS NFV IFA011: Section 7.1.6.3 Cpd information element";
      }
    }
    list vip-cpd {
      key "id";

      leaf-list int-cpd {
        type leafref {
          path "../../vdu/int-cpd/id";
        }
        description
          "Reference to the internal VDU CPD which is used to
           instantiate internal CPs. These internal CPs share the
           virtual IP addresses allocated when a VipCp instance
           is created from the VipCpd.";
        reference
          "GS NFV IFA011: Section 7.1.17.2, VipCpd information element.";
      leaf int-virtual-link-desc {
        type leafref {
          path "../../int-virtual-link-desc/id";
          "Reference of the internal VLD which this VipCpd
           connects to";
          "GS NFV IFA011: Section 7.1.17.2 VipCpd information element.";
      }

      leaf dedicated-ip-address {
        type boolean;
        description
          "If set to true, it indicates that the VIP address
           shall be different from the addresses allocated to
           all of the VduCp instances associated to it.
           If set to false, the VIP address shall be the same
           as one of the VduCp instances associated to it.";
          "GS NFV IFA011: Section 7.1.17.2 VipCpd information element.";
      }

      leaf vip-function {
        type identityref {
          base vip-function;
        }
        description
          "It indicates the function the virtual IP address is used
           for.
           Values:
             • high availability
             • load balancing.";
          "GS NFV IFA011: Section 7.1.17.2, VipCpd information element.";
      }

      uses cpd;

      description
        "Describes virtual IP addresses to be shared among instances
         of connection points. See clause 7.1.17.";
      reference
        "GS NFV IFA011: Section 7.1.2, VNFD information element.";
    }

    list virtual-cpd {
      key "id";
      leaf-list vdu {
        type leafref {
           path "../../vdu/id";
        }
        description
          "References the VDU(s) which implement this service.";
        reference
          "GS NFV IFA011: Section 7.1.18.2, Information elements
           related to VirtualCpd.";
      }

    container additional-service-data {
      list port-data {
        key "name";
        leaf name {
          type string;
          description
            "The name of the port exposed by the VirtualCp.";
          reference
            "GS NFV IFA011: Section 7.1.18.4, ServicePortData
             information element.";
        }

        leaf protocol {
          type enumeration {
            enum tcp;
            enum udp;
            enum sctp;
          }
          description