Add msg to clarify usage #529
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@jdef Please take a look. Thanks. |
jdef
reviewed
Oct 30, 2022
| @@ -1056,6 +1056,8 @@ message ControllerServiceCapability { | |||
| // If for some reason Controller and Node Plugins report | |||
| // misaligned volume conditions, CO SHALL assume the worst case | |||
| // is the truth. | |||
| // Note that `VolumeCondition` can be used to generate events and | |||
There was a problem hiding this comment.
"events" .. smells like k8s lingo.
also, I specifically called out use of the message field of VolumeCondition. and how it's not clear what the intended use is for it. can you please attempt to clarify? we cannot assume k8s semantics/terminology in this spec - it should be very clear to all users of all COs what message means. and whether it is for humans or machines to interpret
There was a problem hiding this comment.
The message field of VolumeCondition is intended for humans, not for machines to interpret. The abnormal field can be used for automation.
message VolumeCondition {
// Normal volumes are available for use and operating optimally.
// An abnormal volume does not meet these criteria.
// This field is REQUIRED.
bool abnormal = 1;
// The message describing the condition of the volume.
// This field is REQUIRED.
string message = 2;
}
|
Closing this one. See this: #530 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
This PR adds a message to clarify how VOLUME_CONDITION is used.
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce an API-breaking change?: