SOL005_36 to SOL005_40, SOL005_54 to SOL005_57, SOL005_61 SOL005_v040009 (8abcbc6a) · Commits · NFV - Network Functions Virtualisation / SOL005

src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml

+297 −8

Original line number	Original line	Diff line number	Diff line
	@@ -480,6 +480,17 @@ definitions:
	description: >		description: >
	Identifies the version of the VNFD. The value is copied from the VNFD.		Identifies the version of the VNFD. The value is copied from the VNFD.
	$ref: "../../definitions/SOL005_def.yaml#/definitions/Version"		$ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
			versionDependency:
			description: >
			Describes version dependencies currently valid for the VNF instance. Identifies
			versions of descriptors of other constituents in the NSD upon which the VNF depends.
			The dependencies may be described for the VNFD referenced in this VnfInfo with vnfdId
			and for VNFDs with the same VnfdExtInvariantId.
			There shall not be more than one versionDependency present with the same
			dependentConstituentId.
			type: array
			items:
			$ref: "#/definitions/VersionDependency"
	vnfPkgId:		vnfPkgId:
	description: >		description: >
	Identifier of information held by the NFVO about		Identifier of information held by the NFVO about
	@@ -583,6 +594,14 @@ definitions:
	type: array		type: array
	items:		items:
	$ref: "#/definitions/VipCpInfo"		$ref: "#/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/VirtualCpInfo"
	extVirtualLinkInfo:		extVirtualLinkInfo:
	description: >		description: >
	Information about the external VLs the VNF instance is connected to.		Information about the external VLs the VNF instance is connected to.
	@@ -633,6 +652,13 @@ definitions:
	type: array		type: array
	items:		items:
	$ref: "#/definitions/VirtualStorageResourceInfo"		$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"
	metadata:		metadata:
	description: >		description: >
	Additional VNF-specific attributes that provide		Additional VNF-specific attributes that provide
	@@ -665,6 +691,184 @@ definitions:
	In addition, the provisions in clause 6.7 shall apply.		In addition, the provisions in clause 6.7 shall apply.
	$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"		$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"


			VirtualCpInfo :
			type: object
			description: 'This type represents the information related to a virtual CP instance of a VNF.
			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 "vduId" values.'
			required:
			- cpInstanceId
			- cpdId
			- resourceHandle
			- vduId
			properties:
			cpInstanceId:
			description: >
			Identifier of this virtual CP instance.
			$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf"
			cpdId:
			description: >
			Identifier of the VirtualCpd in the VNFD.
			$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
			resourceHandle:
			description: >
			Reference to the virtualised resource realizing this virtual CP.
			$ref: "../../definitions/SOL005_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: "../../definitions/SOL005_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"
			vduId:
			description: >
			Reference to the VDU(s) which implement the service accessible via the virtual CP instance. See note.
			type: array
			items:
			$ref: "../../definitions/SOL005_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.
			type: array
			items:
			$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"


			AdditionalServiceInfo:
			type: object
			required:
			- portInfo
			description:
			'This type represents the additional service information of the virtual CP instance
			used to expose properties of the virtual CP to NFV-MANO.

			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.'
			properties:
			portInfo:
			description: >
			Service port numbers exposed by the virtual CP instance.
			type: array
			items:
			$ref: "#/definitions/ServicePortInfo"
			serviceInfo:
			description: >
			Service matching information exposed by the virtual CP instance. See note.
			type: array
			items:
			$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

			ServicePortInfo:
			type: object
			required:
			- name
			- protocol
			- port
			- isPortConfigurable
			description:
			'This type represents the information related to the service identifying port
			properties exposed by the virtual CP instance.'
			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
			isPortConfigurable:
			description: >
			Specifies whether the port attribute value is allowed to be configurable.
			type: boolean

			McioInfo:
			type: object
			required:
			- mcioId
			- mcioName
			- mcioNamespace
			- vduId
			- cismId
			- mcioType
			- desiredInstances
			- availableInstances
			description:
			'This type provides information about an MCIO representing the set of VNFC instances realized by one or a set of
			OS containers which have been created based on the same VDU.

			NOTE 1 The type of MCIO as specified in the declarative descriptor of the MCIO, and that can be read from the CISM.
			EXAMPLE In case of MCIOs managed by Kubernetes, the type of MCIO corresponds to the “kind” property of the declarative descriptor.
			NOTE 2 If the attribute additionalInfo is present, it may contain runtime information on the actual and desired state of the MCIO(s).
			NOTE 3 When the container infrastructure service is a Kubernetes® instance, the mcioId is the combined values from the kind
			and name fields of the Kubernetes® resource object, separated by a slash. Example: "Deployment/abcd".
			NOTE 4 When the container infrastructure service is a Kubernetes® instance, the mcioName is the name field of the resource object.'
			properties:
			mcioId:
			description: >
			Identifier of this MCIO, created by the CISM. See note 3.
			$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
			mcioName:
			description: >
			Human readable name of this MCIO. See note 4.
			type: string
			mcioNamespace:
			description: >
			Namespace of this MCIO.
			type: string
			vduId:
			description: >
			Reference to the related VDU in the VNFD applicable to this resource.
			$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
			cismId:
			description: >
			Identifier of the CISM managing this MCIO.
			$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
			mcioType:
			description: >
			The type of MCIO. Specific values, their semantics and associated MCIO
			types are defined in clause 6.5.4.13. Additional values are also permitted.
			See note 1.
			type: string
			desiredInstances:
			description: >
			Number of desired MCIO instances.
			type: integer
			availableInstances:
			description: >
			Number of available MCIO instances
			type: integer
			additionalInfo:
			description: >
			Additional information which is specific to the MCIO, its type, and which is available from the CISM.
			See note 2.
			$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
	LccnLinks:		LccnLinks:
	type: object		type: object
	required:		required:
	@@ -975,19 +1179,19 @@ definitions:
	description: >		description: >
	Identifier of the VNF external CP instance in the scope		Identifier of the VNF external CP instance in the scope
	of the VNF instance. This attribute shall be present if the CP instance is VNF		of the VNF instance. This attribute shall be present if the CP instance is VNF
	external CP. See notes 1 and 4.		external CP. See note 1 and note 4.
	$ref: "#/definitions/IdentifierInVnf"		$ref: "#/definitions/IdentifierInVnf"
	pnfInfoId:		pnfInfoId:
	description: >		description: >
	Identifier of the PNF instance associated to the CP		Identifier of the PNF instance associated to the CP
	instance. This attribute shall be present if the CP instance is PNF		instance. This attribute shall be present if the CP instance is PNF
	external CP. See notes 2 and 4.		external CP. See note 2 and note 4.
	$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"		$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
	pnfExtCpInstanceId:		pnfExtCpInstanceId:
	description: >		description: >
	Identifier of the PNF external CP instance in the scope		Identifier of the PNF external CP instance in the scope
	of the PNF. This attribute shall be present if the CP instance is PNF		of the PNF. This attribute shall be present if the CP instance is PNF
	external CP. See notes 2 and 4.		external CP. See note 2 and note 4.
	$ref: "#/definitions/IdentifierInPnf"		$ref: "#/definitions/IdentifierInPnf"
	nsInstanceId:		nsInstanceId:
	description: >		description: >
	@@ -999,7 +1203,7 @@ definitions:
	description: >		description: >
	Identifier of the SAP instance in the scope of the NS		Identifier of the SAP instance in the scope of the NS
	instance. This attribute shall be present if the CP instance is NS		instance. This attribute shall be present if the CP instance is NS
	SAP. See notes 3 and 4.		SAP. See note 3 and note 4.
	$ref: "#/definitions/IdentifierInNs"		$ref: "#/definitions/IdentifierInNs"

	SapInfo:		SapInfo:
	@@ -1298,11 +1502,12 @@ definitions:
	associated to the network address information.		associated to the network address information.
	Permitted values:		Permitted values:
	- IP_OVER_ETHERNET		- IP_OVER_ETHERNET
			- IP_FOR_VIRTUAL_CP
	See note.		See note.
	type: string		type: string
	enum:		enum:
	- IP_OVER_ETHERNET		- IP_OVER_ETHERNET
			- IP_FOR_VIRTUAL_CP
	ipOverEthernet:		ipOverEthernet:
	description: >		description: >
	IP addresses over Ethernet to assign to the CP		IP addresses over Ethernet to assign to the CP
	@@ -1310,6 +1515,37 @@ definitions:
	layerProtocol is equal to "		layerProtocol is equal to "
	IP_OVER_ETHERNET", and shall be absent otherwise.		IP_OVER_ETHERNET", and shall be absent otherwise.
	$ref: "#/definitions/IpOverEthernetAddressInfo"		$ref: "#/definitions/IpOverEthernetAddressInfo"
			virtualCpAddress:
			description: >
			IP address data assigned to an external CP instance
			exposing a virtual CP. It shall be present if layerProtocol
			is equal to “IP_FOR_VIRTUAL_CP” and the external CP instance
			exposes a virtual CP and shall not be present otherwise.
			$ref: "#/definitions/VirtualCpAddressInfo"

			VirtualCpAddressInfo:
			description: >
			This type represents information about a network address that has been assigned to a virtual CP.
			type: object
			required:
			- type
			properties:
			type:
			description: >
			The type of the IP addresses.
			Permitted values:
			- IPV4
			- IPV6
			type: string
			enum:
			- IPV4
			- IPV6
			loadBalancerIp:
			description: Fixed addresses assigned to an external load balancer.
			$ref: "#/definitions/IpAddress"




	IpOverEthernetAddressInfo:		IpOverEthernetAddressInfo:
	description: >		description: >
	@@ -1544,6 +1780,8 @@ definitions:

	ExtManagedVirtualLinkInfo:		ExtManagedVirtualLinkInfo:
	type: object		type: object
			description: >
			This type provides information about an externally-managed internal virtual link for VNFs
	required:		required:
	- id		- id
	- vnfVirtualLinkDescId		- vnfVirtualLinkDescId
	@@ -1575,6 +1813,12 @@ definitions:
	type: array		type: array
	items:		items:
	$ref: "#/definitions/VnfLinkPortInfo"		$ref: "#/definitions/VnfLinkPortInfo"
			vnfNetAttDefResource:
			description: >
			Network attachment definition resources that provide the specification of the interface
			to attach connection points to this VL..
			$ref: "#/definitions/NetAttDefResourceInfo"

	extManagedMultisiteVirtualLinkId:		extManagedMultisiteVirtualLinkId:
	description: >		description: >
	Identifier of the externally-managed multi-site VL instance. The identifier is assigned by the NFV-MANO entity		Identifier of the externally-managed multi-site VL instance. The identifier is assigned by the NFV-MANO entity
	@@ -1584,6 +1828,38 @@ definitions:
	shall refer to the same extManagedMultisiteVirtualLinkId.		shall refer to the same extManagedMultisiteVirtualLinkId.
	$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"		$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"

			NetAttDefResourceInfo:
			type: object
			description: >
			This type represents the 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
			required:
			- netAttDefResourceInfoId
			- netAttDefResource
			properties:
			netAttDefResourceInfoId:
			description: >
			Identifier of this network attachment definition resource as provided by the entity that has created it.
			$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
			netAttDefResource:
			description: >
			Resource handle of the resource in the scope of the CISM.
			$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
			associatedExtCpId:
			description: >
			Identifier of the external CP of the VNF 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: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf"
			associatedVnfcCpId:
			description: >
			Identifier of the VNFC CP of the VNF 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: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf"

	VnfLinkPortInfo:		VnfLinkPortInfo:
	type: object		type: object
	description: >		description: >
	@@ -1690,6 +1966,10 @@ definitions:
	is "exposed as" an external CP if it is connected directly to an external VL.		is "exposed as" an external CP if it is connected directly to an external VL.
	NOTE 3: The information can be omitted because it is already available		NOTE 3: The information can be omitted because it is already available
	as part of the external CP information.		as part of the external CP information.
			NOTE 4: Cardinality greater than 1 is only applicable for specific cases where more than one network
			attachment definition resource is needed to fulfil the connectivity requirements of the internal CP,
			e.g. to build a link redundant mated pair in SR-IOV cases.
			NOTE 5: When more than one "netAttDefResourceId" is indicated, all shall belong to the same namespace.
	type: object		type: object
	required:		required:
	- id		- id
	@@ -1712,12 +1992,12 @@ definitions:
	$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"		$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
	computeResource:		computeResource:
	description: >		description: >
	Reference to the VirtualCompute resource.		Reference to the VirtualCompute resource or reference to a Compute MCIO.
	$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"		$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
	storageResourceIds:		storageResourceIds:
	description: >		description: >
	References to the VirtualStorage resources. The value refers to a		References to the VirtualStorage resources or references to Storage MCIOs.
	VirtualStorageResourceInfo item in the VnfInstance.		The value refers to a VirtualStorageResourceInfo item in the VnfInstance.
	type: array		type: array
	items:		items:
	$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"		$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
	@@ -1777,6 +2057,15 @@ definitions:
	structure. Shall be present if the CP is associated to a link port on an internal VL (including		structure. Shall be present if the CP is associated to a link port on an internal VL (including
	externally-managed internal VL) of the VNF instance and shall be absent otherwise.		externally-managed internal VL) of the VNF instance and shall be absent otherwise.
	$ref: "#/definitions/IdentifierInVnf"		$ref: "#/definitions/IdentifierInVnf"
			netAttDefResourceId:
			description: >
			Identifier of the "NetAttDefResourceInfo" structure that provides the specification of the interface to attach
			the connection point to a secondary container cluster network. See notes 4 and 5.
			It shall be present if the internal CP is associated to a VNFC realized by one or a set of OS containers and
			is connected to a secondary container cluster network. It shall not be present otherwise.
			type: array
			items:
			$ref: "#/definitions/IdentifierInVnf"
	metadata:		metadata:
	description: >		description: >
	Metadata about this CP.		Metadata about this CP.

Admin message