Set default volume type in storage class

README.md

@@ -231,6 +231,24 @@ If the reload fails, the provisioner will log the error and **continue using the
 
 >time="2018-10-03T06:39:28Z" level=error msg="failed to load the new config file: config canonicalization failed: duplicate node yasker-lp-dev3"
 
+### Volume Types
+
+To specify the type of volume you want the provisioner to create, add either of the following annotations;
+
+- PVC: 
+```yaml
+annotations:
+  volumeType: <local or hostPath>
+```
+
+- StorageClass:
+```yaml
+annotations:
+  defaultVolumeType: <local or hostPath>
+```
+
+A few things to note; the annotation for the `StorageClass` will apply to all volumes using it and is superseded by the annotation on the PVC if one is provided. If neither of the annotations was provided then we default to `hostPath`.
+
 ## Uninstall
 
 Before uninstallation, make sure the PVs created by the provisioner have already been deleted. Use `kubectl get pv` and make sure no PV with StorageClass `local-path`.

provisioner.go

@@ -45,6 +45,7 @@ const (
 
 const (
 	defaultCmdTimeoutSeconds = 120
+	defaultVolumeType        = "hostPath"
 )
 
 var (
@@ -282,20 +283,18 @@ func (p *LocalPathProvisioner) Provision(ctx context.Context, opts pvController.
 	fs := v1.PersistentVolumeFilesystem
 
 	var pvs v1.PersistentVolumeSource
-	if val, ok := opts.PVC.GetAnnotations()["volumeType"]; ok && strings.ToLower(val) == "local" {
-		pvs = v1.PersistentVolumeSource{
-			Local: &v1.LocalVolumeSource{
-				Path: path,
-			},
-		}
+	var volumeType string
+	if dVal, ok := opts.StorageClass.GetAnnotations()["defaultVolumeType"]; ok {
+		volumeType = dVal
 	} else {
-		hostPathType := v1.HostPathDirectoryOrCreate
-		pvs = v1.PersistentVolumeSource{
-			HostPath: &v1.HostPathVolumeSource{
-				Path: path,
-				Type: &hostPathType,
-			},
-		}
+		volumeType = defaultVolumeType
+	}
+	if val, ok := opts.PVC.GetAnnotations()["volumeType"]; ok {
+		volumeType = val
+	}
+	pvs, err = createPersistentVolumeSource(volumeType, path)
+	if err != nil {
+		return nil, pvController.ProvisioningFinished, err
 	}
 
 	var nodeAffinity *v1.VolumeNodeAffinity
@@ -655,3 +654,30 @@ func canonicalizeConfig(data *ConfigData) (cfg *Config, err error) {
 	}
 	return cfg, nil
 }
+
+func createPersistentVolumeSource(volumeType string, path string) (pvs v1.PersistentVolumeSource, err error) {
+	defer func() {
+		err = errors.Wrapf(err, "failed to create persistent volume source")
+	}()
+
+	switch strings.ToLower(volumeType) {
+	case "local":
+		pvs = v1.PersistentVolumeSource{
+			Local: &v1.LocalVolumeSource{
+				Path: path,
+			},
+		}
+	case "hostpath":
+		hostPathType := v1.HostPathDirectoryOrCreate
+		pvs = v1.PersistentVolumeSource{
+			HostPath: &v1.HostPathVolumeSource{
+				Path: path,
+				Type: &hostPathType,
+			},
+		}
+	default:
+		return pvs, fmt.Errorf("\"%s\" is not a recognised volume type", volumeType)
+	}
+
+	return pvs, nil
+}

test/pod_test.go

@@ -1,3 +1,4 @@
+//go:build e2e
 // +build e2e
 
 package test
@@ -6,9 +7,9 @@ import (
 	"fmt"
 	"github.com/kelseyhightower/envconfig"
 	"github.com/stretchr/testify/suite"
+	"strings"
 	"testing"
 	"time"
-	"strings"
 )
 
 const (
@@ -89,6 +90,12 @@ func (p *PodTestSuite) TestPodWithLocalVolume() {
 	runTest(p, []string{p.config.IMAGE}, "ready", localVolumeType)
 }
 
+func (p *PodTestSuite) TestPodWithLocalVolumeDefault() {
+	p.kustomizeDir = "pod-with-default-local-volume"
+
+	runTest(p, []string{p.config.IMAGE}, "ready", localVolumeType)
+}
+
 func (p *PodTestSuite) TestPodWithNodeAffinity() {
 	p.kustomizeDir = "pod-with-node-affinity"
 

test/testdata/pod-with-default-local-volume/kustomization.yaml

@@ -0,0 +1,12 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+- ../../../deploy
+- ../../../examples/pod
+patches:
+- path: patch.yaml
+commonLabels:
+  app: local-path-provisioner
+images:
+- name: rancher/local-path-provisioner
+  newTag: dev

test/testdata/pod-with-default-local-volume/patch.yaml

@@ -0,0 +1,9 @@
+apiVersion: storage.k8s.io/v1
+kind: StorageClass
+metadata:
+  name: local-path
+  annotations:
+    defaultVolumeType: local
+provisioner: rancher.io/local-path
+reclaimPolicy: Delete
+volumeBindingMode: WaitForFirstConsumer