SOL005: v2.8.1 review fixes (f8671fbc) · Commits · NFV - Network Functions Virtualisation / SOL005

src/SOL005/NSDManagement/NSDManagement.yaml

+21 −15

Original line number	Diff line number	Diff line
		@@ -828,16 +828,22 @@ paths:
		• If the "Accept" header contains both "text/plain" and "application/zip", it is up
		to the NFVO to choose the format to return for a single-file NSD; for a multi-file NSD,
		a ZIP file shall be returned.
		The default format of the ZIP file shall be the one specified in ETSI GS NFV-SOL 007
		where only the YAML files representing the NSD, and information necessary to navigate
		the ZIP file and to identify the file that is the entry point for parsing the NSD and
		(if requested) further security information are included. This means that the content
		of the ZIP archive shall contain the following files from the NSD archive:
		• TOSCA.meta (if available in the NSD archive);
		• the main service template (either as referenced from TOSCA.meta or available as a
		file with the extension ".yml" or ".yaml" from the root of the archive);
		• every component of the NSD referenced (recursively) from the main service template;
		• the related security information, if the "include_signatures" URI parameter is provided, as follows:
		The default format of the ZIP file shall comply with the CSAR format as specified in ETSI GS NFV-SOL 007
		where only the YAML files representing the NSD, and information necessary to navigate the ZIP file and to
		identify the file that is the entry point for parsing the NSD and (if requested) further security information
		are included, and other artifacts referenced from the YAML files are excluded. This means that the content of
		the ZIP archive shall contain the following files from the NSD archive:
		- TOSCA.meta (if available in the NSD archive);
		- the main TOSCA definitions YAML file (either as referenced from TOSCA.meta or available as a file with the
		extension ".yml" or ".yaml" from the root of the archive);
		- every component of the NSD referenced (recursively) from the main TOSCA definitions YAML file;

		NOTE 1: For a NSD based on TOSCA, it includes all the imported type definition files as indicated in the top
		level service template and in any of the lower level service template if it has any as described in ETSI GS NFV-SOL 001.
		NOTE 2: For a NSD based on YANG, it includes the file as indicated by the "yang_definitions" keyname in the metadata
		section of the main yaml file as described in ETSI GS NFV-SOL 007.

		- the related security information, if the "include_signatures" URI parameter is provided, as follows:
		- the manifest file;
		- the singleton certificate file in the root of the NSD archive (if available in the NSD archive);
		- the signing certificates of the individual files included in the ZIP archive

src/SOL005/NSFaultManagement/NSFaultManagement.yaml

+15 −15

Original line number	Diff line number	Diff line
		@@ -324,20 +324,20 @@ paths:
		406:
		$ref: "../responses/SOL005_resp.yaml#/responses/406"
		409:
		description: >
		409 CONFLICT
		#description: >
		# 409 CONFLICT

		Shall be returned upon the following error: The
		operation cannot be executed currently, due to a
		conflict with the state of the "Individual alarm"
		resource.
		Typically, this is due to the fact that the alarm is
		already in the state that is requested to be set (such
		as trying to acknowledge an already-acknowledged
		alarm).
		The response body shall contain a ProblemDetails
		structure, in which the "detail" attribute shall convey
		more information about the error.
		# Shall be returned upon the following error: The
		# operation cannot be executed currently, due to a
		# conflict with the state of the "Individual alarm"
		# resource.
		# Typically, this is due to the fact that the alarm is
		# already in the state that is requested to be set (such
		# as trying to acknowledge an already-acknowledged
		# alarm).
		# The response body shall contain a ProblemDetails
		# structure, in which the "detail" attribute shall convey
		# more information about the error.
		$ref: "../responses/SOL005_resp.yaml#/responses/409"
		412:
		$ref: "../responses/SOL005_resp.yaml#/responses/412"
		@@ -371,8 +371,8 @@ paths:
		The POST method creates a new subscription.
		This method shall follow the provisions specified in the Tables 8.4.4.3.1-1 and 8.4.4.3.1-2 for URI query
		parameters, request and response data structures, and response codes.
		As the result of successfully executing this method, a new "Individual subscription" resource shall exist
		as defined in clause 8.4.5. This method shall not trigger any notification.
		As the result of successfully executing this method, a new "Individual subscription" resource as defined in
		clause 8.4.5 shall have been created. This method shall not trigger any notification.
		Creation of two subscription resources with the same callbackURI and the same filter can result in performance
		degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare
		use cases. Consequently, the NFVO may either allow creating a subscription resource if another subscription

