From 324f9e4bfb17d2737a65652f4ec2cced1575f2a0 Mon Sep 17 00:00:00 2001 From: Zhang Yujun Date: Fri, 20 May 2016 14:19:26 +0800 Subject: [PATCH] Fix typo and inconsistency JIRA: DOCTOR-37 Change-Id: I67a38611a828a5d293cdfd1702b37fc89f5229a0 Signed-off-by: Zhang Yujun --- docs/design/notification-alarm-evaluator.rst | 2 +- docs/requirements/05-implementation.rst | 14 ++++++++------ 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/design/notification-alarm-evaluator.rst b/docs/design/notification-alarm-evaluator.rst index 8e13dcff..06a082be 100644 --- a/docs/design/notification-alarm-evaluator.rst +++ b/docs/design/notification-alarm-evaluator.rst @@ -12,7 +12,7 @@ Notification Alarm Evaluator ============================ .. NOTE:: - This is spec draft of brlueprint for OpenStack Ceilomter Liberty. + This is spec draft of blueprint for OpenStack Ceilomter Liberty. To see current version: https://review.openstack.org/172893 To track development activity: https://blueprints.launchpad.net/ceilometer/+spec/notification-alarm-evaluator diff --git a/docs/requirements/05-implementation.rst b/docs/requirements/05-implementation.rst index 3ae512f5..e0753bdd 100644 --- a/docs/requirements/05-implementation.rst +++ b/docs/requirements/05-implementation.rst @@ -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 -- 2.16.6