make helper pod configurable and add xfs quota example

rancher · Oct 15, 2020 · 8740885 · 8740885
1 parent c3192ec
commit 8740885
Show file tree

Hide file tree

Showing 18 changed files with 625 additions and 96 deletions.
diff --git a/README.md b/README.md
@@ -132,12 +132,49 @@ data:
         }
   setup: |-
         #!/bin/sh
-        path=$1
-        mkdir -m 0777 -p ${path}
+        while getopts "m:s:p:" opt
+        do
+            case $opt in
+                p)
+                absolutePath=$OPTARG
+                ;;
+                s)
+                sizeInBytes=$OPTARG
+                ;;
+                m)
+                volMode=$OPTARG
+                ;;
+            esac
+        done
+
+        mkdir -m 0777 -p ${absolutePath}
   teardown: |-
         #!/bin/sh
-        path=$1
-        rm -rf ${path}
+        while getopts "m:s:p:" opt
+        do
+            case $opt in
+                p)
+                absolutePath=$OPTARG
+                ;;
+                s)
+                sizeInBytes=$OPTARG
+                ;;
+                m)
+                volMode=$OPTARG
+                ;;
+            esac
+        done
+
+        rm -rf ${absolutePath}
+  helperPod.yaml: |-
+        apiVersion: v1
+        kind: Pod
+        metadata:
+          name: helper-pod
+        spec:
+          containers:
+          - name: helper-pod
+            image: busybox
 
 ```
 
@@ -158,12 +195,17 @@ The configuration must obey following rules:
 3. No duplicate paths allowed for one node.
 4. No duplicate node allowed.
 
-#### Scripts `setup` and `teardown`
+#### Scripts `setup` and `teardown` and `helperPod.yaml`
 
 The script `setup` will be executed before the volume is created, to prepare the directory on the node for the volume.
 
 The script `teardown` will be executed after the volume is deleted, to cleanup the directory on the node for the volume.
 
+The yaml file `helperPod.yaml` will be created by local-path-storage to execute `setup` or `teardown` script with three paramemters  `-p <path> -s <size> -m <mode>` :
+* path: the absolute path provisioned on the node
+- size: pvc.Spec.resources.requests.storage in bytes
+* mode: pvc.Spec.VolumeMode
+
 #### Reloading
 
 The provisioner supports automatic configuration reloading. Users can change the configuration using `kubectl apply` or `kubectl edit` with config map `local-path-config`. There is a delay between when the user updates the config map and the provisioner picking it up.
@@ -198,7 +240,7 @@ git clone https://github.com/rancher/local-path-provisioner.git
 cd local-path-provisioner
 go build
 kubectl apply -f debug/config.yaml
-./local-path-provisioner --debug start --namespace=local-path-storage
+./local-path-provisioner --debug start --service-account-name=default
 ```
 
 ### example

diff --git a/debug/config.yaml b/debug/config.yaml
@@ -39,10 +39,47 @@ data:
         }
   setup: |-
         #!/bin/sh
-        path=$1
-        mkdir -m 0777 -p ${path}
+        while getopts "m:s:p:" opt
+        do
+            case $opt in
+                p)
+                absolutePath=$OPTARG
+                ;;
+                s)
+                sizeInBytes=$OPTARG
+                ;;
+                m)
+                volMode=$OPTARG
+                ;;
+            esac
+        done
+
+        mkdir -m 0777 -p ${absolutePath}
   teardown: |-
         #!/bin/sh
-        path=$1
-        rm -rf ${path}
+        while getopts "m:s:p:" opt
+        do
+            case $opt in
+                p)
+                absolutePath=$OPTARG
+                ;;
+                s)
+                sizeInBytes=$OPTARG
+                ;;
+                m)
+                volMode=$OPTARG
+                ;;
+            esac
+        done
+
+        rm -rf ${absolutePath}
+  helperPod.yaml: |-
+        apiVersion: v1
+        kind: Pod
+        metadata:
+          name: helper-pod
+        spec:
+          containers:
+          - name: helper-pod
+            image: busybox
 
diff --git a/deploy/chart/README.md b/deploy/chart/README.md
@@ -71,9 +71,11 @@ default values.
 | `nodeSelector`                      | Node labels for Local Path Provisioner pod assignment                           | `{}`                                                                                |
 | `tolerations`                       | Node taints to tolerate                                                         | `[]`                                                                                |
 | `affinity`                          | Pod affinity                                                                    | `{}`                                                                                |
