Commit bbe929eb authored by Mubeena Ishaq's avatar Mubeena Ishaq
Browse files

Update SOL002 LCM API as per v5.1.1

parent 97ea05cd
Loading
Loading
Loading
Loading
Loading
+282 −7
Original line number Diff line number Diff line
@@ -131,7 +131,217 @@ definitions:
          structure, and whether or not this attribute is available, is dependent
          on the type of the PaaS Service.
        $ref: "#/definitions/KeyValuePairs"
  ResourceCapacityDefinition:
    description: >
      This type represents selected values for capacity related VDU attributes.

      * NOTE: Resource definitions not related to a VDU are not considered in this version of the present document.

    type: object
    required:
      - type
    properties: 
      tag:
        description: 
          Tag assigned by the issuer of a VNF LCM operation request that contains this data type with values to be applied to a VDU.
          It is used for tracking purposes. The tag is preserved in the run time record as long as at least one value of the capacity
          related attributes associated with that tag is still valid, i.e., it has not been modified by a later VNF LCM operation request. 
          At most one tag can be included when the data type is used in a VNF LCM operation request.
          When the data type is used in the VnfInstance data type it may contain multiple tags, namely those provided in 
          VNF LCM requests, if at least one of the values provided in that request associated to that tag is still 
          applicable in the VNFCs created from this VDU, i.e., it has not been modified by a later request.
        type: array
        items:
          $ref: "#/definitions/String"
      type:
        description:
          Type of the resource definition referenced.
          VALUES
          	COMPUTE
          	STORAGE
          	OSCONTAINER
        type: string
        enum:
          - COMPUTE
          - STORAGE
          - OSCONTAINER
      vduId:
        description: 
          Reference to the related Vdu applicable to this resource in the VNFD. It shall be present 
          when the referenced resource definition is related to a VDU. See note.
        $ref: "#/definitions/IdentifierInVnfd"
      osContainerDescData:
        description:
          Indicates values for resource capacity related attributes in an OsContainerDesc. It shall be present when the 
          attribute ‘type’ indicates OSCONTAINER and absent otherwise.
        type: array
        items:
          $ref: "#/definitions/OsContainerDescData"
      virtualComputeDescData:
        description: 
          Indicates values for resource capacity related attributes in an OsContainerDesc. 
          It shall be present when the attribute 'type' indicates OSCONTAINER and absent otherwise.
        $ref: "#/definitions/VirtualComputeDescData"
      virtualStorageDescData:
        description: >
          Indicates the value for the storage size related attribute in an VirtualStorageDesc. 
          It shall be present when the attribute 'type' indicates STORAGE and absent otherwise.
        type: array
        items:
          $ref: "#/definitions/VirtualStorageDescData"
  OsContainerDescData:
    description: >
      This type represents selected values for capacity related VDU attributes of an OsContainer resource.

      * NOTE: At least one of the attributes shall be present.
    type: object
    required:
      - resourceTemplateId
    oneOf:
      - required:
          - resourceTemplateId
      - required:
          - requestedCpuResources
      - required:
          - requestedMemoryResources
      - required:
          - requestedEphemeralStorageResources
      - required:
          - extendedResourceRequests
      - required:
          - cpuResourceLimit
      - required:
          - memoryResourceLimit
      - required:
          - ephemeralStorageResourceLimit
      - required:
          - hugePageResources
    properties:
      resourceTemplateId:
        description: >
          Identifier of an osContainerDesc in the VNFD.
        $ref: "#/definitions/IdentifierInVnfd"
      requestedCpuResources:
        description: >
          Number of CPU resources requested for the container in milli-CPU. See note.
        type: integer
      requestedMemoryResources:
        description: >
          Amount of memory resources requested for the container expressed in the same units as specified in the 
          requested_memory_resources_valid_values property in VNFD for this container descriptor. See note.
        type: array
        items:
          $ref: "#/definitions/Number"
      requestedEphemeralStorageResources:
        description: >
          Size of ephemeral storage resources requested for the container expressed in the same units as specified in the 
          requested_ephemeral_storage_resources_valid_values property VNFD.
        $ref: "#/definitions/Number"
      extendedResourceRequests:
        description: >
          Map of the amount of extended resources of the type indicated in the key.
          The key is a string that identifies an extended resource indicated in the extended_resource_requests
          property in the VNFD for this container descriptor.
          The value is an integer that indicates the required amount for a particular extended resource.See note.
        type: array
        items:
          type: integer
      cpuResourceLimit:
        description: >
          Number of CPU resources the container can maximally use in milli-CPU.  See note.   
        type: integer
      memoryResourceLimit:
        description: >
          Amount of memory resources the container can maximally use expressed in the same units as specified in the 
          memory_resource_limit_valid_values property VNFD for this container descriptor. See note.
        $ref: "#/definitions/Number"
      ephemeralStorageResourceLimit:
        description: >
          Size of ephemeral storage resources the container can maximally use expressed in the same units as specified in 
          the ephemeral_storage_resource_limit_valid_values property VNFD for this container descriptor. See note.
        $ref: "#/definitions/Number"
      hugePageResources:
        description: >
          Map of the total size values required for all the hugepages of the size indicated in the key.
          The key is a string and corresponds to one of the values of the hugepage sizes indicated in the huge_pages_resources 
          property in the VNFD for this container descriptor.
          The value is a number that indicates the required total size expressed in the same units as in the huge_pages_resources_property
          in the VNFD that indicates the valid values for required total size for the particular hugepage size.
          See note.
        type: array
        items:
          $ref: "#/definitions/Number"
  VirtualComputeDescData:
    description: >
      This type represents selected values for capacity related VDU attributes of the virtual compute resource of a VM.

      * NOTE: At least one of the attributes shall be present.
    type: object
    required:
      - resourceTemplateId
    oneOf:
      - required:
          - resourceTemplateId
      - required:
          - numVirtualCpu
      - required:
          - virtualMemSize
      - required:
          - sizeOfVirtualDisk
      - required:
          - hugePagesRequirements
    properties:
      resourceTemplateId:
        description: >
          Identifier of a VirtualComputeDesc in the VNFD.
        $ref: "#/definitions/IdentifierInVnfd"
      numVirtualCpu:
        description: >
          Number of virtual CPUs. See note.
        type: integer
      virtualMemSize:
        description: >
          Amount of virtual Memory expressed in the same units as specified in the virtual_mem_size_valid_values property 
          in the VNFD for this virtual compute descriptor. See note.
        $ref: "#/definitions/Number"
      sizeOfVirtualDisk:
        description: >
          Size of virtualised storage resource expressed in the same units as specified in the size_of_storage_valid_values 
          property in the VNFD for this virtual compute descriptor. See note.
        $ref: "#/definitions/Number"
      hugePagesRequirements:
        description: >
          Map of the total size values required for all the hugepages of the size indicated in the key.
          The key is a string and corresponds to one of the values of the hugepage sizes indicated in the huge_pages_requirements
          property in the VNFD for this virtual compute descriptor.
          The value is a number that indicates the required total size expressed in the same units as in the huge_pages_requirements
          property in the VNFD that indicates the valid values for required total size for the particular hugepage size.
          See note.
        type: array
        items:
          $ref: "#/definitions/Number"

  VirtualStorageDescData:
    description: >
      This type represents selected values for capacity related VDU attributes of the virtual storage resource. 
    type: object
    required:
      - resourceTemplateId
      - sizeOfStorage
    properties:
      resourceTemplateId:
        description: >
          Identifier of a VirtualStorageDesc in the VNFD.
        $ref: "#/definitions/IdentifierInVnfd"
      sizeOfStorage:
        description: >
          If the ‘typeOfStorage’ attribute in the VirtualStorageDesc referenced by the resourceTemplateId indicates BLOCK or FILE it is 
          the size of the virtualized storage resource, expressed in the same units as specified in the size_of_storage_valid_values
          property in the VNFD.
          If the ‘typeOfStorage’ attribute in the VirtualStorageDesc referenced by the resourceTemplateId indicates OBJECT it is the 
          maximum size of the virtualized storage resource expressed in the same units as specified in the max_size_of_storage_valid_values 
          property in the VNFD.
        $ref: "#/definitions/Number"
  CmfInfo:
    description: >
      This type provides input information related to CMF for certificate management.
