blob: b4f0b23613b934a0dbbefc9a17bacc098d13c877 [file] [log] [blame]
gio3e1b96b2026-07-21 18:52:35 +04001categories:
2 - storage
3namespace: longhorn-system
4questions:
5 - variable: image.defaultImage
6 default: 'true'
7 description: Use default Longhorn images
8 label: Use Default Images
9 type: boolean
10 show_subquestion_if: false
11 group: Longhorn Images
12 subquestions:
13 - variable: image.longhorn.manager.repository
14 default: longhornio/longhorn-manager
15 description: Repository for the Longhorn Manager image.
16 type: string
17 label: Longhorn Manager Image Repository
18 group: Longhorn Images Settings
19 - variable: image.longhorn.manager.tag
20 default: v1.10.2
21 description: Tag for the Longhorn Manager image.
22 type: string
23 label: Longhorn Manager Image Tag
24 group: Longhorn Images Settings
25 - variable: image.longhorn.engine.repository
26 default: longhornio/longhorn-engine
27 description: Repository for the Longhorn Engine image.
28 type: string
29 label: Longhorn Engine Image Repository
30 group: Longhorn Images Settings
31 - variable: image.longhorn.engine.tag
32 default: v1.10.2
33 description: Tag for the Longhorn Engine image.
34 type: string
35 label: Longhorn Engine Image Tag
36 group: Longhorn Images Settings
37 - variable: image.longhorn.ui.repository
38 default: longhornio/longhorn-ui
39 description: Repository for the Longhorn UI image.
40 type: string
41 label: Longhorn UI Image Repository
42 group: Longhorn Images Settings
43 - variable: image.longhorn.ui.tag
44 default: v1.10.2
45 description: Tag for the Longhorn UI image.
46 type: string
47 label: Longhorn UI Image Tag
48 group: Longhorn Images Settings
49 - variable: image.longhorn.instanceManager.repository
50 default: longhornio/longhorn-instance-manager
51 description: Repository for the Longhorn Instance Manager image.
52 type: string
53 label: Longhorn Instance Manager Image Repository
54 group: Longhorn Images Settings
55 - variable: image.longhorn.instanceManager.tag
56 default: v1.10.2
57 description: Tag for the Longhorn Instance Manager image.
58 type: string
59 label: Longhorn Instance Manager Image Tag
60 group: Longhorn Images Settings
61 - variable: image.longhorn.shareManager.repository
62 default: longhornio/longhorn-share-manager
63 description: Repository for the Longhorn Share Manager image.
64 type: string
65 label: Longhorn Share Manager Image Repository
66 group: Longhorn Images Settings
67 - variable: image.longhorn.shareManager.tag
68 default: v1.10.2
69 description: Tag for the Longhorn Share Manager image.
70 type: string
71 label: Longhorn Share Manager Image Tag
72 group: Longhorn Images Settings
73 - variable: image.longhorn.backingImageManager.repository
74 default: longhornio/backing-image-manager
75 description: >-
76 Repository for the Backing Image Manager image. When unspecified, Longhorn uses the default value.
77 type: string
78 label: Longhorn Backing Image Manager Image Repository
79 group: Longhorn Images Settings
80 - variable: image.longhorn.backingImageManager.tag
81 default: v1.10.2
82 description: >-
83 Tag for the Backing Image Manager image. When unspecified, Longhorn uses the default value.
84 type: string
85 label: Longhorn Backing Image Manager Image Tag
86 group: Longhorn Images Settings
87 - variable: image.longhorn.supportBundleKit.repository
88 default: longhornio/support-bundle-kit
89 description: Repository for the Longhorn Support Bundle Manager image.
90 type: string
91 label: Longhorn Support Bundle Kit Image Repository
92 group: Longhorn Images Settings
93 - variable: image.longhorn.supportBundleKit.tag
94 default: v0.0.79
95 description: Tag for the Longhorn Support Bundle Manager image.
96 type: string
97 label: Longhorn Support Bundle Kit Image Tag
98 group: Longhorn Images Settings
99 - variable: image.csi.attacher.repository
100 default: longhornio/csi-attacher
101 description: >-
102 Repository for the CSI attacher image. When unspecified, Longhorn uses the default value.
103 type: string
104 label: Longhorn CSI Attacher Image Repository
105 group: Longhorn CSI Driver Images
106 - variable: image.csi.attacher.tag
107 default: v4.10.0-20251226
108 description: >-
109 Tag for the CSI attacher image. When unspecified, Longhorn uses the default value.
110 type: string
111 label: Longhorn CSI Attacher Image Tag
112 group: Longhorn CSI Driver Images
113 - variable: image.csi.provisioner.repository
114 default: longhornio/csi-provisioner
115 description: >-
116 Repository for the CSI Provisioner image. When unspecified, Longhorn uses the default value.
117 type: string
118 label: Longhorn CSI Provisioner Image Repository
119 group: Longhorn CSI Driver Images
120 - variable: image.csi.provisioner.tag
121 default: v5.3.0-20251226
122 description: >-
123 Tag for the CSI Provisioner image. When unspecified, Longhorn uses the default value.
124 type: string
125 label: Longhorn CSI Provisioner Image Tag
126 group: Longhorn CSI Driver Images
127 - variable: image.csi.nodeDriverRegistrar.repository
128 default: longhornio/csi-node-driver-registrar
129 description: >-
130 Repository for the CSI Node Driver Registrar image. When unspecified, Longhorn uses the default value.
131 type: string
132 label: Longhorn CSI Node Driver Registrar Image Repository
133 group: Longhorn CSI Driver Images
134 - variable: image.csi.nodeDriverRegistrar.tag
135 default: v2.15.0-20251226
136 description: >-
137 Tag for the CSI Node Driver Registrar image. When unspecified, Longhorn uses the default value.
138 type: string
139 label: Longhorn CSI Node Driver Registrar Image Tag
140 group: Longhorn CSI Driver Images
141 - variable: image.csi.resizer.repository
142 default: longhornio/csi-resizer
143 description: >-
144 Repository for the CSI Resizer image. When unspecified, Longhorn uses the default value.
145 type: string
146 label: Longhorn CSI Driver Resizer Image Repository
147 group: Longhorn CSI Driver Images
148 - variable: image.csi.resizer.tag
149 default: v1.14.0-20260119
150 description: >-
151 Tag for the CSI Resizer image. When unspecified, Longhorn uses the default value.
152 type: string
153 label: Longhorn CSI Driver Resizer Image Tag
154 group: Longhorn CSI Driver Images
155 - variable: image.csi.snapshotter.repository
156 default: longhornio/csi-snapshotter
157 description: >-
158 Repository for the CSI Snapshotter image. When unspecified, Longhorn uses the default value.
159 type: string
160 label: Longhorn CSI Driver Snapshotter Image Repository
161 group: Longhorn CSI Driver Images
162 - variable: image.csi.snapshotter.tag
163 default: v8.4.0-20251226
164 description: >-
165 Tag for the CSI Snapshotter image. When unspecified, Longhorn uses the default value.
166 type: string
167 label: Longhorn CSI Driver Snapshotter Image Tag
168 group: Longhorn CSI Driver Images
169 - variable: image.csi.livenessProbe.repository
170 default: longhornio/livenessprobe
171 description: >-
172 Repository for the CSI liveness probe image. When unspecified, Longhorn uses the default value.
173 type: string
174 label: Longhorn CSI Liveness Probe Image Repository
175 group: Longhorn CSI Driver Images
176 - variable: image.csi.livenessProbe.tag
177 default: v2.17.0-20251226
178 description: >-
179 Tag for the CSI liveness probe image. When unspecified, Longhorn uses the default value.
180 type: string
181 label: Longhorn CSI Liveness Probe Image Tag
182 group: Longhorn CSI Driver Images
183 - variable: privateRegistry.registryUrl
184 label: Private registry URL
185 description: >-
186 URL of a private registry. When unspecified, Longhorn uses the default system registry.
187 group: Private Registry Settings
188 type: string
189 default: ''
190 subquestions: []
191 - variable: privateRegistry.registrySecret
192 label: Private registry secret name
193 description: >-
194 If 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.
195 group: Private Registry Settings
196 type: string
197 default: ''
198 subquestions: []
199 - variable: privateRegistry.createSecret
200 default: 'true'
201 description: Set to true to automatically create a new private registry secret.
202 type: boolean
203 group: Private Registry Settings
204 label: Create Secret for Private Registry Settings
205 show_subquestion_if: true
206 subquestions:
207 - variable: privateRegistry.registryUser
208 label: Private registry user
209 description: User account used for authenticating with a private registry.
210 type: string
211 default: ''
212 - variable: privateRegistry.registryPasswd
213 label: Private registry password
214 description: Password for authenticating with a private registry.
215 type: password
216 default: ''
217 - variable: longhorn.default_setting
218 default: 'false'
219 description: >-
220 Customize the default settings before installing Longhorn for the first time. This option will only work if the cluster hasn't installed Longhorn.
221 label: Customize Default Settings
222 type: boolean
223 show_subquestion_if: true
224 group: Longhorn Default Settings
225 subquestions:
226 - variable: csi.kubeletRootDir
227 default: null
228 description: >-
229 kubelet root directory. When unspecified, Longhorn uses the default value.
230 type: string
231 label: Kubelet Root Directory
232 group: Longhorn CSI Driver Settings
233 - variable: csi.attacherReplicaCount
234 type: int
235 default: 3
236 min: 1
237 max: 10
238 description: >-
239 Replica count of the CSI Attacher. When unspecified, Longhorn uses the default value ("3").
240 label: Longhorn CSI Attacher replica count
241 group: Longhorn CSI Driver Settings
242 - variable: csi.provisionerReplicaCount
243 type: int
244 default: 3
245 min: 1
246 max: 10
247 description: >-
248 Replica count of the CSI Provisioner. When unspecified, Longhorn uses the default value ("3").
249 label: Longhorn CSI Provisioner replica count
250 group: Longhorn CSI Driver Settings
251 - variable: csi.resizerReplicaCount
252 type: int
253 default: 3
254 min: 1
255 max: 10
256 description: >-
257 Replica count of the CSI Resizer. When unspecified, Longhorn uses the default value ("3").
258 label: Longhorn CSI Resizer replica count
259 group: Longhorn CSI Driver Settings
260 - variable: csi.snapshotterReplicaCount
261 type: int
262 default: 3
263 min: 1
264 max: 10
265 description: >-
266 Replica count of the CSI Snapshotter. When unspecified, Longhorn uses the default value ("3").
267 label: Longhorn CSI Snapshotter replica count
268 group: Longhorn CSI Driver Settings
269 - variable: defaultSettings.allowRecurringJobWhileVolumeDetached
270 label: Allow Recurring Job While Volume Is Detached
271 description: >-
272 Setting that allows Longhorn to automatically attach a volume and create snapshots or backups when recurring jobs are run.
273 group: Longhorn Default Settings
274 type: boolean
275 default: 'false'
276 - variable: defaultSettings.snapshotMaxCount
277 label: Snapshot Maximum Count
278 description: >-
279 Maximum snapshot count for a volume. The value should be between 2 to 250.
280 group: Longhorn Default Settings
281 type: int
282 min: 2
283 max: 250
284 default: 250
285 - variable: defaultSettings.createDefaultDiskLabeledNodes
286 label: Create Default Disk on Labeled Nodes
287 description: >-
288 Setting that allows Longhorn to automatically create a default disk only on nodes with the label "node.longhorn.io/create-default-disk=true" (if no other disks exist). When this setting is disabled, Longhorn creates a default disk on each node that is added to the cluster.
289 group: Longhorn Default Settings
290 type: boolean
291 default: 'false'
292 - variable: defaultSettings.defaultDataPath
293 label: Default Data Path
294 description: >-
295 Default path to use for storing data on a host. An absolute directory path indicates a filesystem-type disk used by the V1 Data Engine, while a path to a block device indicates a block-type disk used by the V2 Data Engine. The default value is "/var/lib/longhorn/".
296 group: Longhorn Default Settings
297 type: string
298 default: /var/lib/longhorn/
299 - variable: defaultSettings.defaultDataLocality
300 label: Default Data Locality
301 description: >-
302 Default data locality. A Longhorn volume has data locality if a local replica of the volume exists on the same node as the pod that is using the volume.
303 group: Longhorn Default Settings
304 type: enum
305 options:
306 - disabled
307 - best-effort
308 default: disabled
309 - variable: defaultSettings.replicaSoftAntiAffinity
310 label: Replica Node Level Soft Anti-Affinity
311 description: >-
312 Allow scheduling on nodes with existing healthy replicas of the same volume. By default, false.
313 group: Longhorn Default Settings
314 type: boolean
315 default: 'false'
316 - variable: defaultSettings.replicaAutoBalance
317 label: Replica Auto Balance
318 description: >-
319 Enable this setting automatically re-balances replicas when discovered an available node.
320 group: Longhorn Default Settings
321 type: enum
322 options:
323 - disabled
324 - least-effort
325 - best-effort
326 default: disabled
327 - variable: defaultSettings.storageOverProvisioningPercentage
328 label: Storage Over Provisioning Percentage
329 description: >-
330 Percentage of storage that can be allocated relative to hard drive capacity. The default value is 100.
331 group: Longhorn Default Settings
332 type: int
333 min: 0
334 default: 100
335 - variable: defaultSettings.storageMinimalAvailablePercentage
336 label: Storage Minimal Available Percentage
337 description: >-
338 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.
339 group: Longhorn Default Settings
340 type: int
341 min: 0
342 max: 100
343 default: 25
344 - variable: defaultSettings.storageReservedPercentageForDefaultDisk
345 label: Storage Reserved Percentage For Default Disk
346 description: >-
347 The reserved percentage specifies the percentage of disk space that will not be allocated to the default disk on each new Longhorn node.
348 group: Longhorn Default Settings
349 type: int
350 min: 0
351 max: 100
352 default: 30
353 - variable: defaultSettings.upgradeChecker
354 label: Enable Upgrade Checker
355 description: >-
356 Upgrade Checker that periodically checks for new Longhorn versions. When a new version is available, a notification appears on the Longhorn UI. This setting is enabled by default.
357 group: Longhorn Default Settings
358 type: boolean
359 default: 'true'
360 - variable: defaultSettings.upgradeResponderURL
361 label: Upgrade Responder URL
362 description: >-
363 The Upgrade Responder sends a notification whenever a new Longhorn version that you can upgrade to becomes available. The default value is "https://longhorn-upgrade-responder.rancher.io/v1/checkupgrade".
364 group: Longhorn Default Settings
365 type: string
366 default: 'https://longhorn-upgrade-responder.rancher.io/v1/checkupgrade'
367 - variable: defaultSettings.defaultReplicaCount
368 label: Default Replica Count
369 description: >-
370 Default number of replicas for volumes created using the Longhorn UI. For Kubernetes configuration, modify the `numberOfReplicas` field in the StorageClass.
371 group: Longhorn Default Settings
372 type: string
373 default: '{"v1":"3","v2":"3"}'
374 - variable: defaultSettings.defaultLonghornStaticStorageClass
375 label: Default Longhorn Static StorageClass Name
376 description: >-
377 Default name of Longhorn Static StorageClass. The "storageClassName" is assigned to PVs and PVCs that are created for an existing Longhorn volume. The "storageClassName" 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. The "storageClassName" needs to be an existing StorageClass. The default value is "longhorn-static".
378 group: Longhorn Default Settings
379 type: string
380 default: longhorn-static
381 - variable: defaultSettings.failedBackupTTL
382 label: Failed Backup Time to Live
383 description: >-
384 Number of minutes that Longhorn keeps a failed backup resource. When the value is "0", automatic deletion is disabled.
385 group: Longhorn Default Settings
386 type: int
387 min: 0
388 default: 1440
389 - variable: defaultSettings.backupExecutionTimeout
390 label: Backup Execution Timeout
391 description: >-
392 Number of minutes that Longhorn allows for the backup execution. The default value is "1".
393 group: Longhorn Default Settings
394 type: int
395 min: 1
396 default: 1
397 - variable: defaultSettings.restoreVolumeRecurringJobs
398 label: Restore Volume Recurring Jobs
399 description: >-
400 Restore recurring jobs from the backup volume on the backup target and create recurring jobs if not exist during a backup restoration.
401 group: Longhorn Default Settings
402 type: boolean
403 default: 'false'
404 - variable: defaultSettings.recurringSuccessfulJobsHistoryLimit
405 label: Cronjob Successful Jobs History Limit
406 description: >-
407 This setting specifies how many successful backup or snapshot job histories should be retained. History will not be retained if the value is 0.
408 group: Longhorn Default Settings
409 type: int
410 min: 0
411 default: 1
412 - variable: defaultSettings.recurringFailedJobsHistoryLimit
413 label: Cronjob Failed Jobs History Limit
414 description: >-
415 Maximum number of failed recurring backup and snapshot jobs to be retained. When the value is "0", a history of failed recurring jobs is not retained.
416 group: Longhorn Default Settings
417 type: int
418 min: 0
419 default: 1
420 - variable: defaultSettings.recurringJobMaxRetention
421 label: Maximum Retention Number for Recurring Job
422 description: Maximum number of snapshots or backups to be retained.
423 group: Longhorn Default Settings
424 type: int
425 default: 100
426 - variable: defaultSettings.supportBundleFailedHistoryLimit
427 label: SupportBundle Failed History Limit
428 description: >-
429 This 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.
430 group: Longhorn Default Settings
431 type: int
432 min: 0
433 default: 1
434 - variable: defaultSettings.autoSalvage
435 label: Automatic salvage
436 description: >-
437 Setting that allows Longhorn to automatically salvage volumes when all replicas become faulty (for example, when the network connection is interrupted). Longhorn determines which replicas are usable and then uses these replicas for the volume. This setting is enabled by default.
438 group: Longhorn Default Settings
439 type: boolean
440 default: 'true'
441 - variable: defaultSettings.autoDeletePodWhenVolumeDetachedUnexpectedly
442 label: >-
443 Automatically Delete Workload Pod when The Volume Is Detached Unexpectedly
444 description: >-
445 Setting that allows Longhorn to automatically delete a workload pod that is managed by a controller (for example, daemonset) whenever a Longhorn volume is detached unexpectedly (for example, during Kubernetes upgrades). After deletion, the controller restarts the pod and then Kubernetes handles volume reattachment and remounting.
446 group: Longhorn Default Settings
447 type: boolean
448 default: 'true'
449 - variable: defaultSettings.blacklistForAutoDeletePodWhenVolumeDetachedUnexpectedly
450 label: >-
451 Blacklist for Automatically Delete Workload Pod when The Volume Is Detached Unexpectedly
452 description: >-
453 Blacklist of controller api/kind values for the setting Automatically Delete Workload Pod when the Volume Is Detached Unexpectedly. If a workload pod is managed by a controller whose api/kind is listed in this blacklist, Longhorn will not automatically delete the pod when its volume is unexpectedly detached. Multiple controller api/kind entries can be specified, separated by semicolons. For example: `apps/StatefulSet;apps/DaemonSet`. Note that the controller api/kind is case sensitive and must exactly match the api/kind in the workload pod's owner reference.
454 group: Longhorn Default Settings
455 type: string
456 default: null
457 - variable: defaultSettings.disableSchedulingOnCordonedNode
458 label: Disable Scheduling On Cordoned Node
459 description: >-
460 Setting that prevents Longhorn Manager from scheduling replicas on a cordoned Kubernetes node. This setting is enabled by default.
461 group: Longhorn Default Settings
462 type: boolean
463 default: 'true'
464 - variable: defaultSettings.replicaZoneSoftAntiAffinity
465 label: Replica Zone Level Soft Anti-Affinity
466 description: >-
467 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. 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.
468 group: Longhorn Default Settings
469 type: boolean
470 default: 'true'
471 - variable: defaultSettings.replicaDiskSoftAntiAffinity
472 label: Replica Disk Level Soft Anti-Affinity
473 description: >-
474 Allow scheduling on disks with existing healthy replicas of the same volume. By default, true.
475 group: Longhorn Default Settings
476 type: boolean
477 default: 'true'
478 - variable: defaultSettings.allowEmptyNodeSelectorVolume
479 label: Allow Empty Node Selector Volume
480 description: >-
481 Setting that allows scheduling of empty node selector volumes to any node.
482 group: Longhorn Default Settings
483 type: boolean
484 default: 'true'
485 - variable: defaultSettings.allowEmptyDiskSelectorVolume
486 label: Allow Empty Disk Selector Volume
487 description: >-
488 Setting that allows scheduling of empty disk selector volumes to any disk.
489 group: Longhorn Default Settings
490 type: boolean
491 default: 'true'
492 - variable: defaultSettings.nodeDownPodDeletionPolicy
493 label: Pod Deletion Policy When Node is Down
494 description: >-
495 Policy that defines the action Longhorn takes when a volume is stuck with a StatefulSet or Deployment pod on a node that failed.
496 group: Longhorn Default Settings
497 type: enum
498 options:
499 - do-nothing
500 - delete-statefulset-pod
501 - delete-deployment-pod
502 - delete-both-statefulset-and-deployment-pod
503 default: do-nothing
504 - variable: defaultSettings.nodeDrainPolicy
505 label: Node Drain Policy
506 description: >-
507 Policy that defines the action Longhorn takes when a node with the last healthy replica of a volume is drained.
508 group: Longhorn Default Settings
509 type: enum
510 options:
511 - block-for-eviction
512 - block-for-eviction-if-contains-last-replica
513 - block-if-contains-last-replica
514 - allow-if-replica-is-stopped
515 - always-allow
516 default: block-if-contains-last-replica
517 - variable: defaultSettings.detachManuallyAttachedVolumesWhenCordoned
518 label: Detach Manually Attached Volumes When Cordoned
519 description: >-
520 Setting that allows automatic detaching of manually-attached volumes when a node is cordoned.
521 group: Longhorn Default Settings
522 type: boolean
523 default: 'false'
524 - variable: defaultSettings.priorityClass
525 label: Priority Class
526 description: >-
527 PriorityClass for system-managed Longhorn components. This setting can help prevent Longhorn components from being evicted under Node Pressure. 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.) Note that this will be applied to Longhorn user-deployed components by default if there are no priority class values set yet, such as `longhornManager.priorityClass`. WARNING: DO NOT CHANGE THIS SETTING WITH ATTACHED VOLUMES.
528 group: Longhorn Default Settings
529 type: string
530 default: longhorn-critical
531 - variable: defaultSettings.replicaReplenishmentWaitInterval
532 label: Replica Replenishment Wait Interval
533 description: >-
534 The interval in seconds determines how long Longhorn will at least wait to reuse the existing data on a failed replica rather than directly creating a new replica for a degraded volume.
535 group: Longhorn Default Settings
536 type: int
537 min: 0
538 default: 600
539 - variable: defaultSettings.concurrentReplicaRebuildPerNodeLimit
540 label: Concurrent Replica Rebuild Per Node Limit
541 description: >-
542 Maximum number of replicas that can be concurrently rebuilt on each node. **Caution**: [1] This setting replaces "Disable Replica Rebuild". Instead of delaying replica startup, Longhorn skips replica object replenishment to limit the number of concurrently rebuilding replicas. [2] When the value is "0", the eviction and data locality features do not work, but ongoing replica rebuilding and backup/restoration operations should remain unaffected.
543 group: Longhorn Default Settings
544 type: int
545 min: 0
546 default: 5
547 - variable: defaultSettings.concurrentVolumeBackupRestorePerNodeLimit
548 label: Concurrent Volume Backup Restore Per Node Limit
549 description: >-
550 Maximum number of volumes that can be concurrently restored on each node using a backup. When the value is "0", restoration of volumes using a backup is disabled.
551 group: Longhorn Default Settings
552 type: int
553 min: 0
554 default: 5
555 - variable: defaultSettings.disableRevisionCounter
556 label: Disable Revision Counter
557 description: >-
558 Setting that disables the revision counter and thereby prevents Longhorn from tracking all write operations to a volume. When salvaging a volume, Longhorn uses properties of the "volume-head-xxx.img" file (the last file size and the last time the file was modified) to select the replica to be used for volume recovery. This setting applies only to volumes created using the Longhorn UI.
559 group: Longhorn Default Settings
560 type: string
561 default: '{"v1":"true"}'
562 - variable: defaultSettings.systemManagedPodsImagePullPolicy
563 label: System Managed Pod Image Pull Policy
564 description: >-
565 Image pull policy for system-managed pods, such as Instance Manager, engine images, and CSI Driver. Changes to the image pull policy are applied only after the system-managed pods restart.
566 group: Longhorn Default Settings
567 type: enum
568 options:
569 - if-not-present
570 - always
571 - never
572 default: if-not-present
573 - variable: defaultSettings.allowVolumeCreationWithDegradedAvailability
574 label: Allow Volume Creation with Degraded Availability
575 description: >-
576 Setting that allows you to create and attach a volume without having all replicas scheduled at the time of creation.
577 group: Longhorn Default Settings
578 type: boolean
579 default: 'true'
580 - variable: defaultSettings.autoCleanupSystemGeneratedSnapshot
581 label: Automatically Cleanup System Generated Snapshot
582 description: >-
583 Setting that allows Longhorn to automatically clean up the system-generated snapshot after replica rebuilding is completed.
584 group: Longhorn Default Settings
585 type: boolean
586 default: 'true'
587 - variable: defaultSettings.autoCleanupRecurringJobBackupSnapshot
588 label: Automatically Cleanup Recurring Job Backup Snapshot
589 description: >-
590 Setting that allows Longhorn to automatically clean up the snapshot generated by a recurring backup job.
591 group: Longhorn Default Settings
592 type: boolean
593 default: 'true'
594 - variable: defaultSettings.concurrentAutomaticEngineUpgradePerNodeLimit
595 label: Concurrent Automatic Engine Upgrade Per Node Limit
596 description: >-
597 Maximum number of engines that are allowed to concurrently upgrade on each node after Longhorn Manager is upgraded. When the value is "0", Longhorn does not automatically upgrade volume engines to the new default engine image version.
598 group: Longhorn Default Settings
599 type: int
600 min: 0
601 default: 0
602 - variable: defaultSettings.backingImageCleanupWaitInterval
603 label: Backing Image Cleanup Wait Interval
604 description: >-
605 Number of minutes that Longhorn waits before cleaning up the backing image file when no replicas in the disk are using it.
606 group: Longhorn Default Settings
607 type: int
608 min: 0
609 default: 60
610 - variable: defaultSettings.backingImageRecoveryWaitInterval
611 label: Backing Image Recovery Wait Interval
612 description: >-
613 Number of seconds that Longhorn waits before downloading a backing image file again when the status of all image disk files changes to "failed" or "unknown".
614 group: Longhorn Default Settings
615 type: int
616 min: 0
617 default: 300
618 - variable: defaultSettings.guaranteedInstanceManagerCPU
619 label: Guaranteed Instance Manager CPU
620 description: >-
621 Percentage of the total allocatable CPU resources on each node to be reserved for each Instance Manager pod when the V1 Data Engine is enabled. You can specify a floating point value between "0" and "40" to accommodate the possible number of new Instance Manager pods during upgrades. The default value is "12". **Caution**: [1] When the value is "0", CPU requests are removed from the spec of Instance Manager pods. [2] A new set of Instance Manager pods must be deployed when Longhorn is upgraded. If the available CPUs are not sufficient for the new pods, you must detach the volumes using the oldest Instance Manager pods so that Longhorn can automatically clean up the old pods and release the CPU resources. Once completed, the new pods with the latest Instance Manager image are launched. [3] This global setting is not applied to nodes with a specified value for the "InstanceManagerCPURequest" field. [4] After this setting is configured, Instance Manager pods on all nodes that use this setting are automatically restarted. **Do not change this setting while volumes are still attached. [5] or the v2 Data Engine, the spdk_tgt process inside each instance manager pod uses one or more dedicated CPU cores. Setting a minimum CPU usage is critical to maintaining stability during periods of high node load.**
622 group: Longhorn Default Settings
623 type: string
624 default: '{"v1":"12","v2":"12"}'
625 - variable: defaultSettings.logLevel
626 label: Log Level
627 description: >-
628 Log levels that indicate the type and severity of logs in Longhorn Manager. The default value is "Info". (Options: "Panic", "Fatal", "Error", "Warn", "Info", "Debug", "Trace")
629 group: Longhorn Default Settings
630 type: string
631 default: Info
632 - variable: defaultSettings.disableSnapshotPurge
633 label: Disable Snapshot Purge
634 description: >-
635 Setting that temporarily prevents all attempts to purge volume snapshots.
636 group: Longhorn Default Settings
637 type: boolean
638 default: 'false'
639 - variable: defaultSettings.freezeFilesystemForSnapshot
640 description: >-
641 Setting that freezes the filesystem on the root partition before a snapshot is created.
642 group: Longhorn Default Settings
643 type: string
644 default: '{"v1":"false"}'
645 - variable: defaultSettings.kubernetesClusterAutoscalerEnabled
646 label: Kubernetes Cluster Autoscaler Enabled (Experimental)
647 description: >-
648 Setting that notifies Longhorn that the cluster is using the Kubernetes Cluster Autoscaler. **Caution**: Replica rebuilding may consume significant resources if the Kubernetes Cluster Autoscaler removes nodes with reusable replicas.
649 group: Longhorn Default Settings
650 type: boolean
651 default: false
652 - variable: defaultSettings.orphanResourceAutoDeletion
653 label: Orphaned Data Cleanup
654 description: >-
655 Enables Longhorn to automatically delete orphaned resources and their associated data or processes (e.g., stale replicas). Orphaned resources on failed or unknown nodes are not automatically cleaned up. You need to specify the resource types to be deleted using a semicolon-separated list (e.g., `replica-data;instance`). Valid resource types: `replica-data`, `instance`.
656 group: Longhorn Default Settings
657 type: string
658 default: null
659 - variable: defaultSettings.orphanResourceAutoDeletionGracePeriod
660 label: Orphaned Data Cleanup
661 description: >-
662 Specifies the wait time, in seconds, before Longhorn automatically deletes an orphaned Custom Resource (CR) and its associated resources. Note that if a user manually deletes an orphaned CR, the deletion occurs immediately and does not respect this grace period.
663 group: Longhorn Default Settings
664 type: int
665 default: '300'
666 - variable: defaultSettings.storageNetwork
667 label: Storage Network
668 description: >-
669 Longhorn uses the storage network for in-cluster data traffic. Leave this blank to use the Kubernetes cluster network. **Caution**: This setting should change after all volumes are detached because some Longhorn component pods must be recreated to apply the setting. You cannot modify this setting while volumes are still attached.
670 group: Longhorn Default Settings
671 type: string
672 default: null
673 - variable: defaultSettings.taintToleration
674 label: Taint Toleration
675 description: >-
676 Taint or toleration for system-managed Longhorn components. Specify values using a semicolon-separated list in `kubectl taint` syntax (Example: key1=value1:effect; key2=value2:effect). **Caution**: This setting should change after all volumes are detached because some Longhorn component pods must be recreated to apply the setting. You cannot modify this setting while volumes are still attached.
677 group: Longhorn Default Settings
678 type: string
679 default: null
680 - variable: defaultSettings.systemManagedComponentsNodeSelector
681 label: System Managed Components NodeSelector
682 description: >-
683 Node selector for system-managed Longhorn components.. **Caution**: This setting should change after all volumes are detached because some Longhorn component pods must be recreated to apply the setting. You cannot modify this setting while volumes are still attached.
684 group: Longhorn Default Settings
685 type: string
686 default: null
687 - variable: defaultSettings.deletingConfirmationFlag
688 label: Deleting Confirmation Flag
689 description: Flag that prevents accidental uninstallation of Longhorn.
690 group: Longhorn Default Settings
691 type: boolean
692 default: 'false'
693 - variable: defaultSettings.engineReplicaTimeout
694 label: Timeout between Engine and Replica
695 description: >-
696 Timeout between the Longhorn Engine and replicas. Specify a value between "8" and "30" seconds. The default value is "8".
697 group: Longhorn Default Settings
698 type: string
699 default: '{"v1":"8","v2":"8"}'
700 - variable: defaultSettings.snapshotDataIntegrity
701 label: Snapshot Data Integrity
702 description: >-
703 This setting allows users to enable or disable snapshot hashing and data integrity checking.
704 group: Longhorn Default Settings
705 type: enum
706 options:
707 - enabled
708 - fast-check
709 - disabled
710 default: disabled
711 - variable: >-
712 defaultSettings.snapshotDataIntegrityImmediateCheckAfterSnapshotCreation
713 label: Immediate Snapshot Data Integrity Check After Creating a Snapshot
714 description: >-
715 Hashing 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.
716 group: Longhorn Default Settings
717 type: string
718 default: '{"v1":"false","v2":"false"}'
719 - variable: defaultSettings.snapshotDataIntegrityCronjob
720 label: Snapshot Data Integrity Check CronJob
721 description: >-
722 Unix-cron string format. The setting specifies when Longhorn checks the data integrity of snapshot disk files.
723 group: Longhorn Default Settings
724 type: string
725 default: '{"v1":"0 0 */7 * *","v2":"0 0 */7 * *"}'
726 - variable: defaultSettings.removeSnapshotsDuringFilesystemTrim
727 label: Remove Snapshots During Filesystem Trim
728 description: >-
729 This 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.
730 group: Longhorn Default Settings
731 type: boolean
732 default: 'false'
733 - variable: defaultSettings.fastReplicaRebuildEnabled
734 label: Fast Replica Rebuild Enabled
735 description: >-
736 Setting that allows fast rebuilding of replicas using the checksum of snapshot disk files. Before enabling this setting, you must set the snapshot-data-integrity value to "enable" or "fast-check".
737 group: Longhorn Default Settings
738 type: string
739 default: '{"v1":"true","v2":"true"}'
740 - variable: defaultSettings.replicaFileSyncHttpClientTimeout
741 label: Timeout of HTTP Client to Replica File Sync Server
742 description: >-
743 In seconds. The setting specifies the HTTP client timeout to the file sync server.
744 group: Longhorn Default Settings
745 type: int
746 default: '30'
747 - variable: defaultSettings.longGRPCTimeOut
748 label: Long gRPC Timeout
749 description: >-
750 Number of seconds that Longhorn allows for the completion of replica rebuilding and snapshot cloning operations.
751 group: Longhorn Default Settings
752 type: int
753 default: '86400'
754 - variable: defaultSettings.backupCompressionMethod
755 label: Backup Compression Method
756 description: Setting that allows you to specify a backup compression method.
757 group: Longhorn Default Settings
758 type: string
759 default: lz4
760 - variable: defaultSettings.backupConcurrentLimit
761 label: Backup Concurrent Limit Per Backup
762 description: >-
763 Maximum number of worker threads that can concurrently run for each backup.
764 group: Longhorn Default Settings
765 type: int
766 min: 1
767 default: 2
768 - variable: defaultSettings.backupBlockSize
769 label: Backup Block Size
770 description: >-
771 Specifies the default backup block size, in MiB, used when creating a new volume. Supported values are 2 or 16.
772 group: Longhorn Default Settings
773 type: enum
774 options:
775 - '2'
776 - '16'
777 default: '2'
778 - variable: defaultSettings.restoreConcurrentLimit
779 label: Restore Concurrent Limit Per Backup
780 description: >-
781 This setting controls how many worker threads per restore concurrently.
782 group: Longhorn Default Settings
783 type: int
784 min: 1
785 default: 2
786 - variable: defaultSettings.allowCollectingLonghornUsageMetrics
787 label: Allow Collecting Longhorn Usage Metrics
788 description: >-
789 Setting that allows Longhorn to periodically collect anonymous usage data for product improvement purposes. Longhorn sends collected data to the [Upgrade Responder](https://github.com/longhorn/upgrade-responder) server, which is the data source of the Longhorn Public Metrics Dashboard (https://metrics.longhorn.io). The Upgrade Responder server does not store data that can be used to identify clients, including IP addresses.
790 group: Longhorn Default Settings
791 type: boolean
792 default: true
793 - variable: defaultSettings.v1DataEngine
794 label: V1 Data Engine
795 description: Setting that allows you to enable the V1 Data Engine.
796 group: Longhorn V1 Data Engine Settings
797 type: boolean
798 default: true
799 - variable: defaultSettings.v2DataEngine
800 label: V2 Data Engine
801 description: >-
802 Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). The V2 Data Engine is an experimental feature and should not be used in production environments. **Caution**: [1] **Do not modify this setting while volumes are still attached.** [2] When the V2 Data Engine is enabled, each Instance Manager pod for the V2 Data Engine uses 1 CPU core. The high CPU usage is caused by `spdk_tgt`, a process running in each Instance Manager pod that handles input/output (IO) operations and requires intensive polling. `spdk_tgt` consumes 100% of a dedicated CPU core to efficiently manage and process the IO requests, ensuring optimal performance and responsiveness for storage operations.
803 group: Longhorn V2 Data Engine (Experimental Feature) Settings
804 type: boolean
805 default: false
806 - variable: defaultSettings.dataEngineHugepageEnabled
807 label: V2 Data Engine
808 description: >-
809 Applies only to the V2 Data Engine. Enables hugepages for the Storage Performance Development Kit (SPDK) target daemon. If disabled, legacy memory is used. Allocation size is set via the Data Engine Memory Size setting.
810 group: Longhorn V2 Data Engine (Experimental Feature) Settings
811 type: string
812 default: '{"v2":"true"}'
813 - variable: defaultSettings.dataEngineMemorySize
814 label: V2 Data Engine
815 description: >-
816 Applies only to the V2 Data Engine. Specifies the memory size, in MiB, allocated to the Storage Performance Development Kit (SPDK) target daemon. When hugepage is enabled, this defines the hugepage size; when legacy memory is used, hugepage is disabled.
817 group: Longhorn V2 Data Engine (Experimental Feature) Settings
818 type: string
819 default: '{"v2":"2048"}'
820 - variable: defaultSettings.dataEngineLogLevel
821 label: Data Engine Log Level
822 description: >-
823 Applies only to the V2 Data Engine. Specifies the log level for the Storage Performance Development Kit (SPDK) target daemon. Supported values are: Error, Warning, Notice, Info, and Debug. The default is Notice.
824 group: Longhorn V2 Data Engine (Experimental Feature) Settings
825 type: string
826 default: '{"v2":"Notice"}'
827 - variable: defaultSettings.dataEngineLogFlags
828 label: Data Engine Log Flags
829 description: >-
830 Applies only to the V2 Data Engine. Specifies the log flags for the Storage Performance Development Kit (SPDK) target daemon.
831 group: Longhorn V2 Data Engine (Experimental Feature) Settings
832 type: string
833 default: '{"v2":""}'
834 - variable: defaultSettings.autoCleanupSnapshotWhenDeleteBackup
835 label: Auto Cleanup Snapshot When Delete Backup
836 description: >-
837 Setting that automatically cleans up the snapshot when the backup is deleted.
838 group: Longhorn Default Settings
839 type: boolean
840 default: false
841 - variable: defaultSettings.autoCleanupSnapshotAfterOnDemandBackupCompleted
842 label: Auto Cleanup Snapshot After On-Demand Backup Completed
843 description: >-
844 Setting that automatically cleans up the snapshot after the on-demand backup is completed.
845 group: Longhorn Default Settings
846 type: boolean
847 default: false
848 - variable: defaultSettings.rwxVolumeFastFailover
849 label: RWX Volume Fast Failover (Experimental)
850 description: >-
851 Setting that allows Longhorn to detect node failure and immediately migrate affected RWX volumes.
852 group: Longhorn Default Settings
853 type: boolean
854 default: false
855 - variable: defaultSettings.offlineReplicaRebuilding
856 label: Offline Replica Rebuilding
857 description: >-
858 Enables automatic rebuilding of degraded replicas while the volume is detached. This setting only takes effect if the individual volume setting is set to `ignored` or `enabled`.
859 group: Longhorn Default Settings
860 type: string
861 default: '{"v1":"false","v2":"false"}'
862 - variable: defaultSettings.dataEngineCPUMask
863 label: Data Engine CPU Mask
864 description: >-
865 Applies only to the V2 Data Engine. Specifies the CPU cores on which the Storage Performance Development Kit (SPDK) target daemon runs. The daemon is deployed in each Instance Manager pod. Ensure that the number of assigned cores does not exceed the guaranteed Instance Manager CPUs for the V2 Data Engine.
866 group: Longhorn Default Settings
867 type: string
868 default: '{"v2":"0x1"}'
869 - variable: defaultSettings.replicaRebuildingBandwidthLimit
870 label: Replica Rebuilding Bandwidth Limit
871 description: >-
872 Applies only to the V2 Data Engine. Specifies the default write bandwidth limit, in megabytes per second (MB/s), for volume replica rebuilding. If this value is set to 0, there will be no write bandwidth limitation. Individual volumes can override this setting by specifying their own rebuilding bandwidth limit.
873 group: Longhorn Default Settings
874 type: string
875 default: '{"v2":"0"}'
876 - variable: defaultSettings.instanceManagerPodLivenessProbeTimeout
877 label: Instance Manager Pod Liveness Probe Timeout
878 description: >-
879 In seconds. The setting specifies the timeout for the instance manager pod liveness probe. The default value is 10 seconds.
880 group: Longhorn Default Settings
881 type: int
882 min: 1
883 max: 60
884 default: 10
885 - variable: persistence.defaultClass
886 default: 'true'
887 description: Setting that allows you to specify the default Longhorn StorageClass.
888 label: Default Storage Class
889 group: Longhorn Storage Class Settings
890 required: true
891 type: boolean
892 subquestions: []
893 - variable: persistence.reclaimPolicy
894 label: Storage Class Retain Policy
895 description: >-
896 Reclaim policy that provides instructions for handling of a volume after its claim is released. (Options: "Retain", "Delete")
897 group: Longhorn Storage Class Settings
898 required: true
899 type: enum
900 options:
901 - Delete
902 - Retain
903 default: Delete
904 subquestions: []
905 - variable: persistence.volumeBindingMode
906 label: Storage Class Volume Binding Mode
907 description: >-
908 VolumeBindingMode controls when volume binding and dynamic provisioning should occur. (Options: "Immediate", "WaitForFirstConsumer") (Defaults to "Immediate")
909 group: Longhorn Storage Class Settings
910 required: true
911 type: enum
912 options:
913 - Immediate
914 - WaitForFirstConsumer
915 default: Immediate
916 subquestions: []
917 - variable: persistence.defaultFsType
918 label: Storage Class Filesystem Type
919 description: Filesystem type of the default Longhorn StorageClass
920 group: Longhorn Storage Class Settings
921 type: enum
922 options:
923 - xfs
924 - ext4
925 default: ext4
926 subquestions: []
927 - variable: persistence.disableRevisionCounter
928 label: Default Storage Class Disable Revision Counter
929 description: >-
930 Setting that disables the revision counter and thereby prevents Longhorn from tracking all write operations to a volume. When salvaging a volume, Longhorn uses properties of the volume-head-xxx.img file (the last file size and the last time the file was modified) to select the replica to be used for volume recovery. (Options: "true", "false")
931 group: Longhorn Storage Class Settings
932 required: true
933 type: enum
934 options:
935 - 'true'
936 - 'false'
937 default: 'true'
938 subquestions: []
939 - variable: persistence.defaultClassReplicaCount
940 description: Replica count of the default Longhorn StorageClass.
941 label: Default Storage Class Replica Count
942 group: Longhorn Storage Class Settings
943 type: int
944 min: 1
945 max: 10
946 default: 3
947 subquestions: []
948 - variable: persistence.defaultDataLocality
949 description: >-
950 Data locality of the default Longhorn StorageClass. (Options: "disabled", "best-effort")
951 label: Default Storage Class Data Locality
952 group: Longhorn Storage Class Settings
953 type: enum
954 options:
955 - disabled
956 - best-effort
957 default: disabled
958 subquestions: []
959 - variable: persistence.recurringJobSelector.enable
960 description: >-
961 Setting that allows you to enable the recurring job selector for a Longhorn StorageClass.
962 group: Longhorn Storage Class Settings
963 label: Enable Storage Class Recurring Job Selector
964 type: boolean
965 default: false
966 show_subquestion_if: true
967 subquestions:
968 - variable: persistence.recurringJobSelector.jobList
969 description: >-
970 Recurring job selector for a Longhorn StorageClass. Ensure that quotes are used correctly when specifying job parameters. (Example: `[{"name":"backup", "isGroup":true}]`)
971 label: Storage Class Recurring Job Selector List
972 group: Longhorn Storage Class Settings
973 type: string
974 default: null
975 - variable: persistence.defaultDiskSelector.enable
976 description: >-
977 Setting that allows you to enable the disk selector for the default Longhorn StorageClass.
978 group: Longhorn Storage Class Settings
979 label: Enable Storage Class Disk Selector
980 type: boolean
981 default: false
982 show_subquestion_if: true
983 subquestions:
984 - variable: persistence.defaultDiskSelector.selector
985 label: Storage Class Disk Selector
986 description: >-
987 Disk selector for the default Longhorn StorageClass. Longhorn uses only disks with the specified tags for storing volume data. (Examples: "nvme,sata")
988 group: Longhorn Storage Class Settings
989 type: string
990 default: null
991 - variable: persistence.defaultNodeSelector.enable
992 description: >-
993 Setting that allows you to enable the node selector for the default Longhorn StorageClass.
994 group: Longhorn Storage Class Settings
995 label: Enable Storage Class Node Selector
996 type: boolean
997 default: false
998 show_subquestion_if: true
999 subquestions:
1000 - variable: persistence.defaultNodeSelector.selector
1001 label: Storage Class Node Selector
1002 description: >-
1003 Node selector for the default Longhorn StorageClass. Longhorn uses only nodes with the specified tags for storing volume data. (Examples: "storage,fast")
1004 group: Longhorn Storage Class Settings
1005 type: string
1006 default: null
1007 - variable: persistence.backingImage.enable
1008 description: Setting that allows you to use a backing image in a Longhorn StorageClass.
1009 group: Longhorn Storage Class Settings
1010 label: Default Storage Class Backing Image
1011 type: boolean
1012 default: false
1013 show_subquestion_if: true
1014 subquestions:
1015 - variable: persistence.backingImage.name
1016 description: >-
1017 Backing image to be used for creating and restoring volumes in a Longhorn StorageClass. When no backing images are available, specify the data source type and parameters that Longhorn can use to create a backing image.
1018 label: Storage Class Backing Image Name
1019 group: Longhorn Storage Class Settings
1020 type: string
1021 default: null
1022 - variable: persistence.backingImage.expectedChecksum
1023 description: >-
1024 Expected SHA-512 checksum of a backing image used in a Longhorn StorageClass. **Caution** [1] This field is useful only if the backing image name is specified. [2] Specifying a checksum is not recommended when the data source type is \"export-from-volume\".
1025 label: Storage Class Backing Image Expected SHA512 Checksum
1026 group: Longhorn Storage Class Settings
1027 type: string
1028 default: null
1029 - variable: persistence.backingImage.dataSourceType
1030 description: >-
1031 Data source type of a backing image used in a Longhorn StorageClass. If the backing image exists in the cluster, Longhorn uses this setting to verify the image. If the backing image does not exist, Longhorn creates one using the specified data source type. **Caution** [1] This field is useful only if the backing image name is specified. [2] Backing images with data source type \"upload\" are best created using the Longhorn UI. Uploading requires sending file data to Longhorn after object creation, which can be complicated when performed manually.
1032 label: Storage Class Backing Image Data Source Type
1033 group: Longhorn Storage Class Settings
1034 type: enum
1035 options:
1036 - ''
1037 - download
1038 - upload
1039 - export-from-volume
1040 default: ''
1041 - variable: persistence.backingImage.dataSourceParameters
1042 description: >-
1043 Data source parameters of a backing image used in a Longhorn StorageClass. You can specify a JSON string of a map. (Example: `'{"url":"https://backing-image-example.s3-region.amazonaws.com/test-backing-image"}'`) **Caution** [1] This field is useful only if the backing image name is specified. [2] Ensure that quotes are used correctly when specifying parameters.
1044 label: Storage Class Backing Image Data Source Parameters
1045 group: Longhorn Storage Class Settings
1046 type: string
1047 default: null
1048 - variable: persistence.unmapMarkSnapChainRemoved
1049 description: >-
1050 Setting that allows you to enable automatic snapshot removal during filesystem trim for a Longhorn StorageClass. (Options: "ignored", "enabled", "disabled")
1051 label: Default Storage Class Remove Snapshots During Filesystem Trim
1052 group: Longhorn Storage Class Settings
1053 type: enum
1054 options:
1055 - ignored
1056 - enabled
1057 - disabled
1058 default: ignored
1059 subquestions: []
1060 - variable: persistence.dataEngine
1061 description: >-
1062 Setting that allows you to specify the data engine version for the default Longhorn StorageClass. (Options: "v1", "v2")
1063 label: Default Storage Class Data Engine
1064 group: Longhorn Storage Class Settings
1065 type: enum
1066 options:
1067 - v1
1068 - v2
1069 default: v1
1070 subquestions: []
1071 - variable: persistence.backupTargetName
1072 description: >-
1073 Setting that allows you to specify the backup target for the default Longhorn StorageClass
1074 label: Default Storage Class Backup Target Name
1075 group: Longhorn Storage Class Settings
1076 type: string
1077 default: default
1078 subquestions: []
1079 - variable: ingress.enabled
1080 default: 'false'
1081 description: Expose app using Layer 7 Load Balancer - ingress
1082 type: boolean
1083 group: Services and Load Balancing
1084 label: Expose app using Layer 7 Load Balancer
1085 show_subquestion_if: true
1086 subquestions:
1087 - variable: ingress.host
1088 default: xip.io
1089 description: Hostname of the Layer 7 load balancer.
1090 type: hostname
1091 required: true
1092 label: Layer 7 Load Balancer Hostname
1093 - variable: ingress.path
1094 default: /
1095 description: >-
1096 Default ingress path. You can access the Longhorn UI by following the full ingress path {{host}}+{{path}}.
1097 type: string
1098 required: true
1099 label: Ingress Path
1100 - variable: ingress.pathType
1101 default: ImplementationSpecific
1102 description: >-
1103 Path type for the ingress. (Options: "ImplementationSpecific", "Exact", "Prefix")
1104 type: enum
1105 options:
1106 - ImplementationSpecific
1107 - Exact
1108 - Prefix
1109 required: true
1110 label: Ingress Path Type
1111 - variable: service.ui.type
1112 default: Rancher-Proxy
1113 description: >-
1114 Service type for Longhorn UI. (Options: "ClusterIP", "NodePort", "LoadBalancer", "Rancher-Proxy")
1115 type: enum
1116 options:
1117 - ClusterIP
1118 - NodePort
1119 - LoadBalancer
1120 - Rancher-Proxy
1121 label: Longhorn UI Service
1122 show_if: ingress.enabled=false
1123 group: Services and Load Balancing
1124 show_subquestion_if: NodePort
1125 subquestions:
1126 - variable: service.ui.nodePort
1127 default: ''
1128 description: >-
1129 NodePort port number for Longhorn UI. When unspecified, Longhorn selects a free port between 30000 and 32767.
1130 type: int
1131 min: 30000
1132 max: 32767
1133 show_if: service.ui.type=NodePort||service.ui.type=LoadBalancer
1134 label: UI Service NodePort number
1135 - variable: longhorn.default_resource
1136 default: 'false'
1137 description: >-
1138 Customize the default resource before installing Longhorn for the first time. This option will only work if the cluster hasn't installed Longhorn.
1139 label: Customize Default Resources
1140 type: boolean
1141 show_subquestion_if: true
1142 group: Longhorn Default Resources
1143 subquestions:
1144 - variable: defaultBackupStore.backupTarget
1145 label: Backup Target
1146 description: >-
1147 Endpoint used to access the backupstore. (Options: "NFS", "CIFS", "AWS", "GCP", "AZURE")
1148 group: Longhorn Default Resources
1149 type: string
1150 default: null
1151 - variable: defaultBackupStore.backupTargetCredentialSecret
1152 label: Backup Target Credential Secret
1153 description: Name of the Kubernetes secret associated with the backup target.
1154 group: Longhorn Default Resources
1155 type: string
1156 default: null
1157 - variable: defaultBackupStore.backupstorePollInterval
1158 label: Backupstore Poll Interval
1159 description: >-
1160 Number of seconds that Longhorn waits before checking the backupstore for new backups. The default value is "300". When the value is "0", polling is disabled.
1161 group: Longhorn Default Resources
1162 type: int
1163 min: 0
1164 default: 300
1165 - variable: enablePSP
1166 default: 'false'
1167 description: >-
1168 Setting that allows you to enable pod security policies (PSPs) that allow privileged Longhorn pods to start. This setting applies only to clusters running Kubernetes 1.25 and earlier, and with the built-in Pod Security admission controller enabled.
1169 label: Pod Security Policy
1170 type: boolean
1171 group: Other Settings
1172 subquestions: []
1173 - variable: global.cattle.windowsCluster.enabled
1174 default: 'false'
1175 description: Setting that allows Longhorn to run on a Rancher Windows cluster.
1176 label: Rancher Windows Cluster
1177 type: boolean
1178 group: Other Settings
1179 subquestions: []
1180 - variable: networkPolicies.enabled
1181 description: >-
1182 Setting that allows you to enable network policies that control access to Longhorn pods. **Caution** The Rancher Proxy will work only if this feature is enabled and a custom NetworkPolicy is added.
1183 group: Other Settings
1184 label: Network Policies
1185 default: 'false'
1186 type: boolean
1187 subquestions:
1188 - variable: networkPolicies.type
1189 label: Network Policies for Ingress
1190 description: >-
1191 Distribution that determines the policy for allowing access for an ingress. (Options: "k3s", "rke2", "rke1")
1192 show_if: networkPolicies.enabled=true&&ingress.enabled=true
1193 type: enum
1194 default: rke2
1195 options:
1196 - rke1
1197 - rke2
1198 - k3s