docs: document local path provisioner install

Use kustomize (as the official supported way for Local Path Provisioner). Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
siderolabs · Jan 26, 2024 · f11139c · f11139c
1 parent e0dfbb8
commit f11139c
Show file tree

Hide file tree

Showing 2 changed files with 96 additions and 0 deletions.
diff --git a/website/content/v1.6/kubernetes-guides/configuration/local-storage.md b/website/content/v1.6/kubernetes-guides/configuration/local-storage.md
@@ -33,3 +33,51 @@ Both `EPHEMERAL` partition and user disks can be used for `hostPath` mounts.
 [Local Path Provisioner](https://github.com/rancher/local-path-provisioner) can be used to dynamically provision local storage.
 Make sure to update its configuration to use a path under `/var`, e.g. `/var/local-path-provisioner` as the root path for the local storage.
 (In Talos Linux default local path provisioner path `/opt/local-path-provisioner` is read-only).
+
+For example, Local Path Provisioner can be installed using [kustomize](https://kustomize.io/) with the following configuration:
+
+```yaml
+# kustomization.yaml
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+- github.com/rancher/local-path-provisioner/deploy?ref=v0.0.26
+patches:
+- patch: |-
+    kind: ConfigMap
+    apiVersion: v1
+    metadata:
+      name: local-path-config
+      namespace: local-path-storage
+    data:
+      config.json: |-
+        {
+                "nodePathMap":[
+                {
+                        "node":"DEFAULT_PATH_FOR_NON_LISTED_NODES",
+                        "paths":["/var/local-path-provisioner"]
+                }
+                ]
+        }
+- patch: |-
+    apiVersion: storage.k8s.io/v1
+    kind: StorageClass
+    metadata:
+      name: local-path
+      annotations:
+        storageclass.kubernetes.io/is-default-class: "true"
+- patch: |-
+    apiVersion: v1
+    kind: Namespace
+    metadata:
+      name: local-path-storage
+      labels:
+        pod-security.kubernetes.io/enforce: privileged
+```
+
+Put `kustomization.yaml` into a new directory, and run `kustomize build | kubectl apply -f -` to install Local Path Provisioner to a Talos Linux cluster.
+There are three patches applied:
+
+* change default `/opt/local-path-provisioner` path to `/var/local-path-provisioner`
+* make `local-path` storage class the default storage class (optional)
+* label the `local-path-storage` namespace as privileged to allow privileged pods to be scheduled there
diff --git a/website/content/v1.7/kubernetes-guides/configuration/local-storage.md b/website/content/v1.7/kubernetes-guides/configuration/local-storage.md
@@ -33,3 +33,51 @@ Both `EPHEMERAL` partition and user disks can be used for `hostPath` mounts.
 [Local Path Provisioner](https://github.com/rancher/local-path-provisioner) can be used to dynamically provision local storage.
 Make sure to update its configuration to use a path under `/var`, e.g. `/var/local-path-provisioner` as the root path for the local storage.
 (In Talos Linux default local path provisioner path `/opt/local-path-provisioner` is read-only).
+
+For example, Local Path Provisioner can be installed using [kustomize](https://kustomize.io/) with the following configuration:
+
+```yaml
+# kustomization.yaml
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+- github.com/rancher/local-path-provisioner/deploy?ref=v0.0.26
+patches:
+- patch: |-
+    kind: ConfigMap
+    apiVersion: v1
+    metadata:
+      name: local-path-config
+      namespace: local-path-storage
+    data:
+      config.json: |-
+        {
+                "nodePathMap":[
+                {
+                        "node":"DEFAULT_PATH_FOR_NON_LISTED_NODES",
+                        "paths":["/var/local-path-provisioner"]
+                }
+                ]
+        }
+- patch: |-
+    apiVersion: storage.k8s.io/v1
+    kind: StorageClass
+    metadata:
+      name: local-path
+      annotations:
+        storageclass.kubernetes.io/is-default-class: "true"
+- patch: |-
+    apiVersion: v1
+    kind: Namespace
+    metadata:
+      name: local-path-storage
+      labels:
+        pod-security.kubernetes.io/enforce: privileged
+```
+
+Put `kustomization.yaml` into a new directory, and run `kustomize build | kubectl apply -f -` to install Local Path Provisioner to a Talos Linux cluster.
+There are three patches applied:
+
+* change default `/opt/local-path-provisioner` path to `/var/local-path-provisioner`
+* make `local-path` storage class the default storage class (optional)
+* label the `local-path-storage` namespace as privileged to allow privileged pods to be scheduled there