Fix typo and inconsistency
[doctor.git] / docs / requirements / 05-implementation.rst
index 1f1b4a7..e0753bd 100644 (file)
@@ -1,3 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
 Detailed architecture and interface specification
 =================================================
 
@@ -118,10 +121,9 @@ The detailed work flow for fault management is as follows (see also :numref:`fig
    affected resources, for example migrate/update/terminate specific
    resource(s). After reception of such instructions, the VIM is executing the
    requested action, e.g. it will migrate or terminate a virtual resource.
-
-   a. Query request from Consumer to VIM to get information about the current
+a. Query request from Consumer to VIM to get information about the current
    status of a resource.
-   b. Response to the query request with information about the current status of
+b. Response to the query request with information about the current status of
    the queried resource. In case the resource is in "fault" state, information
    about the related fault(s) is returned.
 
@@ -164,6 +166,11 @@ the 4 building blocks introduced in :ref:`impl_fb`.
 
 NFVI Maintenance
 ^^^^^^^^^^^^^^^^
+.. figure:: images/figure9.png
+   :name: figure9
+   :width: 100%
+
+   NFVI maintenance work flow
 
 The detailed work flow for NFVI maintenance is shown in :numref:`figure9`
 and has the following steps. Note that steps 1, 2, and 5 to 8a in the NFVI
@@ -180,25 +187,18 @@ flow and share a similar implementation plan in Release 1.
 6. Maintenance notification to Consumer.
 7. The Consumer switches to standby configuration (STBY)
 8. Instructions from Consumer to VIM requesting certain recovery actions to be
-   performed (step 7a). After reception of such instructions, the VIM is
+   performed (step 8a). After reception of such instructions, the VIM is
    executing the requested action in order to empty the physical resources (step
-   7b).
+   8b).
 9. Maintenance response from VIM to inform the Administrator that the physical
    machines have been emptied (or the operation resulted in an error state).
 10. Administrator is coordinating and executing the maintenance operation/work
     on the NFVI.
-
-    A) Query request from Administrator to VIM to get information about the
-    current state of a resource.
-    B) Response to the query request with information about the current state of
-    the queried resource(s). In case the resource is in "maintenance" state,
-    information about the related maintenance operation is returned.
-
-.. figure:: images/figure9.png
-   :name: figure9
-   :width: 100%
-
-   NFVI maintenance work flow
+a) Query request from Administrator to VIM to get information about the
+   current state of a resource.
+b) Response to the query request with information about the current state of
+   the queried resource(s). In case the resource is in "maintenance" state,
+   information about the related maintenance operation is returned.
 
 .. figure:: images/figure10.png
    :name: figure10
@@ -206,7 +206,7 @@ flow and share a similar implementation plan in Release 1.
 
    NFVI Maintenance implementation plan
 
-:numref:`figure10` shows a more detailed message flow (Steps 4 to 6)
+:numref:`figure10` shows a more detailed message flow (Steps 3 to 6 and 9)
 between the 4 building blocks introduced in Section 5.1..
 
 3. The Administrator is sending a StateChange request to the Controller residing
@@ -313,9 +313,9 @@ working group.
 
 Simple information elements:
 
-* SubscriptionID: identifies a subscription to receive fault or maintenance
+* SubscriptionID (Identifier): identifies a subscription to receive fault or maintenance
   notifications.
-* NotificationID: identifies a fault or maintenance notification.
+* NotificationID (Identifier): identifies a fault or maintenance notification.
 * VirtualResourceID (Identifier): identifies a virtual resource affected by a
   fault or a maintenance action of the underlying physical resource.
 * PhysicalResourceID (Identifier): identifies a physical resource affected by a
@@ -342,7 +342,7 @@ Simple information elements:
 * EventTime (Datetime): Time when the fault was observed.
 * EventStartTime and EventEndTime (Datetime): Datetime range that can be used in
   a FaultQueryFilter to narrow down the faults to be queried.
-* ProbableCause: information about the probable cause of the fault.
+* ProbableCause (String): information about the probable cause of the fault.
 * CorrelatedFaultID (Integer): list of other faults correlated to this fault.
 * isRootCause (Boolean): Parameter indicating if this fault is the root for
   other correlated faults. If TRUE, then the faults listed in the parameter
@@ -356,7 +356,7 @@ Simple information elements:
 * ZoneID (Identifier): Identifier of the resource zone. A resource zone is the
   logical separation of physical and software resources in an NFVI deployment
   for physical isolation, redundancy, or administrative designation.
-* Metadata (Key-Value-Pairs): provides additional information of a physical
+* Metadata (Key-value pair): provides additional information of a physical
   resource in maintenance/error state.
 
 Complex information elements (see also UML diagrams in :numref:`figure13`
@@ -374,10 +374,10 @@ and :numref:`figure14`):
   particular describing the information elements used for alarm notifications.
 
   - FaultID [1] (Identifier)
-  - FaultType [1]
+  - FaultType [1] (String)
   - Severity [1] (Integer)
   - EventTime [1] (Datetime)
-  - ProbableCause [1]
+  - ProbableCause [1] (String)
   - CorrelatedFaultID [0..*] (Identifier)
   - FaultDetails [0..*] (Key-value pair)
 
@@ -406,6 +406,7 @@ and :numref:`figure14`):
   - PhysicalResourceID [1] (Identifier)
   - PhysicalResourceState [1] (String): mandates the new state of the physical
     resource.
+  - Metadata [0..*] (Key-value pair)
 
 * PhysicalResourceInfoClass:
 
@@ -414,6 +415,7 @@ and :numref:`figure14`):
   - FirmwareVersion [0..1] (String)
   - HypervisorVersion [0..1] (String)
   - ZoneID [0..1] (Identifier)
+  - Metadata [0..*] (Key-value pair)
 
 * StateQueryFilterClass: narrows down a StateQueryRequest, for example it limits
   the query to certain physical resources, a certain zone, or a given resource