nfs-provisioner-operator

NFS Provisioner Operator

Kubernetes operator that deploys an NFS server and provides a StorageClass for dynamic PV provisioning.

What it does

• Deploys an NFS server pod with flexible storage backend
• Creates a nfs StorageClass for dynamic PV provisioning (ReadWriteMany)
• Handles RBAC, ServiceAccount, and SCC (OpenShift) automatically

Quick Start

# Install CRDs
kubectl apply -f config/crd/bases/

# Run operator
make run

# Create NFS server (uses cluster default StorageClass)
kubectl apply -f config/samples/cache_v1alpha1_nfsprovisioner_default_sc.yaml

# Create a PVC using NFS
kubectl apply -f - <<EOF
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: my-nfs-claim
spec:
  storageClassName: nfs
  accessModes: [ReadWriteMany]
  resources:
    requests:
      storage: 1Gi
EOF

Storage Modes

See config/samples/ for example CRs.

Installation

Testing

make test           # Unit tests (80%+ coverage)
make test-e2e       # E2E on Kind
make test-e2e-ocp   # E2E on OpenShift
make lint           # Linter

Documentation

Project Structure

pkg/
├── validation/    # CR validation
├── defaults/      # Default value application
├── builder/       # Stateless resource construction
├── resources/     # Resource lifecycle managers
└── reconciler/    # Reconciliation orchestration

controllers/       # Thin controller wrapper
catalog/           # File-Based Catalog (FBC) for OLM
test/
├── integration/   # envtest-based tests
└── e2e/           # Kind + OpenShift E2E tests