categories: - storage namespace: longhorn-system questions: - variable: image.defaultImage default: "true" description: "Use default Longhorn images" label: Use Default Images type: boolean show_subquestion_if: false group: "Longhorn Images" subquestions: - variable: image.longhorn.manager.repository default: rancher/longhornio-longhorn-manager description: "Specify Longhorn Manager Image Repository" type: string label: Longhorn Manager Image Repository group: "Longhorn Images Settings" - variable: image.longhorn.manager.tag default: v1.1.0 description: "Specify Longhorn Manager Image Tag" type: string label: Longhorn Manager Image Tag group: "Longhorn Images Settings" - variable: image.longhorn.engine.repository default: rancher/longhornio-longhorn-engine description: "Specify Longhorn Engine Image Repository" type: string label: Longhorn Engine Image Repository group: "Longhorn Images Settings" - variable: image.longhorn.engine.tag default: v1.1.0 description: "Specify Longhorn Engine Image Tag" type: string label: Longhorn Engine Image Tag group: "Longhorn Images Settings" - variable: image.longhorn.ui.repository default: rancher/longhornio-longhorn-ui description: "Specify Longhorn UI Image Repository" type: string label: Longhorn UI Image Repository group: "Longhorn Images Settings" - variable: image.longhorn.ui.tag default: v1.1.0 description: "Specify Longhorn UI Image Tag" type: string label: Longhorn UI Image Tag group: "Longhorn Images Settings" - variable: image.longhorn.instanceManager.repository default: rancher/longhornio-longhorn-instance-manager description: "Specify Longhorn Instance Manager Image Repository" type: string label: Longhorn Instance Manager Image Repository group: "Longhorn Images Settings" - variable: image.longhorn.instanceManager.tag default: v1_20201216 description: "Specify Longhorn Instance Manager Image Tag" type: string label: Longhorn Instance Manager Image Tag group: "Longhorn Images Settings" - variable: image.longhorn.shareManager.repository default: rancher/longhornio-longhorn-share-manager description: "Specify Longhorn Share Manager Image Repository" type: string label: Longhorn Share Manager Image Repository group: "Longhorn Images Settings" - variable: image.longhorn.shareManager.tag default: v1_20201204 description: "Specify Longhorn Share Manager Image Tag" type: string label: Longhorn Share Manager Image Tag group: "Longhorn Images Settings" - variable: image.csi.attacher.repository default: rancher/longhornio-csi-attacher description: "Specify CSI attacher image repository. Leave blank to autodetect." type: string label: Longhorn CSI Attacher Image Repository group: "Longhorn CSI Driver Images" - variable: image.csi.attacher.tag default: v2.2.1-lh1 description: "Specify CSI attacher image tag. Leave blank to autodetect." type: string label: Longhorn CSI Attacher Image Tag group: "Longhorn CSI Driver Images" - variable: image.csi.provisioner.repository default: rancher/longhornio-csi-provisioner description: "Specify CSI provisioner image repository. Leave blank to autodetect." type: string label: Longhorn CSI Provisioner Image Repository group: "Longhorn CSI Driver Images" - variable: image.csi.provisioner.tag default: v1.6.0-lh1 description: "Specify CSI provisioner image tag. Leave blank to autodetect." type: string label: Longhorn CSI Provisioner Image Tag group: "Longhorn CSI Driver Images" - variable: image.csi.nodeDriverRegistrar.repository default: rancher/longhornio-csi-node-driver-registrar description: "Specify CSI Node Driver Registrar image repository. Leave blank to autodetect." type: string label: Longhorn CSI Node Driver Registrar Image Repository group: "Longhorn CSI Driver Images" - variable: image.csi.nodeDriverRegistrar.tag default: v1.2.0-lh1 description: "Specify CSI Node Driver Registrar image tag. Leave blank to autodetect." type: string label: Longhorn CSI Node Driver Registrar Image Tag group: "Longhorn CSI Driver Images" - variable: image.csi.resizer.repository default: rancher/longhornio-csi-resizer description: "Specify CSI Driver Resizer image repository. Leave blank to autodetect." type: string label: Longhorn CSI Driver Resizer Image Repository group: "Longhorn CSI Driver Images" - variable: image.csi.resizer.tag default: v0.5.1-lh1 description: "Specify CSI Driver Resizer image tag. Leave blank to autodetect." type: string label: Longhorn CSI Driver Resizer Image Tag group: "Longhorn CSI Driver Images" - variable: image.csi.snapshotter.repository default: rancher/longhornio-csi-snapshotter description: "Specify CSI Driver Snapshotter image repository. Leave blank to autodetect." type: string label: Longhorn CSI Driver Snapshotter Image Repository group: "Longhorn CSI Driver Images" - variable: image.csi.snapshotter.tag default: v2.1.1-lh1 description: "Specify CSI Driver Snapshotter image tag. Leave blank to autodetect." type: string label: Longhorn CSI Driver Snapshotter Image Tag group: "Longhorn CSI Driver Images" - variable: privateRegistry.registryUrl label: Private registry URL description: "URL of private registry. Leave blank to apply system default registry." group: "Private Registry Settings" type: string default: "" - variable: privateRegistry.registryUser label: Private registry user description: "User used to authenticate to private registry" group: "Private Registry Settings" type: string default: "" - variable: privateRegistry.registryPasswd label: Private registry password description: "Password used to authenticate to private registry" group: "Private Registry Settings" type: password default: "" - variable: privateRegistry.registrySecret label: Private registry secret name description: "Longhorn will automatically generate a Kubernetes secret with this name and use it to pull images from your private registry." group: "Private Registry Settings" type: string default: "" - variable: longhorn.default_setting default: "false" description: "Customize the default settings before installing Longhorn for the first time. This option will only work if the cluster hasn't installed Longhorn." label: "Customize Default Settings" type: boolean show_subquestion_if: true group: "Longhorn Default Settings" subquestions: - variable: csi.kubeletRootDir default: description: "Specify kubelet root-dir. Leave blank to autodetect." type: string label: Kubelet Root Directory group: "Longhorn CSI Driver Settings" - variable: csi.attacherReplicaCount type: int default: 3 min: 1 max: 10 description: "Specify replica count of CSI Attacher. By default 3." label: Longhorn CSI Attacher replica count group: "Longhorn CSI Driver Settings" - variable: csi.provisionerReplicaCount type: int default: 3 min: 1 max: 10 description: "Specify replica count of CSI Provisioner. By default 3." label: Longhorn CSI Provisioner replica count group: "Longhorn CSI Driver Settings" - variable: csi.resizerReplicaCount type: int default: 3 min: 1 max: 10 description: "Specify replica count of CSI Resizer. By default 3." label: Longhorn CSI Resizer replica count group: "Longhorn CSI Driver Settings" - variable: csi.snapshotterReplicaCount type: int default: 3 min: 1 max: 10 description: "Specify replica count of CSI Snapshotter. By default 3." label: Longhorn CSI Snapshotter replica count group: "Longhorn CSI Driver Settings" - variable: defaultSettings.backupTarget label: Backup Target description: "The endpoint used to access the backupstore. NFS and S3 are supported." group: "Longhorn Default Settings" type: string default: - variable: defaultSettings.backupTargetCredentialSecret label: Backup Target Credential Secret description: "The name of the Kubernetes secret associated with the backup target." group: "Longhorn Default Settings" type: string default: - variable: defaultSettings.allowRecurringJobWhileVolumeDetached label: Allow Recurring Job While Volume Is Detached description: 'If this setting is enabled, Longhorn will automatically attaches the volume and takes snapshot/backup when it is the time to do recurring snapshot/backup. Note that the volume is not ready for workload during the period when the volume was automatically attached. Workload will have to wait until the recurring job finishes.' group: "Longhorn Default Settings" type: boolean default: "false" - variable: defaultSettings.createDefaultDiskLabeledNodes label: Create Default Disk on Labeled Nodes description: 'Create 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.' group: "Longhorn Default Settings" type: boolean default: "false" - variable: defaultSettings.defaultDataPath label: Default Data Path description: 'Default path to use for storing data on a host. By default "/var/lib/longhorn/"' group: "Longhorn Default Settings" type: string default: "/var/lib/longhorn/" - variable: defaultSettings.defaultDataLocality label: Default Data Locality description: 'We say a Longhorn 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. This setting specifies the default data locality when a volume is created from the Longhorn UI. For Kubernetes configuration, update the `dataLocality` in the StorageClass The available modes are: - **disabled**. This is the default option. There may or may not be a replica on the same node as the attached volume (workload) - **best-effort**. This option instructs Longhorn to try to keep a replica on the same node as the attached volume (workload). Longhorn will not stop the volume, even if it cannot keep a replica local to the attached volume (workload) due to environment limitation, e.g. not enough disk space, incompatible disk tags, etc.' group: "Longhorn Default Settings" type: enum options: - "disabled" - "best-effort" default: "disabled" - variable: defaultSettings.replicaSoftAntiAffinity label: Replica Node Level Soft Anti-Affinity description: 'Allow scheduling on nodes with existing healthy replicas of the same volume. By default false.' group: "Longhorn Default Settings" type: boolean default: "false" - variable: defaultSettings.storageOverProvisioningPercentage label: Storage Over Provisioning Percentage description: "The over-provisioning percentage defines how much storage can be allocated relative to the hard drive's capacity. By default 200." group: "Longhorn Default Settings" type: int min: 0 default: 200 - variable: defaultSettings.storageMinimalAvailablePercentage label: Storage Minimal Available Percentage description: "If 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." group: "Longhorn Default Settings" type: int min: 0 max: 100 default: 25 - variable: defaultSettings.upgradeChecker label: Enable Upgrade Checker description: 'Upgrade 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.' group: "Longhorn Default Settings" type: boolean default: "true" - variable: defaultSettings.defaultReplicaCount label: Default Replica Count description: "The 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." group: "Longhorn Default Settings" type: int min: 1 max: 20 default: 3 - variable: defaultSettings.guaranteedEngineCPU label: Guaranteed Engine CPU description: "Allow Longhorn Instance Managers to have guaranteed CPU allocation. By default 0.25. The value is how many CPUs should be reserved for each Engine/Replica Instance Manager Pod created by Longhorn. For example, 0.1 means one-tenth of a CPU. This will help maintain engine stability during high node workload. It only applies to the Engine/Replica Instance Manager Pods created after the setting took effect. In order to prevent unexpected volume crash, you can use the following formula to calculate an appropriate value for this setting: 'Guaranteed Engine CPU = The estimated max Longhorn volume/replica count on a node * 0.1'. The result of above calculation doesn't mean that's the maximum CPU resources the Longhorn workloads require. To fully exploit the Longhorn volume I/O performance, you can allocate/guarantee more CPU resources via this setting. If it's hard to estimate the volume/replica count now, you can leave it with the default value, or allocate 1/8 of total CPU of a node. Then you can tune it when there is no running workload using Longhorn volumes. WARNING: After this setting is changed, all the instance managers on all the nodes will be automatically restarted WARNING: DO NOT CHANGE THIS SETTING WITH ATTACHED VOLUMES." group: "Longhorn Default Settings" type: float default: 0.25 - variable: defaultSettings.defaultLonghornStaticStorageClass label: Default Longhorn Static StorageClass Name description: "The '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'." group: "Longhorn Default Settings" type: string default: "longhorn-static" - variable: defaultSettings.backupstorePollInterval label: Backupstore Poll Interval description: "In 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." group: "Longhorn Default Settings" type: int min: 0 default: 300 - variable: defaultSettings.taintToleration label: Kubernetes Taint Toleration description: "To dedicate nodes to store Longhorn replicas and reject other general workloads, set tolerations for Longhorn and add taints for the storage nodes. All Longhorn volumes should be detached before modifying toleration settings. We recommend setting tolerations during Longhorn deployment because the Longhorn system cannot be operated during the update. Multiple tolerations can be set here, and these tolerations are separated by semicolon. For example: * `key1=value1:NoSchedule; key2:NoExecute` * `:` this toleration tolerates everything because an empty key with operator `Exists` matches all keys, values and effects * `key1=value1:` this toleration has empty effect. It matches all effects with key `key1` Because `kubernetes.io` is used as the key of all Kubernetes default tolerations, it should not be used in the toleration settings. WARNING: DO NOT CHANGE THIS SETTING WITH ATTACHED VOLUMES!" group: "Longhorn Default Settings" type: string default: "" - variable: defaultSettings.priorityClass label: Priority Class description: "The name of the Priority Class to set on the Longhorn workloads. This can help prevent Longhorn workloads from being evicted under Node Pressure. WARNING: DO NOT CHANGE THIS SETTING WITH ATTACHED VOLUMES." group: "Longhorn Default Settings" type: string default: "" - variable: defaultSettings.autoSalvage label: Automatic salvage description: "If 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." group: "Longhorn Default Settings" type: boolean default: "true" - variable: defaultSettings.autoDeletePodWhenVolumeDetachedUnexpectedly label: Automatically Delete Workload Pod when The Volume Is Detached Unexpectedly description: 'If 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. If disabled, Longhorn will not delete the workload pod that is managed by a controller. You will have to manually restart the pod to reattach and remount the volume. **Note:** This setting does not apply to the workload pods that do not have a controller. Longhorn never deletes them.' group: "Longhorn Default Settings" type: boolean default: "true" - variable: defaultSettings.disableSchedulingOnCordonedNode label: Disable Scheduling On Cordoned Node description: "Disable Longhorn manager to schedule replica on Kubernetes cordoned node. By default true." group: "Longhorn Default Settings" type: boolean default: "true" - variable: defaultSettings.replicaZoneSoftAntiAffinity label: Replica Zone Level Soft Anti-Affinity description: "Allow 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. By default true." group: "Longhorn Default Settings" type: boolean default: "true" - variable: defaultSettings.volumeAttachmentRecoveryPolicy label: Volume Attachment Recovery Policy description: "Defines the Longhorn action when a Volume is stuck with a Deployment Pod on a failed node. `wait` leads to the deletion of the volume attachment as soon as the pods deletion time has passed. `never` is the default Kubernetes behavior of never deleting volume attachments on terminating pods. `immediate` leads to the deletion of the volume attachment as soon as all workload pods are pending. By default wait." group: "Longhorn Default Settings" type: enum options: - "wait" - "never" - "immediate" default: "wait" - variable: defaultSettings.nodeDownPodDeletionPolicy label: Pod Deletion Policy When Node is Down description: "Defines the Longhorn action when a Volume is stuck with a StatefulSet/Deployment Pod on a node that is down. - **do-nothing** is the default Kubernetes behavior of never force deleting StatefulSet/Deployment terminating pods. Since the pod on the node that is down isn't removed, Longhorn volumes are stuck on nodes that are down. - **delete-statefulset-pod** Longhorn will force delete StatefulSet terminating pods on nodes that are down to release Longhorn volumes so that Kubernetes can spin up replacement pods. - **delete-deployment-pod** Longhorn will force delete Deployment terminating pods on nodes that are down to release Longhorn volumes so that Kubernetes can spin up replacement pods. - **delete-both-statefulset-and-deployment-pod** Longhorn will force delete StatefulSet/Deployment terminating pods on nodes that are down to release Longhorn volumes so that Kubernetes can spin up replacement pods." group: "Longhorn Default Settings" type: enum options: - "do-nothing" - "delete-statefulset-pod" - "delete-deployment-pod" - "delete-both-statefulset-and-deployment-pod" default: "do-nothing" - variable: defaultSettings.allowNodeDrainWithLastHealthyReplica label: Allow Node Drain with the Last Healthy Replica description: "By default, Longhorn will block `kubectl drain` action on a node if the node contains the last healthy replica of a volume. If this setting is enabled, Longhorn will **not** block `kubectl drain` action on a node even if the node contains the last healthy replica of a volume." group: "Longhorn Default Settings" type: boolean default: "false" - variable: defaultSettings.mkfsExt4Parameters label: Custom mkfs.ext4 parameters description: "Allows setting additional filesystem creation parameters for ext4. For older host kernels it might be necessary to disable the optional ext4 metadata_csum feature by specifying `-O ^64bit,^metadata_csum`." group: "Longhorn Default Settings" type: string - variable: defaultSettings.disableReplicaRebuild label: Disable Replica Rebuild description: "This setting disable replica rebuild cross the whole cluster, eviction and data locality feature won't work if this setting is true. But doesn't have any impact to any current replica rebuild and restore disaster recovery volume." group: "Longhorn Default Settings" type: boolean default: "false" - variable: defaultSettings.replicaReplenishmentWaitInterval label: Replica Replenishment Wait Interval description: "In 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. Warning: This option works only when there is a failed replica in the volume. And this option may block the rebuilding for a while in the case." group: "Longhorn Default Settings" type: int min: 0 default: 600 - variable: defaultSettings.disableRevisionCounter label: Disable Revision Counter description: "This 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 repica 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." group: "Longhorn Default Settings" type: boolean default: "false" - variable: defaultSettings.systemManagedPodsImagePullPolicy label: System Managed Pod Image Pull Policy description: "This setting defines the Image Pull Policy of Longhorn system managed pods, e.g. instance manager, engine image, CSI driver, etc. The new Image Pull Policy will only apply after the system managed pods restart." group: "Longhorn Default Settings" type: enum options: - "if-not-present" - "always" - "never" default: "if-not-present" - variable: defaultSettings.allowVolumeCreationWithDegradedAvailability label: Allow Volume Creation with Degraded Availability description: "This setting allows user to create and attach a volume that doesn't have all the replicas scheduled at the time of creation." group: "Longhorn Default Settings" type: boolean default: "true" - variable: defaultSettings.autoCleanupSystemGeneratedSnapshot label: Automatically Cleanup System Generated Snapshot description: "This setting enables Longhorn to automatically cleanup the system generated snapshot after replica rebuild is done." group: "Longhorn Default Settings" type: boolean default: "true" - variable: persistence.defaultClass default: "true" description: "Set as default StorageClass for Longhorn" label: Default Storage Class group: "Longhorn Storage Class Settings" required: true type: boolean - variable: persistence.reclaimPolicy label: Storage Class Retain Policy description: "Define reclaim policy (Retain or Delete)" group: "Longhorn Storage Class Settings" required: true type: enum options: - "Delete" - "Retain" default: "Delete" - variable: persistence.defaultClassReplicaCount description: "Set replica count for Longhorn StorageClass" label: Default Storage Class Replica Count group: "Longhorn Storage Class Settings" type: int min: 1 max: 10 default: 3 - variable: persistence.recurringJobs.enable description: "Enable recurring job for Longhorn StorageClass" group: "Longhorn Storage Class Settings" label: Enable Storage Class Recurring Job type: boolean default: false show_subquestion_if: true subquestions: - variable: persistence.recurringJobs.jobList description: 'Recurring job list for Longhorn StorageClass. Please be careful of quotes of input. e.g., [{"name":"backup", "task":"backup", "cron":"*/2 * * * *", "retain":1,"labels": {"interval":"2m"}}]' label: Storage Class Recurring Job List group: "Longhorn Storage Class Settings" type: string default: - variable: ingress.enabled default: "false" description: "Expose app using Layer 7 Load Balancer - ingress" type: boolean group: "Services and Load Balancing" label: Expose app using Layer 7 Load Balancer show_subquestion_if: true subquestions: - variable: ingress.host default: "xip.io" description: "layer 7 Load Balancer hostname" type: hostname required: true label: Layer 7 Load Balancer Hostname - variable: service.ui.type default: "Rancher-Proxy" description: "Define Longhorn UI service type" type: enum options: - "ClusterIP" - "NodePort" - "LoadBalancer" - "Rancher-Proxy" label: Longhorn UI Service show_if: "ingress.enabled=false" group: "Services and Load Balancing" show_subquestion_if: "NodePort" subquestions: - variable: service.ui.nodePort default: "" description: "NodePort port number(to set explicitly, choose port between 30000-32767)" type: int min: 30000 max: 32767 show_if: "service.ui.type=NodePort||service.ui.type=LoadBalancer" label: UI Service NodePort number - variable: enablePSP default: "true" description: "Setup a pod security policy for Longhorn workloads." label: Pod Security Policy type: boolean group: "Other Settings"