Skip to content

Commit 62b0122

Browse files
committedNov 30, 2017
Documentation for CSIPersistentVolume

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed
 

‎docs/concepts/storage/volumes.md

+33
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ Kubernetes supports several types of Volumes:
6969
* `azureDisk`
7070
* `azureFile`
7171
* `cephfs`
72+
* `csi`
7273
* `downwardAPI`
7374
* `emptyDir`
7475
* `fc` (fibre channel)
@@ -170,6 +171,38 @@ writers simultaneously.
170171

171172
See the [CephFS example](https://github.com/kubernetes/examples/tree/{{page.githubbranch}}/staging/volumes/cephfs/) for more details.
172173

174+
### csi
175+
176+
CSI stands for [Container Storage Interface](https://github.com/container-storage-interface/spec/blob/master/spec.md),
177+
a specification attempting to establish an industry standard interface that
178+
Container Orchestration Systems (COs) can use to expose arbitrary storage systems
179+
to their container workloads.
180+
For more information about the details, please check the
181+
[design proposal](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/storage/container-storage-interface.md).
182+
183+
<!-- TODO: add link to the kubernetes extension section -->
184+
The `csi` volume type is an in-tree CSI volume plugin for Pods to interact
185+
with external CSI volume drivers running on the same node.
186+
After having deployed a CSI compatible volume driver, users can use `csi` as the
187+
volume type to mount the storage provided by the driver.
188+
189+
CSI persistent volume support is introduced in Kubernetes v1.9 as an alpha feature
190+
which has to be explicitly enabled by the cluster administrator. In other words,
191+
the cluster administrator needs to add "`CSIPersistentVolume=true`" to the
192+
"`--feature-gates=`" flag for the apiserver, the controller-manager and the kubelet
193+
components.
194+
195+
A CSI persistent volume has the following fields for users to specify:
196+
197+
- `driver`: A string value that specifies the name of the volume driver to use.
198+
It has to be less than 63 characters and starts with a character. The driver
199+
name can have '`.`', '`-`', '`_`' or digits in it.
200+
- `volumeHandle`: A string value that uniquely identify the volume name returned
201+
from the CSI volume plugin's `CreateVolume` call. The volume handle is then
202+
used in all subsequent calls to the the volume driver for referencing the volume.
203+
- `readOnly`: An optional boolean value indicating whether the volume is to be
204+
published as read only. Default is false.
205+
173206
### downwardAPI
174207

175208
A `downwardAPI` volume is used to make downward API data available to applications.

0 commit comments

Comments
 (0)
Please sign in to comment.