SOL003: fixing broken references (1c9ee83a) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml

+23 −11

Original line number	Diff line number	Diff line
		@@ -109,7 +109,7 @@ paths:
		- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
		responses:
		200:
		$ref: '#/components/responses/VNFInstances.Get.20'
		$ref: '#/components/responses/VNFInstances.Get.200'
		400:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
		401:
		@@ -1773,7 +1773,7 @@ paths:
		for URI query parameters, request and response data structures, and response codes.
		parameters:
		- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
		- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Range
		- $ref: '#/components/parameters/Range'
		responses:
		200:
		$ref: '#/components/responses/IndividualVnfSnapshotState.Get.200'
		@@ -1857,6 +1857,19 @@ components:
		schema:
		type: string

		Range:
		name: Range
		in: header
		description: \|
		The request may contain a "Range" HTTP header to obtain single
		range of bytes from a VNF state snapshot file. This can be used to
		continue an aborted transmission.
		If the "Range" header is present in the request and the VNFM
		does not support responding to range requests with a 206
		response, it shall return a 200 OK response instead.
		schema:
		type: string

		requestBodies:
		CreateVnfRequest:
		description: The VNF creation parameters
		@@ -2038,7 +2051,7 @@ components:
		content:
		application/json:
		schema:
		$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
		$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"

		VNFInstances.Get.200:
		description: \|
		@@ -2088,7 +2101,7 @@ components:
		schema:
		type: array
		items:
		$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
		$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"

		IndividualVnfInstance.Get.200:
		description: \|
		@@ -2121,7 +2134,7 @@ components:
		content:
		application/json:
		schema:
		$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
		$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"

		IndividualVnfInstance.Patch.202:
		description: \|
		@@ -2165,7 +2178,7 @@ components:
		content:
		application/json:
		schema:
		$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
		$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"

		IndividualVnfInstance.Delete.204:
		description: \|
		@@ -2924,7 +2937,7 @@ components:
		content:
		application/json:
		schema:
		$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
		$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"

		VnfSnapshots.Get.200:
		description: \|
		@@ -2970,7 +2983,7 @@ components:
		schema:
		type: array
		items:
		$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
		$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"

		IndividualVnfSnapshot.Get.200:
		description: \|
		@@ -3006,7 +3019,7 @@ components:
		schema:
		type: array
		items:
		$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
		$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"

		IndividualVnfSnapshot.Patch.200:
		description: \|
		@@ -3102,7 +3115,6 @@ components:
		type: string
		format: binary


		IndividualVnfSnapshotState.Get.206:
		description: \|
		206 PARTIAL CONTENT

src/SOL003/VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml

+16 −337

