Skip to content

Commit

Permalink
Clarify comments
Browse files Browse the repository at this point in the history
  • Loading branch information
xing-yang committed Feb 19, 2020
1 parent aef5599 commit 2d701d9
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 15 deletions.
15 changes: 10 additions & 5 deletions csi.proto
Original file line number Diff line number Diff line change
Expand Up @@ -1328,7 +1328,10 @@ message VolumeHealth {
option (alpha_message) = true;

enum Condition {
// Volume health condition is unknown; treat it as healthy.
// Volume health condition is unknown; If this is the initial
// report of volume health, treat it as healthy. If there was
// already a condition reported previously, treat unknown as
// unchanged from the previous condition.
UNKNOWN = 0;
// Volume is accessible and no problems are detected.
HEALTHY = 1;
Expand All @@ -1337,13 +1340,15 @@ message VolumeHealth {
// maintenance.
TEMPORARY_INACCESSIBLE = 2;
// Volume is accessible currently, but is degraded. Data loss
// is unlikely as the storage system is fixing the problem
// automatically.
// is unlikely as the storage system is rebuilding to fix the
// problem automatically. For example, a replica is lost on
// the storage system but a spare is configured, and the storage
// system is resyncing/reconstructing.
TEMPORARY_DEGRADED = 3;
// 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.
// failure (i.e. the disk needs to be manually replaced by a human),
// cooling failure, equipment significantly past end of life.
FAILURE_LIKELY = 4;
// Volume is not accessible currently, and there is reason to
// believe the outage may be permanent. Examples: unrecoverable
Expand Down
15 changes: 10 additions & 5 deletions lib/go/csi/csi.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 10 additions & 5 deletions spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -2336,7 +2336,10 @@ message VolumeHealth {
option (alpha_message) = true;
enum Condition {
// Volume health condition is unknown; treat it as healthy.
// Volume health condition is unknown; If this is the initial
// report of volume health, treat it as healthy. If there was
// already a condition reported previously, treat unknown as
// unchanged from the previous condition.
UNKNOWN = 0;
// Volume is accessible and no problems are detected.
HEALTHY = 1;
Expand All @@ -2345,13 +2348,15 @@ message VolumeHealth {
// maintenance.
TEMPORARY_INACCESSIBLE = 2;
// Volume is accessible currently, but is degraded. Data loss
// is unlikely as the storage system is fixing the problem
// automatically.
// is unlikely as the storage system is rebuilding to fix the
// problem automatically. For example, a replica is lost on
// the storage system but a spare is configured, and the storage
// system is resyncing/reconstructing.
TEMPORARY_DEGRADED = 3;
// 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.
// failure (i.e. the disk needs to be manually replaced by a human),
// cooling failure, equipment significantly past end of life.
FAILURE_LIKELY = 4;
// Volume is not accessible currently, and there is reason to
// believe the outage may be permanent. Examples: unrecoverable
Expand Down

0 comments on commit 2d701d9

Please sign in to comment.