Merge pull request #456 from twelho/job-tolerations

feat: support applying tolerations to cleanup jobs

Author: andyzhangx

helm/generated_examples/baremetal-tolerations.yaml

@@ -23,6 +23,9 @@ metadata:
     app.kubernetes.io/managed-by: Helm
     app.kubernetes.io/instance: local-static-provisioner
 data:
+  jobTolerations: | 
+    - effect: NoSchedule
+      key: node-role.kubernetes.io/master
   storageClassMap: |
     local-storage:
       hostDir: /mnt/disks
@@ -114,7 +117,7 @@ spec:
         app.kubernetes.io/name: local-static-provisioner
         app.kubernetes.io/instance: local-static-provisioner
       annotations:
-        checksum/config: f81e575a8ce66fff1873e5bae2df0f963609f540da196b9a86c3146a94d284b8
+        checksum/config: bdea962be4bc6072011b44367cc56d21c61868009d4cb63b6415c1c27695ce96
     spec:
       serviceAccountName: local-static-provisioner
       nodeSelector:

helm/provisioner/templates/configmap.yaml

@@ -27,6 +27,9 @@ data:
 {{- if .Values.useJobForCleaning }}
   useJobForCleaning: "yes"
 {{- end}}
+{{- if .Values.tolerations }}
+  jobTolerations: | {{ toYaml .Values.tolerations | nindent 4 }}
+{{- end }}
 {{- if .Values.useNodeNameOnly }}
   useNodeNameOnly: "true"
 {{- end }}

pkg/common/common.go

@@ -108,6 +108,8 @@ type UserConfig struct {
 	Namespace string
 	// JobContainerImage of container to use for jobs (optional)
 	JobContainerImage string
+	// JobTolerations defines the tolerations to apply to jobs (optional)
+	JobTolerations []v1.Toleration
 	// MinResyncPeriod is minimum resync period. Resync period in reflectors
 	// will be random between MinResyncPeriod and 2*MinResyncPeriod.
 	MinResyncPeriod metav1.Duration
@@ -205,6 +207,9 @@ type ProvisionerConfiguration struct {
 	// default is false.
 	// +optional
 	UseJobForCleaning bool `json:"useJobForCleaning" yaml:"useJobForCleaning"`
+	// JobTolerations defines the tolerations to apply to jobs
+	// +optional
+	JobTolerations []v1.Toleration `json:"jobTolerations" yaml:"jobTolerations"`
 	// MinResyncPeriod is minimum resync period. Resync period in reflectors
 	// will be random between MinResyncPeriod and 2*MinResyncPeriod.
 	MinResyncPeriod metav1.Duration `json:"minResyncPeriod" yaml:"minResyncPeriod"`
@@ -397,6 +402,7 @@ func UserConfigFromProvisionerConfig(node *v1.Node, namespace, jobImage string,
 		UseNodeNameOnly:   config.UseNodeNameOnly,
 		Namespace:         namespace,
 		JobContainerImage: jobImage,
+		JobTolerations:    config.JobTolerations,
 		LabelsForPV:       config.LabelsForPV,
 		SetPVOwnerRef:     config.SetPVOwnerRef,
 	}

pkg/deleter/deleter.go

@@ -358,7 +358,7 @@ func (d *Deleter) runJob(pv *v1.PersistentVolume, volMode v1.PersistentVolumeMod
 	if d.JobContainerImage == "" {
 		return fmt.Errorf("cannot run cleanup job without specifying job image name in the environment variable")
 	}
-	job, err := NewCleanupJob(pv, volMode, d.JobContainerImage, d.Node.Name, d.Namespace, mountPath, config)
+	job, err := NewCleanupJob(pv, volMode, d.JobContainerImage, d.JobTolerations, d.Node.Name, d.Namespace, mountPath, config)
 	if err != nil {
 		return err
 	}

pkg/deleter/jobcontroller.go

@@ -253,7 +253,7 @@ func (c *jobController) RemoveJob(pvName string) (CleanupState, *time.Time, erro
 }
 
 // NewCleanupJob creates manifest for a cleaning job.
-func NewCleanupJob(pv *apiv1.PersistentVolume, volMode apiv1.PersistentVolumeMode, imageName string, nodeName string, namespace string, mountPath string, config common.MountConfig) (*batch_v1.Job, error) {
+func NewCleanupJob(pv *apiv1.PersistentVolume, volMode apiv1.PersistentVolumeMode, imageName string, tolerations []apiv1.Toleration, nodeName string, namespace string, mountPath string, config common.MountConfig) (*batch_v1.Job, error) {
 	priv := true
 	// Container definition
 	jobContainer := apiv1.Container{
@@ -325,6 +325,7 @@ func NewCleanupJob(pv *apiv1.PersistentVolume, volMode apiv1.PersistentVolumeMod
 		Containers:   []apiv1.Container{jobContainer},
 		Volumes:      volumes,
 		NodeSelector: map[string]string{common.NodeNameLabel: nodeName},
+		Tolerations:  tolerations,
 	}
 	podTemplate.ObjectMeta = meta_v1.ObjectMeta{
 		Name:        generateCleaningJobName(pv.Name),