diff --git a/docs/admin/admission-controllers.md b/docs/admin/admission-controllers.md index 6be627e4816ce..99740c3bad05c 100644 --- a/docs/admin/admission-controllers.md +++ b/docs/admin/admission-controllers.md @@ -387,6 +387,32 @@ This plug-in will deny any pod that attempts to set certain escalating [Security This plug-in implements automation for [serviceAccounts](/docs/user-guide/service-accounts). We strongly recommend using this plug-in if you intend to make use of Kubernetes `ServiceAccount` objects. +### PersistentVolumeClaimResize + +This plug-in implements additional validations for checking incoming `PersistentVolumeClaim` resize +requests. Currently support for Volume resizing is in Alpha and admin must set feature gate `ExpandPersistentVolumes` +to `true` to enable resizing. + +After the `ExpandPersistentVolumes` feature gate is enabled - it is recommend that `PersistentVolumeClaimResize` admission +plug-in is enabled too. This feature gate will prevent resizing of all claims by default unless claim's `StorageClass` +has explicitly enabled resizing by setting `allowVolumeExpansion` to true. + +For example all `PersistnetVolumeClaims` created from following `StorageClass` will support volume expansion: + +``` yaml +kind: StorageClass +apiVersion: storage.k8s.io/v1 +metadata: + name: gluster-vol-default +provisioner: kubernetes.io/glusterfs +parameters: + resturl: "http://192.168.10.100:8080" + restuser: "" + secretNamespace: "" + secretName: "" +allowVolumeExpansion: true +``` + ## Is there a recommended set of plug-ins to use? Yes. diff --git a/docs/concepts/storage/persistent-volumes.md b/docs/concepts/storage/persistent-volumes.md index 9f2c141e887a3..bf8525320a087 100644 --- a/docs/concepts/storage/persistent-volumes.md +++ b/docs/concepts/storage/persistent-volumes.md @@ -109,6 +109,39 @@ However, the particular path specified in the custom recycler pod template in th For volume plugins that support the Delete reclaim policy, deletion removes both the `PersistentVolume` object from Kubernetes, as well as deleting the associated storage asset in the external infrastructure, such as an AWS EBS, GCE PD, Azure Disk, or Cinder volume. Volumes that were dynamically provisioned inherit the [reclaim policy of their `StorageClass`](#reclaim-policy-1), which defaults to Delete. The administrator should configure the `StorageClass` according to users' expectations, otherwise the PV must be edited or patched after it is created. See [Change the Reclaim Policy of a PersistentVolume](https://kubernetes.io/docs/tasks/administer-cluster/change-pv-reclaim-policy/). + +### Expanding Persistent Volumes Claims + +With Kubernetes 1.8, we have added Alpha support for expanding persistent volumes. The current Alpha support was designed to only support volume types +that don't need file system resizing (Currently only glusterfs). + +Administrator can allow expanding persistent volume claims by setting `ExpandPersistentVolumes` feature gate to true. Administrator +should also enable [`PersistentVolumeClaimResize` admission plugin](/docs/admin/admission-controllers/#persistentvolumeclaimresize) +to perform additional validations of volumes that can be resized. + +Once `PersistentVolumeClaimResize` admission plugin has been turned on, resizing will only be allowed for storage classes +whose `allowVolumeExpansion` field is set to true. + +``` yaml +kind: StorageClass +apiVersion: storage.k8s.io/v1 +metadata: + name: gluster-vol-default +provisioner: kubernetes.io/glusterfs +parameters: + resturl: "http://192.168.10.100:8080" + restuser: "" + secretNamespace: "" + secretName: "" +allowVolumeExpansion: true +``` + +Once both feature gate and aforementioned admission plug-in are turned on, an user can request larger volume for their `PersistentVolumeClaim` +by simply editing the claim and requesting bigger size. This in turn will trigger expansion of volume that is backing underlying `PersistentVolume`. + +Under no circustances a new `PersistentVolume` gets created to satisfy the claim. Kubernetes will attempt to resize existing volume to satisfy the claim. + + ## Types of Persistent Volumes `PersistentVolume` types are implemented as plugins. Kubernetes currently supports the following plugins: