Helm Values


The values.yaml contains items used to tweak a deployment of this chart.

Cattle Settings

global.cattle.systemDefaultRegistrystring""System default registry
global.cattle.windowsCluster.defaultSetting.systemManagedComponentsNodeSelectorstring"kubernetes.io/os:linux"Node selector for Longhorn system managed components
global.cattle.windowsCluster.defaultSetting.taintTolerationstring"cattle.io/os=linux:NoSchedule"Toleration for Longhorn system managed components
global.cattle.windowsCluster.enabledboolfalseEnable this to allow Longhorn to run on the Rancher deployed Windows cluster
global.cattle.windowsCluster.nodeSelectorobject{"kubernetes.io/os":"linux"}Select Linux nodes to run Longhorn user deployed components
global.cattle.windowsCluster.tolerationslist[{"effect":"NoSchedule","key":"cattle.io/os","operator":"Equal","value":"linux"}]Tolerate Linux nodes to run Longhorn user deployed components

Network Policies

networkPolicies.enabledboolfalseEnable NetworkPolicies to limit access to the Longhorn pods
networkPolicies.typestring"k3s"Create the policy based on your distribution to allow access for the ingress. Options: k3s, rke2, rke1

Image Settings

image.csi.attacher.repositorystring"longhornio/csi-attacher"Specify CSI attacher image repository. Leave blank to autodetect
image.csi.attacher.tagstring"v4.2.0"Specify CSI attacher image tag. Leave blank to autodetect
image.csi.livenessProbe.repositorystring"longhornio/livenessprobe"Specify CSI liveness probe image repository. Leave blank to autodetect
image.csi.livenessProbe.tagstring"v2.9.0"Specify CSI liveness probe image tag. Leave blank to autodetect
image.csi.nodeDriverRegistrar.repositorystring"longhornio/csi-node-driver-registrar"Specify CSI node driver registrar image repository. Leave blank to autodetect
image.csi.nodeDriverRegistrar.tagstring"v2.7.0"Specify CSI node driver registrar image tag. Leave blank to autodetect
image.csi.provisioner.repositorystring"longhornio/csi-provisioner"Specify CSI provisioner image repository. Leave blank to autodetect
image.csi.provisioner.tagstring"v3.4.1"Specify CSI provisioner image tag. Leave blank to autodetect
image.csi.resizer.repositorystring"longhornio/csi-resizer"Specify CSI driver resizer image repository. Leave blank to autodetect
image.csi.resizer.tagstring"v1.7.0"Specify CSI driver resizer image tag. Leave blank to autodetect
image.csi.snapshotter.repositorystring"longhornio/csi-snapshotter"Specify CSI driver snapshotter image repository. Leave blank to autodetect
image.csi.snapshotter.tagstring"v6.2.1"Specify CSI driver snapshotter image tag. Leave blank to autodetect.
image.longhorn.backingImageManager.repositorystring"longhornio/backing-image-manager"Specify Longhorn backing image manager image repository
image.longhorn.backingImageManager.tagstring"master-head"Specify Longhorn backing image manager image tag
image.longhorn.engine.repositorystring"longhornio/longhorn-engine"Specify Longhorn engine image repository
image.longhorn.engine.tagstring"master-head"Specify Longhorn engine image tag
image.longhorn.instanceManager.repositorystring"longhornio/longhorn-instance-manager"Specify Longhorn instance manager image repository
image.longhorn.instanceManager.tagstring"master-head"Specify Longhorn instance manager image tag
image.longhorn.manager.repositorystring"longhornio/longhorn-manager"Specify Longhorn manager image repository
image.longhorn.manager.tagstring"master-head"Specify Longhorn manager image tag
image.longhorn.shareManager.repositorystring"longhornio/longhorn-share-manager"Specify Longhorn share manager image repository
image.longhorn.shareManager.tagstring"master-head"Specify Longhorn share manager image tag
image.longhorn.supportBundleKit.repositorystring"longhornio/support-bundle-kit"Specify Longhorn support bundle manager image repository
image.longhorn.supportBundleKit.tagstring"v0.0.27"Specify Longhorn support bundle manager image tag
image.longhorn.ui.repositorystring"longhornio/longhorn-ui"Specify Longhorn ui image repository
image.longhorn.ui.tagstring"master-head"Specify Longhorn ui image tag
image.openshift.oauthProxy.repositorystring"quay.io/openshift/origin-oauth-proxy"For openshift user. Specify oauth proxy image repository
image.openshift.oauthProxy.tagfloat4.13For openshift user. Specify oauth proxy image tag. Note: Use your OCP/OKD 4.X Version, Current Stable is 4.13
image.pullPolicystring"IfNotPresent"Image pull policy which applies to all user deployed Longhorn Components. e.g, Longhorn manager, Longhorn driver, Longhorn UI

