From b0b2cb1a31c0ff72208627c46f95547d1f4cf0cf Mon Sep 17 00:00:00 2001 From: Humble Chirammal Date: Fri, 5 May 2017 19:22:10 +0530 Subject: [PATCH] Correct glusterfs storageclass filename and add reference Signed-off-by: Humble Chirammal --- persistent-volume-provisioning/README.md | 9 +++++++++ .../{glusterfs-dp.yaml => glusterfs-storageclass.yaml} | 0 2 files changed, 9 insertions(+) rename persistent-volume-provisioning/glusterfs/{glusterfs-dp.yaml => glusterfs-storageclass.yaml} (100%) diff --git a/persistent-volume-provisioning/README.md b/persistent-volume-provisioning/README.md index 4ddd05b1..2af91fc2 100644 --- a/persistent-volume-provisioning/README.md +++ b/persistent-volume-provisioning/README.md @@ -111,13 +111,20 @@ parameters: volumetype: "replicate:3" ``` +Example storageclass can be found in [glusterfs-storageclass.yaml](glusterfs/glusterfs-storageclass.yaml). + * `resturl` : Gluster REST service/Heketi service url which provision gluster volumes on demand. The general format should be `IPaddress:Port` and this is a mandatory parameter for GlusterFS dynamic provisioner. If Heketi service is exposed as a routable service in openshift/kubernetes setup, this can have a format similar to `http://heketi-storage-project.cloudapps.mystorage.com` where the fqdn is a resolvable heketi service url. + * `restauthenabled` : Gluster REST service authentication boolean that enables authentication to the REST server. If this value is 'true', `restuser` and `restuserkey` or `secretNamespace` + `secretName` have to be filled. This option is deprecated, authentication is enabled when any of `restuser`, `restuserkey`, `secretName` or `secretNamespace` is specified. + * `restuser` : Gluster REST service/Heketi user who has access to create volumes in the Gluster Trusted Pool. + * `restuserkey` : Gluster REST service/Heketi user's password which will be used for authentication to the REST server. This parameter is deprecated in favor of `secretNamespace` + `secretName`. + * `secretNamespace` + `secretName` : Identification of Secret instance that contains user password to use when talking to Gluster REST service. These parameters are optional, empty password will be used when both `secretNamespace` and `secretName` are omitted. The provided secret must have type "kubernetes.io/glusterfs". When both `restuserkey` and `secretNamespace` + `secretName` is specified, the secret will be used. + * `clusterid`: `630372ccdc720a92c681fb928f27b53f` is the ID of the cluster which will be used by Heketi when provisioning the volume. It can also be a list of clusterids, for ex: "8452344e2becec931ece4e33c4674e4e,42982310de6c63381718ccfa6d8cf397". This is an optional parameter. @@ -127,6 +134,7 @@ Example of a secret can be found in [glusterfs-secret.yaml](glusterfs/glusterfs- * `volumetype` : The volume type and its parameters can be configured with this optional value. If the volume type is not mentioned, it's up to the provisioner to decide the volume type. For example: + 'Replica volume': `volumetype: replicate:3` where '3' is replica count. 'Disperse/EC volume': @@ -137,6 +145,7 @@ For example: For available volume types and its administration options refer: ([Administration Guide](https://access.redhat.com/documentation/en-US/Red_Hat_Storage/3.1/html/Administration_Guide/part-Overview.html)) Reference : ([How to configure Gluster on Kubernetes](https://github.com/gluster/gluster-kubernetes/blob/master/docs/setup-guide.md)) + Reference : ([How to configure Heketi](https://github.com/heketi/heketi/wiki/Setting-up-the-topology)) When the persistent volumes are dynamically provisioned, the Gluster plugin automatically create an endpoint and a headless service in the name `gluster-dynamic-`. This dynamic endpoint and service will be deleted automatically when the persistent volume claim is deleted. diff --git a/persistent-volume-provisioning/glusterfs/glusterfs-dp.yaml b/persistent-volume-provisioning/glusterfs/glusterfs-storageclass.yaml similarity index 100% rename from persistent-volume-provisioning/glusterfs/glusterfs-dp.yaml rename to persistent-volume-provisioning/glusterfs/glusterfs-storageclass.yaml