Added PersistentVolumeController
This commit is contained in:
markturansky
124
examples/experimental/persistent-volume-provisioning/README.md
Normal file
124
examples/experimental/persistent-volume-provisioning/README.md
Normal file
@@ -0,0 +1,124 @@
|
||||
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
|
||||
|
||||
<!-- BEGIN STRIP_FOR_RELEASE -->
|
||||
|
||||
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
||||
width="25" height="25">
|
||||
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
||||
width="25" height="25">
|
||||
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
||||
width="25" height="25">
|
||||
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
||||
width="25" height="25">
|
||||
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
||||
width="25" height="25">
|
||||
|
||||
<h2>PLEASE NOTE: This document applies to the HEAD of the source tree</h2>
|
||||
|
||||
If you are using a released version of Kubernetes, you should
|
||||
refer to the docs that go with that version.
|
||||
|
||||
<strong>
|
||||
The latest release of this document can be found
|
||||
[here](http://releases.k8s.io/release-1.1/examples/experimental/persistent-volume-provisioning/README.md).
|
||||
|
||||
Documentation for other releases can be found at
|
||||
[releases.k8s.io](http://releases.k8s.io).
|
||||
</strong>
|
||||
--
|
||||
|
||||
<!-- END STRIP_FOR_RELEASE -->
|
||||
|
||||
<!-- END MUNGE: UNVERSIONED_WARNING -->
|
||||
|
||||
## Persistent Volume Provisioning
|
||||
|
||||
This example shows how to use experimental persistent volume provisioning.
|
||||
|
||||
### Pre-requisites
|
||||
|
||||
This example assumes that you have an understanding of Kubernetes administration and can modify the
|
||||
scripts that launch kube-controller-manager.
|
||||
|
||||
### Admin Configuration
|
||||
|
||||
No configuration is required by the admin! 3 cloud providers will be provided in the alpha version
|
||||
of this feature: EBS, GCE, and Cinder.
|
||||
|
||||
When Kubernetes is running in one of those clouds, there will be an implied provisioner.
|
||||
There is no provisioner when running outside of any of those 3 cloud providers.
|
||||
|
||||
A fourth provisioner is included for testing and development only. It creates HostPath volumes,
|
||||
which will never work outside of a single node cluster. It is not supported in any way except for
|
||||
local for testing and development.
|
||||
|
||||
|
||||
### User provisioning requests
|
||||
|
||||
Users request dynamically provisioned storage by including a storage class in their `PersistentVolumeClaim`.
|
||||
The annotation `volume.alpha.kubernetes.io/storage-class` is used to access this experimental feature.
|
||||
In the future, admins will be able to define many storage classes.
|
||||
The storage class may remain in an annotation or become a field on the claim itself.
|
||||
|
||||
> The value of the storage-class annotation does not matter in the alpha version of this feature. There is
|
||||
a single implied provisioner per cloud (which creates 1 kind of volume in the provider). The full version of the feature
|
||||
will require that this value matches what is configured by the administrator.
|
||||
|
||||
```
|
||||
{
|
||||
"kind": "PersistentVolumeClaim",
|
||||
"apiVersion": "v1",
|
||||
"metadata": {
|
||||
"name": "claim1",
|
||||
"annotations": {
|
||||
"volume.alpha.kubernetes.io/storage-class": "foo"
|
||||
}
|
||||
},
|
||||
"spec": {
|
||||
"accessModes": [
|
||||
"ReadWriteOnce"
|
||||
],
|
||||
"resources": {
|
||||
"requests": {
|
||||
"storage": "3Gi"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Sample output
|
||||
|
||||
This example uses HostPath but any provisioner would follow the same flow.
|
||||
|
||||
First we note there are no Persistent Volumes in the cluster. After creating a claim, we see a new PV is created
|
||||
and automatically bound to the claim requesting storage.
|
||||
|
||||
|
||||
```
|
||||
$ kubectl get pv
|
||||
|
||||
$ kubectl create -f examples/experimental/persistent-volume-provisioning/claim1.json
|
||||
I1012 13:07:57.666759 22875 decoder.go:141] decoding stream as JSON
|
||||
persistentvolumeclaim "claim1" created
|
||||
|
||||
$ kubectl get pv
|
||||
NAME LABELS CAPACITY ACCESSMODES STATUS CLAIM REASON AGE
|
||||
pv-hostpath-r6z5o createdby=hostpath-dynamic-provisioner 3Gi RWO Bound default/claim1 2s
|
||||
|
||||
$ kubectl get pvc
|
||||
NAME LABELS STATUS VOLUME CAPACITY ACCESSMODES AGE
|
||||
claim1 <none> Bound pv-hostpath-r6z5o 3Gi RWO 7s
|
||||
|
||||
# delete the claim to release the volume
|
||||
$ kubectl delete pvc claim1
|
||||
persistentvolumeclaim "claim1" deleted
|
||||
|
||||
# the volume is deleted in response to being release of its claim
|
||||
$ kubectl get pv
|
||||
|
||||
```
|
||||
|
||||
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
|
||||
[]()
|
||||
<!-- END MUNGE: GENERATED_ANALYTICS -->
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"kind": "PersistentVolumeClaim",
|
||||
"apiVersion": "v1",
|
||||
"metadata": {
|
||||
"name": "claim1",
|
||||
"annotations": {
|
||||
"volume.alpha.kubernetes.io/storage-class": "foo"
|
||||
}
|
||||
},
|
||||
"spec": {
|
||||
"accessModes": [
|
||||
"ReadWriteOnce"
|
||||
],
|
||||
"resources": {
|
||||
"requests": {
|
||||
"storage": "3Gi"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"kind": "PersistentVolumeClaim",
|
||||
"apiVersion": "v1",
|
||||
"metadata": {
|
||||
"name": "claim2",
|
||||
"annotations": {
|
||||
"volume.alpha.kubernetes.io/storage-class": "bar"
|
||||
}
|
||||
},
|
||||
"spec": {
|
||||
"accessModes": [
|
||||
"ReadWriteOnce"
|
||||
],
|
||||
"resources": {
|
||||
"requests": {
|
||||
"storage": "3Gi"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user