Commit 97ea05cd authored by Muhammad Umair Khan's avatar Muhammad Umair Khan
Browse files

Update as per 5.1.1

parent df8667a7
Loading
Loading
Loading
Loading
Loading
+290 −7
Original line number Diff line number Diff line
@@ -643,14 +643,14 @@ 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.
      * NOTE 3: The attribute is only relevant if the virtual CP is instantiated in a cluster that supports configuration of IP
                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:
      - type
@@ -668,12 +668,35 @@ 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
          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: array
        items:
          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: >
@@ -783,6 +806,266 @@ definitions:
          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.
        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:
          - 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 (clause 6.8.12 in ETSI GS NFV-SOL 001 [14]) 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 (clause 6.8.12 in ETSI GS NFV-SOL 001 [14]) for this container descriptor. See note.
        $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 (clause 6.8.12 in ETSI GS NFV-SOL 001 [14]) 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 
          (clause 6.8.12 in ETSI GS NFV-SOL 001 [14]) 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 
          (clause 6.8.12 in ETSI GS NFV-SOL 001 [14]) 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 (clause 6.8.12 in ETSI GS NFV-SOL 001 [14]) 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_resource property in the VNFD (clause 6.8.12 in ETSI GS NFV-SOL 001 [14]) 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:
          - numVirtualCpu
      - required:
          - virtualMemSize
      - required:
          - sizeOfVirtualDisk
      - required:
          - hugePagesRequirements
    properties:
      resourceTemplateId:
        description: >
          Identifier of an osContainerDesc 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 (clause 6.2.7.2 in ETSI GS NFV-SOL 001 [14]) 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 
          (clause 6.2.39.2 in ETSI GS NFV-SOL 001 [14]) 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 (clause 6.2.7.2 in ETSI GS NFV-SOL 001 [14]) for this virtual compute descriptor.
          The value is a numberthat indicates the required total size expressed in the same units 
          as in the huge_pages_requirements property in the VNFD (clause 6.2.7.2 in ETSI GS NFV-SOL 001 [14]) that indicates the valid vaues 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 an osContainerDesc in the VNFD.
        $ref: "#/definitions/IdentifierInVnfd"
      sizeOfStorage:
        description: >
          If the 'typeOfStorage' attribute in the VirtualStorageDesc 
          (see clause 7.1.9.4.2.2 in ETSI GS NFV-IFA 011) 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 
          (clause 6.2.39.2 or 6.2.41.2, respectively, in ETSI GS NFV-SOL 001).
          If the 'typeOfStorage' attribute in the VirtualStorageDesc (see clause 7.1.9.4.2.2 in 
          ETSI GS NFV-SOL 001) 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 (clause 6.2.40.2 in ETSI GS NFV-SOL 001).
        $ref: "#/definitions/Number"

  MonitoringConnection:
    description: >
      The MonitoringConnection shall follow the indications provided.

      * 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 [i.18]).
    type: object
    required:
      - id
      - monitoringType
    properties:
      id:
        description: >
          Identifier of the monitoring connection. See note.
        $ref: "#/definitions/Identifier"
      monitoringType:
        description: >
          Type of monitoring way.
        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"
        
  ScaleInfo:
    description: >
      This type represents the scale level of a VNF instance related to a scaling aspect.
+1 −1
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ info:
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  version: "1.12.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
  version: "1.14.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"

externalDocs:
  description: ETSI GS NFV-SOL 003 V4.5.1
+30 −4
Original line number Diff line number Diff line
@@ -42,7 +42,11 @@ definitions:
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
      managedObjectId:
        description: >
          Identifier of the affected VNF instance.
          Identifier of the affected VNF instance. The managed objects for this information 
          element will be VNF instances. A VNF instance can have fault monitored sub-object 
          types and identification information is carried as defined in the respective Alarm 
          definition as defined in clause 7.3 of ETSI GS NFV-IFA 045 [13], e.g., using the 
          "faultDetails" attribute.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
      rootCauseFaultyResource:
        description: >
@@ -81,7 +85,10 @@ definitions:
          - ACKNOWLEDGED
      perceivedSeverity:
        description: >
          Perceived severity of the managed object failure.
          Perceived severity of the managed object failure. Valid values applicable to 
          specific Alarms are specified as "Perceived severity" values of the Alarm 
          applicable to Or-Vnfm reference point, as defined in clause 7.3 of 
          ETSI GS NFV-IFA 045 [13].
        $ref: "#/definitions/PerceivedSeverityType"
      eventTime:
        description: >
@@ -89,11 +96,16 @@ definitions:
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/DateTime"
      eventType:
        description: >
          Type of event.
          Type of event. Valid values applicable to specific Alarms are specified as 
          "Event type" values of the Alarm applicable to Or-Vnfm reference point, as 
          defined in clause 7.3 of ETSI GS NFV-IFA 045 [13].
        $ref: "#/definitions/EventType"
      faultType:
        description: >
          Additional information to clarify the type of the fault.
          Valid values applicable to specific Alarms are specified as "Alarm definition 
          identifier" values of the Alarm applicable to Or-Vnfm reference point, as 
          defined in clause 7.3 of ETSI GS NFV-IFA 045 [13].
          If the alarm is related to changes in the state of virtualised resources 
          due to NFVI operation and maintenance, this attribute shall be set to 
          "NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE".
@@ -101,6 +113,9 @@ definitions:
      probableCause:
        description: >
          Information about the probable cause of the fault.
          Valid values applicable to specific Alarms are specified as "Probable cause" 
          values of the Alarm applicable to Or-Vnfm reference point, as defined in 
          clause 7.3 of ETSI GS NFV-IFA 045 [13].
          If the attribute "faultType" has the value “NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE”,
          the permitted values are: 
            - "NFVI_COMPONENT_MAINTENANCE": Maintenance of NFVI components, e.g. 
@@ -123,7 +138,10 @@ definitions:
          $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
      faultDetails:
        description: >
          Provides additional information about the fault. See notes 1 and 2.
          Provides additional information about the fault. See notes 1 and 2. Valid values 
          applicable to specific Alarms are specified as "Fault details" values of the Alarm 
          applicable to Or-Vnfm reference point, as defined in clause 7.3 of 
          ETSI GS NFV-IFA 045 [13].
        type: array
        items:
          type: string
@@ -250,6 +268,14 @@ definitions:
        description: >
          The URI of the endpoint to send the notification to.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Uri"
      fmConnection:
        description: >
          An access information and interface information to monitor the FM of VNF instance by 
          the VNFM. This can include for instance certain interface endpoint URI together with 
          necessary credentials to access it.
        type: array
        items:
          $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/MonitoringConnection"
      _links:
        description: >
          Links for this resource.
+1 −1
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ info:
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  version: "1.12.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
  version: "1.13.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"

externalDocs:
  description: ETSI GS NFV-SOL 003 V4.5.1
+7 −0
Original line number Diff line number Diff line
@@ -31,6 +31,13 @@ definitions:
        description: >
          Identifier of the "Individual VNF instance" which provides the indicator value.
        $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
      vnfcInstanceIds:
        description: >
          The vnfcInstanceIds attribute is optionally present. If present, it contains the list of 
          identifiers of VNFC instances which provide the indicator value(s).
        type: array
        items:
          $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnf"
      _links:
        description: >
          Links for this resource.
Loading