-| `configmap.setup`                   | Configuration of script to execute setup operations on each node                | #!/bin/sh<br>path=$1<br>mkdir -m 0777 -p ${path}                                    |
-| `configmap.teardown`                | Configuration of script to execute teardown operations on each node             | #!/bin/sh<br>path=$1<br>rm -rf ${path}                                              |
+| `configmap.setup`                   | Configuration of script to execute setup operations on each node                | #!/bin/sh<br>while getopts "m:s:p:" opt<br>do<br>&emsp;case $opt in <br>&emsp;&emsp;p)<br>&emsp;&emsp;absolutePath=$OPTARG<br>&emsp;&emsp;;;<br>&emsp;&emsp;s)<br>&emsp;&emsp;sizeInBytes=$OPTARG<br>&emsp;&emsp;;;<br>&emsp;&emsp;m)<br>&emsp;&emsp;volMode=$OPTARG<br>&emsp;&emsp;;;<br>&emsp;esac<br>done<br>mkdir -m 0777 -p ${absolutePath}                                    |
+| `configmap.teardown`                | Configuration of script to execute teardown operations on each node             | #!/bin/sh<br>while getopts "m:s:p:" opt<br>do<br>&emsp;case $opt in <br>&emsp;&emsp;p)<br>&emsp;&emsp;absolutePath=$OPTARG<br>&emsp;&emsp;;;<br>&emsp;&emsp;s)<br>&emsp;&emsp;sizeInBytes=$OPTARG<br>&emsp;&emsp;;;<br>&emsp;&emsp;m)<br>&emsp;&emsp;volMode=$OPTARG<br>&emsp;&emsp;;;<br>&emsp;esac<br>done<br>rm -rf ${absolutePath}                                              |
 | `configmap.name`                    | configmap name                                                                  | `local-path-config`                                                                 |
+| `configmap.helperPod`               | helper pod yaml file                                                            | apiVersion: v1<br>kind: Pod<br>metadata:<br>&emsp;name: helper-pod<br>spec:<br>&emsp;containers:<br>&emsp;- name: helper-pod<br>&emsp;&emsp;image: busybox |
+
 
 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
 

diff --git a/deploy/chart/templates/clusterrole.yaml b/deploy/chart/templates/clusterrole.yaml
@@ -7,7 +7,7 @@ metadata:
 {{ include "local-path-provisioner.labels" . | indent 4 }}
 rules:
 - apiGroups: [""]
-  resources: ["nodes", "persistentvolumeclaims"]
+  resources: ["nodes", "persistentvolumeclaims", "configmaps"]
   verbs: ["get", "list", "watch"]
 - apiGroups: [""]
   resources: ["endpoints", "persistentvolumes", "pods"]

diff --git a/deploy/chart/templates/configmap.yaml b/deploy/chart/templates/configmap.yaml
@@ -13,3 +13,6 @@ data:
     {{ .Values.configmap.setup | nindent 4 }}
   teardown: |-
     {{ .Values.configmap.teardown | nindent 4 }}
+  helperPod.yaml: |-
+    {{ .Values.configmap.helperPod | nindent 4 }}
+
diff --git a/deploy/chart/values.yaml b/deploy/chart/values.yaml
@@ -93,11 +93,52 @@ configmap:
   # specify the custom script for setup and teardown
   setup: |-
     #!/bin/sh
-    path=$1
-    mkdir -m 0777 -p ${path}
-
+    while getopts "m:s:p:" opt
+    do
+        case $opt in
+            p)
+            absolutePath=$OPTARG
+            ;;
+            s)
+            sizeInBytes=$OPTARG
+            ;;
+            m)
+            volMode=$OPTARG
+            ;;
+        esac
+    done
+
+    mkdir -m 0777 -p ${absolutePath}
   teardown: |-
     #!/bin/sh