@@ -236,7 +446,7 @@ definitions:
    anyOf:
      - oneOf:
        - required:
            - vnfdId
            - vnfdIds
        - required:
            - vnfProductsFromProviders
      - oneOf:
@@ -319,6 +529,53 @@ definitions:
        items:
          type: string

  MonitoringConnection:
    description: >
      The MonitoringConnection shall follow the indications.
      * NOTE:	The VNFM can be made aware of monitoring connection information, including their identifiers to 
              be used by configuration means outside the scope of the present document (e.g. using relevant NFV-MANO management 
              APIs as defined in ETSI GS NFV-SOL 009). 
    type: object
    properties:
      id:
        description: >
          Identifier of the monitoring connection. See note.
        $ref: "#/definitions/Identifier"
      monitoringType:
        description: >
          Type of monitoring way.
          VALUES: 
            •	VIM_CISM
            •	EXTERNAL
            •	PAAS
        type: string
        enum:
          -	VIM_CISM
          -	EXTERNAL
          -	PAAS
      vimId:
        description: >
          Information about VIM or CISM connection(s) for monitoring resources for the VNF instance. 
          Can be set when MonitoringType is equal to “VIM_CISM”.
        $ref: "#/definitions/Identifier"
      paasServiceId:
        description: >
          Information about PaasAsset to be used. Can be set when MonitoringType is equal to “PAAS”.
        $ref: "#/definitions/Identifier"
      interfaceInfo:
        description: >
          Information about the interface(s) to the external monitoring tool, if available, including interface 
          endpoint e.g. URL API version, and protocol type. Can be set when MonitoringType is equal to “EXTERNAL”.
        $ref: "#/definitions/KeyValuePairs"
      accessInfo:
        description: >
          Authentication credentials for accessing the external monitoring tool. Examples can include those to support 
          different authentication schemes, e.g. OAuth, Token, Username/password, etc. Can be set when MonitoringType is equal to “EXTERNAL”.
        $ref: "#/definitions/KeyValuePairs"
      extra:
        description: >
          Type specific additional information, if applicable.
        $ref: "#/definitions/String"
  ResourceHandle:
    required:
      - resourceId
@@ -680,8 +937,8 @@ definitions:
    description: >
      This type represents network address data for a virtual CP.

      * NOTE 1: If the container cluster is set up to be able to configure an external load balancer this address will be used,
                otherwise it will be ignored by the CISM.
      * NOTE 1: The loadBalancerIp and the loadBalancerSourceRanges attributes are only used if the 
                CIS cluster is set up to be able to configure an external load balancer. Otherwise, it shall be ignored.

      * NOTE 2: In case the cluster can configure an external load balancer but no loadBalancerIp is provided the container
                cluster will assign an IP address.
@@ -690,7 +947,7 @@ definitions:
                address pools for virtual CPs. Otherwise it shall be ignored. MetalLB is an example of a solution for 
                Kubernetes® that supports configuration of address pools for load balancer services.

      * NOTE 4: The loadBalancerIp and the addressPoolName attributes shall not be present at the same time.
      * NOTE 4: The loadBalancerIp, addressPoolName and the externalIp attributes shall not be present at the same time.

    type: object
    required:
@@ -709,12 +966,30 @@ definitions:
          Fixed address to assign to an external load balancer.
          See notes 1, 2 and 4.
        $ref: "#/definitions/IpAddress"
      externalIp:
        description: >
          An external IP address assigned to the virtual CP. This IP address is not managed by CISM. See note 4.
        $ref: "#/definitions/IpAddress"
      addressPoolName :
        description: >
          Name of an address pool from which the container 
          cluster will assign an IP address to the virtual CP. See 
          notes 3 and 4.
          Name of an address pool from which the CIS cluster will assign an IP address to the virtual CP. See notes 3 and 4.
        type: string
      loadBalancerSourceRanges:
        description: >
          List of client IP address ranges allowed to access an external load balancer. See note 1.
        type: object
        required:
          - minAddress
          - maxAddress
        properties:
          minAddress:
            description: >
              Lowest IP address belonging to the range.
            $ref: "#/definitions/IpAddress"
          maxAddress:
            description: >
              Highest IP address belonging to the range.
            $ref: "#/definitions/IpAddress"

  ExtVirtualLinkData:
    description: >
+3 −3
Original line number Diff line number Diff line
@@ -16,11 +16,11 @@ info:
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  version: 2.12.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
  version: 2.14.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

externalDocs:
  description: ETSI GS NFV-SOL 002 V4.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/04.05.01_60/gs_NFV-SOL002v040501p.pdf
  description: ETSI GS NFV-SOL 002 V5.1.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/05.01.01_60/gs_NFV-SOL002v050101p.pdf

servers:
  - url: http://127.0.0.1/vnflcm/v2
+108 −15
Original line number Diff line number Diff line
@@ -179,6 +179,16 @@ definitions:
            type: array
            items:
              $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnfd"
          resourceCapacityDefinition:
            description: >
              Shows current values of VDU attributes related to resource capacity, if different to the default 
              values from the VNFD, as indicated in the (one or more) request(s) of all completed VNF LCM operation(s) that 
              contain this attribute. If an attribute value has been modified multiple times, only the last value is shown. 
              The values indicated in this attribute are applicable to all VNFC instances based on the VDU to which the 
              resourceCapacityDefinition is related.
            type: array
            items:
              $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/ResourceCapacityDefinition"
          extCpInfo:
            description: >
              Information about the external CPs exposed by the VNF instance. When trunking is enabled, the list of
@@ -410,8 +420,10 @@ definitions:
  SelectVnfDeployableModulesRequest:
    description: >
      This type represents request parameters for the "Select VNF deployable modules" operation.
      * NOTE: Thus, the select VNF deployable modules operation cannot be used as a scale VNF operation to scale VNFCs 
              that were already instantiated
      * NOTE 1: Thus, the select VNF deployable modules operation cannot be used as a scale VNF operation to 
                horizontally scale VNFCs that were already instantiated.
      * NOTE 2: Thus, the select VNF deployable modules operation cannot be used as a scale VNF operation to 
                vertically scale VNFCs that were already instantiated.
    type: object
    properties:
      selectedDeployableModule:
@@ -437,6 +449,17 @@ definitions:
        type: array  
        items:
          $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/ScaleInfo"
      resourceCapacityDefinition:
        description: >
          Indicates values for resource capacity related attributes pertaining to a descriptor. Values can only be 
          provided for resource capacity related attributes that have been defined in the VNFD as being configurable. 
          Furthermore, provided values shall be within the allowed values indicated in the VNFD.
          This attribute should only contain information about resource capacity related attributes of VDUs that will be 
          used to instantiate VNFCs as a result of this operation. If it contains information about attributes of other 
          VDUs it shall be ignored. See note 2.
        type: array
        items:
          $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/ResourceCapacityDefinition"
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to the selection of deployable modules process, specific to 
@@ -540,9 +563,14 @@ definitions:
        type: array
        items:
          $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnfd"



      resourceCapacityDefinition:
        description: >
          Indicates values for resource capacity related attributes pertaining to a descriptor. Values can only be 
          provided for resource capacity related attributes that have been defined in the VNFD as being configurable. 
          Furthermore, provided values shall be within the allowed values indicated in the VNFD.
        type: array
        items:
          $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/ResourceCapacityDefinition"
  ChangeVnfFlavourRequest:
    description: >
      This type represents request parameters for the "Change VNF flavour" operation.
@@ -627,6 +655,14 @@ definitions:
        type: array
        items:
          $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnfd"
      resourceCapacityDefinition:
        description: >
          Indicates values for resource capacity related attributes pertaining to a descriptor. Values can only be 
          provided for resource capacity related attributes that have been defined in the VNFD as being configurable. 
          Furthermore, provided values shall be within the allowed values indicated in the VNFD.
        type: array
        items:
          $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/ResourceCapacityDefinition"
      certificateConfigurationData:
        description: >
          Configuration for certificate management such as certificate profile and security policy in this VNF. Can be
@@ -676,6 +712,8 @@ definitions:
        $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/KeyValuePairs"

  HealVnfRequest:
    description: >
      This type represents request parameters for the "Heal VNF" operation. 
    type: object
    properties:
      vnfcInstanceId:
