heathcliff26/p3 repository overview

⁠P3 (Predictable Path Provisioner)

A Kubernetes external dynamic provisioner that creates local PersistentVolumes under human-readable folder paths.

⁠Table of Contents

• P3 (Predictable Path Provisioner)⁠
  • Table of Contents⁠
  • Important considerations⁠
  • Installation⁠
    • Using helm⁠
    • Using kubectl⁠
  • Usage⁠
    • Example storage classes⁠
      • With defaults:⁠
      • With custom basePath and pathTemplate:⁠
  • Container Images⁠
    • Image location⁠
    • Tags⁠

⁠Important considerations

• There is mechanism to prevent path collisions. Use custom name templates at your own risk.
• This is mostly a hobby project, intended for my own use. Use at your own risk.
• Only AccessModes ReadWriteOnce and ReadWriteOncePod is supported.

⁠Installation

⁠Using helm

P3 helm charts are released via oci repos and can be installed with:

helm install p3 oci://ghcr.io/heathcliff26/manifests/predictable-path-provisioner --version <version>

Please use the latest version from the releases page⁠.

⁠Using kubectl

An example deployment can be found here⁠.

To deploy it to your cluster, run:

kubectl apply -f https://raw.githubusercontent.com/heathcliff26/predictable-path-provisioner/main/examples/p3.yaml

This will deploy the app to your cluster into the namespace p3.

⁠Usage

By default P3 uses the provisioner name heathcliff.eu/predictable-path-provisioner.

It's behaviour can be configured via the StorageClass parameters. The following parameters are supported:

⁠Example storage classes

⁠With defaults:

---
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
  name: "p3"
  annotations:
    storageclass.kubernetes.io/is-default-class: "true"
provisioner: heathcliff.eu/predictable-path-provisioner
reclaimPolicy: Delete
volumeBindingMode: Immediate

This would result in the Persistent Volume for the Claim default/test being created under /var/lib/predictable-path-provisioner/default/test.

⁠With custom basePath and pathTemplate:

---
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
  name: "p3"
  annotations:
    storageclass.kubernetes.io/is-default-class: "true"
provisioner: heathcliff.eu/predictable-path-provisioner
parameters:
    basePath: /data/p3
    pathTemplate: pvc-{{pvc.uid}}
reclaimPolicy: Delete
volumeBindingMode: Immediate

This would result in the Persistent Volume being created under /data/p3/pvc-<some-uid>

⁠Container Images

⁠Image location

⁠Tags

There are different flavors of the image: