From 73cb92a0a988a5d20b9dd9153145ead4e157e78f Mon Sep 17 00:00:00 2001 From: Vladimir Vivien Date: Wed, 8 Mar 2017 19:21:38 -0500 Subject: [PATCH] Adds documentation for Dell EMC ScaleIO volume plugin This commit updates the volumes documentation to include ScaleIO volume plugin information. --- docs/user-guide/persistent-volumes/index.md | 38 ++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/docs/user-guide/persistent-volumes/index.md b/docs/user-guide/persistent-volumes/index.md index c7099eb928..4558b6fae5 100644 --- a/docs/user-guide/persistent-volumes/index.md +++ b/docs/user-guide/persistent-volumes/index.md @@ -121,7 +121,7 @@ However, the particular path specified in the custom recycler pod template in th * Quobyte Volumes * HostPath (single node testing only -- local storage is not supported in any way and WILL NOT WORK in a multi-node cluster) * VMware Photon - +* ScaleIO Volumes ## Persistent Volumes @@ -188,6 +188,7 @@ In the CLI, the access modes are abbreviated to: | NFS | ✓ | ✓ | ✓ | | RBD | ✓ | ✓ | - | | VsphereVolume | ✓ | - | - | +| ScaleIO | ✓ | ✓ | - | ### Class @@ -533,6 +534,41 @@ parameters: * `location`: Azure storage account location. Default is empty. * `storageAccount`: Azure storage account name. If storage account is not provided, all storage accounts associated with the resource group are searched to find one that matches `skuName` and `location`. If storage account is provided, it must reside in the same resource group as the cluster, and `skuName` and `location` are ignored. +#### ScaleIO +```yaml +kind: StorageClass +apiVersion: storage.k8s.io/v1 +metadata: + name: slow +provisioner: kubernetes.io/scaleio +parameters: + gateway: https://192.168.99.200:443/api + system: scaleio + protectionDomain: default + storagePool: default + storageMode: ThinProvisionned + secretRef: sio-secret + readOnly: false + fsType: xfs +``` + +* `provisioner`: attribute is set to `kubernetes.io/scaleio` +* `gateway`: address to a ScaleIO API gateway (required) +* `system`: the name of the ScaleIO system (required) +* `protectionDomain`: the name of the ScaleIO protection domain +* `storagePool`: the name of the volume storage pool +* `storageMode`: the storage provision mode: `ThinProvisionned` (default) or `ThickProvisionned` +* `secretRef`: reference to a configuered Secret object (required, see detail below) +* `readOnly`: specifies the access mode to the mounted volume +* `fsType`: the file system to use for the volume + +The ScaleIO Kubernetes volume plugin requires a configuered Secret object. +The secret must be created with type `kubernetes.io/scaleio` and use the same namespace value as that of the PVC where it is referenced +as shown in the following command: + +``` +$> kubectl create secret generic sio-secret --type="kubernetes.io/scaleio" --from-literal=username=sioadmin --from-literal=password=d2NABDNjMA== --namespace=default +``` ## Writing Portable Configuration