From 1c8bc666ab08c4d6b06b7bb4d6a671dceca5290c Mon Sep 17 00:00:00 2001 From: Matthew Wong Date: Tue, 23 Aug 2016 19:39:13 -0400 Subject: [PATCH] copy latest paremeters section from examples readme --- docs/user-guide/persistent-volumes/index.md | 54 +++++++++++++++++---- 1 file changed, 45 insertions(+), 9 deletions(-) diff --git a/docs/user-guide/persistent-volumes/index.md b/docs/user-guide/persistent-volumes/index.md index 6f3e5c1ff2..ab5ebb1c8e 100644 --- a/docs/user-guide/persistent-volumes/index.md +++ b/docs/user-guide/persistent-volumes/index.md @@ -345,11 +345,10 @@ parameters: ``` * `type`: `io1`, `gp2`, `sc1`, `st1`. See AWS docs for details. Default: `gp2`. -* `zone`: AWS zone. If not specified, a random zone where the cluster has a node -is chosen -* `iopsPerGB`: only for `io1` volumes. I/O operations per second per GiB. AWS -volume plugin multiplies this with size of requested volume to compute IOPS of -the volume and caps it at 20 000 IOPS (maximum supported by AWS, see AWS docs). +* `zone`: AWS zone. If not specified, a random zone from those where Kubernetes cluster has a node is chosen. +* `iopsPerGB`: only for `io1` volumes. I/O operations per second per GiB. AWS volume plugin multiplies this with size of requested volume to compute IOPS of the volume and caps it at 20 000 IOPS (maximum supported by AWS, see AWS docs). +* `encrypted`: denotes whether the EBS volume should be encrypted or not. Valid values are `true` or `false`. +* `kmsKeyId`: optional. The full Amazon Resource Name of the key to use when encrypting the volume. If none is supplied but `encrypted` is true, a key is generated by AWS. See AWS docs for valid ARN value. #### GCE @@ -358,12 +357,49 @@ kind: StorageClass apiVersion: extensions/v1beta1 metadata: name: slow -provisionerType: kubernetes.io/gce-pd -provisionerParameters: +provisioner: kubernetes.io/gce-pd +parameters: type: pd-standard zone: us-central1-a ``` * `type`: `pd-standard` or `pd-ssd`. Default: `pd-ssd` -* `zone`: GCE zone. If not specified, a random zone in the same region as -controller-manager will be chosen. +* `zone`: GCE zone. If not specified, a random zone in the same region as controller-manager will be chosen. + +#### GLUSTERFS + +```yaml +apiVersion: extensions/v1beta1 +kind: StorageClass +metadata: + name: slow +provisioner: kubernetes.io/glusterfs +parameters: + endpoint: "glusterfs-cluster" + resturl: "http://127.0.0.1:8081" + restauthenabled: "true" + restuser: "admin" + restuserkey: "password" +``` + +* `endpoint`: `glusterfs-cluster` is the endpoint/service name which includes GlusterFS trusted pool IP addresses and this parameter is mandatory. +* `resturl` : Gluster REST service url which provision gluster volumes on demand. The format should be `IPaddress:Port` and this is a mandatory parameter for GlusterFS dynamic provisioner. +* `restauthenabled` : Gluster REST service authentication boolean is required if the authentication is enabled on the REST server. If this value is 'true', 'restuser' and 'restuserkey' have to be filled. +* `restuser` : Gluster REST service user who has access to create volumes in the Gluster Trusted Pool. +* `restuserkey` : Gluster REST service user's password which will be used for authentication to the REST server. + +#### OpenStack Cinder + +```yaml +kind: StorageClass +apiVersion: extensions/v1beta1 +metadata: + name: gold +provisioner: kubernetes.io/cinder +parameters: + type: fast + availability: nova +``` + +* `type`: [VolumeType](http://docs.openstack.org/admin-guide/dashboard-manage-volumes.html) created in Cinder. Default is empty. +* `availability`: Availability Zone. Default is empty.