Merge branch '3.7.1-dev' into 'master' (1bc71794) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

Readme.md

+2 −2

Original line number	Diff line number	Diff line
		# NFV SOL002 and SOL003 APIs

		This repository hosts the [OpenAPI](https://www.openapis.org/) specificatons and other documentation
		for the APIs defined in ETSI NFV GSs SOL002 and SOL003 v3.6.1.
		for the APIs defined in ETSI NFV GSs SOL002 and SOL003 v3.7.1.

		The APIs described in this repository are defined for the following reference points:

		@@ -35,7 +35,7 @@ and the results will be stored in a `build/` directory in the project folder.

		## How to raise issues

		Change requests can be filed at [ETSI Forge Bugzilla](forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=62&product=NFV). Please report errors, bugs or other issues [here](https://forge.etsi.org/bugzilla/enter_bug.cgi?product=NFV).
		Please report errors, bugs or other issues [here](https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/issues).

		## How to contribute

src/SOL002/APIVersion/APIVersion.yaml

+2 −2

Original line number	Diff line number	Diff line
		@@ -19,8 +19,8 @@ info:
		version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

		externalDocs:
		description: ETSI GS NFV-SOL 002 V3.6.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.06.01_60/gs_NFV-SOL002v030601p.pdf
		description: ETSI GS NFV-SOL 002 V3.7.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.07.01_60/gs_NFV-SOL002v030701p.pdf

		paths:
		/vnfconfig/api_versions:

src/definitions/SOL002SOL003_def.yaml→src/SOL002/General_Definitions/SOL002_def.yaml

+97 −140

Original line number	Diff line number	Diff line
		@@ -185,93 +185,26 @@ definitions:
		items:
		type: string

		VimConnectionInfo:
		description: >
		This type represents parameters to connect to a VIM for managing the
		resources of a VNF instance.
		* NOTE 1: If applicable, this attribute also provides information about the resourceGroupIds
		that are accessible using a particular set of credentials. See definition of
		"resourceGroupId" in clause 9.5.3.3.
		* NOTE 2: Once the connectivity between VNFM and VIM is provided through a secure connection over
		HTTP Secure (HTTP over SSL/TLS), and the connection might also be established through a VPN
		(for example TLS-based VPN tunnelling) for site-to-site connection, the "accessInfo" JSON data
		structure, and the sensitive data related information ("username"/"password" as required properties
		for authentication purpose), will be transmitted as plain text through a TLS tunnel without additional
		encoding/encryption before transmitting it, making the sensitive data visible to the endpoint.
		The base64 encoded certificates are only used by the VNFM to verify the authenticity of the
		interface endpoint of the VIM.
		type: object
		required:
		- vimType
		properties:
		vimId:
		description: >
		The identifier of the VIM instance. This identifier is managed by
		the NFVO.
		Shall be present to address additional information about the VIM if
		such information has been configured into the VNFM by means outside
		the scope of the present document, and should be absent otherwise.
		$ref: "#/definitions/Identifier"
		vimType:
		description: >
		Discriminator for the different types of the VIM information. The
		value of this attribute determines the structure of the
		"interfaceInfo" and "accessInfo" attributes, based on the type of the
		VIM. The set of permitted values is expected to change over time as
		new types or versions of VIMs become available.
		The ETSI NFV registry of VIM-related information provides access to
		information about VimConnectionInfo definitions for various VIM
		types. The structure of the registry is defined in Annex C of SOL003.
		type: string
		interfaceInfo:
		description: >
		Information about the interface or interfaces to the VIM, if
		applicable, such as the URI of an interface endpoint to
		communicate with the VIM. The applicable keys are dependent on the
		content of vimType.
		Alternatively, such information may have been configured into the
		VNFM and bound to the vimId.
		$ref: "#/definitions/KeyValuePairs"
		accessInfo:
		description: >
		Authentication credentials for accessing the VIM, and other
		access-related information such as tenants or infrastructure
		resource groups (see note 1). The applicable keys are dependent on the
		content of vimType.
		If the VimConnectionInfo structure is part of an HTTP response
		payload body, sensitive attributes that are children of this attributes
		(such as passwords) shall not be included.
		If the VimConnectionInfo structure is part of an HTTP request payload
		body, sensitive attributes that are children of this attribute (such
		as passwords) shall be present if they have not been provisioned out
		of band.

		See note 2.
		$ref: "#/definitions/KeyValuePairs"
		extra:
		description: >
		VIM type specific additional information. The applicable structure,
		and whether or not this attribute is available, is dependent on the
		content of vimType.
		$ref: "#/definitions/KeyValuePairs"

		ResourceHandle:
		required:
		- resourceId
		type: object
		description: >
		This type represents the information that allows addressing a virtualised
		resource that is used by a VNF instance. Information about the resource
		is available from the VIM.
		This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.
		Information about the resource is available from the VIM.

		* NOTE 1: The information about the VIM connection referenced by the VIM connection id is known to the VNFM. Moreover,
		the identifier of the VIM connection provides scope to the resourceId.

		* NOTE 2: The value set of the "vimLevelResourceType" attribute is within the scope of the VIM or the resource provider
		and can be used as information that complements the ResourceHandle.

		properties:
		vimConnectionId:
		description: >
		Identifier of the VIM connection to manage the resource. This
		attribute shall only be supported and present if VNF-related resource
		management in direct mode is applicable. The applicable
		"VimConnectionInfo" structure, which is referenced by
		vimConnectionId, can be obtained from the "vimConnectionInfo"
		attribute of the "VnfInstance" structure.
		Identifier of the VIM connection to manage the resource.
		This attribute shall only be supported and present if VNF-related resource management in direct mode is applicable.
		See note 1.
		$ref: "#/definitions/Identifier"
		resourceProviderId:
		description: >
		@@ -282,15 +215,11 @@ definitions:
		$ref: "#/definitions/Identifier"
		resourceId:
		description: >
		Identifier of the resource in the scope of the VIM or the resource
		provider.
		Identifier of the resource in the scope of the VIM or the resource provider.
		$ref: "#/definitions/IdentifierInVim"
		vimLevelResourceType:
		description: >
		The value set of the "vimLevelResourceType" attribute is within the scope
		of the VIM or the resource provider and can be used as information that
		complements the ResourceHandle. This value set is different from the value
		set of the "type" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).
		Type of the resource in the scope of the VIM or the resource provider. See note 2.
		type: string

		VnfExtCpData:
		@@ -311,12 +240,12 @@ definitions:
		last key from the map removes the affected instance of the "VnfExtCpData" structure from
		its parent data structure.
		* NOTE 4: If, as defined by the input parameters of a "ChangeVnfFlavour", "ChangeExtVnfConnectivity" or
		"ChangeCurrentVnfPkg" operation or as part of the Grant response for any of these operations, a
		cpConfig map entry identified by a particular map key value is moved into another "ExtVirtualLinkData"
		or "VnfExtCpData" structure, this particular cpConfig map entry may be used by an external CP instance
		different than the one that has used it before the operation, or by no external CP instance at all.
		Renaming a CPD identifier during the "changeCurrentVnfPkg" operation does not count as moving the
		related "cpConfig" map entries to a new "extCpData" structure.
		"ChangeCurrentVnfPkg" operation, a cpConfig map entry identified by a particular map key value
		is moved into another "ExtVirtualLinkData" or "VnfExtCpData" structure, this particular cpConfig
		map entry may be used by an external CP instance different than the one that has used it before the
		operation, or by no external CP instance at all. Renaming a CPD identifier during the "changeCurrentVnfPkg"
		operation does not count as moving the related "cpConfig" map entries to a new "extCpData" structure.

		type: object
		required:
		- cpdId
		@@ -330,7 +259,7 @@ definitions:
		Map of instance data that need to be configured on the CP instances
		created from the respective CPD.
		The key of the map which identifies the individual VnfExtCpConfig entries is of type "IdentifierInVnf"
		and is managed by the API consumer.
		and is managed by the NFVO.
		The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396).
		See notes 2, 3 and 4.
		type: object
		@@ -339,31 +268,31 @@ definitions:

		VnfExtCpConfig:
		description: >
		This type represents an externally provided link port or network address
		information per instance of an external connection point. In case a link
		port is provided, the VNFM shall use that link port when connecting the
		external CP to the external VL. In a link port is not provided, the VNFM
		shall create a link port on the external VL, and use that link port to
		connect the external CP to the external VL.
		This type represents an externally provided link port or network address information per instance of an
		external connection point. In case a link port is provided, the VNFM shall use that link port when
		connecting the external CP to the external VL. In case a link port is not provided, the VNFM shall create
		a link port on the external VL, and use that link port to connect the external CP to the external VL.

		* NOTE : The following conditions apply to the attributes "linkPortId" and "cpProtocolData":
		1) Void.
		2) At least one of the "linkPortId" and "cpProtocolData" attributes shall be present for an external
		CP instance representing a subport that is to be created, or an external CP instance that is to be
		created by creating the corresponding VNFC or VNF instance during the current or a subsequent LCM
		operation, or for an existing external CP instance that is to be re-configured or added to a
		particular external virtual link.
		2) At least one of the "linkPortId" and "cpProtocolData" attributes shall be present for an external CP instance
		representing a subport that is to be created, or an external CP instance that is to be created by creating the
		corresponding VNFC or VNF instance during the current or a subsequent LCM operation, or for an existing
		external CP instance that is to be re-configured or added to a particular external virtual link.
		3) If the "linkPortId" attribute is absent, the VNFM shall create a link port.
		4) If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided referencing
		a pre created link port, and the VNFM can use means outside the scope of the present document to obtain
		the pre-configured address information for the connection point from the resource representing
		the link port.
		5) If both "cpProtocolData" and "linkportId" are provided, the API consumer shall ensure that the
		4) If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided referencing a
		precreated link port, and the VNFM can use means outside the scope of the present document to obtain the
		pre-configured address information for the connection point from the resource representing the link port.
		5) If both "cpProtocolData" and "linkportId" are provided, the NFVO shall ensure that the
		cpProtocolData can be used with the pre-created link port referenced by "linkPortId".

		anyOf:
		- required:
		- linkPortId
		- required:
		- cpProtocolData
		- required:
		- netAttDefResourceId
		type: object
		properties:
		parentCpConfigId:
		@@ -373,10 +302,11 @@ definitions:
		in "VnfExtCpConfig" structures that provide configuration information for a CP which represents a sub-port in
		a trunk, and if parent ports are supported.
		$ref: "#/definitions/IdentifierInVnf"

		linkPortId:
		description: >
		Identifier of a pre-configured link port to which the external CP
		will be associated. See note
		will be associated. See notes 1 and 4.
		$ref: "#/definitions/Identifier"

		createExtLinkPort:
		@@ -390,8 +320,8 @@ definitions:

		cpProtocolData:
		description: >
		Parameters for configuring the network protocols on the link port
		that connects the CP to a VL. See note.
		Parameters for configuring the network protocols on the link port that connects the
		CP to a VL. See note.
		type: array
		items:
		$ref: "#/definitions/CpProtocolData"
		@@ -408,15 +338,14 @@ definitions:
		properties:
		layerProtocol:
		description: >
		Identifier of layer(s) and protocol(s). See note.
		Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET See note.
		type: string
		enum:
		- IP_OVER_ETHERNET
		ipOverEthernet:
		description: >
		Network address data for IP over Ethernet to assign to the extCP
		instance. Shall be present if layerProtocol is equal to
		"IP_OVER_ETHERNET", and shall be absent otherwise.
		Network address data for IP over Ethernet to assign to the extCP instance. Shall be
		present if layerProtocol is equal to "IP_OVER_ETHERNET", and shall be absent otherwise.
		$ref: "#/definitions/IpOverEthernetAddressData"

		IpOverEthernetAddressData:
		@@ -431,7 +360,7 @@ definitions:
		of the packets or it may be an identifier used between the application and the NFVI networking
		infrastructure to identify the network sub-interface of the trunk port in question. In the latter
		case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is
		actually used by the NFVI’s transport technology.
		actually used by the NFVI's transport technology.
		type: object
		anyOf:
		- required:
		@@ -456,14 +385,13 @@ definitions:
		Specifies the encapsulation type for the traffics coming in and out of the trunk subport.
		Permitted values:
		- VLAN: the subport uses VLAN as encapsulation type.
		- INHERIT: the subport gets its segmentation type from the network it’s connected to.
		- INHERIT: the subport gets it is segmentation type from the network it’s connected to.
		This attribute may be present for CP instances that represent subports in a trunk and shall be
		absent otherwise. If this attribute is not present for a subport CP instance, default value VLAN shall be used.
		type: string
		enum:
		- VLAN
		- INHERIT

		segmentationId:
		description: >
		Identification of the network segment to which the CP instance connects to. See note 3 and note 4.
		@@ -531,14 +459,18 @@ definitions:
		ExtVirtualLinkData:
		description: >
		This type represents an external VL.
		* NOTE: A link port is not needed for an external CP instance that exposes a VIP CP in the following cases:
		1 For a VIP CP directly exposed as extCP:
		1.1 No dedicated IP address is allocated as VIP address, as indicated in the VNFD.
		1.2 A dedicated IP addresss is allocated as VIP address, but the NFVO indicates that no port
		is needed (createExtLinkPort in VnfExtCpconfig set to false).
		2 For a VIP CP exposed as extCP via a floating IP address:
		2.1 No dedicated IP address is allocated as VIP address, as indicated in the VNFD, and the VNFC
		CP associated to the VIP CP is also exposed via a floating IP addresss.
		* NOTE 1: The information about the VIM connection referenced by the VIM connection id is known to the VNFM.
		Moreover, the identifier of the VIM connection provides scope to the resourceId.

		* NOTE 2: A link port is not needed for an external CP instance that exposes a VIP CP in the following cases:
		1) For a VIP CP directly exposed as an extCP:
		1.1) No dedicated IP address is allocated as VIP address, as indicated in the VNFD.
		1.2) A dedicated IP address is allocated as VIP address, but the NFVO indicates that no port is needed
		(createExtLinkPort in VnfExtCpConfig set to false).
		2) For a VIP CP exposed as an extCP via a floating IP address:
		2.1) No dedicated IP address is allocated as VIP address, as indicated in the VNFD, and the VNFC CP
		associated to the VIP CP is also exposed via a floating IP address.

		type: object
		required:
		- id
		@@ -554,7 +486,7 @@ definitions:
		description: >
		Identifier of the VIM connection to manage this resource. This
		attribute shall only be supported and present if VNF-related
		resource management in direct mode is applicable.
		resource management in direct mode is applicable. See note 1.
		$ref: "#/definitions/Identifier"
		resourceProviderId:
		description: >
		@@ -579,15 +511,41 @@ definitions:
		$ref: "#/definitions/VnfExtCpData"
		extLinkPorts:
		description: >
		Externally provided link ports to be used to connect external
		connection points to this external VL. If this attribute is not
		present, the VNFM shall create the link ports on the external VL
		unless the extCp exposes a VIP CP and a link port is not needed
		for it based on the conditions defined below. See note.
		Externally provided link ports to be used to connect external connection points to this external
		VL. If this attribute is not present, the VNFM shall create the link ports on the external VL
		unless the extCp exposes a VIP CP and a link port is not needed for it based on the conditions
		defined below. See note 2.
		type: array
		items:
		$ref: "#/definitions/ExtLinkPortData"

		ScaleInfo:
		description: >
		This type represents the scale level of a VNF instance related to a scaling aspect.
		type: object
		required:
		- aspectId
		- scaleLevel
		properties:
		aspectId:
		description: >
		Identifier of the scaling aspect.
		$ref: "#/definitions/IdentifierInVnfd"
		vnfdId:
		description: >
		Identifier of the VNFD.
		Shall be present in case the value differs from the vnfdId
		attribute of the VnfInstance (e.g. during a "Change
		current VNF package" operation or due to its final
		failure).
		$ref: "#/definitions/IdentifierInVnfd"
		scaleToLevel:
		description: >
		Indicates the scale level. The minimum value shall be 0
		and the maximum value shall be ≤ maxScaleLevel as
		described in the VNFD.
		$ref: "#/definitions/Identifier"

		Identifier:
		description: >
		An identifier with the intention of being globally unique.
		@@ -653,7 +611,7 @@ definitions:

		IdentifierInVim:
		description: >
		An identifier maintained by the VIM or other resource provider. It is
		An identifier maintained by the VIM or the CISM or other resource provider. It is
		expected to be unique within the VIM instance.
		type: string

		@@ -760,7 +718,6 @@ definitions:
		VNF lifecycle operation types in VNF lifecycle management operation
		occurrence resources and VNF lifecycle management operation occurrence
		notifications.
		It shall comply with the provisions defined in table 5.5.4.5-1.

		Value \| Description
		------\|------------

src/SOL002/VNFConfiguration/VNFConfiguration.yaml

+37 −3

Original line number	Diff line number	Diff line
		@@ -16,11 +16,11 @@ info:
		license:
		name: ETSI Forge copyright notice
		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
		version: 1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
		version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

		externalDocs:
		description: ETSI GS NFV-SOL 002 V3.6.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.06.01_60/gs_NFV-SOL002v030601p.pdf
		description: ETSI GS NFV-SOL 002 V3.7.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.07.01_60/gs_NFV-SOL002v030701p.pdf

		servers:
		- url: http://127.0.0.1/vnfconfig/v1
		@@ -67,6 +67,9 @@ paths:
		patch:
		description: \|
		This method sets or modifies a configuration resource. See clause 9.4.2.3.4.
		parameters:
		- $ref: ../../components/SOL002_params.yaml#/components/parameters/If-Unmodified-Since
		- $ref: ../../components/SOL002_params.yaml#/components/parameters/If-Match
		requestBody:
		$ref: '#/components/requestBodies/ConfigurationRequest'
		responses:
		@@ -137,6 +140,22 @@ components:
		explode: false
		schema:
		type: string
		ETag:
		description: >
		Used to provide the current entity-tag for the selected resource representation. It can be sent in
		"200 OK", "201 Created" and "204 No Content" responses.
		style: simple
		schema:
		type: string
		Last-Modified:
		description: >
		Used to provide a timestamp indicating the date and time at which the server believes the selected resource
		representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses.
		style: simple
		schema:
		type: string
		format: date-time

		content:
		application/json:
		schema:
		@@ -160,6 +179,21 @@ components:
		explode: false
		schema:
		type: string
		ETag:
		description: >
		Used to provide the current entity-tag for the selected resource representation. It can be sent in
		"200 OK", "201 Created" and "204 No Content" responses.
		style: simple
		schema:
		type: string
		Last-Modified:
		description: >
		Used to provide a timestamp indicating the date and time at which the server believes the selected resource
		representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses.
		style: simple
		schema:
		type: string
		format: date-time
		content:
		application/json:
		schema:

src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml

+8 −18

File changed.

Preview size limit exceeded, changes collapsed.