Updated description for the conditions

container-storage-interface · Feb 13, 2020 · ebec916 · ebec916
1 parent c74ce24
commit ebec916
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 15 deletions.
diff --git a/csi.proto b/csi.proto
@@ -1305,14 +1305,20 @@ message VolumeHealth {
   enum Condition {
     // Volume health condition is unknown; treat it as healthy.
     UNKNOWN = 0;
-    // Volume is healthy.
+    // Volume is accessible and no problems are detected. 
     HEALTHY = 1;
-    // Volume is temporarily unhealthy, but will likely become healthy.
+    // Volume has degrading performance or is not accessible currently,
+    // but there's no reason to expect data loss. Examples: power
+    // outage, network outage, maintenance.
     TEMPORARY_UNHEALTHY = 2;
-    // Volume will fail soon. Move your data off and replace volume or
-    // you may lose your data.
+    // Volume is accessible currently, but a problem is detected that
+    // could lead to eventual data loss. Examples: recoverable hardware
+    // failure, cooling failure, equipment significantly past end of
+    // life.
     FATAL_IMMINENT = 3;
-    // Volume is unusable. Data loss is likely.
+    // Volume is not accessible currently, and there is reason to
+    // believe the outage may be permanent. Examples: unrecoverable
+    // hardware failure, natural disasters, damage to equipment.
     FATAL = 4;
   }
 

diff --git a/lib/go/csi/csi.pb.go b/lib/go/csi/csi.pb.go
diff --git a/spec.md b/spec.md
@@ -2311,14 +2311,20 @@ message VolumeHealth {
   enum Condition {
     // Volume health condition is unknown; treat it as healthy.
     UNKNOWN = 0;
-    // Volume is healthy.
+    // Volume is accessible and no problems are detected. 
     HEALTHY = 1;
-    // Volume is temporarily unhealthy, but will likely become healthy.
+    // Volume has degrading performance or is not accessible currently,
+    // but there's no reason to expect data loss. Examples: power
+    // outage, network outage, maintenance.
     TEMPORARY_UNHEALTHY = 2;
-    // Volume will fail soon. Move your data off and replace volume or
-    // you may lose your data.
+    // Volume is accessible currently, but a problem is detected that
+    // could lead to eventual data loss. Examples: recoverable hardware
+    // failure, cooling failure, equipment significantly past end of
+    // life.
     FATAL_IMMINENT = 3;
-    // Volume is unusable. Data loss is likely.
+    // Volume is not accessible currently, and there is reason to
+    // believe the outage may be permanent. Examples: unrecoverable
+    // hardware failure, natural disasters, damage to equipment.
     FATAL = 4;
   }