src/SOL005/NSFaultManagementNotification/definitions/SOL005NSFaultManagementNotification_def.yaml

+2 −1

Original line number	Diff line number	Diff line
		@@ -119,7 +119,8 @@ definitions:
		description: >
		This type represents a notification that the alarm list has been rebuilt, e.g. if the NFVO detects its storage holding the
		alarm list is corrupted. It shall comply with the provisions defined in Table 8.5.2.7-1.
		The notification shall be triggered by the NFVO when the alarm list has been rebuilt.
		The notification shall be triggered by the NFVO when the alarm list has been rebuilt,
		e.g. because the NFVO has detected that its storage holding the alarm list was corrupted.
		type: object
		required:
		- id

src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml

+23 −37

Original line number	Diff line number	Diff line
		@@ -404,8 +404,6 @@ definitions:
		Identifier of information held by the NFVO about
		the specific VNF package on which the VNF is
		based. This identifier has been allocated by the NFVO.
		This attribute can be modified with the PATCH
		method.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
		vnfConfigurableProperties:
		description: >
		@@ -548,38 +546,28 @@ definitions:
		$ref: "#/definitions/VirtualStorageResourceInfo"
		metadata:
		description: >
		Additional VNF-specific attributes that provide
		metadata describing the VNF instance.
		Metadata that are writeable are declared in the
		VNFD (see note 2).
		These attributes represent values that are
		stored persistently in the VnfInstance structure
		for consumption by functional blocks that
		invoke the VNF lifecycle management
		interface. They are not consumed by the
		VNFM, or the lifecycle management scripts.
		Modifying the values of these attributes has no
		effect on the VNF instance, it only affects the
		information represented in the VnfInstance
		structure.
		Metadata that the VNF provider foresees are
		expected to be declared in the VNFD (see note 2).
		Modifications to these attributes can be
		requested using the "ModifyVnfInfoData" structure.
		Additional VNF-specific attributes that provide metadata describing the VNF instance.
		These attributes represent values that are stored persistently in the VnfInstance structure
		for consumption by functional blocks that invoke the VNF lifecycle management interface.
		They are not consumed by the VNFM, or the lifecycle management scripts.
		Modifying the values of these attributes has no effect on the VNF instance, it only affects
		the information represented in the VnfInstance structure.
		Metadata that the VNF provider foresees are expected to be declared in the VNFD (see note 2).
		Modifications to these attributes can be requested using the "ModifyVnfInfoData" structure.

		NOTE 2: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
		extensions:
		description: >
		Additional VNF-specific attributes that affect the lifecycle management of this VNF instance.
		These attributes represent values that are stored persistently in the VnfInstance structure
		for consumption by the VNFM, or by the lifecycle management scripts. during the execution
		of VNF lifecycle management operations.
		Modifying the values of these attributes has no direct effect on the VNF instance; however,
		the modified attribute values can be considered during subsequent VNF lifecycle management
		operations, which means that the modified values can indirectly affect the configuration of the VNF instance.
		These attributes represent values that are stored persistently in the VnfInstance structure for
		consumption by the VNFM or by the lifecycle management scripts during the execution of VNF lifecycle
		management operations.
		Modifying the values of these attributes has no direct effect on the VNF instance; however, the modified
		attribute values can be considered during subsequent VNF lifecycle management operations, which means that
		the modified values can indirectly affect the configuration of the VNF instance.
		All extensions that are allowed for the VNF are declared in the VNFD.
		Modifications to these attributes can be
		requested using the "ModifyVnfInfoData" structure.
		ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
		Modifications to these attributes can be requested using the "ModifyVnfInfoData" structure.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

		LccnLinks:
		@@ -3618,10 +3606,10 @@ definitions:
		to a given level, or to scale a VNF instance by steps.
		type: object
		required:
		- vnfInstanceid
		- vnfInstanceId
		- scaleVnfType
		properties:
		vnfInstanceid:
		vnfInstanceId:
		description: >
		Identifier of the VNF instance being scaled.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
		@@ -3796,7 +3784,8 @@ definitions:

		LcmOpNameForChangeNotificationType:
		description: >
		The enumeration LcmOpNameForChangeNotificationType represents the name of the lifecycle operation that impacts the NS component and trigger an NS change notification. It shall comply with the provisions defined in Table 6.5.4.6-1.
		The enumeration LcmOpNameForChangeNotificationType represents the name of the lifecycle operation that impacts the NS component and
		trigger an NS change notification. It shall comply with the provisions defined in Table 6.5.4.6-1.
		Value \| Description
		------\|------------
		VNF_INSTANTIATE \| Represents the "Instantiate VNF" LCM operation.
		@@ -3839,7 +3828,8 @@ definitions:
		------\|------------
		START \| The impact on the NS component is identified.
		COMPLETED \| The impact on the NS component stops and related lifecycle operation completes successfully.
		PARTIALLY_COMPLETED \| The impact on the NS component stops and related lifecycle operation partially completes. Inconsistency state may exist on the NS component.
		PARTIALLY_COMPLETED \| The impact on the NS component stops and related lifecycle operation partially completes.
		Inconsistency state may exist on the NS component.
		FAILED \| The impact on the NS component stops and related lifecycle operation fails. Inconsistency state may exist for the NS component.
		ROLLED_BACK \| The impact on the NS component stops and related lifecycle operation is rolled back.
		type: string
		@@ -4301,8 +4291,6 @@ definitions:
		* At least one of these attributes shall be present for a
		to-be-created external CP instance or an existing external
		CP instance.
		* If the "linkPortId" attribute is absent, the VNFM shall create a
		link port.
		* 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
		@@ -4324,8 +4312,6 @@ definitions:
		* At least one of these attributes shall be present for a
		to-be-created external CP instance or an existing external
		CP instance.
		* If the "linkPortId" attribute is absent, the VNFM shall create a
		link port.
		* 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

