Skip to content

Commit 948e871

Browse files
author
James DeFelice
committed
spec: clarify 1) intent of Probe; 2) configuration of operating mode
1 parent 91c1897 commit 948e871

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

spec.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,7 @@ The status `details` MUST be empty. In the future, this spec may require `detail
384384
### Identity Service RPC
385385

386386
Identity service RPCs allow a CO to negotiate an API protocol version that MAY be used for subsequent RPCs across all CSI services with respect to a particular CSI plugin.
387-
The general flow of the success case is as follows (protos illustrated in YAML for brevity):
387+
The general flow of the success case MAY be as follows (protos illustrated in YAML for brevity):
388388

389389
1. CO queries supported versions via Identity RPC. The CO is expected to gracefully handle, in the manner of its own choosing, the case wherein the returned `supported_versions` from the plugin are not supported by the CO.
390390

@@ -564,9 +564,9 @@ The primary utility of the Probe RPC is deployment verification: this can be a o
564564
This information can be used, for example, to monitor the health of the plugin and redeploy the plugin (or take other automated measures) when it becomes unhealthy.
565565

566566
The Plugin SHOULD verify if it has the right configurations, devices, dependencies and drivers in order to run and return a success if the validation succeeds.
567-
The CO SHALL invoke this RPC prior to any other controller service or node service RPC in order to allow the CO to determine the readiness of the plugin.
567+
The CO MAY invoke this RPC at any time after version negotiation has been completed (see `GetSupportedVersions`).
568568
A CO MAY invoke this call multiple times with the understanding that a plugin's implementation MAY NOT be trivial and there MAY be overhead incurred by such repeated calls.
569-
The SP SHALL document known limitations regarding a particular Plugin's implementation of this RPC.
569+
The SP SHALL document guidance and known limitations regarding a particular Plugin's implementation of this RPC.
570570
For example, the SP MAY document the maximum frequency at which its Probe implementation should be called.
571571

572572
```protobuf
@@ -1637,6 +1637,7 @@ Supervised plugins MAY be isolated and/or resource-bounded.
16371637
##### Available Services
16381638

16391639
* Plugin Packages MAY support all or a subset of CSI services; service combinations MAY be configurable at runtime by the Plugin Supervisor.
1640+
* A plugin must know the "mode" in which it's operating: mode of operation is NOT discoverable via interaction with the CO via the CSI specification.
16401641
* Misconfigured plugin software SHOULD fail-fast with an OS-appropriate error code.
16411642

16421643
##### Linux Capabilities

0 commit comments

Comments
 (0)