summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKubernetes Submit Queue <k8s-merge-robot@users.noreply.github.com>2017-08-18 17:01:16 -0700
committerGitHub <noreply@github.com>2017-08-18 17:01:16 -0700
commit57a04fba7bc262ea476261b153c551005b50e390 (patch)
tree240a5c0a5dc9fc95eef57ee9cf211ddc857ef48d
parentbf6057138c12a427fb0fecf71b74025f6b0bb9b6 (diff)
parentd14ed06144906cacfe5ccd8c6d2df95b92d76c05 (diff)
Merge pull request #786 from verult/Capabilities
Automatic merge from submit-queue Updating FlexVolume doc with capabilities addition. The following PR introduces a FlexVolume API change, so the documentation needs to be updated. https://github.com/kubernetes/kubernetes/pull/47503
-rw-r--r--contributors/devel/flexvolume.md10
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)>
+ }
}
```