From 51eec030e0070c8b86f1f20db3e56bb4a9fa799e Mon Sep 17 00:00:00 2001 From: Starttoaster Date: Mon, 10 Feb 2025 13:57:16 -0800 Subject: [PATCH] Add notes to readme on maintainership and versioning --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7088fb41..5e875083 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Kubernetes NFS Subdir External Provisioner -This is a fork of an upstream kubernetes-sigs project [here](https://github.com/kubernetes-sigs/nfs-subdir-external-provisioner). The upstream project has seen little support in years, resulting in horribly insecure build artifacts since their images aren't rebuilt over time, and with no new releases they haven't been able to publish a new image with fewer CVEs from the base image. This project is unlikely to see much in the way of features in this fork, but should be more secure to run with a more up-to-date base image and Go dependencies. +This is a fork of [kubernetes-sigs/nfs-subdir-external-provisioner](https://github.com/kubernetes-sigs/nfs-subdir-external-provisioner). This fork will receive security updates, but it won't receive feature updates. The goal of this project is just to offer a more secure version of the kubernetes-sigs project with a distroless base container image and updated Golang dependencies. Unfortunately, since the upstream project lost maintainership, it had accrued a number of critical CVEs, and runs on an EoL Alpine Linux version. -**NFS subdir external provisioner** is an automatic provisioner that use your _existing and already configured_ NFS server to support dynamic provisioning of Kubernetes Persistent Volumes via Persistent Volume Claims. Persistent volumes are provisioned as `${namespace}-${pvcName}-${pvName}`. +**NFS subdir external provisioner** is an automatic provisioner that uses your _existing and already configured_ NFS server to support dynamic provisioning of Kubernetes Persistent Volumes via Persistent Volume Claims. Persistent volumes are provisioned as `${namespace}-${pvcName}-${pvName}`. ## How to deploy NFS Subdir External Provisioner to your cluster @@ -25,3 +25,7 @@ helm install nfs-subdir-external-provisioner nfs-subdir-external-provisioner/nfs * The provisioned storage is not guaranteed. You may allocate more than the NFS share's total size. The share may also not have enough storage space left to actually accommodate the request. * The provisioned storage limit is not enforced. The application can expand to use all the available storage regardless of the provisioned size. * Storage resize/expansion operations are not presently supported in any form. You will end up in an error state: `Ignoring the PVC: didn't find a plugin capable of expanding the volume; waiting for an external controller to process this PVC.` + +# Note on Versioning + +Note that this fork continued on with the existing versioning from the upstream kubernetes-sigs project, which abandoned the project at v4.0.2. This means that if kubernetes ever picks up and continues the source project, v4.0.3 and greater in this fork would not be identical code to v4.0.3 and greater in the upstream kubernetes-sigs project. Be aware of this difference if migrating between one or the other. This fork is a compatible replacement for kubernetes-sigs/nfs-subdir-external-provisioner@v4.0.2, which is the latest release there at time of writing.