Skip to content

Commit 456214c

Browse files
committed
Make reason field required in CSI spec
1 parent 2a7193d commit 456214c

3 files changed

Lines changed: 18 additions & 6 deletions

File tree

csi.proto

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1074,7 +1074,9 @@ message VolumeHealth {
10741074

10751075
// A brief CamelCase string that describes the condition and is
10761076
// suitable for machine parsing and concise CLI display.
1077-
// This field is OPTIONAL.
1077+
// The Plugin MUST NOT return multiple VolumeHealthEntry messages
1078+
// for the same volume with the same (status, reason) combination.
1079+
// This field is REQUIRED.
10781080
string reason = 2;
10791081

10801082
// A user friendly description of the volume health condition.
@@ -1805,7 +1807,9 @@ message NodeGetStorageHealthResponse {
18051807

18061808
// A brief CamelCase string that describes the condition and is
18071809
// suitable for machine parsing and concise CLI display.
1808-
// This field is OPTIONAL.
1810+
// The Plugin MUST NOT return multiple StorageBackendHealth messages
1811+
// with the same (status, reason, volume_capability) combination.
1812+
// This field is REQUIRED.
18091813
string reason = 2;
18101814

18111815
// A user friendly description of the storage health condition.

lib/go/csi/csi.pb.go

Lines changed: 6 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

spec.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1718,7 +1718,9 @@ message VolumeHealth {
17181718
17191719
// A brief CamelCase string that describes the condition and is
17201720
// suitable for machine parsing and concise CLI display.
1721-
// This field is OPTIONAL.
1721+
// The Plugin MUST NOT return multiple VolumeHealthEntry messages
1722+
// for the same volume with the same (status, reason) combination.
1723+
// This field is REQUIRED.
17221724
string reason = 2;
17231725
17241726
// A user friendly description of the volume health condition.
@@ -3007,7 +3009,9 @@ message NodeGetStorageHealthResponse {
30073009
30083010
// A brief CamelCase string that describes the condition and is
30093011
// suitable for machine parsing and concise CLI display.
3010-
// This field is OPTIONAL.
3012+
// The Plugin MUST NOT return multiple StorageBackendHealth messages
3013+
// with the same (status, reason, volume_capability) combination.
3014+
// This field is REQUIRED.
30113015
string reason = 2;
30123016
30133017
// A user friendly description of the storage health condition.

0 commit comments

Comments
 (0)