-    path=$1
-    rm -rf ${path}
+    while getopts "m:s:p:" opt
+    do
+        case $opt in
+            p)
+            absolutePath=$OPTARG
+            ;;
+            s)
+            sizeInBytes=$OPTARG
+            ;;
+            m)
+            volMode=$OPTARG
+            ;;
+        esac
+    done
+
+    rm -rf ${absolutePath}
+  # specify the custom helper pod yaml
+  helperPod: |-
+    apiVersion: v1
+    kind: Pod
+    metadata:
+      name: helper-pod
+    spec:
+      containers:
+      - name: helper-pod
+        image: busybox
+
+
+
+
 
diff --git a/deploy/example-config.yaml b/deploy/example-config.yaml
@@ -23,10 +23,48 @@ data:
         }
   setup: |-
         #!/bin/sh
-        path=$1
-        mkdir -m 0777 -p ${path}
+        while getopts "m:s:p:" opt
+        do
+            case $opt in
+                p)
+                absolutePath=$OPTARG
+                ;;
+                s)
+                sizeInBytes=$OPTARG
+                ;;
+                m)
+                volMode=$OPTARG
+                ;;
+            esac
+        done
+
+        mkdir -m 0777 -p ${absolutePath}
   teardown: |-
         #!/bin/sh
-        path=$1
-        rm -rf ${path}
+        while getopts "m:s:p:" opt
+        do
+            case $opt in
+                p)
+                absolutePath=$OPTARG
+                ;;
+                s)
+                sizeInBytes=$OPTARG
+                ;;
+                m)
+                volMode=$OPTARG
+                ;;
+            esac
+        done
+
+        rm -rf ${absolutePath}
+  helperPod.yaml: |-
+        apiVersion: v1
+        kind: Pod
+        metadata:
+          name: helper-pod
+        spec:
+          containers:
+          - name: helper-pod
+            image: busybox
+
 
diff --git a/deploy/local-path-storage.yaml b/deploy/local-path-storage.yaml
@@ -15,7 +15,7 @@ metadata:
   name: local-path-provisioner-role
 rules:
 - apiGroups: [""]
-  resources: ["nodes", "persistentvolumeclaims"]
+  resources: ["nodes", "persistentvolumeclaims", "configmaps"]
   verbs: ["get", "list", "watch"]
 - apiGroups: [""]
   resources: ["endpoints", "persistentvolumes", "pods"]
@@ -104,10 +104,48 @@ data:
         }
   setup: |-
         #!/bin/sh
-        path=$1
-        mkdir -m 0777 -p ${path}
+        while getopts "m:s:p:" opt
+        do
+            case $opt in
+                p)
+                absolutePath=$OPTARG
+                ;;
+                s)
+                sizeInBytes=$OPTARG
+                ;;
+                m)
+                volMode=$OPTARG
+                ;;
+            esac
+        done
+
+        mkdir -m 0777 -p ${absolutePath}
   teardown: |-
         #!/bin/sh
-        path=$1
-        rm -rf ${path}
+        while getopts "m:s:p:" opt
+        do
+            case $opt in
+                p)
+                absolutePath=$OPTARG
+                ;;
+                s)
+                sizeInBytes=$OPTARG
+                ;;
+                m)
+                volMode=$OPTARG
+                ;;
+            esac
+        done
+
+        rm -rf ${absolutePath}
+  helperPod.yaml: |-
+        apiVersion: v1
+        kind: Pod
+        metadata:
+          name: helper-pod
+        spec:
+          containers:
+          - name: helper-pod
+            image: busybox
+
 
diff --git a/examples/quota/Dockerfile b/examples/quota/Dockerfile
@@ -0,0 +1,3 @@
+From centos:7
+RUN yum install -y xfsprogs
+
diff --git a/examples/quota/README.md b/examples/quota/README.md
@@ -0,0 +1,18 @@
+# Overview
+this is an example to enable quota for xfs 
+
+# Usage
+> 1. build a helper image using the sample dockerfile to replace helper image xxx/storage-xfs-quota:v0.1 at configmap(helperPod.yaml) of debug.yaml.
+> 2. use the sample setup and teardown script at configmap of debug.yaml
+
+Notice:
+> 1. make sure the path at nodePathMap is the mountpoint of xfs which enables pquota
+
+# debug
+```Bash
+> git clone https://github.com/rancher/local-path-provisioner.git
+> cd local-path-provisioner
+> go build
+> kubectl apply -f debug.yaml
+> ./local-path-provisioner --debug start --namespace=local-path-storage
+```