diff --git a/src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml b/src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml index 5a493a9f22e8c6efc6ef118660143fb36f432be1..024737ce06dd2fd541a512f06a1a0a5e9eee4783 100644 --- a/src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml +++ b/src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml @@ -33,6 +33,15 @@ definitions: vnfdId: description: > Identifier of the VNFD on which the VNF instance is based. + This attribute can be modified with the PATCH method. + 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 apart from 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: > @@ -58,7 +67,39 @@ definitions: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfConfigurableProperties: description: > - Current values of the configurable properties of the VNF instance. + Additional VNF-specific attributes that provide the current values + of the configurable properties of the VNF instance. + These attributes represent values that are stored persistently in + the VnfInstance structure and that correspond to configuration + parameters of the VNF instance. + Modifying these attributes affects the configuration of the VNF + instance either directly (if the VNF instance is in INSTANTIATED + state at the time of the modification) or as part of the subsequent + VNF instantiation operation (if the VNF instance is in NOT_INSTANTIATED + state at the time of the modification). + Configurable properties referred in these attributes shall be declared + in the VNFD. + The declaration of configurable properties in the VNFD can optionally + contain the specification of initial values. + 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. + This attributeThese attributes can be modified with the PATCH method. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" instantiationState: description: > @@ -148,17 +189,47 @@ definitions: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VirtualStorageResourceInfo" metadata: description: > - Additional VNF-specific metadata describing the VNF instance. - Metadata that are writeable are declared in the VNFD. + 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 VNF provider foresees shall be declared in the VNFD. The VNFM shall + accept requests to write metadata that are not are declared in the VNFD. + + These attributes can be initialized with default values from VNFD and/or with values + passed in the CreateVnfRequest structure (see clause 5.5.2.3). + This attribute can be modified with the PATCH method. + ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" extensions: description: > - VNF specific attributes that affect the lifecycle management of this VNF instance by the VNFM, - or the lifecycle management scripts. Extensions that are writeable are declared in the VNFD. - This attribute can be modified with the PATCH method. - ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. + Additional VNF specific attributes that affect the lifecycle management of this + VNF instance by the VNFM, or the lifecycle management scripts. + 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 shall be declared in the VNFD. + This attribute can be be initialized with default values from VNFD and/or + with values passed in the InstantiateVnfRequest structure (see clause 5.5.2.4). + + A value initialised with default values from the VNFD can be updated with values + passed in the InstantiateVnfRequest structure. + + Further, these attributes can be modified with the PATCH method. + + ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on + TOSCA specifications. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" _links: description: > @@ -175,54 +246,54 @@ definitions: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" instantiate: description: > - Link to the "instantiate" task resource, if the related operation + 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" task resource, if the related operation + 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" task resource, if the related operation is + 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_to_level" task resource, if the related + 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_flavour" task resource, if the related + 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" task resource, if the related operation is + 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" task resource, if the related operation is + 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_ext_conn" task resource, if the related + 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"