Commit 6f667d1a authored by Muhammad Hamza's avatar Muhammad Hamza
Browse files

update data models in VNF LCM as per ed 4.3.1

parent 5b46cb71
Loading
Loading
Loading
Loading
Loading
+178 −63
Original line number Diff line number Diff line
@@ -7,17 +7,24 @@ definitions:
      This type represents request parameters for the "Instantiate VNF" operation. 
      It shall comply with the provisions defined in table 5.5.2.4-1.

      NOTE 1:	The indication of externally-managed internal VLs is needed in case 
      * NOTE 1:	The indication of externally-managed internal VLs is needed in case 
                networks have been pre-configured for use with certain VNFs, for instance 
                to ensure that these networks have certain properties such as security or 
                acceleration features, or to address particular network topologies. 
                The present document assumes that externally-managed internal VLs are 
                managed by the NFVO and created towards the VIM.
      NOTE 2:	It is possible to have several ExtManagedVirtualLinkData for the same VNF 
      * NOTE 2:	It is possible to have several ExtManagedVirtualLinkData for the same VNF 
                internal VL in case of a multi-site VNF spanning several VIMs. The set of 
                ExtManagedVirtualLinkData corresponding to the same VNF internal VL shall 
                indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed 
                multi-site VL instance (refer to clause 4.4.1.12).
      * NOTE 3: The target size for VNF instantiation may be specified in either instantiationLevelId or targetScaleLevelInfo, but
                not both. If none of the two attributes (instantiationLevelId or targetScaleLevelInfo) are present, the default
                instantiation level as declared in the VNFD shall be used.
      * NOTE 4: If targetScaleLevelInfo is specified, information provided in targetScaleLevelInfo shall be used for instantiating
                scalable constituents of the VNF (e.g, VDUs/VLs). For scaling aspects not specified in targetScaleLevelInfo or
                for the VNF constituents (e.g.,VDUs/VLs) that are not scalable, the default instantiation level as declared in the
                VNFD shall be used for instantiation.
    type: object
    required:
      - flavourId
@@ -28,20 +35,34 @@ definitions:
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      instantiationLevelId:
        description: >
          Identifier of the instantiation level of the deployment flavour to be
          instantiated. If not present, the default instantiation level as
          declared in the VNFD is instantiated.
          Identifier of the instantiation level of the deployment
          flavour to be instantiated. See note 3.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      targetScaleLevelInfo:
        description: >
          This attribute is applicable if VNF supports target
          scale level instantiation.
          For each scaling aspect of the current deployment
          flavour, the attribute specifies the scale level of VNF
          constituents (e.g., VDU level) to be instantiated. See
          notes 3 and 4.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ScaleInfo"
      extVirtualLinks:
        description: >
          Information about external VLs to connect the VNF to, including configuration information
          for the CPs via which the VNF instance can attach to this VL.
          The following applies to the "ExtVirtualLinkData" information provided in this
          request, together with the related overriding information provided in the 
          "Grant" structure (see clause 9.5.2.3): Even if the VNF is not instantiated in
          fully scaled-out state, the  API consumer shall provide enough CP configuration
          records to allow connecting the VNF instance, fully scaled out in all scaling 
          aspects, to the external VLs
          Information about external VLs to connect the VNF
          to, including configuration information for the CPs
          via which the VNF instance can attach to this VL.
          The following applies to the "ExtVirtualLinkData"
          information provided in this request, together with
          the the related overriding information provided in the
          "Grant" structure (see clause 9.5.2.3): Even if the
          VNF is not instantiated in fully scaled-out state, the
          API consumer shall provide enough CP
          configuration records to allow connecting the VNF
          instance, fully scaled out in all scaling aspects, to
          the external VLs.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
@@ -53,11 +74,21 @@ definitions:
          $ref: "#/definitions/ExtManagedVirtualLinkData"
      vimConnectionInfo:
        description: >
          Information about VIM connections to be used for managing the resources for the VNF instance, or refer to
          external / externally-managed virtual links. This attribute shall only be supported and may be present if 
          VNF-related resource management in direct mode is applicable. The VNFM shall apply the content of this 
          attribute to the "vimConnectionInfo" attribute of "VnfInstance" according to the rules of JSON Merge Patch 
          (see IETF RFC 7396).
          Information about VIM or CISM connections to be
          used for managing the resources for the VNF
          instance, or refer to external/externally-managed
          virtual links.
          This attribute shall only be supported and may be
          present if
          - the resources for at least one of the VNFCs
          shall be managed by a VIM and VNFrelated resource management in direct
          mode is applicable.
          - the resources for at least one of the VNFCs
          shall be managed by a CISM.
          The VNFM shall apply the content of this attribute to
          the "vimConnectionInfo" attribute of "VnfInstance"
          according to the rules of JSON Merge Patch (see
          IETF RFC 7396 [5]).
        type: object
        additionalProperties:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
@@ -69,9 +100,10 @@ definitions:
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
      additionalParams:
        description: >
          Additional input parameters for the instantiation process, specific
          to the VNF being instantiated, as declared in the VNFD as part of
          "InstantiateVnfOpConfig".
          Additional input parameters for the instantiation
          process, specific to the VNF being instantiated, as
          declared in the VNFD as part of
          "InstantiateVnfOpConfig" defined in ETSI GS NFVIFA 011 [10].
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
@@ -170,16 +202,23 @@ definitions:
      This type represents request parameters for the "Change VNF flavour" operation. 
      It shall comply with the provisions defined in table 5.5.2.7-1.

      NOTE 1:	The indication of externally-managed internal VLs is needed in case networks 
      * NOTE 1:	The indication of externally-managed internal VLs is needed in case networks 
                have been pre-configured for use with certain VNFs, for instance to ensure 
                that these networks have certain properties such as security or acceleration 
                features, or to address particular network topologies. The present document 
                assumes that externally-managed internal VLs are managed by the NFVO and created 
                towards the VIM.
      NOTE 2:	It is possible to have several ExtManagedVirtualLinkData for the same VNF internal 
      * NOTE 2:	It is possible to have several ExtManagedVirtualLinkData for the same VNF internal 
                VL in case of a multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkData 
                corresponding to the same VNF internal VL shall indicate so by referencing to the same 
                VnfVirtualLinkDesc and externally-managed multi-site VL instance (refer to clause 4.4.1.12).
      * NOTE 3: The target size for VNF instantiation may be specified in either instantiationLevelId or targetScaleLevelInfo, but
                not both. If none of the two attributes (instantiationLevelId or targetScaleLevelInfo) are present, the default
                instantiation level as declared in the VNFD shall be used.
      * NOTE 4: If targetScaleLevelInfo is specified, information provided in targetScaleLevelInfo shall be used for instantiating
                scalable constituents of the VNF (e.g, VDUs/VLs). For scaling aspects not specified in targetScaleLevelInfo or
                for the VNF constituents (e.g.,VDUs/VLs) that are not scalable, the default instantiation level as declared in the
                VNFD shall be used for instantiation.
    type: object
    required:
      - newFlavourId
@@ -191,9 +230,20 @@ definitions:
      instantiationLevelId:
        description: >
          Identifier of the instantiation level of the deployment flavour to
          be instantiated. If not present, the default instantiation level as
          be instantiated. See note 3. If not present, the default instantiation level as
          declared in the VNFD is instantiated.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      targetScaleLevelInfo:
        description: >
          This attribute is applicable if VNF supports target scale
          level instantiation.
          For each scaling aspect of the current deployment
          flavour, the attribute specifies the scale level of VNF
          constituents (e.g., VDU level) to be instantiated. See
          notes 3 and 4.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ScaleInfo"
      extVirtualLinks:
        description: >
          Information about external VLs to connect the VNF to, including configuration information 
@@ -218,11 +268,21 @@ definitions:
          $ref: "#/definitions/ExtManagedVirtualLinkData"
      vimConnectionInfo:
        description: >
          Information about VIM connections to be used for managing the resources for the VNF instance, or refer to
          external / externally-managed virtual links. This attribute shall only be supported and may be present if 
          VNF-related resource management in direct mode is applicable. The VNFM shall apply the content of this 
          attribute to the "vimConnectionInfo" attribute of "VnfInstance" according to the rules of JSON Merge Patch 
          (see IETF RFC 7396).
          Information about VIM or CISM connections to be used
          for managing the resources for the VNF instance, or
          refer to external/externally-managed virtual links.
          This attribute shall only be supported and may be
          present if
          - the resources for at least one of the VNFCs
          shall be managed by a VIM and VNF-related
          resource management in direct mode is
          applicable.
          - the resources for at least one of the VNFCs
          shall be managed by a CISM.
          The VNFM shall apply the content of this attribute to
          the "vimConnectionInfo" attribute of "VnfInstance"
          according to the rules of JSON Merge Patch (see IETF
          RFC 7396 [5]).
        type: object
        additionalProperties:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
@@ -230,7 +290,7 @@ definitions:
        description: >
          Additional input parameters for the instantiation process, specific
          to the VNF being instantiated, as declared in the VNFD as part of
          "InstantiateVnfOpConfig".
          "InstantiateVnfOpConfig" defined in ETSI GS NFV-IFA 011 [10].
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
@@ -290,7 +350,7 @@ definitions:
        description: >
          Additional parameters passed by the NFVO as input to the termination
          process, specific to the VNF being terminated, as declared in the
          VNFD as part of "TerminateVnfOpConfig".
          VNFD as part of "TerminateVnfOpConfig" defined in ETSI GS NFV-IFA 011 [10].
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  HealVnfRequest:
@@ -304,7 +364,7 @@ definitions:
        description: >
          Additional parameters passed by the NFVO as input to the healing
          process, specific to the VNF being healed, as declared in the VNFD
          as part of "HealVnfOpConfig".
          as part of "HealVnfOpConfig" defined in ETSI GS NFV-IFA 011 [10].
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  OperateVnfRequest:
@@ -342,7 +402,7 @@ definitions:
        description: >
          Additional parameters passed by the NFVO as input to the process,
          specific to the VNF of which the operation status is changed, as
          declared in the VNFD as part of "OperateVnfOpConfig".
          declared in the VNFD as part of "OperateVnfOpConfig" defined in ETSI GS NFV-IFA 011 [10].
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  ChangeExtVnfConnectivityRequest:
@@ -819,20 +879,55 @@ definitions:
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      vimConnectionInfo:
        description: >
          Information about VIM connections to be used for managing the
          resources for the VNF instance. The keys of the map, each of
          which identifies information about a particular VIM connection,
          are managed by the NFVO and referenced from other data structures
          via the "vimConnectionId" attribute. This attribute shall only
          be supported and present if VNF-related resource management in
          direct mode is pplicable.
          This attribute can be modified with the PATCH method.
          Information about VIM or CISM connections
          to be used for managing the resources for
          the VNF instance. The keys of the map, each
          of which identifies information about a
          particular VIM connection, are managed by
          the NFVO and referenced from other data
          structures via the "vimConnectionId"
          attribute.
          This attribute shall only be supported and
          present if
          - the resources of at least of the
          VNFCs are managed by a VIM and
          VNF-related resource management
          in direct mode is applicable.
          - the resources of at least of the
          VNFCs are managed by a CISM.
          This attribute can be modified with the
          PATCH method.
        type: object
        additionalProperties:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
      cirConnectionInfo:
        description: >
          Information about the CIR connection for
          managing OS container images for the VNF
          instance.
          Shall be present when all or part of the VNF
          is realized by a set of OS containers and
          shall be absent otherwise.
        type: object
        additionalProperties:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
      mciopRepositoryInfo:
        description: >
          Information about the MCIOP repository for
          the VNF instance.
          Shall be present when all or part of the VNF
          is realized by a set of OS containers and
          shall be absent otherwise.
          See note 1.
        type: object
        additionalProperties:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
      instantiationState:
        description: >
          The instantiation state of the VNF.
          Permitted values:
          - NOT_INSTANTIATED: The VNF instance is terminated or not instantiated.
          - INSTANTIATED: The VNF instance is instantiated.
        type: string
        enum:
          - NOT_INSTANTIATED
@@ -857,9 +952,12 @@ definitions:
            $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfOperationalStateType"
          scaleStatus:
            description: >
              Scale status of the VNF, one entry per aspect.
              Represents for every scaling aspect how "big" the VNF has been scaled w.r.t. that aspect.
              This attribute shall be present if the VNF supports scaling.
              Scale status of the VNF, one entry per
              aspect. Represents for every scaling aspect 
              how "big" the VNF has been scaled w.r.t.
              that aspect.
              This attribute shall be present if the VNF
              supports scaling.
              See clause B.2 for an explanation of VNF scaling.
            type: array
            items:
@@ -889,6 +987,14 @@ definitions:
            minItems: 1
            items:
              $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VipCpInfo"
          virtualCpInfo:
            description: >
              Virtual CPs that are part of the VNF instance. Shall be present when a particular Virtual CP
              is associated to an external CP of the VNF instance.
              May be present otherwise.
            type: array
            items:
              $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VirtualCpInfo - TO DO"
          extVirtualLinkInfo:
            description: >
              Information about the external VLs the VNF instance is connected to.
@@ -934,6 +1040,15 @@ definitions:
            type: array
            items:
              $ref: "#/definitions/VirtualStorageResourceInfo"
          mcioInfo:
            description: >
              Information on the MCIO(s) representing
              VNFC instance(s) realized by one or a set of
              OS containers and created from the same
              VDU for the VNF instance.
            type: array
            items:
              $ref: "#/definitions/McioInfo - TO DO"
      metadata:
        description: >
          Additional VNF-specific attributes that provide metadata describing the VNF instance.
+3 −0
Original line number Diff line number Diff line
@@ -28,6 +28,9 @@ definitions:
        $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  ScaleVnfRequest:
    description: >
      This type represents request parameters for the "Scale VNF" operation. It shall comply with the provisions defined in
      table 5.5.2.5-1. See clause B.2 in annex B for an explanation of VNF scaling.
    type: object
    required:
      - type