SOL003 VNF Fault Management - Implementation of deltas between v4.3.1 and v3.6.1

This merge request refers to the implementation of deltas between v4.3.1 and v3.6.1 of SOL003 VNF Fault Management Interface.

@lynchpi @matsuurat @sayama @hamza @ayuba @ishaqm @reinaortega

Deadline for review: Friday 13th January 2023 @6pm CET

Merge request reports

Loading
+1 −0
Changes for SOL003/VNFFaultManagement-API/environment/variables.txt: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -39,6 +39,7 @@ ${eventType} COMMUNICATIONS_ALARM
${perceivedSeverity}    CRITICAL
${probableCause}    ""

${HEADER_TEST_SUPPORTED}    0

${response}    {}

+1 −1
Changes for SOL003/VNFFaultManagement-API/jsons/AlarmClearedNotification.json: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@
	"subscriptionId":"{subscriptionId}",
	"timeStamp":"",
	"alarmId":"{alarmId}",
	"alarmCleareTime":"",
	"alarmClearedTime":"",
	"_links":{{
		"subscription":"",
		"alarm":""
+8 −1
Changes for SOL003/VNFFaultManagement-API/jsons/AlarmNotification.json: 8 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -5,7 +5,14 @@
	"timeStamp":"",
	"alarm":{{
		"id":"",
		"managedObjectId":""
		"managedObjectId":"",
		"alarmRaisedTime":"",
		"ackState":"",
		"perceivedSeverity":"",
		"eventTime":"",
		"eventType":"",
		"probableCause":"",
		"isRootCause":"" 
	}},
	"_links":{{
		"subscription":""
+2 −4
Changes for SOL003/VNFFaultManagement-API/schemas/AlarmModification.schema.json: 2 added lines, 4 removed lines.
Original line number Diff line number Diff line
@@ -7,11 +7,9 @@
    ],
    "properties": {
      "ackState": {
        "description": "New value of the \"ackState\" attribute in \"Alarm\". Permitted values: * ACKNOWLEDGED\n",
        "description": "New value of the \"ackState\" attribute in \"Alarm\". Permitted values: * ACKNOWLEDGED * UNACKNOWLEDGED\n",
        "type": "string",
        "enum": [
          "ACKNOWLEDGED"
        ]
        "enum": ["ACKNOWLEDGED", "UNACKNOWLEDGED"]
      }
    }
  }
+50 −44
Changes for SOL003/VNFFaultManagement-API/schemas/Alarms.schema.json: 50 added lines, 44 removed lines.
Original line number Diff line number Diff line
@@ -3,12 +3,11 @@
  "items": {
    "type": "object",
    "items": {
      "description": "The alarm data type encapsulates information about an alarm.\n",
      "description": "The alarm data type encapsulates information about an alarm. \nNOTE 1: For an alarm about upcoming impact due to NFVI operation and maintenance (i.e. the attribute  \n        \"faultType\" has the value \"NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE\"), the attribute \n        \"rootCauseFaultyResource\" indicates a resource to be impacted. Further information on the upcoming\n        impact (e.g. group of impacted resources, time of impact) is provided in the attribute \"faultDetails\".\nNOTE 2: When alarms are due to upcoming NFVI operation and maintenance (i.e. the attribute \"faultType\" has the \n        value \"NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE\"), the attribute \"faultDetails\" shall include \n        information about the anticipated time of the maintenance. See provisions under the present table.\n\nIf the attribute \"faultType\" has the value \"NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE\", the following provisions  apply for the values of the attribute \"faultDetails\" related to changes in the state of virtualised resources:\n  - One of the entries in the array shall provide information about the anticipated time of maintenance in the \n  following format: \"anticipatedTime=$time\", wherein \"$time\" shall be formatted as a \"DateTime\", as specified \n  in ETSI GS NFV-SOL 013 [8]. \n  - One of the entries in the array shall provide identification information about the affinity/anti-affinity\n  group defined in the VNFD that is associated to the affected virtualised resource indicated by \n  \"rootCauseFaultyResource\" in the following format: \"affinityOrAntiAffinityGroupId=$group\", wherein \n  \"$group\" shall be equal to the \"affinityOrAntiAffinityGroupId\" value in the corresponding \"VduProfile\" (for a \n  VNFC/COMPUTE affected resource) or \"VirtualLinkProfile\" for a VL/NETWORK affected resource) in the \n  VNFD, which is mapped by the VNFM to the virtualised resource group identifier in the virtualised resource \n  change notification received by the VNFM from the VIM.\n",
      "type": "object",
      "required": [
        "id",
        "managedObjectId",
        "rootCauseFaultyResource",
        "alarmRaisedTime",
        "ackState",
        "perceivedSeverity",
@@ -30,18 +29,12 @@
        "rootCauseFaultyResource": {
          "description": "This type represents the faulty virtual resources that have a negative impact on a VNF.\n",
          "type": "object",
          "required": [
            "faultyResource",
            "faultyResourceType"
          ],
          "required": ["faultyResource", "faultyResourceType"],
          "properties": {
            "faultyResource": {
              "required": [
                "vimConnectionId",
                "resourceId"
              ],
              "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.\n",
              "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.\n* NOTE 1: The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or CISM or the resource \n          provider and can be used as information that complements the ResourceHandle. This value set is different from \n          the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2). When the container \n          infrastructure service management is a Kubernetes® instance the vimLevelResourceType is the type of \n          resource, as would correspond to the 'kind' field if the resource is declared in its own Kubernetes® manifest, \n          e.g.: Pod, PersistentVolumeClaim, NetworkAttachmentDefinition.\n\n* NOTE 2: When the container infrastructure service management is a Kubernetes® instance the resourceId shall be \n          populated in the following way:\n          - For a compute MCIO, it is the instance identifier that Kubernetes® assigns, which is unique cluster wide \n          per resource type.\n          - For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim, \n          i.e. the value of the 'claimName' field in the Kubernetes® manifest, or a compound name built by \n          Kubernetes® if the persistent volume claim is defined inline in another template instead of in its own \n          manifest.\n          - For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value of \n          the 'metadata.name' field in Kubernetes® manifest.\n",
              "properties": {
                "vimConnectionId": {
                  "description": "An identifier with the intention of being globally unique.\n",
@@ -52,11 +45,33 @@
                  "type": "string"
                },
                "resourceId": {
                  "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
                  "description": "An identifier maintained by the VIM  or the CISM or other resource provider. It is expected to be unique within the VIM instance.\n",
                  "type": "string"
                },
                "vimLevelResourceType": {
                  "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
                  "description": "Type of the resource in the scope of the VIM or the CISM or the resource provider. See note 1.\n",
                  "type": "string"
                },
                "vimLevelAdditionalResourceInfo": {
                  "description": "This type represents additional resource information which resource and resource type specific, and which is available from the VIM or the CISM or the resource provider.\n* NOTE: At least one attribute shall be present.\n",
                  "type": "object",
                  "properties": {
                    "hostName": {
                      "description": "Name of the host where the resource is allocated. It shall be present for compute resources in the scope of the CISM and shall be absent otherwise. See note.\n",
                      "type": "string"
                    },
                    "persistentVolume": {
                      "description": "Name of the persistent volume to which the persistent volume claim representing the storage resource is bound. It may be present for storage resources in the scope of the CISM and shall be absent otherwise. See note.\n",
                      "type": "string"
                    },
                    "additionalInfo": {
                      "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
                      "type": "object"
                    }
                  }
                },
                "containerNamespace": {
                  "description": "The value of the namespace in which the MCIO corresponding to the resource is deployed. This attribute shall be present if the resource is managed by a CISM and it shall be absent otherwise.\n",
                  "type": "string"
                }
              }
@@ -64,11 +79,7 @@
            "faultyResourceType": {
              "description": "The enumeration FaultyResourceType represents those types of faulty resource.\n",
              "type": "string",
              "enum": [
                "COMPUTE",
                "STORAGE",
                "NETWORK"
              ]
              "enum": ["COMPUTE", "STORAGE", "NETWORK"]
            }
          }
        },
@@ -87,15 +98,18 @@
          "type": "string",
          "format": "date-time"
        },
        "alarmAcknowledgedTime": {
          "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
          "type": "string",
          "format": "date-time"
        },
        "ackState": {
          "description": "Acknowledgement state of the alarm. Permitted values: * UNACKNOWLEDGED * ACKNOWLEDGED.\n",
          "type": "string",
          "enum": [
            "UNACKNOWLEDGED",
            "ACKNOWLEDGED"
          ]
          "enum": ["UNACKNOWLEDGED", "ACKNOWLEDGED"]
        },
        "perceivedSeverity": {
          "description": "Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service\n  affecting condition has occurred and an immediate corrective action\n  is required. Such a severity can be reported, for example, when a\n  managed object becomes totally out of service and its capability needs\n  to be restored (ITU-T Recommendation X.733).\n* MAJOR: The Major severity level indicates that a service affecting\n  condition has developed and an urgent corrective action is required.\n  Such a severity can be reported, for example, when there is a severe\n  degradation in the capability of the managed object and its full\n  capability needs to be restored (ITU-T Recommendation X.733).\n* MINOR: The Minor severity level indicates the existence of a\n  non-service affecting fault condition and that corrective action\n  should be taken in order to prevent a more serious (for example,\n  service affecting) fault. Such a severity can be reported, for\n  example, when the detected alarm condition is not currently degrading\n  the capacity of the managed object (ITU-T Recommendation X.733).\n* WARNING: The Warning severity level indicates the detection of a\n  potential or impending service affecting fault, before any significant\n  effects have been felt. Action should be taken to further diagnose (if\n  necessary) and correct the problem in order to prevent it from\n  becoming a more serious service affecting fault (ITU-T Recommendation\n  X.733).\n* INDETERMINATE: The Indeterminate severity level indicates that the\n  severity level cannot be determined (ITU-T Recommendation X.733).\n* CLEARED: The Cleared severity level indicates the clearing of one or\n  more previously reported alarms. This alarm clears all alarms for this\n  managed object that have the same Alarm type, Probable cause and\n  Specific problems (if given) (ITU-T Recommendation X.733).\n",
          "type": "string",
          "enum": [
            "CRITICAL",
@@ -112,7 +126,7 @@
          "format": "date-time"
        },
        "eventType": {
          "description": "The enumeration EventType represents those types of events that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of this type is associated with the  procedure and/or process required conveying information from one point\n  to another (ITU-T Recommendation X.733).\n* PROCESSING_ERROR_ALARM: An alarm of this type is associated with a  software or processing fault (ITU-T Recommendation X.733).\n* ENVIRONMENTAL_ALARM: An alarm of this type is associated with a  condition related to an enclosure in which the equipment resides\n  (ITU-T Recommendation X.733).\n* QOS_ALARM: An alarm of this type is associated with degradation in the  quality of a service (ITU-T Recommendation X.733).\n* EQUIPMENT_ALARM: An alarm of this type is associated with an equipment  fault (ITU-T Recommendation X.733).\n",
          "description": "The enumeration EventType represents those types of events that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of this type is associated with the\n  procedure and/or process required conveying information from one point\n  to another (ITU-T Recommendation X.733).\n* PROCESSING_ERROR_ALARM: An alarm of this type is associated with a\n  software or processing fault (ITU-T Recommendation X.733).\n* ENVIRONMENTAL_ALARM: An alarm of this type is associated with a\n  condition related to an enclosure in which the equipment resides\n  (ITU-T Recommendation X.733).\n* QOS_ALARM: An alarm of this type is associated with degradation in the\n  quality of a service (ITU-T Recommendation X.733).\n* EQUIPMENT_ALARM: An alarm of this type is associated with an equipment\n  fault (ITU-T Recommendation X.733).\n",
          "type": "string",
          "enum": [
            "COMMUNICATIONS_ALARM",
@@ -123,15 +137,15 @@
          ]
        },
        "faultType": {
          "description": "Additional information to clarify the type of the fault.\n",
          "description": "Additional information to clarify the type of the fault. If the alarm is related to changes in the state of virtualised resources  due to NFVI operation and maintenance, this attribute shall be set to  \"NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE\".\n",
          "type": "string"
        },
        "probableCause": {
          "description": "Information about the probable cause of the fault.\n",
          "description": "Information about the probable cause of the fault. If the attribute \"faultType\" has the value “NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE”, the permitted values are: \n  - \"NFVI_COMPONENT_MAINTENANCE\": Maintenance of NFVI components, e.g. \n    physical maintenance/repair, hypervisor software updates, etc.\n  - \"NFVI_COMPONENT_EVACUATION\": Evacuation of physical hosts.\n  - \"NFVI_COMPONENT_OPTIMIZATION\": Operation and management of NFVI resources, e.g.\n    to support energy efficiency or resource usage.\n",
          "type": "string"
        },
        "isRootCause": {
          "description": "Attribute indicating if this fault is the root for other correlated alarms. If TRUE, then the alarms listed in the attribute CorrelatedAlarmId are caused by this fault.\n",
          "description": "Attribute indicating if this fault is the root for other correlated alarms. If true, then the alarms listed in the attribute \"correlatedAlarmIds\" are caused by this fault.\n",
          "type": "boolean"
        },
        "correlatedAlarmIds": {
@@ -143,7 +157,7 @@
          }
        },
        "faultDetails": {
          "description": "Provides additional information about the fault.\n",
          "description": "Provides additional information about the fault. See notes 1 and 2.\n",
          "type": "array",
          "items": {
            "type": "string"
@@ -152,35 +166,27 @@
        "_links": {
          "description": "Links for this resource.\n",
          "type": "object",
          "required": [
            "self"
          ],
          "required": ["self"],
          "properties": {
            "self": {
              "description": "This type represents a link to a resource.\n",
              "description": "This type represents a link to a resource using an absolute URI.\n",
              "type": "object",
              "required": [
                "href"
              ],
              "required": ["href"],
              "properties": {
                "href": {
                  "description": "URI of the referenced resource.\n",
                  "type": "string",
                  "format": "url"
                  "description": "String formatted according to IETF RFC 3986.\n",
                  "type": "string"
                }
              }
            },
            "objectInstance": {
              "description": "This type represents a link to a resource.\n",
              "description": "This type represents a link to a resource using an absolute URI.\n",
              "type": "object",
              "required": [
                "href"
              ],
              "required": ["href"],
              "properties": {
                "href": {
                  "description": "URI of the referenced resource.\n",
                  "type": "string",
                  "format": "url"
                  "description": "String formatted according to IETF RFC 3986.\n",
                  "type": "string"
                }
              }
            }
Loading
Loading