@@ -701,7 +739,29 @@ definitions:
          Provides link to a script that should be executed as part
          of the healing action or a set of rules for healing procedure.
        type: string
      healingResource:
        description: >
          Indicates the kinds of the virtual resource to be healed.
          Permitted values:
            •	VL
            •	LINKPORT
            •	STORAGE
            •	VIRTUALCP
            •	COMPUTE
            •	OSCONTAINER

          Default value is COMPUTE when the VDUs of the VNF are realized by a set of virtual machines and 
          OSCONTAINER when the VDUs of the VNF are realized by a set of OS containers.
        type: array
        items:
          type: string
          enum:
            - VL
            - LINKPORT
            - STORAGE
            - VIRTUALCP
            - COMPUTE
            - OSCONTAINER
  OperateVnfRequest:
    description: >
      This type represents request parameters for the "Operate VNF" operation.
@@ -794,6 +854,8 @@ definitions:
                towards the VIM.
      * NOTE 2: Component mappings are defined in the VNFD in the source or destination package for the relevant change
                path. See clause 7.1.15.2 in ETSI GS NFV-IFA 011 [7].
      * NOTE 3: In the current version of the present document, only Rolling upgrade and Blue-green upgrade types 
                are supported. The definition of additional upgrade types is left for future specification.
    type: object
    required:
      - vnfdId
@@ -851,6 +913,14 @@ definitions:
        type: array
        items:
          $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnfd"
      resourceCapacityDefinition:
        description: >
          Indicates values for resource capacity related attributes pertaining to a descriptor. Values can only be 
          provided for resource capacity related attributes that have been defined in the VNFD as being configurable. 
          Furthermore, provided values shall be within the allowed values indicated in the VNFD.
        type: array
        items:
          $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/ResourceCapacityDefinition"
      certificateConfigurationData:
        description: >
          Configuration for certificate management such as certificate profile and security policy in this VNF.
@@ -858,7 +928,17 @@ definitions:
          shall not be present.
          This attribute shall be supported when delegation mode of certificate management is applicable.
        $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/CertificateConfigurationData"

      upgradeType:
        description: >
          Indicates upgrade type when change the current VNF Package on which a VNF instance is based.
          Permitted values:
          •	ROLLING_UPGRADE
          •	BLUE_GREEN
          See note 3.
        type: string
        enum:
          - ROLLING_UPGRADE
          - BLUE_GREEN
  VnfInfoModificationRequest:
    description: >
      This type represents attribute modifications for an "Individual VNF instance" resource,
@@ -2176,7 +2256,6 @@ definitions:
    type: object
    required:
      - type
      - aspectId
    properties:
      type:
        description: >
@@ -2186,13 +2265,17 @@ definitions:
            capacity
          * SCALE_IN: removing VNFC instances from the VNF in order to release
            unused capacity.
          * SCALE_VERTICAL: increasing or decreasing the resource capacity of all 
            instances of one or multiple VNFCs.
        type: string
        enum:
          - SCALE_OUT
          - SCALE_IN
          - SCALE_VERTICAL
      aspectId:
        description: >
          Identifier of the scaling aspect.
          Identifier of the scaling aspect. It shall be present when ‘type’ indicates SCALE_OUT or 
          SCALE_IN and absent otherwise.
        $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnfd"
      numberOfSteps:
        description: >
@@ -2201,6 +2284,16 @@ definitions:
          shall be 1.
        type: integer
        default: 1
      resourceCapacityDefinition:
        description: >
          Indicates values for resource capacity related attributes pertaining to a descriptor. The indicated values are 
          absolute (target) values, as opposed to relative (delta) values. Values can only be provided for 
          resource capacity related attributes that have been defined in the VNFD as being configurable. 
          Furthermore, provided values shall be within the allowed values indicated in the VNFD. It shall be 
          present when ‘type’ indicates SCALE_VERTICAL and absent otherwise.
        type: array
        items:
          $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/ResourceCapacityDefinition"
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to the scaling
+3 −3

File changed.

Preview size limit exceeded, changes collapsed.