Back to Charts

⚠️ Repo Archive Notice

stable/nfs-client-provisioner/README.md

latest6.1 KB
Original Source

⚠️ Repo Archive Notice

As of Nov 13, 2020, charts in this repo will no longer be updated. For more information, see the Helm Charts Deprecation and Archive Notice, and Update.

nfs-client-provisioner

The NFS client provisioner is an automatic provisioner for Kubernetes that uses your already configured NFS server, automatically creating Persistent Volumes.

DEPRECATION NOTICE

This chart is deprecated and no longer supported.

TL;DR;

console
$ helm install --set nfs.server=x.x.x.x --set nfs.path=/exported/path stable/nfs-client-provisioner

For arm deployments set image.repository to --set image.repository=quay.io/external_storage/nfs-client-provisioner-arm

Introduction

This charts installs custom storage class into a Kubernetes cluster using the Helm package manager. It also installs a NFS client provisioner into the cluster which dynamically creates persistent volumes from single NFS share.

Prerequisites

  • Kubernetes 1.9+
  • Existing NFS Share

Installing the Chart

To install the chart with the release name my-release:

console
$ helm install --name my-release --set nfs.server=x.x.x.x --set nfs.path=/exported/path stable/nfs-client-provisioner

The command deploys the given storage class in the default configuration. It can be used afterswards to provision persistent volumes. The configuration section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

console
$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following tables lists the configurable parameters of this chart and their default values.

ParameterDescriptionDefault
replicaCountNumber of provisioner instances to deployed1
strategyTypeSpecifies the strategy used to replace old Pods by new onesRecreate
image.repositoryProvisioner imagequay.io/external_storage/nfs-client-provisioner
image.tagVersion of provisioner imagev3.1.0-k8s1.11
image.pullPolicyImage pull policyIfNotPresent
storageClass.nameName of the storageClassnfs-client
storageClass.defaultClassSet as the default StorageClassfalse
storageClass.allowVolumeExpansionAllow expanding the volumetrue
storageClass.reclaimPolicyMethod used to reclaim an obsoleted volumeDelete
storageClass.provisionerNameName of the provisionerNamenull
storageClass.archiveOnDeleteArchive pvc when deletingtrue
storageClass.accessModesSet access mode for PVReadWriteOnce
nfs.serverHostname of the NFS servernull (ip or hostname)
nfs.pathBasepath of the mount point to be used/ifs/kubernetes
nfs.mountOptionsMount options (e.g. 'nfsvers=3')null
resourcesResources required (e.g. CPU, memory){}
rbac.createUse Role-based Access Controltrue
podSecurityPolicy.enabledCreate & use Pod Security Policy resourcesfalse
priorityClassNameSet pod priorityClassNamenull
serviceAccount.createShould we create a ServiceAccounttrue
serviceAccount.nameName of the ServiceAccount to usenull
nodeSelectorNode labels for pod assignment{}
affinityAffinity settings{}
tolerationsList of node taints to tolerate[]