Original line number	Diff line number	Diff line
		@@ -2,343 +2,6 @@
		# https://forge.etsi.org/etsi-forge-copyright-notice.txt

		definitions:
		VnfInstance:
		description: >
		This type represents a VNF instance.
		type: object
		required:
		- id
		- vnfdId
		- vnfProvider
		- vnfProductName
		- vnfSoftwareVersion
		- vnfdVersion
		- instantiationState
		properties:
		id:
		description: >
		Identifier of the VNF instance.
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		vnfInstanceName:
		description: >
		Name of the VNF instance.
		This attribute can be modified with the PATCH method.
		type: string
		vnfInstanceDescription:
		description: >
		Human-readable description of the VNF instance.
		This attribute can be modified with the PATCH method.
		type: string
		vnfdId:
		description: >
		Identifier of the VNFD on which the VNF instance is based.

		Modifying the value of this attribute shall not be performed when conflicts
		exist between the previous and the newly referred VNF package,
		i.e. when the new VNFD is not changed with respect to the previous VNFD
		in other aspects than merely referencing to other VNF software images.
		In order to avoid misalignment of the VnfInstance with the current VNF's
		on-boarded VNF Package, the values of attributes in the VnfInstance that
		have corresponding attributes in the VNFD shall be kept in sync with the values in the VNFD.
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		vnfProvider:
		description: >
		Provider of the VNF and the VNFD. The value is copied from the VNFD.
		type: string
		vnfProductName:
		description: >
		Name to identify the VNF Product. The value is copied from the VNFD.
		type: string
		vnfSoftwareVersion:
		description: >
		Software version of the VNF. The value is copied from the VNFD.
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
		vnfdVersion:
		description: >
		Identifies the version of the VNFD. The value is copied from the VNFD.
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
		vnfConfigurableProperties:
		description: >
		Current values of the configurable properties of the VNF instance.
		Configurable properties referred in this attribute are declared in
		the VNFD.
		ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD
		based on TOSCA specifications.
		VNF configurable properties are sometimes also referred to as
		configuration parameters applicable to a VNF. Some of these are set
		prior to instantiation and cannot be modified if the VNF is
		instantiated, some are set prior to instantiation (are part of
		initial configuration) and can be modified later, and others can be
		set only after instantiation. The applicability of certain
		configuration may depend on the VNF and the required operation of
		the VNF at a certain point in time.
		These configurable properties include the following standard
		attributes, which are declared in the VNFD if auto-scaling and/or
		auto-healing are supported by the VNF:
		* isAutoscaleEnabled: If present, the VNF supports auto-scaling. If
		set to true, auto-scaling is currently enabled. If set to false,
		auto-scaling is currently disabled.
		* isAutohealEnabled: If present, the VNF supports auto-healing. If
		set to true, auto-healing is currently enabled. If set to false,
		auto-healing is currently disabled.
		These configurable properties can be initialized with default values
		from the VNFD.
		Configurable properties can be modified with values passed in the request
		structures of certain LCM operations, such as the InstantiateVnfRequest
		structure.
		Further, these configurable properties can be created, modified or
		deleted with the PATCH method.

		NOTE: Upon creation of the VnfInstance structure, the VNFM shall create and initialize all child attributes
		of "vnfConfigurableProperties", "metadata" and "extensions" that were declared in the VNFD with a defined
		initial value. The defined initial values can be declared in the VNFD, and/or, in case of "metadata",
		obtained from the "CreateVnfRequest" structure. Child attributes of "vnfConfigurableProperties", "metadata"
		and "extensions" that have no defineddeclared initial value shall not be created, in order to be consistent
		with the semantics of the JSON Merge Patch method (see IETF RFC 7396) that interprets null values as deletion
		request.
		$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.
		type: array
		items:
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
		instantiationState:
		description: >
		The instantiation state of the VNF.
		type: string
		enum:
		- NOT_INSTANTIATED
		- INSTANTIATED
		instantiatedVnfInfo:
		description: >
		Information specific to an instantiated VNF instance. This attribute
		shall be present if the instantiateState attribute value is
		INSTANTIATED.
		type: object
		required:
		- flavourId
		- vnfState
		properties:
		flavourId:
		description: >
		Identifier of the VNF deployment flavour applied to this VNF instance.
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
		vnfState:
		description: >
		The state of the VNF instance.
		$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.
		See clause B.2 for an explanation of VNF scaling.
		type: array
		items:
		$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleInfo"
		maxScaleLevels:
		description: >
		Maximum allowed scale levels of the VNF, one entry per aspect.
		This attribute shall be present if the VNF supports scaling.
		type: array
		items:
		$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleInfo"
		extCpInfo:
		description: >
		Information about the external CPs exposed by the VNF instance. When trunking is enabled,
		the list of entries includes both, external CPs corresponding to parent ports of a trunk,
		and external CPs associated to sub-ports of a trunk.
		type: array
		minItems: 1
		items:
		$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfExtCpInfo"
		extVirtualLinkInfo:
		description: >
		Information about the external VLs the VNF instance is connected to.
		type: array
		items:
		$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo"
		extManagedVirtualLinkInfo:
		description: >
		Information about the externally-managed internal VLs of the VNF instance.

		NOTE: It is possible to have several ExtManagedVirtualLinkInfo for the same
		VNF internal VL in case of a multi-site VNF spanning several VIMs. The set of
		ExtManagedVirtualLinkInfo 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 5.5.3.3).
		type: array
		items:
		$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtManagedVirtualLinkInfo"
		monitoringParameters:
		description: >
		Active monitoring parameters.
		type: array
		items:
		$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/MonitoringParameter"
		localizationLanguage:
		description: >
		Information about localization language of the VNF (includes e.g.
		strings in the VNFD). The localization languages supported by a VNF
		can be declared in the VNFD, and localization language selection can
		take place at instantiation time.
		The value shall comply with the format defined in IETF RFC 5646.
		type: string
		vnfcResourceInfo:
		description: >
		Information about the virtualised compute and storage resources used
		by the VNFCs of the VNF instance.
		type: array
		items:
		$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcResourceInfo"
		virtualLinkResourceInfo:
		description: >
		Information about the virtualised network resources used by the VLs
		of the VNF instance.
		type: array
		items:
		$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfVirtualLinkResourceInfo"
		virtualStorageResourceInfo:
		description: >
		Information on the virtualised storage resource(s) used as storage for the VNF instance.
		type: array
		items:
		$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VirtualStorageResourceInfo"
		metadata:
		description: >
		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 are writeable are the VNF provider foresees are expected to be declared in the VNFD.
		The declaration of metadata in the VNFD can optionally contain the specification of initial values.
		The VNFM shall accept requests to write metadata that are not declared in the VNFD.
		These attributes can be initialized with default values from the VNFD or with values
		passed in the CreateVnfRequest structure (see clause 5.4.2.3.1).
		This attributeThese attributes can be created, modified or removed with the PATCH method.

		ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
		Upon creation of the VnfInstance structure, the VNFM shall create and initialize all child attributes
		of "vnfConfigurableProperties", "metadata" and "extensions" that were declared in the VNFD with
		a defined initial value. Child attributes of "vnfConfigurableProperties", "metadata" and "extensions"
		that have no declared initial value shall not be created, in order to be consistent with the semantics
		of the JSON Merge Patch method (see IETF RFC 7396) that interprets null values as deletion request.
		$ref: "../../../definitions/SOL002SOL003_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 the lifecycle management scripts during the execution of
		VNF lifecycle management operations.
		All extensions that are allowed for the VNF are declared in the VNFD. The declaration of an extension
		in the VNFD contains information on whether its presence is optional or required, and optionally
		can specify an initial value. See note 2 and note 4. The VNFM shall reject requests to write extension
		attributes that are not declared in the VNFD with a "422 Unprocessable entity" error response as defined
		in clause 6.4 of ETSI GS NFV-SOL 013.
		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 can be initialized with default values from the VNFD.
		These attributes can be modified with values passed in the request structures of certain LCM operations,
		such as the InstantiateVnfRequest structure.
		Further, these attributes can be created, modified or deleted with the PATCH method.

		NOTE: Upon creation of the VnfInstance structure, the VNFM shall create and initialize all child attributes
		of "vnfConfigurableProperties", "metadata" and "extensions" that were declared in the VNFD with a defined
		initial value. The defined initial values can be declared in the VNFD, and/or, in case of "metadata",
		obtained from the "CreateVnfRequest" structure. Child attributes of "vnfConfigurableProperties", "metadata"
		and "extensions" that have no defineddeclared initial value shall not be created, in order to be consistent
		with the semantics of the JSON Merge Patch method (see IETF RFC 7396) that interprets null values as deletion
		request.
		_links:
		description: >
		Links to resources related to this resource.
		type: object
		required:
		- self
		properties:
		self:
		description: URI of this resource.
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
		indicators:
		description: Indicators related to this VNF instance, if applicable.
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
		instantiate:
		description: >
		Link to the "Instantiate VNF task" resource, if the related operation
		is possible based on the current status of this VNF instance
		resource (i.e. VNF instance in NOT_INSTANTIATED state).
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
		terminate:
		description: >
		Link to the "Terminate VNF task" resource, if the related operation
		is possible based on the current status of this VNF instance
		resource (i.e. VNF instance is in INSTANTIATED state).
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
		scale:
		description: >
		Link to the "Scale VNF task" resource, if the related operation is
		supported for this VNF instance, and is possible based on the
		current status of this VNF instance resource (i.e. VNF instance
		is in INSTANTIATED state).
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
		scaleToLevel:
		description: >
		Link to the "Scale VNF to level task" resource, if the related
		operation is supported for this VNF instance, and is possible
		based on the current status of this VNF instance resource
		(i.e. VNF instance is in INSTANTIATED state).
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
		changeFlavour:
		description: >
		Link to the "Change VNF flavour task" resource, if the related
		operation is supported for this VNF instance, and is possible
		based on the current status of this VNF instance resource
		(i.e. VNF instance is in INSTANTIATED state).
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
		heal:
		description: >
		Link to the "Heal VNF task" resource, if the related operation is
		supported for this VNF instance, and is possible based on the
		current status of this VNF instance resource
		(i.e. VNF instance is in INSTANTIATED state).
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
		operate:
		description: >
		Link to the "Operate VNF task" resource, if the related operation is
		supported for this VNF instance, and is possible based on the
		current status of this VNF instance resource
		(i.e. VNF instance is in INSTANTIATED state).
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
		changeExtConn:
		description: >
		Link to the "Change external VNF connectivity task" resource, if the related
		operation is possible based on the current status of this VNF
		instance resource (i.e. VNF instance is in INSTANTIATED state).
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
		createSnapshot:
		description: >
		Link to the "Create VNF snapshot task" resource, if the related operation is
		supported for this VNF instance and is possible based on the current status of
		this VNF instance resource (i.e., VNF instance is in INSTANTIATED state).
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
		revertToSnapshot:
		description: >
		Link to the "Revert to VNF snapshot task" resource, if the related operation is
		supported for this VNF instance and is possible based on the current status of
		this VNF instance resource (i.e., VNF instance is in INSTANTIATED state).
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"

		InstantiateVnfRequest:
		#SOL003 location: 5.5.2.4
		type: object
		@@ -875,6 +538,22 @@ definitions:
		Information about the VNF snapshot, content and/or reference to its content.
		$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshot"

		RevertToVnfSnapshotRequest:
		description: >
		This type represents request parameters for the "Revert to VNF Snapshot" operation.
		type: object
		properties:
		vnfSnapshotInfoId:
		description: >
		Identifier of the "Individual VNF snapshot" resource with the information of the VNF snapshot
		to be reverted to.
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		additionalParams:
		description: >
		Additional input parameters for the revert to VNF snapshot process, specific for the VNF being
		“reverted”, as declared in the VNFD as part of “RevertToSnapshotVnfOpConfig”.
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

		VnfSnapshotInfoModificationRequest:
		description: \|
		This type represents attribute modifications for an "Individual VNF snapshot" resource, i.e. modifications

src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml

+3 −3

File changed.

Preview size limit exceeded, changes collapsed.

src/SOL003/VNFLifecycleOperationGranting/definitions/SOL003VNFLifecycleOperationGranting_def.yaml

+1 −1

Original line number	Diff line number	Diff line
		@@ -463,7 +463,7 @@ definitions:
		Information to identify a snapshot resource. Shall only be present if the
		operation to be granted concerns to creating a VNF snapshot from the VNF
		or to reverting the VNF to a VNF snapshot.
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/SnapshotResourceDefinition"
		$ref: "#/definitions/SnapshotResourceDefinition"

		GrantInfo:
		description: >

src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml

+9 −9

File changed.

Preview size limit exceeded, changes collapsed.

Admin message