VNFPackageManagement_def.yaml

# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt

definitions:
  VnfPkgInfo:
    description: >
      This type represents the information of an VNF package.
    type: object
    required:
      - id
      - operationalState
      - usageState
      - _links
    properties:
      id:
        description: >
          Identifier of the on-boarded VNF package. This identifier is
          allocated by the NFVO.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfdId:
        description: >
          This identifier, which is managed by the VNF provider, identifies
          the VNF package and the VNFD in a globally unique way.
          It's copied from the VNFD of the on-boarded VNF package.
          It shall be present after the VNF package content has been
          on-boarded and absent otherwise.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfProvider:
        description: >
          Provider of the VNF package and the VNFD. This information is copied
          from the VNFD.
        type: string
      vnfProductName:
        description: >
          Name to identify the VNF product. Invariant for the VNF product
          lifetime. This information is copied from the VNFD.
          It shall be present after the VNF package content has been
          on-boarded and absent otherwise.
        type: string
      vnfSoftwareVersion:
        description: >
          Software version of the VNF. This is changed when there is any
          change to the software included in the VNF package.
          This information is copied from the VNFD.
          It shall be present after the VNF package content has been
          on-boarded and absent otherwise.
        $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version"
      vnfdVersion:
        description: >
          The version of the VNFD. This information is copied from the VNFD.
          It shall be present after the VNF package content has been
          on-boarded and absent otherwise.
        $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version"
      checksum:
        description: >
          Checksum of the on-boarded VNF package.
          It shall be present after the VNF package content has been
          on-boarded and absent otherwise.
        $ref: "#/definitions/Checksum"
      softwareImages:
        description: >
          Information about VNF package artifacts that are software images.
          This attribute shall not be present before the VNF package content
          is on-boarded. Otherwise, this attribute shall be present unless it
          has been requested to be excluded per attribute selector.
        type: array
        items:
          $ref: "#/definitions/VnfPackageSoftwareImageInfo"
      additionalArtifacts:
        description: >
          Information about VNF package artifacts contained in the VNF package
          that are not software images.
          This attribute shall not be present before the VNF package content
          is on-boarded. Otherwise, this attribute shall be present if the VNF
          package contains additional artifacts.
        type: array
        items:
          $ref: "#/definitions/VnfPackageArtifactInfo"
      onboardingState:
        description: >
          On-boarding state of the VNF package.
        $ref: "#/definitions/PackageOnboardingStateType"
      operationalState:
        description: >
          Operational state of the VNF package.
          If the value of the onboardingState attribute is not equal to
          "ONBOARDED", the value of the operationalState attribute shall be
          equal to "DISABLED".
        $ref: "#/definitions/PackageOperationalStateType"
      usageState:
        description: >
          Usage state of the VNF package.
          If the value of the onboardingState attribute is not equal to
          "ONBOARDED", the value of the usageState attribute shall be
          equal to "NOT_IN_USE".
        $ref: "#/definitions/PackageUsageStateType"
      userDefinedData:
        description: >
          User defined data for the VNF package.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
          - packageContent
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          vnfd:
            description: >
              Link to the "VNFD in an individual VNf package" resource.
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          packageContent:
            description: >
              Link to the "VNF package content" resource.
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"

  PkgmSubscriptionRequest:
    description: >
      This type represents a subscription request related to VNF package
      management notifications about VNF package on-boarding or changes.
    type: object
    required:
      - callbackUri
    properties:
      filter:
        description: >
          Filter settings for this subscription, to define the subset of all
          notifications this subscription relates to.
          A particular notification is sent to the subscriber if the filter
          matches, or if there is no filter.
        $ref: "#/definitions/PkgmNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
      authentication:
        description: >
          Authentication parameters to configure the use of Authorization when
          sending notifications corresponding to this subscription, as defined
          in clause 8.3.4 of ETSI GS NFV-SOL 013.
          This attribute shall only be present if the subscriber requires
          authorization of notifications.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"

  PkgmSubscription:
    description: >
      This type represents a subscription related to notifications about
      VNF package management.
    type: object
    required:
      - id
      - callbackUri
      - _links
    properties:
      id:
        description: >
          Identifier of this "Individual subscription" resource.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      filter:
        description: >
          Filter settings for this subscription, to define the subset of all
          notifications this subscription relates to. A particular
          notification is sent to the subscriber if the filter matches, or if
          there is no filter.
        $ref: "#/definitions/PkgmNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"

  VnfPackageSoftwareImageInfo:
    description: >
      This type represents an artifact contained in a VNF package which
      represents a software image.
    type: object
    required:
      - id
      - name
      - provider
      - version
      - checksum
      - containerFormat
      - diskFormat
      - createdAt
      - minDisk
      - minRam
      - size
      - imagePath
    properties:
      id:
        description: >
          Identifier of the software image.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      name:
        description: >
          Name of the software image.
        type: string
      provider:
        description: >
          Provider of the software image.
        type: string
      version:
        description: >
          Version of the software image.
        $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version"
      checksum:
        description: >
          Checksum of the software image file.
        $ref: "#/definitions/Checksum"
      containerFormat:
        description: >
          Container format indicates whether the software image is in a file
          format that also contains metadata about the actual software.
          Permitted values:
          - AKI: a kernel image format
          - AMI: a machine image format
          - ARI: a ramdisk image format
          - BARE: the image does not have a container or metadata envelope
          - DOCKER: docker container format
          - OVA: OVF package in a tarfile
          - OVF: OVF container format
          The list of permitted values was taken from "Container formats" in
          http://docs.openstack.org/image-guide/image-formats.html
        type: string
        enum:
          - AKI
          - AMI
          - ARI
          - BARE
          - DOCKER
          - OVA
          - OVF
      diskFormat:
        description: >
          Disk format of a software image is the format of the underlying disk
          image.
          Permitted values:
          - AKI: a kernel image format
          - AMI: a machine image format
          - ARI: a ramdisk image format
          - ISO: an archive format for the data contents of an optical disc,
            such as CD-ROM
          - QCOW2: a common disk image format, which can expand dynamically
            and supports copy on write
          - RAW: an unstructured disk image format
          - VDI: a common disk image format
          - VHD: a common disk image format
          - VHDX: enhanced version of VHD format
          - VMDK: a common disk image format
          The list of permitted values was adapted from "Disk formats" in
          http://docs.openstack.org/image-guide/image-formats.html
        type: string
        enum:
          - AKI
          - AMI
          - ISO
          - QCOW2
          - RAW
          - VDI
          - VHD
          - VHDX
          - VMDK
      createdAt:
        description: >
          Time when this software image was created.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
      minDisk:
        description: >
          The minimal disk for this software image in bytes.
        type: integer
      minRam:
        description: >
          The minimal RAM for this software image in bytes.
        type: integer
      size:
        description: >
          Size of this software image in bytes.
        type: integer
      userMetadata:
        description: >
          User-defined data.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      imagePath:
        description: >
          Path in the VNF package, which identifies the image artifact and also
          allows to access a copy of the image artifact.
        type: string

  VnfPackageArtifactInfo:
    description: >
      This type represents an artifact other than a software image which is
      contained in a VNF package.
    type: object
    required:
      - artifactPath
      - checksum
    properties:
      artifactPath:
        description: >
          Path in the VNF package, which identifies the artifact and also
          allows to access a copy of the artifact. The value of this attribute
          shall start with the name of the first segment in the path,
          i.e. it shall not be prefixed by path separator characters such as "." and "/".

            EXAMPLE: foo/bar/run.sh
        type: string
      checksum:
        description: >
          Checksum of the artifact file.
        $ref: "#/definitions/Checksum"
      metadata:
        description: >
          The metadata of the artifact that are available in the VNF package,
          such as Content type, size, creation date, etc.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  PkgmNotificationsFilter:
    description: >
      This type represents a subscription filter related to notifications
      related to VNF package management.
      At a particular nesting level in the filter structure, the following
      applies: All attributes shall match in order for the filter to match
      (logical "and" between different filter attributes). If an attribute
      is an array, the attribute shall match if at least one of the values
      in the array matches (logical "or" between the values of one filter
      attribute).
    type: object
    properties:
      notificationTypes:
        description: >
          Match particular notification types.
          Permitted values:
          - VnfPackageOnboardingNotification
          - VnfPackageChangeNotification
          The permitted values of the "notificationTypes" attribute are
          spelled exactly as the names of the notification types to
          facilitate automated code generation systems.
        type: array
        items:
          type: string
          enum:
            - VnfPackageOnboardingNotification
            - VnfPackageChangeNotification
      vnfProductsFromProviders:
        description: >
          If present, match VNF packages that contain VNF products from
          certain providers.
          The attributes "vnfProductsFromProviders", "vnfdId" and "vnfPkgId"
          are alternatives to reference to particular VNF packages in a
          filter. They should not be used both in the same filter instance,
          but one alternative should be chosen.
        type: array
        items:
          type: object
          required:
            - vnfProvider
          properties:
            vnfProvider:
              description: >
                Name of the VNF provider to match.
              type: string
            vnfProducts:
              description: >
                If present, match VNF packages that contain VNF products with
                certain product names, from one particular provider.
              type: array
              items:
                type: object
                required:
                  - vnfProductName
                properties:
                  vnfProductName:
                    description: >
                      Name of the VNF product to match.
                    type: string
                  versions:
                    description: >
                      If present, match VNF packages that contain VNF products
                      with certain versions and a certain product name, from
                      one particular provider.
                    type: array
                    items:
                      type: object
                      required:
                        - vnfSoftwareVersion
                      properties:
                        vnfSoftwareVersion:
                          description: >
                            VNF software version to match.
                          $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version"
                        vnfdVersions:
                          description: >
                            If present, match VNF packages that contain VNF
                            products with certain VNFD versions, a certain
                            software version and a certain product name, from
                            one particular provider.
                          type: array
                          items:
                            $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version"
      vnfdId:
        description: >
          Match VNF packages with a VNFD identifier listed in the attribute.
          The attributes "vnfProductsFromProviders", "vnfdId" and "vnfPkgId"
          are alternatives to reference to particular VNF packages in a
          filter. They should not be used both in the same filter instance,
          but one alternative should be chosen.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfPkgId:
        description: >
          Match VNF packages with a package identifier listed in the
          attribute.
          May be present if the "notificationTypes" attribute contains the
          value "VnfPackageChangeNotification", and shall be absent
          otherwise.
          The attributes "vnfProductsFromProviders", "vnfdId" and "vnfPkgId"
          are alternatives to reference to particular VNF packages in a
          filter. They should not be used both in the same filter instance,
          but one alternative should be chosen.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      operationalState:
        description: >
          Match particular operational state of the VNF package.
          May be present if the "notificationTypes" attribute contains the
          value "VnfPackageChangeNotification", and shall be absent
          otherwise.
        $ref: "#/definitions/PackageOperationalStateType"
      usageState:
        description: >
          Match particular usage state of the VNF package.
          May be present if the "notificationTypes" attribute contains the
          value "VnfPackageChangeNotification", and shall be absent
          otherwise.
        $ref: "#/definitions/PackageUsageStateType"

  Checksum:
    description: >
      This type represents the checksum of a VNF package or an artifact file.
    type: object
    required:
      - algorithm
      - hash
    properties:
      algorithm:
        description: >
          Name of the algorithm used to generate the checksum, as defined in
          ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.
        type: string
      hash:
        description: >
          The hexadecimal value of the checksum.
        type: string

  PackageOperationalStateType:
    description: >
      - ENABLED: The VNF package is enabled, i.e. it can be used for
        instantiation of new VNF instances.
      - DISABLED: The VNF package is disabled, i.e. it cannot be used for
        further VNF instantiation requests (unless and until the VNF package
        is re-enabled).
    type: string
    enum:
      - ENABLED
      - DISABLED

  PackageUsageStateType:
    description: >
      - IN_USE: VNF instances instantiated from this VNF package exist.
      - NOT_IN_USE: No existing VNF instance is instantiated from this VNF
        package.
    type: string
    enum:
      - IN_USE
      - NOT_IN_USE

  PackageOnboardingStateType:
    description: >
      CREATED: The "Individual VNF package" resource has been created.
      UPLOADING: The associated VNF package content is being uploaded.
      PROCESSING: The associated VNF package content is being processed, e.g.,
        validation.
      ONBOARDED: The associated VNF package content has been successfully
        on-boarded.
    type: string
    enum:
      - CREATED
      - UPLOADING
      - PROCESSING
      - ONBOARDED