Commit 1bdc90f8 authored by Ayesha Ayub's avatar Ayesha Ayub
Browse files

add new datatypes in VNFLCM API

parent f511856a
Loading
Loading
Loading
Loading
Loading
+159 −3
Original line number Diff line number Diff line
@@ -1139,6 +1139,11 @@ definitions:
      changeType:
        description: >
          Signals the type of change.

          Permitted values:
            - ADDED
            - REMOVED
            - MODIFIED
        type: string
        enum:
          - ADDED
@@ -1209,8 +1214,8 @@ definitions:
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      mcioType: 
        description: >
          The type of MCIO. Specific values, their semantics and associated MCIO types are 
          defined in clause 5.5.4.9. Additional values are also permitted.
          The type of MCIO. Specific values, their semantics and associated MCIO types are defined in clause 
          5.5.4.9. Additional values are also permitted.
          See note 1.
        type: string
      desiredInstances: 
@@ -1227,3 +1232,154 @@ definitions:
          from the CISM.
          See note 2. 
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  virtualCpInfo:
    description: >
      This type provides information related to a virtual CP instance of a VNF. It shall comply with the provisions 
      in table 5.5.3.31-1.

      NOTE: A consumer of the VNF LCM interface can learn the actual VNFC instances implementing the service 
            accessible via the virtual CP instance by querying the "vnfcResourceInfo" from the "InstantiatedVnfInfo" 
            and filtering by corresponding "vduIds" values.
    type: object
    required:
      - cpInstanceId
      - cpdId
      - resourceHandle
      - vduIds
    properties:
      cpInstanceId:
        description: >
          Identifier of this virtual CP instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      cpdId:
        description: >
          Identifier of the VirtualCpd in the VNFD.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      resourceHandle:
        description: >
          Reference to the virtualised resource realizing this virtual CP.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle"
      vnfExtCpId:
        description: >
          When the virtual CP is exposed as external CP of the VNF, the identifier of this external VNF CP instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      cpProtocolInfo: 
        description: >
          Protocol information for this CP. There shall be one cpProtocolInfo for each layer protocol supported.
        type: array
        items:
          $ref: "#/definitions/CpProtocolInfo"
      vduIds:
        description: >
          Reference to the VDU(s) which implement the service accessible via the virtual CP instance. See note.
        type: array
        minitems: 1
        items: 
          $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      additionalServiceInfo:
        description: >
          Additional service identification information of the virtual CP instance.
        type: array
        items:
          $ref: "#/definitions/AdditionalServiceInfo"
      metadata:
        description: >
          Metadata about this virtual CP instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" 

  AdditionalServiceInfo:
    description: >
      This type provides additional service information of the virtual CP instance used to expose properties of the 
      virtual CP to NFV-MANO. It shall comply with the provisions in table 5.5.3.32-1.

      NOTE: This attribute shall only be present if additional information is needed to identify the service 
            termination within the VNF, such as for example a URL path information in an HTTP request required 
            to allow a single virtual CP IP address to be used for several HTTP based services that use the 
            same port number.
    type: object
    required:
      - portInfo
    properties:
      portInfo: 
        description: >
          Service port numbers exposed by the virtual CP instance.
        minitems: 1
        type: array
        items:
          $ref: "#/definitions/ServicePortInfo"
      serviceInfo: 
        description: >
          Service matching information exposed by the virtual CP instance.
          See note.
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" 

  ServicePortInfo:
    description: >
      This type describes the service identifying port properties exposed by the virtual CP instance. It shall 
      comply with the provisions in table 5.5.3.33-1.
    type: object
    required:
      - name
      - port
      - portConfigurable
    properties:
      name:
        description: >
          The name of the port exposed by the virtual CP instance.
        type: string
      protocol:
        description: >
          The L4 protocol for this port exposed by the virtual CP instance.

          Permitted values:
          - TCP
          - UDP
          - SCTP
        type: string
        enum:
          - TCP
          - UDP
          - SCTP
      port:
        description: >
          The L4 port number exposed by the virtual CP instance.
        type: integer 
      portConfigurable: 
        description:
          Specifies whether the port attribute value is allowed to be configurable.
        $ref: "SOL002SOL003_def.yaml#/definitions/Boolean"

  NetAttDefResourceInfo:
    description: >
      This type contains information related to a network attachment definition resource that provides the 
      specification of the interface used to connect one or multiple connection points to a secondary container 
      cluster network. It shall comply with the provisions defined in table 5.5.3.36-1.
    type: object
    required:
      - netAttDefResourceInfoId
      - netAttDefResource
    properties: 
      netAttDefResourceInfoId:
        description: >
          Identifier of this network attachment definition resource as provided by the entity that has 
          created it.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      netAttDefResource:
        description: >
          Resource handle of the resource in the scope of the CISM.
        $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle" 
      associatedExtCpId:
        description: >
          Identifier of the external CP associated to this network attachment definition resource. Shall be present 
          when the network attachment definition resource is used for external connectivity by the VNF.
        type: array
        items:
          $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
      associatedVnfcCpId:
        description: >
          Identifier of the VNFC CP associated to this network attachment definition resource. May be present when 
          the network attachment definition resource is used for internal connectivity by the VNF.
        type: array
        items:
          $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
 No newline at end of file