Add Validate RPC to Config service SDK. #55
Conversation
Signed-off-by: Edwin Buck <[email protected]>
edwbuck
requested review from
evan2645,
amartinezfayo,
azdagron,
MarcosDY and
rturner3
as code owners
| // Required. True when the plugin deems the configuration usable. | ||
| bool valid = 1; | ||
|
|
||
| // Required. Text message suitable for presentation to end user. |
There was a problem hiding this comment.
Out of curiosity, what sort of information are you thinking a plugin would return in the valid case?
There was a problem hiding this comment.
Minimally, "Configuration valid" or something like that. Really, it would depend on the plugin. Might indicate more, might indicate less.
For example, for the k8s_psat plugin, it might provide feedback that included the cluster name. For another plugin, it might echo back the configuration text.
There's not yet a distinct constraint on the message; but, having one alleviates the need to have variable logic on the success / failure cases, allowing the receiver to decide what to do without an if statement.
There was a problem hiding this comment.
One idea that would have practical value is for the "success" return value to contain reminders to unblock ports, etc. Like I said, it would be plugin specific.
Instead of passing one message, the API will pass back one or more notes. Each note is independent and will provide feedback to the end user. Signed-off-by: Edwin Buck <[email protected]>
|
@azdagron Sorry, I resolved your "notes" request, because I agreed with the change and pushed it. I'll keep it open next time so you can track it yourself, if you so desire. |
edwbuck
force-pushed
the
validate3
branch
2 times, most recently
from
a2e5ba6
to
2839960
Compare
Co-authored-by: Andrew Harding <[email protected]> Signed-off-by: Edwin Buck <[email protected]>
Co-authored-by: Andrew Harding <[email protected]> Signed-off-by: Edwin Buck <[email protected]>
Signed-off-by: Edwin Buck <[email protected]>
Closes #53