src/SOL005/NSLifecycleManagementNotification/definitions/SOL005NSLifecycleManagementNotification_def.yaml

+6 −4

Original line number	Diff line number	Diff line
		@@ -165,7 +165,9 @@ definitions:
		$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
		nsInstanceId:
		description: >
		The created NS instance identifier
		The created NS instance identifier. Shall be set to the same "id"
		attribute value of the associated "NsInstance" representation of
		the "Individual NS instance" resource.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
		_links:
		description: >
		@@ -205,7 +207,7 @@ definitions:
		$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
		nsInstanceId:
		description: >
		The created NS instance identifier. Shall be set to the
		The deleted NS instance identifier. Shall be set to the
		same "id" attribute value of the associated "NsInstance"
		representation of the "Individual NS instance" resource.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
		@@ -276,7 +278,7 @@ definitions:
		associated to the notification and
		impacts the NS component directly or
		indirectly.
		$ref: "#/definitions/LcmOpNameForChangeNotificationType"
		$ref: "../../NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LcmOpNameForChangeNotificationType"
		lcmOpOccStatusImpactingNsComponent:
		description: >
		Indicates this status of the lifecycle
		@@ -284,7 +286,7 @@ definitions:
		associated to the notification and
		impacts the NS component directly or
		indirectly.
		$ref: "#/definitions/LcmOpOccStatusForChangeNotificationType"
		$ref: "../../NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LcmOpOccStatusForChangeNotificationType"
		notificationType:
		description: >
		Discriminator for the different