-
-
Notifications
You must be signed in to change notification settings - Fork 165
/
config.go
1291 lines (1138 loc) · 45.4 KB
/
config.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package instance
import (
"errors"
"fmt"
"strconv"
"strings"
"time"
"github.com/lxc/incus/shared/api"
"github.com/lxc/incus/shared/units"
"github.com/lxc/incus/shared/validate"
)
// IsUserConfig returns true if the config key is a user configuration.
func IsUserConfig(key string) bool {
return strings.HasPrefix(key, "user.")
}
// ConfigVolatilePrefix indicates the prefix used for volatile config keys.
const ConfigVolatilePrefix = "volatile."
// HugePageSizeKeys is a list of known hugepage size configuration keys.
var HugePageSizeKeys = [...]string{"limits.hugepages.64KB", "limits.hugepages.1MB", "limits.hugepages.2MB", "limits.hugepages.1GB"}
// HugePageSizeSuffix contains the list of known hugepage size suffixes.
var HugePageSizeSuffix = [...]string{"64KB", "1MB", "2MB", "1GB"}
// InstanceConfigKeysAny is a map of config key to validator. (keys applying to containers AND virtual machines).
var InstanceConfigKeysAny = map[string]func(value string) error{
// gendoc:generate(entity=instance, group=boot, key=boot.autostart)
// If set to `false`, restore the last state.
// ---
// type: bool
// liveupdate: no
// shortdesc: Whether to always start the instance when the daemon starts
"boot.autostart": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=boot, key=boot.autostart.delay)
// The number of seconds to wait after the instance started before starting the next one.
// ---
// type: integer
// defaultdesc: 0
// liveupdate: no
// shortdesc: Delay after starting the instance
"boot.autostart.delay": validate.Optional(validate.IsInt64),
// gendoc:generate(entity=instance, group=boot, key=boot.autostart.priority)
// The instance with the highest value is started first.
// ---
// type: integer
// defaultdesc: 0
// liveupdate: no
// shortdesc: What order to start the instances in
"boot.autostart.priority": validate.Optional(validate.IsInt64),
// gendoc:generate(entity=instance, group=boot, key=boot.stop.priority)
// The instance with the highest value is shut down first.
// ---
// type: integer
// defaultdesc: 0
// liveupdate: no
// shortdesc: What order to shut down the instances in
"boot.stop.priority": validate.Optional(validate.IsInt64),
// gendoc:generate(entity=instance, group=boot, key=boot.host_shutdown_action)
// Action to take on host shut down
// ---
// type: integer
// defaultdesc: stop
// liveupdate: yes
// shortdesc: What action to take on the instance when the host is shut down
"boot.host_shutdown_action": validate.Optional(validate.IsOneOf("stop", "force-stop", "stateful-stop")),
// gendoc:generate(entity=instance, group=boot, key=boot.host_shutdown_timeout)
// Number of seconds to wait for the instance to shut down before it is force-stopped.
// ---
// type: integer
// defaultdesc: 30
// liveupdate: yes
// shortdesc: How long to wait for the instance to shut down
"boot.host_shutdown_timeout": validate.Optional(validate.IsInt64),
// gendoc:generate(entity=instance, group=cloud-init, key=cloud-init.network-config)
// The content is used as seed value for `cloud-init`.
// ---
// type: string
// defaultdesc: `DHCP on eth0`
// liveupdate: no
// condition: If supported by image
// shortdesc: Network configuration for `cloud-init`
"cloud-init.network-config": validate.Optional(validate.IsYAML),
// gendoc:generate(entity=instance, group=cloud-init, key=cloud-init.user-data)
// The content is used as seed value for `cloud-init`.
// ---
// type: string
// defaultdesc: `#cloud-config`
// liveupdate: no
// condition: If supported by image
// shortdesc: User data for `cloud-init`
"cloud-init.user-data": validate.Optional(validate.IsCloudInitUserData),
// gendoc:generate(entity=instance, group=cloud-init, key=cloud-init.vendor-data)
// The content is used as seed value for `cloud-init`.
// ---
// type: string
// defaultdesc: `#cloud-config`
// liveupdate: no
// condition: If supported by image
// shortdesc: Vendor data for `cloud-init`
"cloud-init.vendor-data": validate.Optional(validate.IsCloudInitUserData),
// gendoc:generate(entity=instance, group=cloud-init, key=user.network-config)
//
// ---
// type: string
// defaultdesc: `DHCP on eth0`
// liveupdate: no
// condition: If supported by image
// shortdesc: Legacy version of `cloud-init.network-config`
// gendoc:generate(entity=instance, group=cloud-init, key=user.user-data)
//
// ---
// type: string
// defaultdesc: `#cloud-config`
// liveupdate: no
// condition: If supported by image
// shortdesc: Legacy version of `cloud-init.user-data`
// gendoc:generate(entity=instance, group=cloud-init, key=user.vendor-data)
//
// ---
// type: string
// defaultdesc: `#cloud-config`
// liveupdate: no
// condition: If supported by image
// shortdesc: Legacy version of `cloud-init.vendor-data`
// gendoc:generate(entity=instance, group=miscellaneous, key=cluster.evacuate)
// The `cluster.evacuate` provides control over how instances are handled when a cluster member is being
// evacuated.
//
// Available Modes:
// - `auto` *(default)*: The system will automatically decide the best evacuation method based on the
// instance's type and configured devices:
// + If any device is not suitable for migration, the instance will not be migrated (only stopped).
// + Live migration will be used only for virtual machines with the `migration.stateful` setting
// enabled and for which all its devices can be migrated as well.
// - `live-migrate`: Instances are live-migrated to another server. This means the instance remains running
// and operational during the migration process, ensuring minimal disruption.
// - `migrate`: In this mode, instances are migrated to another server in the cluster. The migration
// process will not be live, meaning there will be a brief downtime for the instance during the
// migration.
// - `stop`: Instances are not migrated. Instead, they are stopped on the current server.
// - `stateful-stop`: Instances are not migrated. Instead, they are stopped on the current server
// but with their runtime state (memory) stored on disk for resuming on restore.
// - `force-stop`: Instances are not migrated. Instead, they are forcefully stopped.
//
// See {ref}`cluster-evacuate` for more information.
// ---
// type: string
// defaultdesc: `auto`
// liveupdate: no
// shortdesc: What to do when evacuating the instance
"cluster.evacuate": validate.Optional(validate.IsOneOf("auto", "migrate", "live-migrate", "stop", "stateful-stop", "force-stop")),
// gendoc:generate(entity=instance, group=resource-limits, key=limits.cpu)
// A number or a specific range of CPUs to expose to the instance.
//
// See {ref}`instance-options-limits-cpu` for more information.
// ---
// type: string
// defaultdesc: 1 (VMs)
// liveupdate: yes
// shortdesc: Which CPUs to expose to the instance
"limits.cpu": validate.Optional(validate.IsValidCPUSet),
// gendoc:generate(entity=instance, group=resource-limits, key=limits.cpu.nodes)
// A comma-separated list of NUMA node IDs or ranges to place the instance CPUs on.
// Alternatively, the value `balanced` may be used to have Incus pick the least busy NUMA node on startup.
//
// See {ref}`instance-options-limits-cpu-container` for more information.
// ---
// type: string
// liveupdate: yes
// shortdesc: Which NUMA nodes to place the instance CPUs on
"limits.cpu.nodes": validate.Optional(validate.Or(validate.IsValidCPUSet, validate.IsOneOf("balanced"))),
// gendoc:generate(entity=instance, group=resource-limits, key=limits.disk.priority)
// Controls how much priority to give to the instance's I/O requests when under load.
//
// Specify an integer between 0 and 10.
// ---
// type: integer
// defaultdesc: `5` (medium)
// liveupdate: yes
// shortdesc: Priority of the instance's I/O requests
"limits.disk.priority": validate.Optional(validate.IsPriority),
// gendoc:generate(entity=instance, group=resource-limits, key=limits.memory)
// Percentage of the host's memory or a fixed value in bytes.
// Various suffixes are supported.
//
// See {ref}`instances-limit-units` for details.
// ---
// type: string
// defaultdesc: `1Gib` (VMs)
// liveupdate: yes
// shortdesc: Usage limit for the host's memory
"limits.memory": func(value string) error {
if value == "" {
return nil
}
if strings.HasSuffix(value, "%") {
num, err := strconv.ParseInt(strings.TrimSuffix(value, "%"), 10, 64)
if err != nil {
return err
}
if num == 0 {
return errors.New("Memory limit can't be 0%")
}
return nil
}
num, err := units.ParseByteSizeString(value)
if err != nil {
return err
}
if num == 0 {
return fmt.Errorf("Memory limit can't be 0")
}
return nil
},
// Caller is responsible for full validation of any raw.* value.
// gendoc:generate(entity=instance, group=raw, key=raw.apparmor)
// The specified entries are appended to the generated profile.
// ---
// type: blob
// liveupdate: yes
// shortdesc: AppArmor profile entries
"raw.apparmor": validate.IsAny,
// gendoc:generate(entity=instance, group=raw, key=raw.idmap)
// For example: `both 1000 1000`
// ---
// type: blob
// liveupdate: no
// condition: unprivileged container
// shortdesc: Raw idmap configuration
"raw.idmap": validate.IsAny,
// gendoc:generate(entity=instance, group=security, key=security.guestapi)
// See {ref}`dev-incus` for more information.
// ---
// type: bool
// defaultdesc: `true`
// liveupdate: no
// shortdesc: Whether `/dev/incus` is present in the instance
"security.guestapi": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.protection.delete)
//
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: yes
// shortdesc: Prevents the instance from being deleted
"security.protection.delete": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=snapshots, key=snapshots.schedule)
// Specify either a cron expression (`<minute> <hour> <dom> <month> <dow>`), a comma-separated list of schedule aliases (`@hourly`, `@daily`, `@midnight`, `@weekly`, `@monthly`, `@annually`, `@yearly`), or leave empty to disable automatic snapshots.
//
// ---
// type: string
// defaultdesc: empty
// liveupdate: no
// shortdesc: Schedule for automatic instance snapshots
"snapshots.schedule": validate.Optional(validate.IsCron([]string{"@hourly", "@daily", "@midnight", "@weekly", "@monthly", "@annually", "@yearly", "@startup", "@never"})),
// gendoc:generate(entity=instance, group=snapshots, key=snapshots.schedule.stopped)
//
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// shortdesc: Whether to automatically snapshot stopped instances
"snapshots.schedule.stopped": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=snapshots, key=snapshots.pattern)
// Specify a Pongo2 template string that represents the snapshot name.
// This template is used for scheduled snapshots and for unnamed snapshots.
//
// See {ref}`instance-options-snapshots-names` for more information.
// ---
// type: string
// defaultdesc: `snap%d`
// liveupdate: no
// shortdesc: Template for the snapshot name
"snapshots.pattern": validate.IsAny,
// gendoc:generate(entity=instance, group=snapshots, key=snapshots.expiry)
// Specify an expression like `1M 2H 3d 4w 5m 6y`.
// ---
// type: string
// liveupdate: no
// shortdesc: When snapshots are to be deleted
"snapshots.expiry": func(value string) error {
// Validate expression
_, err := GetExpiry(time.Time{}, value)
return err
},
// Volatile keys.
// gendoc:generate(entity=instance, group=volatile, key=volatile.apply_template)
// The template with the given name is triggered upon next startup.
// ---
// type: string
// shortdesc: Template hook
"volatile.apply_template": validate.IsAny,
// gendoc:generate(entity=instance, group=volatile, key=volatile.base_image)
// The hash of the image that the instance was created from (empty if the instance was not created from an image).
// ---
// type: string
// shortdesc: Hash of the base image
"volatile.base_image": validate.IsAny,
// gendoc:generate(entity=instance, group=volatile, key=volatile.cloud_init.instance-id)
//
// ---
// type: string
// shortdesc: `instance-id` (UUID) exposed to `cloud-init`
"volatile.cloud-init.instance-id": validate.Optional(validate.IsUUID),
// gendoc:generate(entity=instance, group=volatile, key=volatile.cpu.nodes)
// The NUMA node that was selected for the instance.
// ---
// type: string
// shortdesc: Instance NUMA node
"volatile.cpu.nodes": validate.Optional(validate.IsValidCPUSet),
// gendoc:generate(entity=instance, group=volatile, key=volatile.evacuate.origin)
// The cluster member that the instance lived on before evacuation.
// ---
// type: string
// shortdesc: The origin of the evacuated instance
"volatile.evacuate.origin": validate.IsAny,
// gendoc:generate(entity=instance, group=volatile, key=volatile.last_state.power)
//
// ---
// type: string
// shortdesc: Instance state as of last host shutdown
"volatile.last_state.power": validate.IsAny,
// gendoc:generate(entity=instance, group=volatile, key=volatile.last_state.ready)
//
// ---
// type: string
// shortdesc: Instance marked itself as ready
"volatile.last_state.ready": validate.IsBool,
// gendoc:generate(entity=instance, group=volatile, key=volatile.uuid)
// The instance UUID is globally unique across all servers and projects.
// ---
// type: string
// shortdesc: Instance UUID
"volatile.uuid": validate.Optional(validate.IsUUID),
// gendoc:generate(entity=instance, group=volatile, key=volatile.uuid.generation)
// The instance generation UUID changes whenever the instance's place in time moves backwards.
// It is globally unique across all servers and projects.
// ---
// type: string
// shortdesc: Instance generation UUID
"volatile.uuid.generation": validate.Optional(validate.IsUUID),
}
// InstanceConfigKeysContainer is a map of config key to validator. (keys applying to containers only).
var InstanceConfigKeysContainer = map[string]func(value string) error{
// gendoc:generate(entity=instance, group=resource-limits, key=limits.cpu.allowance)
// To control how much of the CPU can be used, specify either a percentage (`50%`) for a soft limit
// or a chunk of time (`25ms/100ms`) for a hard limit.
//
// See {ref}`instance-options-limits-cpu-container` for more information.
// ---
// type: string
// defaultdesc: 100%
// liveupdate: yes
// condition: container
// shortdesc: How much of the CPU can be used
"limits.cpu.allowance": func(value string) error {
if value == "" {
return nil
}
if strings.HasSuffix(value, "%") {
// Percentage based allocation
_, err := strconv.Atoi(strings.TrimSuffix(value, "%"))
if err != nil {
return err
}
return nil
}
// Time based allocation
fields := strings.SplitN(value, "/", 2)
if len(fields) != 2 {
return fmt.Errorf("Invalid allowance: %s", value)
}
_, err := strconv.Atoi(strings.TrimSuffix(fields[0], "ms"))
if err != nil {
return err
}
_, err = strconv.Atoi(strings.TrimSuffix(fields[1], "ms"))
if err != nil {
return err
}
return nil
},
// gendoc:generate(entity=instance, group=resource-limits, key=limits.cpu.priority)
// When overcommitting resources, specify the CPU scheduling priority compared to other instances that share the same CPUs.
// Specify an integer between 0 and 10.
//
// See {ref}`instance-options-limits-cpu-container` for more information.
// ---
// type: integer
// defaultdesc: `10` (maximum)
// liveupdate: yes
// condition: container
// shortdesc: CPU scheduling priority compared to other instances
"limits.cpu.priority": validate.Optional(validate.IsPriority),
// gendoc:generate(entity=instance, group=resource-limits, key=limits.hugepages.64KB)
// Fixed value (in bytes) to limit the number of 64 KB huge pages.
// Various suffixes are supported (see {ref}`instances-limit-units`).
//
// See {ref}`instance-options-limits-hugepages` for more information.
// ---
// type: string
// liveupdate: yes
// condition: container
// shortdesc: Limit for the number of 64 KB huge pages
"limits.hugepages.64KB": validate.Optional(validate.IsSize),
// gendoc:generate(entity=instance, group=resource-limits, key=limits.hugepages.1MB)
// Fixed value (in bytes) to limit the number of 1 MB huge pages.
// Various suffixes are supported (see {ref}`instances-limit-units`).
//
// See {ref}`instance-options-limits-hugepages` for more information.
// ---
// type: string
// liveupdate: yes
// condition: container
// shortdesc: Limit for the number of 1 MB huge pages
"limits.hugepages.1MB": validate.Optional(validate.IsSize),
// gendoc:generate(entity=instance, group=resource-limits, key=limits.hugepages.2MB)
// Fixed value (in bytes) to limit the number of 2 MB huge pages.
// Various suffixes are supported (see {ref}`instances-limit-units`).
//
// See {ref}`instance-options-limits-hugepages` for more information.
// ---
// type: string
// liveupdate: yes
// condition: container
// shortdesc: Limit for the number of 2 MB huge pages
"limits.hugepages.2MB": validate.Optional(validate.IsSize),
// gendoc:generate(entity=instance, group=resource-limits, key=limits.hugepages.1GB)
// Fixed value (in bytes) to limit the number of 1 GB huge pages.
// Various suffixes are supported (see {ref}`instances-limit-units`).
//
// See {ref}`instance-options-limits-hugepages` for more information.
// ---
// type: string
// liveupdate: yes
// condition: container
// shortdesc: Limit for the number of 1 GB huge pages
"limits.hugepages.1GB": validate.Optional(validate.IsSize),
// gendoc:generate(entity=instance, group=resource-limits, key=limits.memory.enforce)
// If the instance's memory limit is `hard`, the instance cannot exceed its limit.
// If it is `soft`, the instance can exceed its memory limit when extra host memory is available.
// ---
// type: string
// defaultdesc: `hard`
// liveupdate: yes
// condition: container
// shortdesc: Whether the memory limit is `hard` or `soft`
"limits.memory.enforce": validate.Optional(validate.IsOneOf("soft", "hard")),
// gendoc:generate(entity=instance, group=resource-limits, key=limits.memory.swap)
//
// ---
// type: bool
// defaultdesc: `true`
// liveupdate: yes
// condition: container
// shortdesc: Whether to encourage/discourage swapping less used pages for this instance
"limits.memory.swap": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=resource-limits, key=limits.memory.swap.priority)
// Specify an integer between 0 and 10.
// The higher the value, the less likely the instance is to be swapped to disk.
// ---
// type: integer
// defaultdesc: `10` (maximum)
// liveupdate: yes
// condition: container
// shortdesc: Prevents the instance from being swapped to disk
"limits.memory.swap.priority": validate.Optional(validate.IsPriority),
// gendoc:generate(entity=instance, group=resource-limits, key=limits.processes)
// If left empty, no limit is set.
// ---
// type: integer
// defaultdesc: empty
// liveupdate: yes
// condition: container
// shortdesc: Maximum number of processes that can run in the instance
"limits.processes": validate.Optional(validate.IsInt64),
// gendoc:generate(entity=instance, group=miscellaneous, key=linux.kernel_modules)
// Specify the kernel modules as a comma-separated list.
// ---
// type: string
// liveupdate: yes
// condition: container
// shortdesc: Kernel modules to load before starting the instance
"linux.kernel_modules": validate.IsAny,
// gendoc:generate(entity=instance, group=migration, key=migration.incremental.memory)
// Using incremental memory transfer of the instance's memory can reduce downtime.
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: yes
// condition: container
// shortdesc: Whether to use incremental memory transfer
"migration.incremental.memory": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=migration, key=migration.incremental.memory.iterations)
//
// ---
// type: integer
// defaultdesc: `10`
// liveupdate: yes
// condition: container
// shortdesc: Maximum number of transfer operations to go through before stopping the instance
"migration.incremental.memory.iterations": validate.Optional(validate.IsUint32),
// gendoc:generate(entity=instance, group=migration, key=migration.incremental.memory.goal)
//
// ---
// type: integer
// defaultdesc: `70`
// liveupdate: yes
// condition: container
// shortdesc: Percentage of memory to have in sync before stopping the instance
"migration.incremental.memory.goal": validate.Optional(validate.IsUint32),
// gendoc:generate(entity=instance, group=nvidia, key=nvidia.runtime)
//
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: container
// shortdesc: Whether to pass the host NVIDIA and CUDA runtime libraries into the instance
"nvidia.runtime": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=nvidia, key=nvidia.driver.capabilities)
// The specified driver capabilities are used to set `libnvidia-container NVIDIA_DRIVER_CAPABILITIES`.
// ---
// type: string
// defaultdesc: `compute,utility`
// liveupdate: no
// condition: container
// shortdesc: What driver capabilities the instance needs
"nvidia.driver.capabilities": validate.IsAny,
// gendoc:generate(entity=instance, group=nvidia, key=nvidia.require.cuda)
// The specified version expression is used to set `libnvidia-container NVIDIA_REQUIRE_CUDA`.
// ---
// type: string
// liveupdate: no
// condition: container
// shortdesc: Required CUDA version
"nvidia.require.cuda": validate.IsAny,
// gendoc:generate(entity=instance, group=nvidia, key=nvidia.require.driver)
// The specified version expression is used to set `libnvidia-container NVIDIA_REQUIRE_DRIVER`.
// ---
// type: string
// liveupdate: no
// condition: container
// shortdesc: Required driver version
"nvidia.require.driver": validate.IsAny,
// Caller is responsible for full validation of any raw.* value.
// gendoc:generate(entity=instance, group=raw, key=raw.lxc)
//
// ---
// type: blob
// liveupdate: no
// condition: container
// shortdesc: Raw LXC configuration to be appended to the generated one
"raw.lxc": validate.IsAny,
// gendoc:generate(entity=instance, group=raw, key=raw.seccomp)
//
// ---
// type: blob
// liveupdate: no
// condition: container
// shortdesc: Raw Seccomp configuration
"raw.seccomp": validate.IsAny,
// gendoc:generate(entity=instance, group=security, key=security.guestapi.images)
//
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: container
// shortdesc: Controls the availability of the `/1.0/images` API over `guestapi`
"security.guestapi.images": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.idmap.base)
// Setting this option overrides auto-detection.
// ---
// type: integer
// liveupdate: no
// condition: unprivileged container
// shortdesc: The base host ID to use for the allocation
"security.idmap.base": validate.Optional(validate.IsUint32),
// gendoc:generate(entity=instance, group=security, key=security.idmap.isolated)
// If specified, the idmap used for this instance is unique among instances that have this option set.
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: unprivileged container
// shortdesc: Whether to use a unique idmap for this instance
"security.idmap.isolated": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.idmap.size)
//
// ---
// type: integer
// liveupdate: no
// condition: unprivileged container
// shortdesc: The size of the idmap to use
"security.idmap.size": validate.Optional(validate.IsUint32),
// gendoc:generate(entity=instance, group=security, key=security.nesting)
//
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: yes
// condition: container
// shortdesc: Whether to support running Incus (nested) inside the instance
"security.nesting": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.privileged)
//
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: container
// shortdesc: Whether to run the instance in privileged mode
"security.privileged": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.protection.shift)
// Set this option to `true` to prevent the instance's file system from being UID/GID shifted on startup.
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: yes
// condition: container
// shortdesc: Whether to protect the file system from being UID/GID shifted
"security.protection.shift": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.syscalls.allow)
// A `\n`-separated list of syscalls to allow.
// This list must be mutually exclusive with `security.syscalls.deny*`.
// ---
// type: string
// liveupdate: no
// condition: container
// shortdesc: List of syscalls to allow
"security.syscalls.allow": validate.IsAny,
// Legacy configuration keys (old names).
"security.syscalls.blacklist_default": validate.Optional(validate.IsBool),
"security.syscalls.blacklist_compat": validate.Optional(validate.IsBool),
"security.syscalls.blacklist": validate.IsAny,
// gendoc:generate(entity=instance, group=security, key=security.syscalls.deny_default)
//
// ---
// type: bool
// defaultdesc: `true`
// liveupdate: no
// condition: container
// shortdesc: Whether to enable the default syscall deny
"security.syscalls.deny_default": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.syscalls.deny_compat)
// On `x86_64`, this option controls whether to block `compat_*` syscalls.
// On other architectures, the option is ignored.
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: container
// shortdesc: Whether to block `compat_*` syscalls (`x86_64` only)
"security.syscalls.deny_compat": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.syscalls.deny)
// A `\n`-separated list of syscalls to deny.
// This list must be mutually exclusive with `security.syscalls.allow`.
// ---
// type: string
// liveupdate: no
// condition: container
// shortdesc: List of syscalls to deny
"security.syscalls.deny": validate.IsAny,
// gendoc:generate(entity=instance, group=security, key=security.syscalls.intercept.bpf)
//
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: container
// shortdesc: Whether to handle the `bpf()` system call
"security.syscalls.intercept.bpf": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.syscalls.intercept.bpf.devices)
// This option controls whether to allow BPF programs for the devices cgroup in the unified hierarchy to be loaded.
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: container
// shortdesc: Whether to allow BPF programs
"security.syscalls.intercept.bpf.devices": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.syscalls.intercept.mknod)
// These system calls allow creation of a limited subset of char/block devices.
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: container
// shortdesc: Whether to handle the `mknod` and `mknodat` system calls
"security.syscalls.intercept.mknod": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.syscalls.intercept.mount)
//
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: container
// shortdesc: Whether to handle the `mount` system call
"security.syscalls.intercept.mount": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.syscalls.intercept.mount.allowed)
// Specify a comma-separated list of file systems that are safe to mount for processes inside the instance.
// ---
// type: string
// liveupdate: yes
// condition: container
// shortdesc: File systems that can be mounted
"security.syscalls.intercept.mount.allowed": validate.IsAny,
// gendoc:generate(entity=instance, group=security, key=security.syscalls.intercept.mount.fuse)
// Specify the mounts of a given file system that should be redirected to their FUSE implementation (for example, `ext4=fuse2fs`).
// ---
// type: string
// liveupdate: yes
// condition: container
// shortdesc: File system that should be redirected to FUSE implementation
"security.syscalls.intercept.mount.fuse": validate.IsAny,
// gendoc:generate(entity=instance, group=security, key=security.syscalls.intercept.mount.shift)
//
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: yes
// condition: container
// shortdesc: Whether to use idmapped mounts for syscall interception
"security.syscalls.intercept.mount.shift": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.syscalls.intercept.sched_setcheduler)
// This system call allows increasing process priority.
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: container
// shortdesc: Whether to handle the `sched_setscheduler` system call
"security.syscalls.intercept.sched_setscheduler": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.syscalls.intercept.setxattr)
// This system call allows setting a limited subset of restricted extended attributes.
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: container
// shortdesc: Whether to handle the `setxattr` system call
"security.syscalls.intercept.setxattr": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.syscalls.intercept.sysinfo)
// This system call can be used to get cgroup-based resource usage information.
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: container
// shortdesc: Whether to handle the `sysinfo` system call
"security.syscalls.intercept.sysinfo": validate.Optional(validate.IsBool),
"security.syscalls.whitelist": validate.IsAny,
// gendoc:generate(entity=instance, group=volatile, key=volatile.last_state.idmap)
//
// ---
// type: string
// shortdesc: Serialized instance UID/GID map
"volatile.last_state.idmap": validate.IsAny,
// gendoc:generate(entity=instance, group=volatile, key=volatile.idmap.base)
//
// ---
// type: integer
// shortdesc: The first ID in the instance's primary idmap range
"volatile.idmap.base": validate.IsAny,
// gendoc:generate(entity=instance, group=volatile, key=volatile.idmap.current)
//
// ---
// type: string
// shortdesc: The idmap currently in use by the instance
"volatile.idmap.current": validate.IsAny,
// gendoc:generate(entity=instance, group=volatile, key=volatile.idmap.next)
//
// ---
// type: string
// shortdesc: The idmap to use the next time the instance starts
"volatile.idmap.next": validate.IsAny,
}
// InstanceConfigKeysVM is a map of config key to validator. (keys applying to VM only).
var InstanceConfigKeysVM = map[string]func(value string) error{
// gendoc:generate(entity=instance, group=resource-limits, key=limits.memory.hugepages)
// If this option is set to `false`, regular system memory is used.
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: virtual machine
// shortdesc: Whether to back the instance using huge pages
"limits.memory.hugepages": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=migration, key=migration.stateful)
// Enabling this option prevents the use of some features that are incompatible with it.
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: virtual machine
// shortdesc: Whether to allow for stateful stop/start and snapshots
"migration.stateful": validate.Optional(validate.IsBool),
// Caller is responsible for full validation of any raw.* value.
// gendoc:generate(entity=instance, group=raw, key=raw.qemu)
//
// ---
// type: blob
// liveupdate: no
// condition: virtual machine
// shortdesc: Raw QEMU configuration to be appended to the generated command line
"raw.qemu": validate.IsAny,
// gendoc:generate(entity=instance, group=raw, key=raw.qemu.conf)
// See {ref}`instance-options-qemu` for more information.
// ---
// type: blob
// liveupdate: no
// condition: virtual machine
// shortdesc: Addition/override to the generated `qemu.conf` file
"raw.qemu.conf": validate.IsAny,
// gendoc:generate(entity=instance, group=security, key=security.agent.metrics)
//
// ---
// type: bool
// defaultdesc: `true`
// liveupdate: no
// condition: virtual machine
// shortdesc: Whether the `incus-agent` is queried for state information and metrics
"security.agent.metrics": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.csm)
// When enabling this option, set {config:option}`instance-security:security.secureboot` to `false`.
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: virtual machine
// shortdesc: Whether to use a firmware that supports UEFI-incompatible operating systems
"security.csm": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.secureboot)
// When disabling this option, consider enabling {config:option}`instance-security:security.csm`.
// ---
// type: bool
// defaultdesc: `true`
// liveupdate: no
// condition: virtual machine
// shortdesc: Whether UEFI secure boot is enabled with the default Microsoft keys
"security.secureboot": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.sev)
//
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: virtual machine
// shortdesc: Whether AMD SEV (Secure Encrypted Virtualization) is enabled for this VM
"security.sev": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.sev.policy.es)
//
// ---
// type: bool
// defaultdesc: `false`
// liveupdate: no
// condition: virtual machine
// shortdesc: Whether AMD SEV-ES (SEV Encrypted State) is enabled for this VM
"security.sev.policy.es": validate.Optional(validate.IsBool),
// gendoc:generate(entity=instance, group=security, key=security.sev.session.dh)
//
// ---
// type: string
// defaultdesc: `true`
// liveupdate: no
// condition: virtual machine
// shortdesc: The guest owner's `base64`-encoded Diffie-Hellman key
"security.sev.session.dh": validate.Optional(validate.IsAny),
// gendoc:generate(entity=instance, group=security, key=security.sev.session.data)
//
// ---
// type: string
// defaultdesc: `true`
// liveupdate: no
// condition: virtual machine
// shortdesc: The guest owner's `base64`-encoded session blob
"security.sev.session.data": validate.Optional(validate.IsAny),
// gendoc:generate(entity=instance, group=miscellaneous, key=user.*)
// User keys can be used in search.
// ---
// type: string
// liveupdate: no
// shortdesc: Free-form user key/value storage
// gendoc:generate(entity=instance, group=miscellaneous, key=agent.nic_config)
// For containers, the name and MTU of the default network interfaces is used for the instance devices.
// For virtual machines, set this option to `true` to set the name and MTU of the default network interfaces to be the same as the instance devices.