Service Settings

service.manager.nodePortNodePort port number (to set explicitly, choose port between 30000-32767)
service.manager.typeDefine Longhorn manager service type.
service.ui.nodePortNodePort port number (to set explicitly, choose port between 30000-32767)
service.ui.typeDefine Longhorn UI service type. Options: ClusterIP, NodePort, LoadBalancer, Rancher-Proxy

StorageClass Settings

persistence.backingImage.dataSourceParametersstringnilSpecify the data source parameters for the backing image used in Longhorn StorageClass. This option accepts a json string of a map. e.g., '{\"url\":\"https://backing-image-example.s3-region.amazonaws.com/test-backing-image\"}'.
persistence.backingImage.dataSourceTypestringnilSpecify the data source type for the backing image used in Longhorn StorageClass. If the backing image does not exists, Longhorn will use this field to create a backing image. Otherwise, Longhorn will use it to verify the selected backing image.
persistence.backingImage.enableboolfalseSet backing image for Longhorn StorageClass
persistence.backingImage.expectedChecksumstringnilSpecify the expected SHA512 checksum of the selected backing image in Longhorn StorageClass
persistence.backingImage.namestringnilSpecify a backing image that will be used by Longhorn volumes in Longhorn StorageClass. If not exists, the backing image data source type and backing image data source parameters should be specified so that Longhorn will create the backing image before using it
persistence.defaultClassbooltrueSet Longhorn StorageClass as default
persistence.defaultClassReplicaCountint3Set replica count for Longhorn StorageClass
persistence.defaultDataLocalitystring"disabled"Set data locality for Longhorn StorageClass. Options: disabled, best-effort
persistence.defaultFsTypestring"ext4"Set filesystem type for Longhorn StorageClass
persistence.defaultMkfsParamsstring""Set mkfs options for Longhorn StorageClass
persistence.defaultNodeSelector.enableboolfalseEnable Node selector for Longhorn StorageClass
persistence.defaultNodeSelector.selectorstring""This selector enables only certain nodes having these tags to be used for the volume. e.g. "storage,fast"
persistence.migratableboolfalseSet volume migratable for Longhorn StorageClass
persistence.reclaimPolicystring"Delete"Define reclaim policy. Options: Retain, Delete
persistence.recurringJobSelector.enableboolfalseEnable recurring job selector for Longhorn StorageClass
persistence.recurringJobSelector.jobListlist[]Recurring job selector list for Longhorn StorageClass. Please be careful of quotes of input. e.g., [{"name":"backup", "isGroup":true}]
persistence.removeSnapshotsDuringFilesystemTrimstring"ignored"Allow automatically removing snapshots during filesystem trim for Longhorn StorageClass. Options: ignored, enabled, disabled

CSI Settings

csi.attacherReplicaCountSpecify replica count of CSI Attacher. Leave blank to use default count: 3
csi.kubeletRootDirSpecify kubelet root-dir. Leave blank to autodetect
csi.provisionerReplicaCountSpecify replica count of CSI Provisioner. Leave blank to use default count: 3
csi.resizerReplicaCountSpecify replica count of CSI Resizer. Leave blank to use default count: 3
csi.snapshotterReplicaCountSpecify replica count of CSI Snapshotter. Leave blank to use default count: 3

Longhorn Manager Settings

Longhorn system contains user deployed components (e.g, Longhorn manager, Longhorn driver, Longhorn UI) and system managed components (e.g, instance manager, engine image, CSI driver, etc.). These settings only apply to Longhorn manager component.

longhornManager.log.formatstring"plain"Options: plain, json
longhornManager.nodeSelectorobject{}Select nodes to run Longhorn manager
longhornManager.priorityClassstringnilPriority class for longhorn manager
longhornManager.serviceAnnotationsobject{}Annotation used in Longhorn manager service
longhornManager.tolerationslist[]Tolerate nodes to run Longhorn manager

Longhorn Driver Settings

Longhorn system contains user deployed components (e.g, Longhorn manager, Longhorn driver, Longhorn UI) and system managed components (e.g, instance manager, engine image, CSI driver, etc.). These settings only apply to Longhorn driver component.

longhornDriver.nodeSelectorobject{}Select nodes to run Longhorn driver
longhornDriver.priorityClassstringnilPriority class for longhorn driver
longhornDriver.tolerationslist[]Tolerate nodes to run Longhorn driver

