kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #5439 from kairen/patch-pvc-1 

Improve persistent volumes page
pull/5459/head
Jennifer Rondeau 2017-09-14 10:29:44 -04:00 committed by GitHub
parent d428cf6581 9e19846706
commit 6da3922bb5
1 changed files with 37 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
docs/concepts/storage/persistent-volumes.md
View File

@ -86,7 +86,7 @@ However, an administrator can configure a custom recycler pod template using the
apiVersion: v1 apiVersion: v1
kind: Pod kind: Pod
metadata: metadata:
name: pv-recycler- name: pv-recycler
namespace: default namespace: default
spec: spec:
restartPolicy: Never restartPolicy: Never
@ -128,7 +128,7 @@ For volume plugins that support the Delete reclaim policy, deletion removes both
* Glusterfs * Glusterfs
* VsphereVolume * VsphereVolume
* Quobyte Volumes * Quobyte Volumes
* HostPath (single node testing only -- local storage is not supported in any way and WILL NOT WORK in a multi-node cluster) * HostPath (Single node testing only -- local storage is not supported in any way and WILL NOT WORK in a multi-node cluster)
* VMware Photon * VMware Photon
* Portworx Volumes * Portworx Volumes
* ScaleIO Volumes * ScaleIO Volumes
@ -139,20 +139,20 @@ For volume plugins that support the Delete reclaim policy, deletion removes both
Each PV contains a spec and status, which is the specification and status of the volume. Each PV contains a spec and status, which is the specification and status of the volume.
```yaml ```yaml
apiVersion: v1 apiVersion: v1
kind: PersistentVolume kind: PersistentVolume
metadata: metadata:
name: pv0003 name: pv0003
spec: spec:
capacity: capacity:
storage: 5Gi storage: 5Gi
accessModes: accessModes:
- ReadWriteOnce - ReadWriteOnce
persistentVolumeReclaimPolicy: Recycle persistentVolumeReclaimPolicy: Recycle
storageClassName: slow storageClassName: slow
nfs: nfs:
path: /tmp path: /tmp
server: 172.17.0.2 server: 172.17.0.2
``` ```
### Capacity ### Capacity
@ -220,7 +220,7 @@ it will become fully deprecated in a future Kubernetes release.
Current reclaim policies are: Current reclaim policies are:
* Retain -- manual reclamation * Retain -- manual reclamation
* Recycle -- basic scrub ("rm -rf /thevolume/*") * Recycle -- basic scrub (`rm -rf /thevolume/*`)
* Delete -- associated storage asset such as AWS EBS, GCE PD, Azure Disk, or OpenStack Cinder volume is deleted * Delete -- associated storage asset such as AWS EBS, GCE PD, Azure Disk, or OpenStack Cinder volume is deleted
Currently, only NFS and HostPath support recycling. AWS EBS, GCE PD, Azure Disk, and Cinder volumes support deletion. Currently, only NFS and HostPath support recycling. AWS EBS, GCE PD, Azure Disk, and Cinder volumes support deletion.
@ -591,7 +591,7 @@ parameters:
```yaml ```yaml
kind: StorageClass kind: StorageClass
apiVersion: storage.k8s.io/v1beta1 apiVersion: storage.k8s.io/v1
metadata: metadata:
name: fast name: fast
provisioner: kubernetes.io/vsphere-volume provisioner: kubernetes.io/vsphere-volume
@ -607,7 +607,7 @@ parameters:
```yaml ```yaml
kind: StorageClass kind: StorageClass
apiVersion: storage.k8s.io/v1beta1 apiVersion: storage.k8s.io/v1
metadata: metadata:
name: vsan-policy-fast name: vsan-policy-fast
provisioner: kubernetes.io/vsphere-volume provisioner: kubernetes.io/vsphere-volume
@ -639,22 +639,22 @@ You can see [vSphere example](https://github.com/kubernetes/examples/tree/master
#### Ceph RBD #### Ceph RBD
```yaml ```yaml
apiVersion: storage.k8s.io/v1 kind: StorageClass
kind: StorageClass apiVersion: storage.k8s.io/v1
metadata: metadata:
name: fast name: fast
provisioner: kubernetes.io/rbd provisioner: kubernetes.io/rbd
parameters: parameters:
monitors: 10.16.153.105:6789 monitors: 10.16.153.105:6789
adminId: kube adminId: kube
adminSecretName: ceph-secret adminSecretName: ceph-secret
adminSecretNamespace: kube-system adminSecretNamespace: kube-system
pool: kube pool: kube
userId: kube userId: kube
userSecretName: ceph-secret-user userSecretName: ceph-secret-user
fsType: ext4 fsType: ext4
imageFormat: "2" imageFormat: "2"
imageFeatures: "layering" imageFeatures: "layering"
``` ```
* `monitors`: Ceph monitors, comma delimited. This parameter is required. * `monitors`: Ceph monitors, comma delimited. This parameter is required.
@ -785,6 +785,7 @@ parameters:
* `ephemeral`: specifies whether the volume should be cleaned-up after unmount or should be persistent. `emptyDir` use case can set this value to true and `persistent volumes` use case such as for databases like Cassandra should set to false, [true/false] (default `false`). A string is expected here i.e. `"true"` and not `true`. * `ephemeral`: specifies whether the volume should be cleaned-up after unmount or should be persistent. `emptyDir` use case can set this value to true and `persistent volumes` use case such as for databases like Cassandra should set to false, [true/false] (default `false`). A string is expected here i.e. `"true"` and not `true`.
#### ScaleIO #### ScaleIO
```yaml ```yaml
kind: StorageClass kind: StorageClass
apiVersion: storage.k8s.io/v1 apiVersion: storage.k8s.io/v1
@ -821,6 +822,7 @@ $> kubectl create secret generic sio-secret --type="kubernetes.io/scaleio" --fro
``` ```
#### StorageOS #### StorageOS
```yaml ```yaml
kind: StorageClass kind: StorageClass
apiVersion: storage.k8s.io/v1 apiVersion: storage.k8s.io/v1