Chainguard Container for kubernetes-csi-driver-nfs

This driver allows Kubernetes to access an NFS server running on a Linux node.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/kubernetes-csi-driver-nfs:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

Chainguard's kubernetes-csi-driver-nfs Image is comparable to the official nfsplugin Image from Docker Hub. However, the Chainguard image contains only the minimum set of tools and dependencies needed to function. This means it doesn't include things like a shell or a package manager.

Getting started

Set up an NFS server

If you already have an NFS server setup, you can skip this step.

If you don't have an existing NFS server setup, you can use the following YAML to get a minimal nfs-server setup up and running. Note that this is not a production setup, and is just meant to test the Chainguard image:

apiVersion: v1
kind: Service
metadata:
  name: nfs-server
  namespace: default
spec:
  ports:
    - name: nfs
      port: 2049
      protocol: TCP
    - name: rpcbind-tcp
      port: 111
      protocol: TCP
    - name: rpcbind-udp
      port: 111
      protocol: UDP
    - name: mountd-tcp
      port: 20048
      protocol: TCP
    - name: mountd-udp
      port: 20048
      protocol: UDP
  selector:
    app: nfs-server
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: nfs-server
  namespace: default
spec:
  replicas: 1
  selector:
    matchLabels:
      app: nfs-server
  template:
    metadata:
      labels:
        app: nfs-server
    spec:
      containers:
        - name: nfs-server
          image: itsthenetwork/nfs-server-alpine:latest
          securityContext:
            privileged: true
          ports:
            - name: nfs
              containerPort: 2049
            - name: rpcbind
              containerPort: 111
            - name: mountd
              containerPort: 20048
          env:
            - name: SHARED_DIRECTORY
              value: "/exports"
          volumeMounts:
            - name: nfs-data
              mountPath: "/exports"
      volumes:
        - name: nfs-data
          hostPath:
            path: /mnt/nfs-share
            type: DirectoryOrCreate

This YAML will set up a server to expose the other server and deployment that run the server pod.

Install csi-driver-nfs with Helm

In this section you will use the Helm chart available from the NFS CSI driver for Kubernetes GitHub repository. This will enable Kubernetes to handle NFS volumes:

helm repo add csi-driver-nfs https://raw.githubusercontent.com/kubernetes-csi/csi-driver-nfs/master/charts
helm install csi-driver-nfs csi-driver-nfs/csi-driver-nfs --namespace kube-system \
--set image.nfs.repository=cgr.dev/ORGANIZATION/kubernetes-csi-driver-nfs \
--set image.nfs.tag=latest

Usage

Say you want to tell Kubernetes how to provision storage using NFS. To do this, you'll first need to retrieve the NFS server's clusterIP:

NFS_SERVER_IP=$(kubectl get svc nfs-server -o jsonpath='{.spec.clusterIP}')

Next, you would create a storage class that tells Kubernetes to use the NFS server for storage:

apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
  name: nfs-csi
provisioner: nfs.csi.k8s.io
parameters:
  server: $NFS_SERVER_IP
  share: /
mountOptions:
  - nolock
  - vers=4
reclaimPolicy: Retain
volumeBindingMode: Immediate

Following that, create a Persistent Volume Claim (PVC) that will request storage from the storage class:

apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: nfs-pvc
  namespace: default
spec:
  accessModes:
    - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: nfs-csi

To test that this setup will work, create a pod that uses the PVC:

apiVersion: v1
kind: Pod
metadata:
  name: nfs-pvc-test
  namespace: default
spec:
  containers:
    - name: nfs-test
      image: cgr.dev/chainguard/wolfi-base:latest
      command: ["sh", "-c", "sleep infinity"]
      volumeMounts:
        - mountPath: "/mnt/nfs"
          name: nfs-storage
  volumes:
    - name: nfs-storage
      persistentVolumeClaim:
        claimName: nfs-pvc

Finally, check whether the pod was created and in a Ready state:

kubectl wait --for=condition=Ready pod/nfs-pvc-test --timeout=120s

This will confirm the csi-driver was able to provision a persistent volume for the pod and that the csi-driver is working as expected.

Documentation and Resources

• Upstream Helm charts

What are Chainguard Containers?

Chainguard Containers are minimal container images that are secure by default.

In many cases, the Chainguard Containers tagged as :latest contain only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager. Chainguard Containers are built with Wolfi, our Linux undistro designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a -dev variant.

Although the -dev container image variants have similar security features as their more minimal versions, they feature additional software that is typically not necessary in production environments. We recommend using multi-stage builds to leverage the -dev variants, copying application artifacts into a final minimal container that offers a reduced attack surface that won’t allow package installations or logins.

Learn More

To better understand how to work with Chainguard Containers, please visit Chainguard Academy and Chainguard Courses.

In addition to Containers, Chainguard offers VMs and Libraries. Contact Chainguard to access additional products.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.