diff options
| author | Cheng Xing <cxing@google.com> | 2017-07-06 11:52:41 -0700 |
|---|---|---|
| committer | Cheng Xing <cxing@google.com> | 2017-08-16 17:00:00 -0700 |
| commit | d14ed06144906cacfe5ccd8c6d2df95b92d76c05 (patch) | |
| tree | f802351cb641f75dcda438209a237b637e2999be | |
| parent | c50d1997bdfca307fffaf8227eaf6aa6bfd1d8e3 (diff) | |
Updating FlexVolume doc with capabilities addition
| -rw-r--r-- | contributors/devel/flexvolume.md | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/contributors/devel/flexvolume.md b/contributors/devel/flexvolume.md index 79df2d53..41d7e54c 100644 --- a/contributors/devel/flexvolume.md +++ b/contributors/devel/flexvolume.md @@ -19,8 +19,10 @@ Call-outs are invoked from Controller-manager only when "--enable-controller-att ### Driver invocation model: #### Init: -Initializes the driver. Called during Kubelet & Controller manager initialization. - +Initializes the driver. Called during Kubelet & Controller manager initialization. On success, the function returns a capabilities map showing whether each Flexvolume capability is supported by the driver. +Current capabilities: +* `attach` - a boolean field indicating whether the driver requires attach and detach operations. This field is *required*, although for backward-compatibility the default value is set to `true`, i.e. requires attach and detach. +See [Driver output](#driver-output) for the capabilities map format. ``` <driver executable> init ``` @@ -105,6 +107,10 @@ following format. "device": "<Path to the device attached. This field is valid only for attach & waitforattach call-outs>" "volumeName": "<Cluster wide unique name of the volume. Valid only for getvolumename call-out>" "attached": <True/False (Return true if volume is attached on the node. Valid only for isattached call-out)> + "capabilities": <Only included as part of the Init response> + { + "attach": <True/False (Return true if the driver implements attach and detach)> + } } ``` |