update VNF LCM Oper Granting API as per SOL003 v4.5.1 (e95fef5d) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL003/VNFLifecycleOperationGranting/definitions/SOL003VNFLifecycleOperationGranting_def.yaml

+103 −47

Original line number	Diff line number	Diff line
		@@ -13,7 +13,10 @@ definitions:
		NOTE 3: The NFVO will assume that the VNFM will be responsible to both allocate and release the temporary
		resource during the runtime of the LCM operation. This means, the resource can be allocated and
		consumed after the "start" notification for the LCM operation is sent by the VNFM, and the resource
		will be released before the "result" notification of the VNF LCM operation is sent by the VNFM.
		will be released before the "result" notification of the VNF LCM operation is sent by the VNFM. In the
		case of PaaS Service requests, the handling of the allocation and release of the PaaS Service is a
		responsibility of the NFVO (supported by corresponding PaaS Service management functions)
		based on the information about the progress and completion of the VNF LCM operation.
		NOTE 4: For the affinity/anti-affinity rules defined in the VNFD and the placement constraints in the
		GrantVnfLifecycleOperation as defined in this clause, the following applies: Assuming unlimited
		capacity, the combination of all the aforementioned rules shall be satisfiable by at least one possible
		@@ -36,6 +39,14 @@ definitions:
		scalable constituents of the VNF (e.g, VDUs/VLs) in the granting process. 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 in the granting process.
		NOTE 9: For resources related to a VDU that has the attribute isNumOfInstancesClusterBased set to TRUE,
		only one occurrence of the addResources, or tempResources or removeResources, or
		updateResources shall be included per descriptor indicated in the resourceTemplateId of the
		ResourceDefinition, not one per VNFC instance.
		NOTE 10: If the granting request is for InstantiateVNF and if there are deployable modules defined in the
		applicable VNF DF in the VNFD, either the selectedDeployableModules attribute or the
		addResource attribute shall be included but not both. If selectedDeployableModules is included,
		either the instantiationLevel or targetScaleLevelInfo attribute shall be also included.
		anyOf:
		- required:
		- instantiationLevelId
		@@ -102,56 +113,68 @@ definitions:
		description: >
		If operation=INSTANTIATE, the identifier of the instantiation level may be provided as an
		alternative way to define the resources to be added. This attribute shall only be used if
		operation=INSTANTIATE. See notes 2 and 7.
		operation=INSTANTIATE. See notes 2, 7 and 10.
		$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
		targetScaleLevelInfo:
		description: >
		This attribute shall only be used for
		Instantiate VNF requests. This is applicable
		if VNF supports target scale level
		instantiation.
		This attribute provides an alternative way to
		define the resources to be added for the
		VNFs.
		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 2,
		7 and 8.
		This attribute shall only be used for Instantiate VNF requests. This is applicable if VNF
		supports target scale level instantiation.

		This attribute provides an alternative way to define the resources to be added for the VNFs.

		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 2,
		7, 8 and 10.
		type: array
		items:
		$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/ScaleInfo"

		selectedDeployableModule:
		description: >
		References a selected deployable module.
		Resources related to VDUs that belong to not selected deployable modules shall not
		be considered in the granting

		This attribute shall only be used for the instantiate VNF request. See note 10.
		type: array
		items:
		$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"

		addResources:
		description: >
		List of resource definitions in the VNFD for resources to be added by the LCM operation
		which is related to this grant request, with one entry per resource. See note 2.
		which is related to this grant request, with one entry per resource. See notes 2, 9 and 10.
		type: array
		items:
		$ref: "#/definitions/ResourceDefinition"

		tempResources:
		description: >
		List of resource definitions in the VNFD for resources to be temporarily instantiated during
		the runtime of the LCM operation which is related to this grant request, with one entry per
		resource. See note 3.
		resource. See notes 3 and 9.
		type: array
		items:
		$ref: "#/definitions/ResourceDefinition"

		removeResources:
		description: >
		Provides the definitions of resources to be removed by the LCM
		operation which is related to this grant request, with one entry per
		resource.
		resource. See note 9.
		type: array
		items:
		$ref: "#/definitions/ResourceDefinition"

		updateResources:
		description: >
		Provides the definitions of resources to be modified by the LCM
		operation which is related to this grant request, with one entry per
		resource.
		resource. See note 9.
		type: array
		items:
		$ref: "#/definitions/ResourceDefinition"

		placementConstraints:
		description: >
		Placement constraints that the VNFM may send to the NFVO in order to influence the resource
		@@ -161,6 +184,7 @@ definitions:
		type: array
		items:
		$ref: "#/definitions/PlacementConstraint"

		vimConstraints:
		description: >
		Used by the VNFM to require that multiple resources are managed
		@@ -174,11 +198,13 @@ definitions:
		type: array
		items:
		$ref: "#/definitions/VimConstraint"

		additionalParams:
		description: >
		Additional parameters passed by the VNFM, specific to the VNF and
		the LCM operation.
		$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/KeyValuePairs"

		_links:
		description: >
		Links to resources related to this request.
		@@ -251,6 +277,9 @@ definitions:
		In a first step, the information passed in the related LCM operation is applied to the baseline
		information known from earlier LCM operation executions. In a second step, the information passed
		in the Grant is applied to the information resulting from the first step.
		NOTE 9: For resources related to ResourceDefinition whose VDU has the attribute
		isNumOfInstancesClusterBased set to TRUE, only one occurrence of the addResources, or
		tempResources or removeResources, or updateResources shall be included.
		type: object
		required:
		- id
		@@ -282,22 +311,12 @@ definitions:
		This attribute is not intended for the modification of VimConnectionInfo
		entries passed earlier; for that, the VnfInfoModificationRequest structure
		shall be used.
		This attribute shall only be supported
		when
		- all or part of the granted
		resources are managed by
		a VIM and VNF-related
		Resource Management in
		direct mode is applicable.
		- all or part of the granted
		resources are managed by
		a CISM.
		In direct mode, this parameter shall
		be absent if the VIM or CISM
		information was configured to the
		VNFM in another way, present
		otherwise.
		See note 1.
		This attribute shall only be supported when
		- all or part of the granted resources are managed by a VIM and VNF-related
		Resource Management in direct mode is applicable.
		- all or part of the granted resources are managed by a CISM.
		In direct mode, this parameter shall be absent if the VIM or CISM
		information was configured to the VNFM in another way, present otherwise. See note 1.
		type: object
		additionalProperties:
		$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/VimConnectionInfo"
		@@ -341,7 +360,7 @@ definitions:
		addResources:
		description: >
		List of resources that are approved to be added, with one entry per
		resource. Shall be set when resources are approved to be added and
		resource. See note 9. Shall be set when resources are approved to be added and
		shall contain the same set of resources requested to be added in the
		related GrantRequest.
		type: array
		@@ -351,7 +370,7 @@ definitions:
		description: >
		List of resources that are approved to be temporarily instantiated
		during the runtime of the lifecycle operation, with one entry per
		resource. Shall be set when resources are approved to be temporarily
		resource. See note 9. Shall be set when resources are approved to be temporarily
		instantiated and shall contain the same set of resources requested to
		be temporarily instantiated in the related GrantRequest.
		type: array
		@@ -360,7 +379,7 @@ definitions:
		removeResources:
		description: >
		List of resources that are approved to be removed, with one entry
		per resource. Shall be set when resources are approved to be removed
		per resource. See note 9. Shall be set when resources are approved to be removed
		and shall contain the same set of resources requested to be removed
		in the related GrantRequest.
		type: array
		@@ -369,7 +388,7 @@ definitions:
		updateResources:
		description: >
		List of resources that are approved to be modified, with one entry
		per resource. Shall be set when resources are approved to be updated
		per resource. See note 9. Shall be set when resources are approved to be updated
		and shall contain the same set of resources requested to be updated
		in the related GrantRequest.
		type: array
		@@ -411,6 +430,12 @@ definitions:
		type: array
		items:
		$ref: "#/definitions/StorageAsset"
		paasAssets:
		description: >
		Information about PaaS Services assigned to the VNF and that are managed in the PSM by the NFVO.
		type: array
		items:
		$ref: "#/definitions/PaasAssets"
		extVirtualLinks:
		description: >
		Information about external VLs to connect the VNF to. See notes 5, 7 and 8. If this attribute
		@@ -454,7 +479,7 @@ definitions:

		ResourceDefinition:
		description: >
		This type provides information of an existing or proposed resource used by the VNF.
		This type provides information of an existing or proposed resource or PaaS Service used by the VNF.

		NOTE 1: The use cases UC#4 and UC#5 in Annex A.4 of ETSI GS NFV-IFA 007 provide examples
		for such a configuration.
		@@ -485,6 +510,7 @@ definitions:
		* LINKPORT
		* OSCONTAINER
		* VIRTUALCP
		* PAASSERVICE
		type: string
		enum:
		- COMPUTE
		@@ -493,6 +519,7 @@ definitions:
		- LINKPORT
		- OSCONTAINER
		- VIRTUALCP
		- PAASSERVICE
		vduId:
		description: >
		Reference to the related VDU in the VNFD applicable to this
		@@ -514,6 +541,7 @@ definitions:
		- if type="STORAGE" : VirtualStorageDesc
		- If type="OSCONTAINER": OsContainerDesc
		- If type="VIRTUALCP": VirtualCpd
		- If type="PAASSERVICE": PaasServiceRequest
		- Cardinality may be greater than "1" when type="OSCONTAINER" and multiple references to
		OsContainerDesc are present in the VDU indicated by the "vduId". Cardinality shall be "1" otherwise.
		type: array
		@@ -543,8 +571,8 @@ definitions:

		GrantInfo:
		description: >
		This type contains information about a Compute, storage or network
		resource whose addition/update/deletion was granted.
		This type contains information about a Compute, storage or network resource whose addition/update/deletion
		was granted. It enables also referencing to a PaaS Service request definition which has been granted.
		type: object
		required:
		- resourceDefinitionId
		@@ -855,7 +883,7 @@ definitions:
		this structure.
		The applicable "VimConnectionInfo" structure, which is referenced by
		vimConnectionId, can be obtained from the "vimConnectionInfo"
		attribute of the "VnfInstance" structure.
		attribute of the "VnfInstance" structure when "vimConnectionInfo" is available.
		This attribute shall only be supported and present if VNF-related
		resource management in direct mode is applicable.
		$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
		@@ -893,11 +921,9 @@ definitions:
		properties:
		vimConnectionId:
		description: >
		Identifier of the VIM or CIR connection to access the
		software image referenced in this structure.
		The applicable "VimConnectionInfo" structure, which is
		referenced by vimConnectionId, can be obtained from the
		"vimConnectionInfo" attribute of the "VnfInstance" structure.
		Identifier of the VIM or CIR connection to access the software image referenced in this structure.
		The applicable "VimConnectionInfo" structure, which is referenced by vimConnectionId, can be obtained from the
		"vimConnectionInfo" attribute of the "VnfInstance" structure when "vimConnectionInfo" is available.
		This attribute shall only be supported and present if
		- the software image is to be loaded in a virtual machine and VNF-related resource management in
		direct mode is applicable.
		@@ -1055,3 +1081,33 @@ definitions:
		Name of storage class, which represents features and policies
		concerning a virtual storage.
		$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/String"

		PaasAssets:
		type: object
		required:
		- paasServiceType
		- paasServiceId
		- paasServiceRequestId
		- paasServiceHandle
		properties:
		paasServiceType:
		description: >
		The type of PaaS Service. The value of this attribute is expected to be
		matched against values of the registered PaaS Services in the PSR.
		$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/String"
		paasServiceId:
		description: >
		Identifier of the assigned PaaS Service as managed by the PSM.
		$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Identifier"
		paasServiceVersion:
		description: >
		Version of the PaaS Service. It shall be present if the PaaS Service is versioned.
		$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Version"
		paasServiceRequestId:
		description: >
		Identifier of the PaaS Service request in the VNFD that maps to the assigned PaaS Service.
		$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/IdentifierInVnfd"
		PaasServiceHandle:
		description: >
		A handle enabling the access and use of the PaaS Service by the VNF.
		$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/PaasServiceHandle"
		No newline at end of file