Longhorn UI Settings

Longhorn system contains user deployed components (e.g, Longhorn manager, Longhorn driver, Longhorn UI) and system managed components (e.g, instance manager, engine image, CSI driver, etc.). These settings only apply to Longhorn UI component.

longhornUI.nodeSelectorobject{}Select nodes to run Longhorn UI
longhornUI.priorityClassstringnilPriority class count for longhorn ui
longhornUI.replicasint2Replica count for longhorn ui
longhornUI.tolerationslist[]Tolerate nodes to run Longhorn UI

Ingress Settings

ingress.annotationsstringnilIngress annotations done as key:value pairs
ingress.enabledboolfalseSet to true to enable ingress record generation
ingress.hoststring"sslip.io"Layer 7 Load Balancer hostname
ingress.ingressClassNamestringnilAdd ingressClassName to the Ingress Can replace the kubernetes.io/ingress.class annotation on v1.18+
ingress.pathstring"/"If ingress is enabled you can set the default ingress path then you can access the UI by using the following full path {{host}}+{{path}}
ingress.secretsstringnilIf you’re providing your own certificates, please use this to add the certificates as secrets
ingress.secureBackendsboolfalseEnable this in order to enable that the backend service will be connected at port 443
ingress.tlsboolfalseSet this to true in order to enable TLS on the ingress record
ingress.tlsSecretstring"longhorn.local-tls"If TLS is set to true, you must declare what secret will store the key/certificate for TLS

Private Registry Settings

Longhorn can be installed in an air gapped environment with private registry settings. Please refer to Air Gap Installation in our official site link

privateRegistry.createSecretSet true to create a new private registry secret
privateRegistry.registryPasswdPassword used to authenticate to private registry
privateRegistry.registrySecretIf create a new private registry secret is true, create a Kubernetes secret with this name; else use the existing secret of this name. Use it to pull images from your private registry
privateRegistry.registryUrlURL of private registry. Leave blank to apply system default registry
privateRegistry.registryUserUser used to authenticate to private registry

OS/Kubernetes Distro Settings

Opensift Settings

Please also refer to this document ocp-readme for more details

openshift.enabledboolfalseEnable when using openshift
openshift.ui.portint443UI port in openshift environment
openshift.ui.proxyint8443UI proxy in openshift environment
openshift.ui.routestring"longhorn-ui"UI route in openshift environment

Other Settings

annotations{}Annotations to add to the Longhorn Manager DaemonSet Pods. Optional.
enablePSPfalseFor Kubernetes < v1.25, if your cluster enables Pod Security Policy admission controller, set this to true to ship longhorn-psp which allow privileged Longhorn pods to start

System Default Settings

For system default settings, you can first leave blank to use default values which will be applied when installing Longhorn. You can then change them through UI after installation. For more details like types or options, you can refer to Settings Reference in our official site link

