blob: 800541c20c28cb8d5230756d6aa13ab9dc5cac5b [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.11.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.11.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.11.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.11.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.11.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.11.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.84
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.11.0-20260428
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-20260428
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.16.0-20260428
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: v2.1.0-20260428
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.5.0-20260428
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.18.0-20260428
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.podAntiAffinityPreset
234 type: string
235 label: Longhorn CSI Pod AntiAffinity Preset
236 group: Longhorn CSI Driver Settings
237 default: soft
238 description: >-
239 Configures Pod anti-affinity to prevent multiple instances on the same node. Use soft (tries to separate) or hard (must separate). When unspecified, Longhorn uses the default value ("soft").
240 - variable: csi.attacherReplicaCount
241 type: int
242 default: 3
243 min: 1
244 max: 10
245 description: >-
246 Replica count of the CSI Attacher. When unspecified, Longhorn uses the default value ("3").
247 label: Longhorn CSI Attacher replica count
248 group: Longhorn CSI Driver Settings
249 - variable: csi.provisionerReplicaCount
250 type: int
251 default: 3
252 min: 1
253 max: 10
254 description: >-
255 Replica count of the CSI Provisioner. When unspecified, Longhorn uses the default value ("3").
256 label: Longhorn CSI Provisioner replica count
257 group: Longhorn CSI Driver Settings
258 - variable: csi.resizerReplicaCount
259 type: int
260 default: 3
261 min: 1
262 max: 10
263 description: >-
264 Replica count of the CSI Resizer. When unspecified, Longhorn uses the default value ("3").
265 label: Longhorn CSI Resizer replica count
266 group: Longhorn CSI Driver Settings
267 - variable: csi.snapshotterReplicaCount
268 type: int
269 default: 3
270 min: 1
271 max: 10
272 description: >-
273 Replica count of the CSI Snapshotter. When unspecified, Longhorn uses the default value ("3").
274 label: Longhorn CSI Snapshotter replica count
275 group: Longhorn CSI Driver Settings
276 - variable: defaultSettings.allowRecurringJobWhileVolumeDetached
277 label: Allow Recurring Job While Volume Is Detached
278 description: >-
279 Setting that allows Longhorn to automatically attach a volume and create snapshots or backups when recurring jobs are run.
280 group: Longhorn Default Settings
281 type: boolean
282 default: 'false'
283 - variable: defaultSettings.snapshotMaxCount
284 label: Snapshot Maximum Count
285 description: >-
286 Maximum snapshot count for a volume. The value should be between 2 to 250.
287 group: Longhorn Default Settings
288 type: int
289 min: 2
290 max: 250
291 default: 250
292 - variable: defaultSettings.createDefaultDiskLabeledNodes
293 label: Create Default Disk on Labeled Nodes
294 description: >-
295 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.
296 group: Longhorn Default Settings
297 type: boolean
298 default: 'false'
299 - variable: defaultSettings.defaultDataPath
300 label: Default Data Path
301 description: >-
302 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/".
303 group: Longhorn Default Settings
304 type: string
305 default: /var/lib/longhorn/
306 - variable: defaultSettings.defaultDataLocality
307 label: Default Data Locality
308 description: >-
309 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.
310 group: Longhorn Default Settings
311 type: enum
312 options:
313 - disabled
314 - best-effort
315 default: disabled
316 - variable: defaultSettings.replicaSoftAntiAffinity
317 label: Replica Node Level Soft Anti-Affinity
318 description: >-
319 Allow scheduling on nodes with existing healthy replicas of the same volume. By default, false.
320 group: Longhorn Default Settings
321 type: boolean
322 default: 'false'
323 - variable: defaultSettings.replicaAutoBalance
324 label: Replica Auto Balance
325 description: >-
326 Enable this setting automatically re-balances replicas when discovered an available node.
327 group: Longhorn Default Settings
328 type: enum
329 options:
330 - disabled
331 - least-effort
332 - best-effort
333 default: disabled
334 - variable: defaultSettings.storageOverProvisioningPercentage
335 label: Storage Over Provisioning Percentage
336 description: >-
337 Percentage of storage that can be allocated relative to hard drive capacity. The default value is 100.
338 group: Longhorn Default Settings
339 type: int
340 min: 0
341 default: 100
342 - variable: defaultSettings.storageMinimalAvailablePercentage
343 label: Storage Minimal Available Percentage
344 description: >-
345 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.
346 group: Longhorn Default Settings
347 type: int
348 min: 0
349 max: 100
350 default: 25
351 - variable: defaultSettings.storageReservedPercentageForDefaultDisk
352 label: Storage Reserved Percentage For Default Disk
353 description: >-
354 The reserved percentage specifies the percentage of disk space that will not be allocated to the default disk on each new Longhorn node.
355 group: Longhorn Default Settings
356 type: int
357 min: 0
358 max: 100
359 default: 30
360 - variable: defaultSettings.upgradeChecker
361 label: Enable Upgrade Checker
362 description: >-
363 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.
364 group: Longhorn Default Settings
365 type: boolean
366 default: 'true'
367 - variable: defaultSettings.upgradeResponderURL
368 label: Upgrade Responder URL
369 description: >-
370 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".
371 group: Longhorn Default Settings
372 type: string
373 default: 'https://longhorn-upgrade-responder.rancher.io/v1/checkupgrade'
374 - variable: defaultSettings.managerUrl
375 label: Manager URL
376 description: >-
377 The external URL used to access the Longhorn Manager API. When set, this URL is returned in API responses (the actions and links fields) instead of the internal pod IP. This is useful when accessing the API through Ingress or Gateway API HTTPRoute. Format: scheme://host[:port] (for example, https://longhorn.example.com or https://longhorn.example.com:8443). Leave it empty to use the default behavior. Warning: Internal components (including longhorn-driver-deployer and longhorn-csi-plugin) follow the links returned in API responses. If this URL passes through proxy middleware (such as an OAuth2 proxy, ingress auth, or any other HTTP-intercepting layer), those components may receive an unexpected response (such as an HTML redirect) instead of JSON, causing errors such as "invalid character '<' looking for beginning of value" and CSI driver deployment failure.
378 group: Longhorn Default Settings
379 type: string
380 default: ''
381 - variable: defaultSettings.defaultReplicaCount
382 label: Default Replica Count
383 description: >-
384 Default number of replicas for volumes created using the Longhorn UI. For Kubernetes configuration, modify the `numberOfReplicas` field in the StorageClass.
385 group: Longhorn Default Settings
386 type: string
387 default: '{"v1":"3","v2":"3"}'
388 - variable: defaultSettings.defaultLonghornStaticStorageClass
389 label: Default Longhorn Static StorageClass Name
390 description: >-
391 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".
392 group: Longhorn Default Settings
393 type: string
394 default: longhorn-static
395 - variable: defaultSettings.failedBackupTTL
396 label: Failed Backup Time to Live
397 description: >-
398 Number of minutes that Longhorn keeps a failed backup resource. When the value is "0", automatic deletion is disabled.
399 group: Longhorn Default Settings
400 type: int
401 min: 0
402 default: 1440
403 - variable: defaultSettings.backupExecutionTimeout
404 label: Backup Execution Timeout
405 description: >-
406 Number of minutes that Longhorn allows for the backup execution. The default value is "1".
407 group: Longhorn Default Settings
408 type: int
409 min: 1
410 default: 1
411 - variable: defaultSettings.restoreVolumeRecurringJobs
412 label: Restore Volume Recurring Jobs
413 description: >-
414 Restore recurring jobs from the backup volume on the backup target and create recurring jobs if not exist during a backup restoration.
415 group: Longhorn Default Settings
416 type: boolean
417 default: 'false'
418 - variable: defaultSettings.recurringSuccessfulJobsHistoryLimit
419 label: Cronjob Successful Jobs History Limit
420 description: >-
421 This setting specifies how many successful backup or snapshot job histories should be retained. History will not be retained if the value is 0.
422 group: Longhorn Default Settings
423 type: int
424 min: 0
425 default: 1
426 - variable: defaultSettings.recurringFailedJobsHistoryLimit
427 label: Cronjob Failed Jobs History Limit
428 description: >-
429 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.
430 group: Longhorn Default Settings
431 type: int
432 min: 0
433 default: 1
434 - variable: defaultSettings.recurringJobMaxRetention
435 label: Maximum Retention Number for Recurring Job
436 description: Maximum number of snapshots or backups to be retained.
437 group: Longhorn Default Settings
438 type: int
439 default: 100
440 - variable: defaultSettings.supportBundleFailedHistoryLimit
441 label: SupportBundle Failed History Limit
442 description: >-
443 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.
444 group: Longhorn Default Settings
445 type: int
446 min: 0
447 default: 1
448 - variable: defaultSettings.autoSalvage
449 label: Automatic salvage
450 description: >-
451 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.
452 group: Longhorn Default Settings
453 type: boolean
454 default: 'true'
455 - variable: defaultSettings.autoDeletePodWhenVolumeDetachedUnexpectedly
456 label: >-
457 Automatically Delete Workload Pod when The Volume Is Detached Unexpectedly
458 description: >-
459 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.
460 group: Longhorn Default Settings
461 type: boolean
462 default: 'true'
463 - variable: defaultSettings.blacklistForAutoDeletePodWhenVolumeDetachedUnexpectedly
464 label: >-
465 Blacklist for Automatically Delete Workload Pod when The Volume Is Detached Unexpectedly
466 description: >-
467 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.
468 group: Longhorn Default Settings
469 type: string
470 default: null
471 - variable: defaultSettings.disableSchedulingOnCordonedNode
472 label: Disable Scheduling On Cordoned Node
473 description: >-
474 Setting that prevents Longhorn Manager from scheduling replicas on a cordoned Kubernetes node. This setting is enabled by default.
475 group: Longhorn Default Settings
476 type: boolean
477 default: 'true'
478 - variable: defaultSettings.replicaZoneSoftAntiAffinity
479 label: Replica Zone Level Soft Anti-Affinity
480 description: >-
481 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.
482 group: Longhorn Default Settings
483 type: boolean
484 default: 'true'
485 - variable: defaultSettings.replicaDiskSoftAntiAffinity
486 label: Replica Disk Level Soft Anti-Affinity
487 description: >-
488 Allow scheduling on disks with existing healthy replicas of the same volume. By default, true.
489 group: Longhorn Default Settings
490 type: boolean
491 default: 'true'
492 - variable: defaultSettings.allowEmptyNodeSelectorVolume
493 label: Allow Empty Node Selector Volume
494 description: >-
495 Setting that allows scheduling of empty node selector volumes to any node.
496 group: Longhorn Default Settings
497 type: boolean
498 default: 'true'
499 - variable: defaultSettings.allowEmptyDiskSelectorVolume
500 label: Allow Empty Disk Selector Volume
501 description: >-
502 Setting that allows scheduling of empty disk selector volumes to any disk.
503 group: Longhorn Default Settings
504 type: boolean
505 default: 'true'
506 - variable: defaultSettings.nodeDownPodDeletionPolicy
507 label: Pod Deletion Policy When Node is Down
508 description: >-
509 Policy that defines the action Longhorn takes when a volume is stuck with a StatefulSet or Deployment pod on a node that failed.
510 group: Longhorn Default Settings
511 type: enum
512 options:
513 - do-nothing
514 - delete-statefulset-pod
515 - delete-deployment-pod
516 - delete-both-statefulset-and-deployment-pod
517 default: do-nothing
518 - variable: defaultSettings.nodeDrainPolicy
519 label: Node Drain Policy
520 description: >-
521 Policy that defines the action Longhorn takes when a node with the last healthy replica of a volume is drained.
522 group: Longhorn Default Settings
523 type: enum
524 options:
525 - block-for-eviction
526 - block-for-eviction-if-contains-last-replica
527 - block-if-contains-last-replica
528 - allow-if-replica-is-stopped
529 - always-allow
530 default: block-if-contains-last-replica
531 - variable: defaultSettings.detachManuallyAttachedVolumesWhenCordoned
532 label: Detach Manually Attached Volumes When Cordoned
533 description: >-
534 Setting that allows automatic detaching of manually-attached volumes when a node is cordoned.
535 group: Longhorn Default Settings
536 type: boolean
537 default: 'false'
538 - variable: defaultSettings.priorityClass
539 label: Priority Class
540 description: >-
541 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.
542 group: Longhorn Default Settings
543 type: string
544 default: longhorn-critical
545 - variable: defaultSettings.replicaReplenishmentWaitInterval
546 label: Replica Replenishment Wait Interval
547 description: >-
548 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.
549 group: Longhorn Default Settings
550 type: int
551 min: 0
552 default: 600
553 - variable: defaultSettings.concurrentReplicaRebuildPerNodeLimit
554 label: Concurrent Replica Rebuild Per Node Limit
555 description: >-
556 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.
557 group: Longhorn Default Settings
558 type: int
559 min: 0
560 default: 5
561 - variable: defaultSettings.rebuildConcurrentSyncLimit
562 label: Rebuild Concurrent Sync Limit
563 description: >-
564 Maximum number of file synchronization operations that can run concurrently during a single replica rebuild. Right now, it's for v1 data engine only.
565 group: Longhorn Default Settings
566 type: int
567 min: 1
568 max: 5
569 default: 1
570 - variable: defaultSettings.concurrentVolumeBackupRestorePerNodeLimit
571 label: Concurrent Volume Backup Restore Per Node Limit
572 description: >-
573 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.
574 group: Longhorn Default Settings
575 type: int
576 min: 0
577 default: 5
578 - variable: defaultSettings.disableRevisionCounter
579 label: Disable Revision Counter
580 description: >-
581 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.
582 group: Longhorn Default Settings
583 type: string
584 default: '{"v1":"true"}'
585 - variable: defaultSettings.systemManagedPodsImagePullPolicy
586 label: System Managed Pod Image Pull Policy
587 description: >-
588 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.
589 group: Longhorn Default Settings
590 type: enum
591 options:
592 - if-not-present
593 - always
594 - never
595 default: if-not-present
596 - variable: defaultSettings.allowVolumeCreationWithDegradedAvailability
597 label: Allow Volume Creation with Degraded Availability
598 description: >-
599 Setting that allows you to create and attach a volume without having all replicas scheduled at the time of creation.
600 group: Longhorn Default Settings
601 type: boolean
602 default: 'true'
603 - variable: defaultSettings.autoCleanupSystemGeneratedSnapshot
604 label: Automatically Cleanup System Generated Snapshot
605 description: >-
606 Setting that allows Longhorn to automatically clean up the system-generated snapshot after replica rebuilding is completed.
607 group: Longhorn Default Settings
608 type: boolean
609 default: 'true'
610 - variable: defaultSettings.autoCleanupRecurringJobBackupSnapshot
611 label: Automatically Cleanup Recurring Job Backup Snapshot
612 description: >-
613 Setting that allows Longhorn to automatically clean up the snapshot generated by a recurring backup job.
614 group: Longhorn Default Settings
615 type: boolean
616 default: 'true'
617 - variable: defaultSettings.concurrentAutomaticEngineUpgradePerNodeLimit
618 label: Concurrent Automatic Engine Upgrade Per Node Limit
619 description: >-
620 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.
621 group: Longhorn Default Settings
622 type: int
623 min: 0
624 default: 0
625 - variable: defaultSettings.backingImageCleanupWaitInterval
626 label: Backing Image Cleanup Wait Interval
627 description: >-
628 Number of minutes that Longhorn waits before cleaning up the backing image file when no replicas in the disk are using it.
629 group: Longhorn Default Settings
630 type: int
631 min: 0
632 default: 60
633 - variable: defaultSettings.backingImageRecoveryWaitInterval
634 label: Backing Image Recovery Wait Interval
635 description: >-
636 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".
637 group: Longhorn Default Settings
638 type: int
639 min: 0
640 default: 300
641 - variable: defaultSettings.guaranteedInstanceManagerCPU
642 label: Guaranteed Instance Manager CPU
643 description: >-
644 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.**
645 group: Longhorn Default Settings
646 type: string
647 default: '{"v1":"12","v2":"12"}'
648 - variable: defaultSettings.logLevel
649 label: Log Level
650 description: >-
651 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")
652 group: Longhorn Default Settings
653 type: string
654 default: Info
655 - variable: defaultSettings.disableSnapshotPurge
656 label: Disable Snapshot Purge
657 description: >-
658 Setting that temporarily prevents all attempts to purge volume snapshots.
659 group: Longhorn Default Settings
660 type: boolean
661 default: 'false'
662 - variable: defaultSettings.freezeFilesystemForSnapshot
663 description: >-
664 Setting that freezes the filesystem on the root partition before a snapshot is created.
665 group: Longhorn Default Settings
666 type: string
667 default: '{"v1":"false"}'
668 - variable: defaultSettings.kubernetesClusterAutoscalerEnabled
669 label: Kubernetes Cluster Autoscaler Enabled (Experimental)
670 description: >-
671 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.
672 group: Longhorn Default Settings
673 type: boolean
674 default: false
675 - variable: defaultSettings.orphanResourceAutoDeletion
676 label: Orphaned Data Cleanup
677 description: >-
678 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`.
679 group: Longhorn Default Settings
680 type: string
681 default: null
682 - variable: defaultSettings.orphanResourceAutoDeletionGracePeriod
683 label: Orphaned Data Cleanup
684 description: >-
685 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.
686 group: Longhorn Default Settings
687 type: int
688 default: '300'
689 - variable: defaultSettings.storageNetwork
690 label: Storage Network
691 description: >-
692 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.
693 group: Longhorn Default Settings
694 type: string
695 default: null
696 - variable: defaultSettings.EndpointNetworkForRWXVolume
697 label: Endpoint Network For RWX Volume
698 description: >-
699 Specifies a dedicated network for mounting RWX (ReadWriteMany) volumes. Leave this blank to use the default Kubernetes cluster network. **Caution**: This setting should change after all RWX volumes are detached because some Longhorn component pods must be recreated to apply the setting. You cannot modify this setting while RWX volumes are still attached.
700 group: Longhorn Default Settings
701 type: string
702 default: null
703 - variable: defaultSettings.taintToleration
704 label: Taint Toleration
705 description: >-
706 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.
707 group: Longhorn Default Settings
708 type: string
709 default: null
710 - variable: defaultSettings.systemManagedComponentsNodeSelector
711 label: System Managed Components NodeSelector
712 description: >-
713 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.
714 group: Longhorn Default Settings
715 type: string
716 default: null
717 - variable: defaultSettings.systemManagedCSIComponentsResourceLimits
718 label: System Managed CSI Components Resource Limits
719 description: >-
720 Resource limits for system managed CSI components. This setting allows you to configure CPU and memory requests/limits for CSI attacher, provisioner, resizer, snapshotter, and plugin components. Supported components: csi-attacher, csi-provisioner, csi-resizer, csi-snapshotter, longhorn-csi-plugin, node-driver-registrar, longhorn-liveness-probe. Notice that changing resource limits will cause CSI components to restart, which may temporarily affect volume provisioning and attach/detach operations until the components are ready. The value should be a JSON object with component names as keys and ResourceRequirements as values.
721 group: Longhorn Default Settings
722 type: string
723 default: null
724 - variable: defaultSettings.deletingConfirmationFlag
725 label: Deleting Confirmation Flag
726 description: Flag that prevents accidental uninstallation of Longhorn.
727 group: Longhorn Default Settings
728 type: boolean
729 default: 'false'
730 - variable: defaultSettings.engineReplicaTimeout
731 label: Timeout between Engine and Replica
732 description: >-
733 Timeout between the Longhorn Engine and replicas. Specify a value between "8" and "30" seconds. The default value is "8".
734 group: Longhorn Default Settings
735 type: string
736 default: '{"v1":"8","v2":"8"}'
737 - variable: defaultSettings.snapshotDataIntegrity
738 label: Snapshot Data Integrity
739 description: >-
740 This setting allows users to enable or disable snapshot hashing and data integrity checking.
741 group: Longhorn Default Settings
742 type: enum
743 options:
744 - enabled
745 - fast-check
746 - disabled
747 default: disabled
748 - variable: >-
749 defaultSettings.snapshotDataIntegrityImmediateCheckAfterSnapshotCreation
750 label: Immediate Snapshot Data Integrity Check After Creating a Snapshot
751 description: >-
752 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.
753 group: Longhorn Default Settings
754 type: string
755 default: '{"v1":"false","v2":"false"}'
756 - variable: defaultSettings.snapshotDataIntegrityCronjob
757 label: Snapshot Data Integrity Check CronJob
758 description: >-
759 Unix-cron string format. The setting specifies when Longhorn checks the data integrity of snapshot disk files.
760 group: Longhorn Default Settings
761 type: string
762 default: '{"v1":"0 0 */7 * *","v2":"0 0 */7 * *"}'
763 - variable: defaultSettings.removeSnapshotsDuringFilesystemTrim
764 label: Remove Snapshots During Filesystem Trim
765 description: >-
766 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.
767 group: Longhorn Default Settings
768 type: boolean
769 default: 'false'
770 - variable: defaultSettings.fastReplicaRebuildEnabled
771 label: Fast Replica Rebuild Enabled
772 description: >-
773 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".
774 group: Longhorn Default Settings
775 type: string
776 default: '{"v1":"true","v2":"true"}'
777 - variable: defaultSettings.replicaFileSyncHttpClientTimeout
778 label: Timeout of HTTP Client to Replica File Sync Server
779 description: >-
780 In seconds. The setting specifies the HTTP client timeout to the file sync server.
781 group: Longhorn Default Settings
782 type: int
783 default: '30'
784 - variable: defaultSettings.longGRPCTimeOut
785 label: Long gRPC Timeout
786 description: >-
787 Number of seconds that Longhorn allows for the completion of replica rebuilding and snapshot cloning operations.
788 group: Longhorn Default Settings
789 type: int
790 default: '86400'
791 - variable: defaultSettings.backupCompressionMethod
792 label: Backup Compression Method
793 description: Setting that allows you to specify a backup compression method.
794 group: Longhorn Default Settings
795 type: string
796 default: lz4
797 - variable: defaultSettings.backupConcurrentLimit
798 label: Backup Concurrent Limit Per Backup
799 description: >-
800 Maximum number of worker threads that can concurrently run for each backup.
801 group: Longhorn Default Settings
802 type: int
803 min: 1
804 default: 2
805 - variable: defaultSettings.backupBlockSize
806 label: Backup Block Size
807 description: >-
808 Specifies the default backup block size, in MiB, used when creating a new volume. Supported values are 2 or 16.
809 group: Longhorn Default Settings
810 type: enum
811 options:
812 - '2'
813 - '16'
814 default: '2'
815 - variable: defaultSettings.restoreConcurrentLimit
816 label: Restore Concurrent Limit Per Backup
817 description: >-
818 This setting controls how many worker threads per restore concurrently.
819 group: Longhorn Default Settings
820 type: int
821 min: 1
822 default: 2
823 - variable: defaultSettings.allowCollectingLonghornUsageMetrics
824 label: Allow Collecting Longhorn Usage Metrics
825 description: >-
826 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.
827 group: Longhorn Default Settings
828 type: boolean
829 default: true
830 - variable: defaultSettings.v1DataEngine
831 label: V1 Data Engine
832 description: Setting that allows you to enable the V1 Data Engine.
833 group: Longhorn V1 Data Engine Settings
834 type: boolean
835 default: true
836 - variable: defaultSettings.v2DataEngine
837 label: V2 Data Engine
838 description: >-
839 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.
840 group: Longhorn V2 Data Engine (Experimental Feature) Settings
841 type: boolean
842 default: false
843 - variable: defaultSettings.dataEngineHugepageEnabled
844 label: V2 Data Engine
845 description: >-
846 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.
847 group: Longhorn V2 Data Engine (Experimental Feature) Settings
848 type: string
849 default: '{"v2":"true"}'
850 - variable: defaultSettings.dataEngineMemorySize
851 label: V2 Data Engine
852 description: >-
853 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.
854 group: Longhorn V2 Data Engine (Experimental Feature) Settings
855 type: string
856 default: '{"v2":"2048"}'
857 - variable: defaultSettings.dataEngineLogLevel
858 label: Data Engine Log Level
859 description: >-
860 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.
861 group: Longhorn V2 Data Engine (Experimental Feature) Settings
862 type: string
863 default: '{"v2":"Notice"}'
864 - variable: defaultSettings.dataEngineLogFlags
865 label: Data Engine Log Flags
866 description: >-
867 Applies only to the V2 Data Engine. Specifies the log flags for the Storage Performance Development Kit (SPDK) target daemon.
868 group: Longhorn V2 Data Engine (Experimental Feature) Settings
869 type: string
870 default: '{"v2":""}'
871 - variable: defaultSettings.autoCleanupSnapshotWhenDeleteBackup
872 label: Auto Cleanup Snapshot When Delete Backup
873 description: >-
874 Setting that automatically cleans up the snapshot when the backup is deleted.
875 group: Longhorn Default Settings
876 type: boolean
877 default: false
878 - variable: defaultSettings.autoCleanupSnapshotAfterOnDemandBackupCompleted
879 label: Auto Cleanup Snapshot After On-Demand Backup Completed
880 description: >-
881 Setting that automatically cleans up the snapshot after the on-demand backup is completed.
882 group: Longhorn Default Settings
883 type: boolean
884 default: false
885 - variable: defaultSettings.rwxVolumeFastFailover
886 label: RWX Volume Fast Failover (Experimental)
887 description: >-
888 Setting that allows Longhorn to detect node failure and immediately migrate affected RWX volumes.
889 group: Longhorn Default Settings
890 type: boolean
891 default: false
892 - variable: defaultSettings.offlineReplicaRebuilding
893 label: Offline Replica Rebuilding
894 description: >-
895 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`.
896 group: Longhorn Default Settings
897 type: string
898 default: '{"v1":"false","v2":"false"}'
899 - variable: defaultSettings.dataEngineCPUMask
900 label: Data Engine CPU Mask
901 description: >-
902 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.
903 group: Longhorn Default Settings
904 type: string
905 default: '{"v2":"0x1"}'
906 - variable: defaultSettings.replicaRebuildingBandwidthLimit
907 label: Replica Rebuilding Bandwidth Limit
908 description: >-
909 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.
910 group: Longhorn Default Settings
911 type: string
912 default: '{"v2":"0"}'
913 - variable: defaultSettings.instanceManagerPodLivenessProbeTimeout
914 label: Instance Manager Pod Liveness Probe Timeout
915 description: >-
916 In seconds. The setting specifies the timeout for the instance manager pod liveness probe. The default value is 10 seconds.
917 group: Longhorn Default Settings
918 type: int
919 min: 1
920 max: 60
921 default: 10
922 - variable: defaultSettings.snapshotHeavyTaskConcurrentLimit
923 label: Snapshot Heavy Task Concurrent Limit
924 description: >-
925 Setting that controls how many snapshot heavy task operations (such as purge and clone) can run concurrently per node. This is a best-effort mechanism: due to the distributed nature of the system, temporary oversubscription may occur. The limiter reduces worst-case overload but does not guarantee perfect enforcement.
926 group: Longhorn Default Settings
927 type: int
928 min: 0
929 default: 5
930 - variable: defaultSettings.nodeDiskHealthMonitoring
931 label: Node Disk Health Monitoring
932 description: >-
933 Controls whether Longhorn monitors and records health information for node disks. When disabled, disk health checks and status updates are skipped.
934 group: Longhorn Default Settings
935 type: boolean
936 default: true
937 - variable: defaultSettings.csiAllowedTopologyKeys
938 label: CSI Allowed Topology Keys
939 description: >-
940 Comma-separated list of topology keys that the Longhorn CSI driver is allowed to pass through. When empty (default), no topology keys are passed through, and PVs will have no nodeAffinity. When configured (e.g., "topology.kubernetes.io/zone,topology.kubernetes.io/region"), only the specified keys are kept in topology segments. All other keys are filtered out from both CreateVolumeResponse.AccessibleTopology and NodeGetInfo topology.
941 group: Longhorn Default Settings
942 type: string
943 default: null
944 - variable: defaultSettings.csiStorageCapacityTracking
945 label: CSI Storage Capacity Tracking
946 description: >-
947 Controls CSI storage capacity tracking, which allows the kube-scheduler to filter nodes that cannot fit the requested volume.
948 group: Longhorn Default Settings
949 type: boolean
950 default: false
951 - variable: persistence.defaultClass
952 default: 'true'
953 description: Setting that allows you to specify the default Longhorn StorageClass.
954 label: Default Storage Class
955 group: Longhorn Storage Class Settings
956 required: true
957 type: boolean
958 subquestions: []
959 - variable: persistence.reclaimPolicy
960 label: Storage Class Retain Policy
961 description: >-
962 Reclaim policy that provides instructions for handling of a volume after its claim is released. (Options: "Retain", "Delete")
963 group: Longhorn Storage Class Settings
964 required: true
965 type: enum
966 options:
967 - Delete
968 - Retain
969 default: Delete
970 subquestions: []
971 - variable: persistence.volumeBindingMode
972 label: Storage Class Volume Binding Mode
973 description: >-
974 VolumeBindingMode controls when volume binding and dynamic provisioning should occur. (Options: "Immediate", "WaitForFirstConsumer") (Defaults to "Immediate")
975 group: Longhorn Storage Class Settings
976 required: true
977 type: enum
978 options:
979 - Immediate
980 - WaitForFirstConsumer
981 default: Immediate
982 subquestions: []
983 - variable: persistence.defaultFsType
984 label: Storage Class Filesystem Type
985 description: Filesystem type of the default Longhorn StorageClass
986 group: Longhorn Storage Class Settings
987 type: enum
988 options:
989 - xfs
990 - ext4
991 default: ext4
992 subquestions: []
993 - variable: persistence.disableRevisionCounter
994 label: Default Storage Class Disable Revision Counter
995 description: >-
996 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")
997 group: Longhorn Storage Class Settings
998 required: true
999 type: enum
1000 options:
1001 - 'true'
1002 - 'false'
1003 default: 'true'
1004 subquestions: []
1005 - variable: persistence.defaultClassReplicaCount
1006 description: Replica count of the default Longhorn StorageClass.
1007 label: Default Storage Class Replica Count
1008 group: Longhorn Storage Class Settings
1009 type: int
1010 min: 1
1011 max: 10
1012 default: 3
1013 subquestions: []
1014 - variable: persistence.defaultDataLocality
1015 description: >-
1016 Data locality of the default Longhorn StorageClass. (Options: "disabled", "best-effort")
1017 label: Default Storage Class Data Locality
1018 group: Longhorn Storage Class Settings
1019 type: enum
1020 options:
1021 - disabled
1022 - best-effort
1023 default: disabled
1024 subquestions: []
1025 - variable: persistence.recurringJobSelector.enable
1026 description: >-
1027 Setting that allows you to enable the recurring job selector for a Longhorn StorageClass.
1028 group: Longhorn Storage Class Settings
1029 label: Enable Storage Class Recurring Job Selector
1030 type: boolean
1031 default: false
1032 show_subquestion_if: true
1033 subquestions:
1034 - variable: persistence.recurringJobSelector.jobList
1035 description: >-
1036 Recurring job selector for a Longhorn StorageClass. Ensure that quotes are used correctly when specifying job parameters. (Example: `[{"name":"backup", "isGroup":true}]`)
1037 label: Storage Class Recurring Job Selector List
1038 group: Longhorn Storage Class Settings
1039 type: string
1040 default: null
1041 - variable: persistence.defaultDiskSelector.enable
1042 description: >-
1043 Setting that allows you to enable the disk selector for the default Longhorn StorageClass.
1044 group: Longhorn Storage Class Settings
1045 label: Enable Storage Class Disk Selector
1046 type: boolean
1047 default: false
1048 show_subquestion_if: true
1049 subquestions:
1050 - variable: persistence.defaultDiskSelector.selector
1051 label: Storage Class Disk Selector
1052 description: >-
1053 Disk selector for the default Longhorn StorageClass. Longhorn uses only disks with the specified tags for storing volume data. (Examples: "nvme,sata")
1054 group: Longhorn Storage Class Settings
1055 type: string
1056 default: null
1057 - variable: persistence.defaultNodeSelector.enable
1058 description: >-
1059 Setting that allows you to enable the node selector for the default Longhorn StorageClass.
1060 group: Longhorn Storage Class Settings
1061 label: Enable Storage Class Node Selector
1062 type: boolean
1063 default: false
1064 show_subquestion_if: true
1065 subquestions:
1066 - variable: persistence.defaultNodeSelector.selector
1067 label: Storage Class Node Selector
1068 description: >-
1069 Node selector for the default Longhorn StorageClass. Longhorn uses only nodes with the specified tags for storing volume data. (Examples: "storage,fast")
1070 group: Longhorn Storage Class Settings
1071 type: string
1072 default: null
1073 - variable: persistence.backingImage.enable
1074 description: Setting that allows you to use a backing image in a Longhorn StorageClass.
1075 group: Longhorn Storage Class Settings
1076 label: Default Storage Class Backing Image
1077 type: boolean
1078 default: false
1079 show_subquestion_if: true
1080 subquestions:
1081 - variable: persistence.backingImage.name
1082 description: >-
1083 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.
1084 label: Storage Class Backing Image Name
1085 group: Longhorn Storage Class Settings
1086 type: string
1087 default: null
1088 - variable: persistence.backingImage.expectedChecksum
1089 description: >-
1090 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\".
1091 label: Storage Class Backing Image Expected SHA512 Checksum
1092 group: Longhorn Storage Class Settings
1093 type: string
1094 default: null
1095 - variable: persistence.backingImage.dataSourceType
1096 description: >-
1097 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.
1098 label: Storage Class Backing Image Data Source Type
1099 group: Longhorn Storage Class Settings
1100 type: enum
1101 options:
1102 - ''
1103 - download
1104 - upload
1105 - export-from-volume
1106 default: ''
1107 - variable: persistence.backingImage.dataSourceParameters
1108 description: >-
1109 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.
1110 label: Storage Class Backing Image Data Source Parameters
1111 group: Longhorn Storage Class Settings
1112 type: string
1113 default: null
1114 - variable: persistence.unmapMarkSnapChainRemoved
1115 description: >-
1116 Setting that allows you to enable automatic snapshot removal during filesystem trim for a Longhorn StorageClass. (Options: "ignored", "enabled", "disabled")
1117 label: Default Storage Class Remove Snapshots During Filesystem Trim
1118 group: Longhorn Storage Class Settings
1119 type: enum
1120 options:
1121 - ignored
1122 - enabled
1123 - disabled
1124 default: ignored
1125 subquestions: []
1126 - variable: persistence.dataEngine
1127 description: >-
1128 Setting that allows you to specify the data engine version for the default Longhorn StorageClass. (Options: "v1", "v2")
1129 label: Default Storage Class Data Engine
1130 group: Longhorn Storage Class Settings
1131 type: enum
1132 options:
1133 - v1
1134 - v2
1135 default: v1
1136 subquestions: []
1137 - variable: persistence.backupTargetName
1138 description: >-
1139 Setting that allows you to specify the backup target for the default Longhorn StorageClass
1140 label: Default Storage Class Backup Target Name
1141 group: Longhorn Storage Class Settings
1142 type: string
1143 default: default
1144 subquestions: []
1145 - variable: ingress.enabled
1146 default: 'false'
1147 description: Expose app using Layer 7 Load Balancer - ingress
1148 type: boolean
1149 group: Services and Load Balancing
1150 label: Expose app using Layer 7 Load Balancer
1151 show_subquestion_if: true
1152 subquestions:
1153 - variable: ingress.host
1154 default: xip.io
1155 description: Hostname of the Layer 7 load balancer.
1156 type: hostname
1157 required: true
1158 label: Layer 7 Load Balancer Hostname
1159 - variable: ingress.path
1160 default: /
1161 description: >-
1162 Default ingress path. You can access the Longhorn UI by following the full ingress path {{host}}+{{path}}.
1163 type: string
1164 required: true
1165 label: Ingress Path
1166 - variable: ingress.pathType
1167 default: ImplementationSpecific
1168 description: >-
1169 Path type for the ingress. (Options: "ImplementationSpecific", "Exact", "Prefix")
1170 type: enum
1171 options:
1172 - ImplementationSpecific
1173 - Exact
1174 - Prefix
1175 required: true
1176 label: Ingress Path Type
1177 - variable: httproute.enabled
1178 default: 'false'
1179 description: Expose app using Gateway API HTTPRoute
1180 type: boolean
1181 group: Services and Load Balancing
1182 label: Expose app using Gateway API HTTPRoute
1183 show_subquestion_if: true
1184 subquestions:
1185 - variable: httproute.parentRefs
1186 default: '[]'
1187 description: >-
1188 Gateway references as JSON array. Required fields: name, namespace. Optional: group (default: gateway.networking.k8s.io), kind (default: Gateway), sectionName. Example: [{"name":"my-gateway","namespace":"default","sectionName":"https"}]
1189 type: string
1190 required: true
1191 label: Gateway References (JSON array)
1192 - variable: httproute.hostnames
1193 default: '[]'
1194 description: >-
1195 Hostnames for HTTPRoute as JSON array (e.g., ["longhorn.example.com"])
1196 type: string
1197 required: true
1198 label: Hostnames (JSON array)
1199 - variable: httproute.path
1200 default: /
1201 description: >-
1202 Default path for HTTPRoute. You can access the Longhorn UI by following the full path.
1203 type: string
1204 required: true
1205 label: HTTPRoute Path
1206 - variable: httproute.pathType
1207 default: PathPrefix
1208 description: >-
1209 Path match type for HTTPRoute. (Options: "Exact", "PathPrefix")
1210 type: enum
1211 options:
1212 - Exact
1213 - PathPrefix
1214 required: true
1215 label: HTTPRoute Path Type
1216 - variable: service.ui.type
1217 default: Rancher-Proxy
1218 description: >-
1219 Service type for Longhorn UI. (Options: "ClusterIP", "NodePort", "LoadBalancer", "Rancher-Proxy")
1220 type: enum
1221 options:
1222 - ClusterIP
1223 - NodePort
1224 - LoadBalancer
1225 - Rancher-Proxy
1226 label: Longhorn UI Service
1227 show_if: ingress.enabled=false
1228 group: Services and Load Balancing
1229 show_subquestion_if: NodePort
1230 subquestions:
1231 - variable: service.ui.nodePort
1232 default: ''
1233 description: >-
1234 NodePort port number for Longhorn UI. When unspecified, Longhorn selects a free port between 30000 and 32767.
1235 type: int
1236 min: 30000
1237 max: 32767
1238 show_if: service.ui.type=NodePort||service.ui.type=LoadBalancer
1239 label: UI Service NodePort number
1240 - variable: longhorn.default_resource
1241 default: 'false'
1242 description: >-
1243 Customize the default resource before installing Longhorn for the first time. This option will only work if the cluster hasn't installed Longhorn.
1244 label: Customize Default Resources
1245 type: boolean
1246 show_subquestion_if: true
1247 group: Longhorn Default Resources
1248 subquestions:
1249 - variable: defaultBackupStore.backupTarget
1250 label: Backup Target
1251 description: >-
1252 Endpoint used to access the backupstore. (Options: "NFS", "CIFS", "AWS", "GCP", "AZURE")
1253 group: Longhorn Default Resources
1254 type: string
1255 default: null
1256 - variable: defaultBackupStore.backupTargetCredentialSecret
1257 label: Backup Target Credential Secret
1258 description: Name of the Kubernetes secret associated with the backup target.
1259 group: Longhorn Default Resources
1260 type: string
1261 default: null
1262 - variable: defaultBackupStore.backupstorePollInterval
1263 label: Backupstore Poll Interval
1264 description: >-
1265 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.
1266 group: Longhorn Default Resources
1267 type: int
1268 min: 0
1269 default: 300
1270 - variable: enablePSP
1271 default: 'false'
1272 description: >-
1273 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.
1274 label: Pod Security Policy
1275 type: boolean
1276 group: Other Settings
1277 subquestions: []
1278 - variable: global.cattle.windowsCluster.enabled
1279 default: 'false'
1280 description: Setting that allows Longhorn to run on a Rancher Windows cluster.
1281 label: Rancher Windows Cluster
1282 type: boolean
1283 group: Other Settings
1284 subquestions: []
1285 - variable: networkPolicies.enabled
1286 description: >-
1287 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.
1288 group: Other Settings
1289 label: Network Policies
1290 default: 'false'
1291 type: boolean
1292 subquestions:
1293 - variable: networkPolicies.type
1294 label: Network Policies for Ingress
1295 description: >-
1296 Distribution that determines the policy for allowing access for an ingress. (Options: "k3s", "rke2", "rke1")
1297 show_if: networkPolicies.enabled=true&&ingress.enabled=true
1298 type: enum
1299 default: rke2
1300 options:
1301 - rke1
1302 - rke2
1303 - k3s