Merge a398074e32 into 59a3ca2cd1

README.md

@@ -186,7 +186,7 @@ $ oc adm policy add-scc-to-user hostmount-anyuid system:serviceaccount:$NAMESPAC
 
 If you would like to use a custom built nfs-subdir-external-provisioner image, you must edit the provisioner's deployment file to specify the correct location of your `nfs-client-provisioner` container image.
 
-Next you must edit the provisioner's deployment file to add connection information for your NFS server. Edit `deploy/deployment.yaml` and replace the two occurences of <YOUR NFS SERVER HOSTNAME> with your server's hostname.
+Next you must edit the provisioner's deployment file to add connection information for your NFS server. Edit `deploy/deployment.yaml` and replace the two occurrences of <YOUR NFS SERVER HOSTNAME> with your server's hostname.
 
 ```yaml
 kind: Deployment
@@ -235,10 +235,10 @@ To disable leader election, define an env variable named ENABLE_LEADER_ELECTION
 **_Parameters:_**
 
 | Name            | Description                                                  |                           Default                            |
-| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------: |
+| --------------- | ------------------------------------------------------------ | :----------------------------------------------------------: |
 | onDelete        | If it exists and has a delete value, delete the directory, if it exists and has a retain value, save the directory. | will be archived with name on the share: `archived-<volume.Name>` |
 | archiveOnDelete | If it exists and has a false value, delete the directory. if `onDelete` exists, `archiveOnDelete` will be ignored. | will be archived with name on the share: `archived-<volume.Name>` |
-| pathPattern     | Specifies a template for creating a directory path via PVC metadata's such as labels, annotations, name or namespace. To specify metadata use `${.PVC.<metadata>}`. Example: If folder should be named like `<pvc-namespace>-<pvc-name>`, use `${.PVC.namespace}-${.PVC.name}` as pathPattern. |                               n/a                                |
+| pathPattern     | Specifies a template for creating a directory path via PVC metadata's such as labels, annotations, name or namespace. To specify metadata use `${.PVC.<metadata>}`. Example: If folder should be named like `<pvc-namespace>-<pvc-name>`, use `${.PVC.namespace}-${.PVC.name}` as pathPattern. The default pattern will add the pvname to folder, which will result in a unique folder name, combining namespace, name and an unique id. | `${.PVC.namespace}-${.PVC.name}-${.PVC.pvname}` |
 
 This is `deploy/class.yaml` which defines the NFS subdir external provisioner's Kubernetes Storage Class:
 

charts/nfs-subdir-external-provisioner/README.md

@@ -49,7 +49,7 @@ The command removes all the Kubernetes components associated with the chart and
 The following tables lists the configurable parameters of this chart and their default values.
 
 | Parameter                            | Description                                                  | Default                                                      |
-| ------------------------------------ | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
+| ------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
 | `replicaCount`                       | Number of provisioner instances to deployed                  | `1`                                                          |
 | `strategyType`                       | Specifies the strategy used to replace old Pods by new ones  | `Recreate`                                                   |
 | `image.repository`                   | Provisioner image                                            | `registry.k8s.io/sig-storage/nfs-subdir-external-provisioner` |
@@ -63,7 +63,7 @@ The following tables lists the configurable parameters of this chart and their d
 | `storageClass.provisionerName`       | Name of the provisionerName                                  | null                                                         |
 | `storageClass.archiveOnDelete`       | Archive PVC when deleting                                    | `true`                                                       |
 | `storageClass.onDelete`              | Strategy on PVC deletion. Overrides archiveOnDelete when set to lowercase values 'delete' or 'retain' | null                                                         |
-| `storageClass.pathPattern`           | Specifies a template for the directory name                                                           | null                                                          |
+| `storageClass.pathPattern`           | Specifies a template for the directory name.  The default will combine PVC namespce, PVC name and PV name which will result in a unique folder name. | `${.PVC.namespace}-${.PVC.name}-${.PVC.pvname}`              |
 | `storageClass.accessModes`           | Set access mode for PV                                       | `ReadWriteOnce`                                              |
 | `storageClass.volumeBindingMode`     | Set volume binding mode for Storage Class                    | `Immediate`                                                  |
 | `storageClass.annotations`           | Set additional annotations for the StorageClass              | `{}`                                                         |

cmd/nfs-subdir-external-provisioner/provisioner.go

@@ -41,6 +41,8 @@ import (
 
 const (
 	provisionerNameKey = "PROVISIONER_NAME"
+	defaultPathPattern = "${.PVC.namespace}-${.PVC.name}-${.PVC.pvname}"
+	mountPath          = "/persistentvolumes"
 )
 
 type nfsProvisioner struct {
@@ -73,10 +75,6 @@ func (meta *pvcMetadata) stringParser(str string) string {
 	return str
 }
 
-const (
-	mountPath = "/persistentvolumes"
-)
-
 var _ controller.Provisioner = &nfsProvisioner{}
 
 func (p *nfsProvisioner) Provision(ctx context.Context, options controller.ProvisionOptions) (*v1.PersistentVolume, controller.ProvisioningState, error) {
@@ -85,31 +83,27 @@ func (p *nfsProvisioner) Provision(ctx context.Context, options controller.Provi
 	}
 	glog.V(4).Infof("nfs provisioner: VolumeOptions %v", options)
 
-	pvcNamespace := options.PVC.Namespace
-	pvcName := options.PVC.Name
-
-	pvName := strings.Join([]string{pvcNamespace, pvcName, options.PVName}, "-")
-
 	metadata := &pvcMetadata{
 		data: map[string]string{
-			"name":      pvcName,
+			"name":      options.PVC.Name,
-			"namespace": pvcNamespace,
+			"namespace": options.PVC.Namespace,
+			"pvname":    options.PVName,
 		},
 		labels:      options.PVC.Labels,
 		annotations: options.PVC.Annotations,
 	}
 
-	fullPath := filepath.Join(mountPath, pvName)
-	path := filepath.Join(p.path, pvName)
-
 	pathPattern, exists := options.StorageClass.Parameters["pathPattern"]
-	if exists {
+	if !exists || pathPattern == "" {
-		customPath := metadata.stringParser(pathPattern)
+		pathPattern = defaultPathPattern
-		if customPath != "" {
-			path = filepath.Join(p.path, customPath)
-			fullPath = filepath.Join(mountPath, customPath)
 	}
+
+	parsedPath := metadata.stringParser(pathPattern)
+	if parsedPath == "" {
+		return nil, controller.ProvisioningFinished, errors.New("unable to parse pathPattern: " + pathPattern)
 	}
+	path := filepath.Join(p.path, parsedPath)
+	fullPath := filepath.Join(mountPath, parsedPath)
 
 	glog.V(4).Infof("creating path %s", fullPath)
 	if err := os.MkdirAll(fullPath, 0o777); err != nil {