defaultSettings.allowEmptyDiskSelectorVolumeAllow Scheduling Empty Disk Selector Volumes To Any Disk
defaultSettings.allowEmptyNodeSelectorVolumeAllow Scheduling Empty Node Selector Volumes To Any Node
defaultSettings.allowRecurringJobWhileVolumeDetachedIf this setting is enabled, Longhorn will automatically attaches the volume and takes snapshot/backup when it is the time to do recurring snapshot/backup.
defaultSettings.allowVolumeCreationWithDegradedAvailabilityThis setting allows user to create and attach a volume that doesn’t have all the replicas scheduled at the time of creation.
defaultSettings.autoCleanupSystemGeneratedSnapshotThis setting enables Longhorn to automatically cleanup the system generated snapshot after replica rebuild is done.
defaultSettings.autoDeletePodWhenVolumeDetachedUnexpectedlyIf enabled, Longhorn will automatically delete the workload pod that is managed by a controller (e.g. deployment, statefulset, daemonset, etc…) when Longhorn volume is detached unexpectedly (e.g. during Kubernetes upgrade, Docker reboot, or network disconnect). By deleting the pod, its controller restarts the pod and Kubernetes handles volume reattachment and remount.
defaultSettings.autoSalvageIf enabled, volumes will be automatically salvaged when all the replicas become faulty e.g. due to network disconnection. Longhorn will try to figure out which replica(s) are usable, then use them for the volume. By default true.
defaultSettings.backingImageCleanupWaitIntervalThis interval in minutes determines how long Longhorn will wait before cleaning up the backing image file when there is no replica in the disk using it.
defaultSettings.backingImageRecoveryWaitIntervalThis interval in seconds determines how long Longhorn will wait before re-downloading the backing image file when all disk files of this backing image become failed or unknown.
defaultSettings.backupCompressionMethodThis setting allows users to specify backup compression method.
defaultSettings.backupConcurrentLimitThis setting controls how many worker threads per backup concurrently.
defaultSettings.backupTargetThe endpoint used to access the backupstore. Available: NFS, CIFS, AWS, GCP, AZURE.
defaultSettings.backupTargetCredentialSecretThe name of the Kubernetes secret associated with the backup target.
defaultSettings.backupstorePollIntervalIn seconds. The backupstore poll interval determines how often Longhorn checks the backupstore for new backups. Set to 0 to disable the polling. By default 300.
defaultSettings.concurrentAutomaticEngineUpgradePerNodeLimitThis setting controls how Longhorn automatically upgrades volumes’ engines to the new default engine image after upgrading Longhorn manager. The value of this setting specifies the maximum number of engines per node that are allowed to upgrade to the default engine image at the same time. If the value is 0, Longhorn will not automatically upgrade volumes’ engines to default version.
defaultSettings.concurrentReplicaRebuildPerNodeLimitThis setting controls how many replicas on a node can be rebuilt simultaneously.
defaultSettings.concurrentVolumeBackupRestorePerNodeLimitThis setting controls how many volumes on a node can restore the backup concurrently. Set the value to 0 to disable backup restore.
defaultSettings.createDefaultDiskLabeledNodesCreate default Disk automatically only on Nodes with the label “node.longhorn.io/create-default-disk=true” if no other disks exist. If disabled, the default disk will be created on all new nodes when each node is first added.
defaultSettings.defaultDataLocalityLonghorn volume has data locality if there is a local replica of the volume on the same node as the pod which is using the volume.
defaultSettings.defaultDataPathDefault path to use for storing data on a host. By default “/var/lib/longhorn/”
defaultSettings.defaultLonghornStaticStorageClassThe ‘storageClassName’ is given to PVs and PVCs that are created for an existing Longhorn volume. The StorageClass name can also be used as a label, so it is possible to use a Longhorn StorageClass to bind a workload to an existing PV without creating a Kubernetes StorageClass object. By default ‘longhorn-static’.
defaultSettings.defaultReplicaCountThe default number of replicas when a volume is created from the Longhorn UI. For Kubernetes configuration, update the numberOfReplicas in the StorageClass. By default 3.
defaultSettings.deletingConfirmationFlagThis flag is designed to prevent Longhorn from being accidentally uninstalled which will lead to data lost.
defaultSettings.disableRevisionCounterThis setting is only for volumes created by UI. By default, this is false meaning there will be a reivision counter file to track every write to the volume. During salvage recovering Longhorn will pick the replica with largest reivision counter as candidate to recover the whole volume. If revision counter is disabled, Longhorn will not track every write to the volume. During the salvage recovering, Longhorn will use the ‘volume-head-xxx.img’ file last modification time and file size to pick the replica candidate to recover the whole volume.
defaultSettings.disableSchedulingOnCordonedNodeDisable Longhorn manager to schedule replica on Kubernetes cordoned node. By default true.
defaultSettings.engineReplicaTimeoutIn seconds. The setting specifies the timeout between the engine and replica(s), and the value should be between 8 to 30 seconds. The default value is 8 seconds.
defaultSettings.failedBackupTTLIn minutes. This setting determines how long Longhorn will keep the backup resource that was failed. Set to 0 to disable the auto-deletion.
defaultSettings.fastReplicaRebuildEnabledThis feature supports the fast replica rebuilding. It relies on the checksum of snapshot disk files, so setting the snapshot-data-integrity to enable or fast-check is a prerequisite.
defaultSettings.guaranteedInstanceManagerCPUThis integer value indicates how many percentage of the total allocatable CPU on each node will be reserved for each instance manager Pod. You can leave it with the default value, which is 12%.
defaultSettings.kubernetesClusterAutoscalerEnabledEnabling this setting will notify Longhorn that the cluster is using Kubernetes Cluster Autoscaler.
defaultSettings.logLevelThe log level Panic, Fatal, Error, Warn, Info, Debug, Trace used in longhorn manager. Default to Info.
defaultSettings.nodeDownPodDeletionPolicyDefines the Longhorn action when a Volume is stuck with a StatefulSet/Deployment Pod on a node that is down.
defaultSettings.nodeDrainPolicyDefine the policy to use when a node with the last healthy replica of a volume is drained.
defaultSettings.offlineReplicaRebuildingThis setting allows users to enable the offline replica rebuilding for volumes using v2 data engine.
defaultSettings.orphanAutoDeletionThis setting allows Longhorn to delete the orphan resource and its corresponding orphaned data automatically like stale replicas. Orphan resources on down or unknown nodes will not be cleaned up automatically.
defaultSettings.priorityClasspriorityClass for longhorn system componentss
defaultSettings.recurringFailedJobsHistoryLimitThis setting specifies how many failed backup or snapshot job histories should be retained. History will not be retained if the value is 0.
defaultSettings.recurringSuccessfulJobsHistoryLimitThis setting specifies how many successful backup or snapshot job histories should be retained. History will not be retained if the value is 0.
defaultSettings.removeSnapshotsDuringFilesystemTrimThis setting allows Longhorn filesystem trim feature to automatically mark the latest snapshot and its ancestors as removed and stops at the snapshot containing multiple children.
defaultSettings.replicaAutoBalanceEnable this setting automatically rebalances replicas when discovered an available node.
defaultSettings.replicaDiskSoftAntiAffinityAllow scheduling on disks with existing healthy replicas of the same volume. By default true.
defaultSettings.replicaFileSyncHttpClientTimeoutIn seconds. The setting specifies the HTTP client timeout to the file sync server.
defaultSettings.replicaReplenishmentWaitIntervalIn seconds. The interval determines how long Longhorn will wait at least in order to reuse the existing data on a failed replica rather than directly creating a new replica for a degraded volume.
defaultSettings.replicaSoftAntiAffinityAllow scheduling on nodes with existing healthy replicas of the same volume. By default false.
defaultSettings.replicaZoneSoftAntiAffinityAllow scheduling new Replicas of Volume to the Nodes in the same Zone as existing healthy Replicas. Nodes don’t belong to any Zone will be treated as in the same Zone. Notice that Longhorn relies on label topology.kubernetes.io/zone=<Zone name of the node> in the Kubernetes node object to identify the zone. By default true.
defaultSettings.restoreConcurrentLimitThis setting controls how many worker threads per restore concurrently.
defaultSettings.restoreVolumeRecurringJobsRestore recurring jobs from the backup volume on the backup target and create recurring jobs if not exist during a backup restoration.
defaultSettings.snapshotDataIntegrityThis setting allows users to enable or disable snapshot hashing and data integrity checking.
defaultSettings.snapshotDataIntegrityCronjobUnix-cron string format. The setting specifies when Longhorn checks the data integrity of snapshot disk files.
defaultSettings.snapshotDataIntegrityImmediateCheckAfterSnapshotCreationHashing snapshot disk files impacts the performance of the system. The immediate snapshot hashing and checking can be disabled to minimize the impact after creating a snapshot.
defaultSettings.storageMinimalAvailablePercentageIf the minimum available disk capacity exceeds the actual percentage of available disk capacity, the disk becomes unschedulable until more space is freed up. By default 25.
defaultSettings.storageNetworkLonghorn uses the storage network for in-cluster data traffic. Leave this blank to use the Kubernetes cluster network.
defaultSettings.storageOverProvisioningPercentageThe over-provisioning percentage defines how much storage can be allocated relative to the hard drive’s capacity. By default 200.
defaultSettings.storageReservedPercentageForDefaultDiskThe reserved percentage specifies the percentage of disk space that will not be allocated to the default disk on each new Longhorn node.
defaultSettings.supportBundleFailedHistoryLimitThis setting specifies how many failed support bundles can exist in the cluster. Set this value to 0 to have Longhorn automatically purge all failed support bundles.
defaultSettings.systemManagedComponentsNodeSelectornodeSelector for longhorn system components
defaultSettings.systemManagedPodsImagePullPolicyThis setting defines the Image Pull Policy of Longhorn system managed pod. e.g. instance manager, engine image, CSI driver, etc. The new Image Pull Policy will only apply after the system managed pods restart.
defaultSettings.taintTolerationtaintToleration for longhorn system components
defaultSettings.upgradeCheckerUpgrade Checker will check for new Longhorn version periodically. When there is a new version available, a notification will appear in the UI. By default true.
defaultSettings.v2DataEngineThis allows users to activate v2 data engine based on SPDK. Currently, it is in the preview phase and should not be utilized in a production environment.

© 2019-2023 Longhorn Authors | Documentation Distributed under CC-BY-4.0

© 2023 The Linux Foundation. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page.