blob: 00e7ad1768dfc27206330b78da9e4e69b028dc50 [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.0
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.0
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.0
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.0
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.0
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.0
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.69
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.9.0-20250826
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-20250826
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.14.0-20250826
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-20250826
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.3.0-20250826
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.16.0-20250826
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.disableSchedulingOnCordonedNode
450 label: Disable Scheduling On Cordoned Node
451 description: >-
452 Setting that prevents Longhorn Manager from scheduling replicas on a cordoned Kubernetes node. This setting is enabled by default.
453 group: Longhorn Default Settings
454 type: boolean
455 default: 'true'
456 - variable: defaultSettings.replicaZoneSoftAntiAffinity
457 label: Replica Zone Level Soft Anti-Affinity
458 description: >-
459 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.
460 group: Longhorn Default Settings
461 type: boolean
462 default: 'true'
463 - variable: defaultSettings.replicaDiskSoftAntiAffinity
464 label: Replica Disk Level Soft Anti-Affinity
465 description: >-
466 Allow scheduling on disks with existing healthy replicas of the same volume. By default, true.
467 group: Longhorn Default Settings
468 type: boolean
469 default: 'true'
470 - variable: defaultSettings.allowEmptyNodeSelectorVolume
471 label: Allow Empty Node Selector Volume
472 description: >-
473 Setting that allows scheduling of empty node selector volumes to any node.
474 group: Longhorn Default Settings
475 type: boolean
476 default: 'true'
477 - variable: defaultSettings.allowEmptyDiskSelectorVolume
478 label: Allow Empty Disk Selector Volume
479 description: >-
480 Setting that allows scheduling of empty disk selector volumes to any disk.
481 group: Longhorn Default Settings
482 type: boolean
483 default: 'true'
484 - variable: defaultSettings.nodeDownPodDeletionPolicy
485 label: Pod Deletion Policy When Node is Down
486 description: >-
487 Policy that defines the action Longhorn takes when a volume is stuck with a StatefulSet or Deployment pod on a node that failed.
488 group: Longhorn Default Settings
489 type: enum
490 options:
491 - do-nothing
492 - delete-statefulset-pod
493 - delete-deployment-pod
494 - delete-both-statefulset-and-deployment-pod
495 default: do-nothing
496 - variable: defaultSettings.nodeDrainPolicy
497 label: Node Drain Policy
498 description: >-
499 Policy that defines the action Longhorn takes when a node with the last healthy replica of a volume is drained.
500 group: Longhorn Default Settings
501 type: enum
502 options:
503 - block-for-eviction
504 - block-for-eviction-if-contains-last-replica
505 - block-if-contains-last-replica
506 - allow-if-replica-is-stopped
507 - always-allow
508 default: block-if-contains-last-replica
509 - variable: defaultSettings.detachManuallyAttachedVolumesWhenCordoned
510 label: Detach Manually Attached Volumes When Cordoned
511 description: >-
512 Setting that allows automatic detaching of manually-attached volumes when a node is cordoned.
513 group: Longhorn Default Settings
514 type: boolean
515 default: 'false'
516 - variable: defaultSettings.priorityClass
517 label: Priority Class
518 description: >-
519 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.
520 group: Longhorn Default Settings
521 type: string
522 default: longhorn-critical
523 - variable: defaultSettings.replicaReplenishmentWaitInterval
524 label: Replica Replenishment Wait Interval
525 description: >-
526 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.
527 group: Longhorn Default Settings
528 type: int
529 min: 0
530 default: 600
531 - variable: defaultSettings.concurrentReplicaRebuildPerNodeLimit
532 label: Concurrent Replica Rebuild Per Node Limit
533 description: >-
534 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.
535 group: Longhorn Default Settings
536 type: int
537 min: 0
538 default: 5
539 - variable: defaultSettings.concurrentVolumeBackupRestorePerNodeLimit
540 label: Concurrent Volume Backup Restore Per Node Limit
541 description: >-
542 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.
543 group: Longhorn Default Settings
544 type: int
545 min: 0
546 default: 5
547 - variable: defaultSettings.disableRevisionCounter
548 label: Disable Revision Counter
549 description: >-
550 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.
551 group: Longhorn Default Settings
552 type: string
553 default: '{"v1":"true"}'
554 - variable: defaultSettings.systemManagedPodsImagePullPolicy
555 label: System Managed Pod Image Pull Policy
556 description: >-
557 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.
558 group: Longhorn Default Settings
559 type: enum
560 options:
561 - if-not-present
562 - always
563 - never
564 default: if-not-present
565 - variable: defaultSettings.allowVolumeCreationWithDegradedAvailability
566 label: Allow Volume Creation with Degraded Availability
567 description: >-
568 Setting that allows you to create and attach a volume without having all replicas scheduled at the time of creation.
569 group: Longhorn Default Settings
570 type: boolean
571 default: 'true'
572 - variable: defaultSettings.autoCleanupSystemGeneratedSnapshot
573 label: Automatically Cleanup System Generated Snapshot
574 description: >-
575 Setting that allows Longhorn to automatically clean up the system-generated snapshot after replica rebuilding is completed.
576 group: Longhorn Default Settings
577 type: boolean
578 default: 'true'
579 - variable: defaultSettings.autoCleanupRecurringJobBackupSnapshot
580 label: Automatically Cleanup Recurring Job Backup Snapshot
581 description: >-
582 Setting that allows Longhorn to automatically clean up the snapshot generated by a recurring backup job.
583 group: Longhorn Default Settings
584 type: boolean
585 default: 'true'
586 - variable: defaultSettings.concurrentAutomaticEngineUpgradePerNodeLimit
587 label: Concurrent Automatic Engine Upgrade Per Node Limit
588 description: >-
589 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.
590 group: Longhorn Default Settings
591 type: int
592 min: 0
593 default: 0
594 - variable: defaultSettings.backingImageCleanupWaitInterval
595 label: Backing Image Cleanup Wait Interval
596 description: >-
597 Number of minutes that Longhorn waits before cleaning up the backing image file when no replicas in the disk are using it.
598 group: Longhorn Default Settings
599 type: int
600 min: 0
601 default: 60
602 - variable: defaultSettings.backingImageRecoveryWaitInterval
603 label: Backing Image Recovery Wait Interval
604 description: >-
605 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".
606 group: Longhorn Default Settings
607 type: int
608 min: 0
609 default: 300
610 - variable: defaultSettings.guaranteedInstanceManagerCPU
611 label: Guaranteed Instance Manager CPU
612 description: >-
613 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.**
614 group: Longhorn Default Settings
615 type: string
616 default: '{"v1":"12","v2":"12"}'
617 - variable: defaultSettings.logLevel
618 label: Log Level
619 description: >-
620 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")
621 group: Longhorn Default Settings
622 type: string
623 default: Info
624 - variable: defaultSettings.disableSnapshotPurge
625 label: Disable Snapshot Purge
626 description: >-
627 Setting that temporarily prevents all attempts to purge volume snapshots.
628 group: Longhorn Default Settings
629 type: boolean
630 default: 'false'
631 - variable: defaultSettings.freezeFilesystemForSnapshot
632 description: >-
633 Setting that freezes the filesystem on the root partition before a snapshot is created.
634 group: Longhorn Default Settings
635 type: string
636 default: '{"v1":"false"}'
637 - variable: defaultSettings.kubernetesClusterAutoscalerEnabled
638 label: Kubernetes Cluster Autoscaler Enabled (Experimental)
639 description: >-
640 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.
641 group: Longhorn Default Settings
642 type: boolean
643 default: false
644 - variable: defaultSettings.orphanResourceAutoDeletion
645 label: Orphaned Data Cleanup
646 description: >-
647 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`.
648 group: Longhorn Default Settings
649 type: string
650 default: null
651 - variable: defaultSettings.orphanResourceAutoDeletionGracePeriod
652 label: Orphaned Data Cleanup
653 description: >-
654 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.
655 group: Longhorn Default Settings
656 type: int
657 default: '300'
658 - variable: defaultSettings.storageNetwork
659 label: Storage Network
660 description: >-
661 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.
662 group: Longhorn Default Settings
663 type: string
664 default: null
665 - variable: defaultSettings.taintToleration
666 label: Taint Toleration
667 description: >-
668 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.
669 group: Longhorn Default Settings
670 type: string
671 default: null
672 - variable: defaultSettings.systemManagedComponentsNodeSelector
673 label: System Managed Components NodeSelector
674 description: >-
675 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.
676 group: Longhorn Default Settings
677 type: string
678 default: null
679 - variable: defaultSettings.deletingConfirmationFlag
680 label: Deleting Confirmation Flag
681 description: Flag that prevents accidental uninstallation of Longhorn.
682 group: Longhorn Default Settings
683 type: boolean
684 default: 'false'
685 - variable: defaultSettings.engineReplicaTimeout
686 label: Timeout between Engine and Replica
687 description: >-
688 Timeout between the Longhorn Engine and replicas. Specify a value between "8" and "30" seconds. The default value is "8".
689 group: Longhorn Default Settings
690 type: string
691 default: '{"v1":"8","v2":"8"}'
692 - variable: defaultSettings.snapshotDataIntegrity
693 label: Snapshot Data Integrity
694 description: >-
695 This setting allows users to enable or disable snapshot hashing and data integrity checking.
696 group: Longhorn Default Settings
697 type: enum
698 options:
699 - enabled
700 - fast-check
701 - disabled
702 default: disabled
703 - variable: >-
704 defaultSettings.snapshotDataIntegrityImmediateCheckAfterSnapshotCreation
705 label: Immediate Snapshot Data Integrity Check After Creating a Snapshot
706 description: >-
707 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.
708 group: Longhorn Default Settings
709 type: string
710 default: '{"v1":"false","v2":"false"}'
711 - variable: defaultSettings.snapshotDataIntegrityCronjob
712 label: Snapshot Data Integrity Check CronJob
713 description: >-
714 Unix-cron string format. The setting specifies when Longhorn checks the data integrity of snapshot disk files.
715 group: Longhorn Default Settings
716 type: string
717 default: '{"v1":"0 0 */7 * *","v2":"0 0 */7 * *"}'
718 - variable: defaultSettings.removeSnapshotsDuringFilesystemTrim
719 label: Remove Snapshots During Filesystem Trim
720 description: >-
721 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.
722 group: Longhorn Default Settings
723 type: boolean
724 default: 'false'
725 - variable: defaultSettings.fastReplicaRebuildEnabled
726 label: Fast Replica Rebuild Enabled
727 description: >-
728 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".
729 group: Longhorn Default Settings
730 type: string
731 default: '{"v1":"true","v2":"true"}'
732 - variable: defaultSettings.replicaFileSyncHttpClientTimeout
733 label: Timeout of HTTP Client to Replica File Sync Server
734 description: >-
735 In seconds. The setting specifies the HTTP client timeout to the file sync server.
736 group: Longhorn Default Settings
737 type: int
738 default: '30'
739 - variable: defaultSettings.longGRPCTimeOut
740 label: Long gRPC Timeout
741 description: >-
742 Number of seconds that Longhorn allows for the completion of replica rebuilding and snapshot cloning operations.
743 group: Longhorn Default Settings
744 type: int
745 default: '86400'
746 - variable: defaultSettings.backupCompressionMethod
747 label: Backup Compression Method
748 description: Setting that allows you to specify a backup compression method.
749 group: Longhorn Default Settings
750 type: string
751 default: lz4
752 - variable: defaultSettings.backupConcurrentLimit
753 label: Backup Concurrent Limit Per Backup
754 description: >-
755 Maximum number of worker threads that can concurrently run for each backup.
756 group: Longhorn Default Settings
757 type: int
758 min: 1
759 default: 2
760 - variable: defaultSettings.backupBlockSize
761 label: Backup Block Size
762 description: >-
763 Specifies the default backup block size, in MiB, used when creating a new volume. Supported values are 2 or 16.
764 group: Longhorn Default Settings
765 type: enum
766 options:
767 - '2'
768 - '16'
769 default: '2'
770 - variable: defaultSettings.restoreConcurrentLimit
771 label: Restore Concurrent Limit Per Backup
772 description: >-
773 This setting controls how many worker threads per restore concurrently.
774 group: Longhorn Default Settings
775 type: int
776 min: 1
777 default: 2
778 - variable: defaultSettings.allowCollectingLonghornUsageMetrics
779 label: Allow Collecting Longhorn Usage Metrics
780 description: >-
781 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.
782 group: Longhorn Default Settings
783 type: boolean
784 default: true
785 - variable: defaultSettings.v1DataEngine
786 label: V1 Data Engine
787 description: Setting that allows you to enable the V1 Data Engine.
788 group: Longhorn V1 Data Engine Settings
789 type: boolean
790 default: true
791 - variable: defaultSettings.v2DataEngine
792 label: V2 Data Engine
793 description: >-
794 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.
795 group: Longhorn V2 Data Engine (Experimental Feature) Settings
796 type: boolean
797 default: false
798 - variable: defaultSettings.dataEngineHugepageEnabled
799 label: V2 Data Engine
800 description: >-
801 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.
802 group: Longhorn V2 Data Engine (Experimental Feature) Settings
803 type: string
804 default: '{"v2":"true"}'
805 - variable: defaultSettings.dataEngineMemorySize
806 label: V2 Data Engine
807 description: >-
808 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.
809 group: Longhorn V2 Data Engine (Experimental Feature) Settings
810 type: string
811 default: '{"v2":"2048"}'
812 - variable: defaultSettings.dataEngineLogLevel
813 label: Data Engine Log Level
814 description: >-
815 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.
816 group: Longhorn V2 Data Engine (Experimental Feature) Settings
817 type: string
818 default: '{"v2":"Notice"}'
819 - variable: defaultSettings.dataEngineLogFlags
820 label: Data Engine Log Flags
821 description: >-
822 Applies only to the V2 Data Engine. Specifies the log flags for the Storage Performance Development Kit (SPDK) target daemon.
823 group: Longhorn V2 Data Engine (Experimental Feature) Settings
824 type: string
825 default: '{"v2":""}'
826 - variable: defaultSettings.autoCleanupSnapshotWhenDeleteBackup
827 label: Auto Cleanup Snapshot When Delete Backup
828 description: >-
829 Setting that automatically cleans up the snapshot when the backup is deleted.
830 group: Longhorn Default Settings
831 type: boolean
832 default: false
833 - variable: defaultSettings.autoCleanupSnapshotAfterOnDemandBackupCompleted
834 label: Auto Cleanup Snapshot After On-Demand Backup Completed
835 description: >-
836 Setting that automatically cleans up the snapshot after the on-demand backup is completed.
837 group: Longhorn Default Settings
838 type: boolean
839 default: false
840 - variable: defaultSettings.rwxVolumeFastFailover
841 label: RWX Volume Fast Failover (Experimental)
842 description: >-
843 Setting that allows Longhorn to detect node failure and immediately migrate affected RWX volumes.
844 group: Longhorn Default Settings
845 type: boolean
846 default: false
847 - variable: defaultSettings.offlineReplicaRebuilding
848 label: Offline Replica Rebuilding
849 description: >-
850 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`.
851 group: Longhorn Default Settings
852 type: string
853 default: '{"v1":"false","v2":"false"}'
854 - variable: persistence.defaultClass
855 default: 'true'
856 description: Setting that allows you to specify the default Longhorn StorageClass.
857 label: Default Storage Class
858 group: Longhorn Storage Class Settings
859 required: true
860 type: boolean
861 subquestions: []
862 - variable: persistence.reclaimPolicy
863 label: Storage Class Retain Policy
864 description: >-
865 Reclaim policy that provides instructions for handling of a volume after its claim is released. (Options: "Retain", "Delete")
866 group: Longhorn Storage Class Settings
867 required: true
868 type: enum
869 options:
870 - Delete
871 - Retain
872 default: Delete
873 subquestions: []
874 - variable: persistence.volumeBindingMode
875 label: Storage Class Volume Binding Mode
876 description: >-
877 VolumeBindingMode controls when volume binding and dynamic provisioning should occur. (Options: "Immediate", "WaitForFirstConsumer") (Defaults to "Immediate")
878 group: Longhorn Storage Class Settings
879 required: true
880 type: enum
881 options:
882 - Immediate
883 - WaitForFirstConsumer
884 default: Immediate
885 subquestions: []
886 - variable: persistence.defaultFsType
887 label: Storage Class Filesystem Type
888 description: Filesystem type of the default Longhorn StorageClass
889 group: Longhorn Storage Class Settings
890 type: enum
891 options:
892 - xfs
893 - ext4
894 default: ext4
895 subquestions: []
896 - variable: persistence.disableRevisionCounter
897 label: Default Storage Class Disable Revision Counter
898 description: >-
899 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")
900 group: Longhorn Storage Class Settings
901 required: true
902 type: enum
903 options:
904 - 'true'
905 - 'false'
906 default: 'true'
907 subquestions: []
908 - variable: persistence.defaultClassReplicaCount
909 description: Replica count of the default Longhorn StorageClass.
910 label: Default Storage Class Replica Count
911 group: Longhorn Storage Class Settings
912 type: int
913 min: 1
914 max: 10
915 default: 3
916 subquestions: []
917 - variable: persistence.defaultDataLocality
918 description: >-
919 Data locality of the default Longhorn StorageClass. (Options: "disabled", "best-effort")
920 label: Default Storage Class Data Locality
921 group: Longhorn Storage Class Settings
922 type: enum
923 options:
924 - disabled
925 - best-effort
926 default: disabled
927 subquestions: []
928 - variable: persistence.recurringJobSelector.enable
929 description: >-
930 Setting that allows you to enable the recurring job selector for a Longhorn StorageClass.
931 group: Longhorn Storage Class Settings
932 label: Enable Storage Class Recurring Job Selector
933 type: boolean
934 default: false
935 show_subquestion_if: true
936 subquestions:
937 - variable: persistence.recurringJobSelector.jobList
938 description: >-
939 Recurring job selector for a Longhorn StorageClass. Ensure that quotes are used correctly when specifying job parameters. (Example: `[{"name":"backup", "isGroup":true}]`)
940 label: Storage Class Recurring Job Selector List
941 group: Longhorn Storage Class Settings
942 type: string
943 default: null
944 - variable: persistence.defaultDiskSelector.enable
945 description: >-
946 Setting that allows you to enable the disk selector for the default Longhorn StorageClass.
947 group: Longhorn Storage Class Settings
948 label: Enable Storage Class Disk Selector
949 type: boolean
950 default: false
951 show_subquestion_if: true
952 subquestions:
953 - variable: persistence.defaultDiskSelector.selector
954 label: Storage Class Disk Selector
955 description: >-
956 Disk selector for the default Longhorn StorageClass. Longhorn uses only disks with the specified tags for storing volume data. (Examples: "nvme,sata")
957 group: Longhorn Storage Class Settings
958 type: string
959 default: null
960 - variable: persistence.defaultNodeSelector.enable
961 description: >-
962 Setting that allows you to enable the node selector for the default Longhorn StorageClass.
963 group: Longhorn Storage Class Settings
964 label: Enable Storage Class Node Selector
965 type: boolean
966 default: false
967 show_subquestion_if: true
968 subquestions:
969 - variable: persistence.defaultNodeSelector.selector
970 label: Storage Class Node Selector
971 description: >-
972 Node selector for the default Longhorn StorageClass. Longhorn uses only nodes with the specified tags for storing volume data. (Examples: "storage,fast")
973 group: Longhorn Storage Class Settings
974 type: string
975 default: null
976 - variable: persistence.backingImage.enable
977 description: Setting that allows you to use a backing image in a Longhorn StorageClass.
978 group: Longhorn Storage Class Settings
979 label: Default Storage Class Backing Image
980 type: boolean
981 default: false
982 show_subquestion_if: true
983 subquestions:
984 - variable: persistence.backingImage.name
985 description: >-
986 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.
987 label: Storage Class Backing Image Name
988 group: Longhorn Storage Class Settings
989 type: string
990 default: null
991 - variable: persistence.backingImage.expectedChecksum
992 description: >-
993 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\".
994 label: Storage Class Backing Image Expected SHA512 Checksum
995 group: Longhorn Storage Class Settings
996 type: string
997 default: null
998 - variable: persistence.backingImage.dataSourceType
999 description: >-
1000 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.
1001 label: Storage Class Backing Image Data Source Type
1002 group: Longhorn Storage Class Settings
1003 type: enum
1004 options:
1005 - ''
1006 - download
1007 - upload
1008 - export-from-volume
1009 default: ''
1010 - variable: persistence.backingImage.dataSourceParameters
1011 description: >-
1012 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.
1013 label: Storage Class Backing Image Data Source Parameters
1014 group: Longhorn Storage Class Settings
1015 type: string
1016 default: null
1017 - variable: persistence.unmapMarkSnapChainRemoved
1018 description: >-
1019 Setting that allows you to enable automatic snapshot removal during filesystem trim for a Longhorn StorageClass. (Options: "ignored", "enabled", "disabled")
1020 label: Default Storage Class Remove Snapshots During Filesystem Trim
1021 group: Longhorn Storage Class Settings
1022 type: enum
1023 options:
1024 - ignored
1025 - enabled
1026 - disabled
1027 default: ignored
1028 subquestions: []
1029 - variable: persistence.dataEngine
1030 description: >-
1031 Setting that allows you to specify the data engine version for the default Longhorn StorageClass. (Options: "v1", "v2")
1032 label: Default Storage Class Data Engine
1033 group: Longhorn Storage Class Settings
1034 type: enum
1035 options:
1036 - v1
1037 - v2
1038 default: v1
1039 subquestions: []
1040 - variable: persistence.backupTargetName
1041 description: >-
1042 Setting that allows you to specify the backup target for the default Longhorn StorageClass
1043 label: Default Storage Class Backup Target Name
1044 group: Longhorn Storage Class Settings
1045 type: string
1046 default: default
1047 subquestions: []
1048 - variable: ingress.enabled
1049 default: 'false'
1050 description: Expose app using Layer 7 Load Balancer - ingress
1051 type: boolean
1052 group: Services and Load Balancing
1053 label: Expose app using Layer 7 Load Balancer
1054 show_subquestion_if: true
1055 subquestions:
1056 - variable: ingress.host
1057 default: xip.io
1058 description: Hostname of the Layer 7 load balancer.
1059 type: hostname
1060 required: true
1061 label: Layer 7 Load Balancer Hostname
1062 - variable: ingress.path
1063 default: /
1064 description: >-
1065 Default ingress path. You can access the Longhorn UI by following the full ingress path {{host}}+{{path}}.
1066 type: string
1067 required: true
1068 label: Ingress Path
1069 - variable: ingress.pathType
1070 default: ImplementationSpecific
1071 description: >-
1072 Path type for the ingress. (Options: "ImplementationSpecific", "Exact", "Prefix")
1073 type: enum
1074 options:
1075 - ImplementationSpecific
1076 - Exact
1077 - Prefix
1078 required: true
1079 label: Ingress Path Type
1080 - variable: service.ui.type
1081 default: Rancher-Proxy
1082 description: >-
1083 Service type for Longhorn UI. (Options: "ClusterIP", "NodePort", "LoadBalancer", "Rancher-Proxy")
1084 type: enum
1085 options:
1086 - ClusterIP
1087 - NodePort
1088 - LoadBalancer
1089 - Rancher-Proxy
1090 label: Longhorn UI Service
1091 show_if: ingress.enabled=false
1092 group: Services and Load Balancing
1093 show_subquestion_if: NodePort
1094 subquestions:
1095 - variable: service.ui.nodePort
1096 default: ''
1097 description: >-
1098 NodePort port number for Longhorn UI. When unspecified, Longhorn selects a free port between 30000 and 32767.
1099 type: int
1100 min: 30000
1101 max: 32767
1102 show_if: service.ui.type=NodePort||service.ui.type=LoadBalancer
1103 label: UI Service NodePort number
1104 - variable: longhorn.default_resource
1105 default: 'false'
1106 description: >-
1107 Customize the default resource before installing Longhorn for the first time. This option will only work if the cluster hasn't installed Longhorn.
1108 label: Customize Default Resources
1109 type: boolean
1110 show_subquestion_if: true
1111 group: Longhorn Default Resources
1112 subquestions:
1113 - variable: defaultBackupStore.backupTarget
1114 label: Backup Target
1115 description: >-
1116 Endpoint used to access the backupstore. (Options: "NFS", "CIFS", "AWS", "GCP", "AZURE")
1117 group: Longhorn Default Resources
1118 type: string
1119 default: null
1120 - variable: defaultBackupStore.backupTargetCredentialSecret
1121 label: Backup Target Credential Secret
1122 description: Name of the Kubernetes secret associated with the backup target.
1123 group: Longhorn Default Resources
1124 type: string
1125 default: null
1126 - variable: defaultBackupStore.backupstorePollInterval
1127 label: Backupstore Poll Interval
1128 description: >-
1129 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.
1130 group: Longhorn Default Resources
1131 type: int
1132 min: 0
1133 default: 300
1134 - variable: enablePSP
1135 default: 'false'
1136 description: >-
1137 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.
1138 label: Pod Security Policy
1139 type: boolean
1140 group: Other Settings
1141 subquestions: []
1142 - variable: global.cattle.windowsCluster.enabled
1143 default: 'false'
1144 description: Setting that allows Longhorn to run on a Rancher Windows cluster.
1145 label: Rancher Windows Cluster
1146 type: boolean
1147 group: Other Settings
1148 subquestions: []
1149 - variable: networkPolicies.enabled
1150 description: >-
1151 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.
1152 group: Other Settings
1153 label: Network Policies
1154 default: 'false'
1155 type: boolean
1156 subquestions:
1157 - variable: networkPolicies.type
1158 label: Network Policies for Ingress
1159 description: >-
1160 Distribution that determines the policy for allowing access for an ingress. (Options: "k3s", "rke2", "rke1")
1161 show_if: networkPolicies.enabled=true&&ingress.enabled=true
1162 type: enum
1163 default: rke2
1164 options:
1165 - rke1
1166 - rke2
1167 - k3s
1168 - variable: defaultSettings.dataEngineCPUMask
1169 label: Data Engine CPU Mask
1170 description: >-
1171 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.
1172 type: string
1173 default: '{"v2":"0x1"}'
1174 - variable: defaultSettings.replicaRebuildingBandwidthLimit
1175 label: Replica Rebuilding Bandwidth Limit
1176 description: >-
1177 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.
1178 type: string
1179 default: '{"v2":"0"}'
1180 - variable: defaultSettings.instanceManagerPodLivenessProbeTimeout
1181 label: Instance Manager Pod Liveness Probe Timeout
1182 description: >-
1183 In seconds. The setting specifies the timeout for the instance manager pod liveness probe. The default value is 10 seconds.
1184 type: int
1185 min: 1
1186 max: 60
1187 default: 10