-
Notifications
You must be signed in to change notification settings - Fork 458
/
v1alpha1_types_doc.go
3030 lines (2715 loc) · 157 KB
/
v1alpha1_types_doc.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
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
// Code generated by hack/docgen tool. DO NOT EDIT.
package v1alpha1
import (
"github.com/siderolabs/go-pointer"
"github.com/talos-systems/talos/pkg/machinery/config/encoder"
"github.com/talos-systems/talos/pkg/machinery/constants"
)
var (
ConfigDoc encoder.Doc
MachineConfigDoc encoder.Doc
MachineSeccompProfileDoc encoder.Doc
ClusterConfigDoc encoder.Doc
ExtraMountDoc encoder.Doc
MachineControlPlaneConfigDoc encoder.Doc
MachineControllerManagerConfigDoc encoder.Doc
MachineSchedulerConfigDoc encoder.Doc
KubeletConfigDoc encoder.Doc
KubeletNodeIPConfigDoc encoder.Doc
NetworkConfigDoc encoder.Doc
InstallConfigDoc encoder.Doc
InstallDiskSelectorDoc encoder.Doc
InstallExtensionConfigDoc encoder.Doc
TimeConfigDoc encoder.Doc
RegistriesConfigDoc encoder.Doc
PodCheckpointerDoc encoder.Doc
CoreDNSDoc encoder.Doc
EndpointDoc encoder.Doc
ControlPlaneConfigDoc encoder.Doc
APIServerConfigDoc encoder.Doc
AdmissionPluginConfigDoc encoder.Doc
ControllerManagerConfigDoc encoder.Doc
ProxyConfigDoc encoder.Doc
SchedulerConfigDoc encoder.Doc
EtcdConfigDoc encoder.Doc
ClusterNetworkConfigDoc encoder.Doc
CNIConfigDoc encoder.Doc
ExternalCloudProviderConfigDoc encoder.Doc
AdminKubeconfigConfigDoc encoder.Doc
MachineDiskDoc encoder.Doc
DiskPartitionDoc encoder.Doc
EncryptionConfigDoc encoder.Doc
EncryptionKeyDoc encoder.Doc
EncryptionKeyStaticDoc encoder.Doc
EncryptionKeyNodeIDDoc encoder.Doc
MachineFileDoc encoder.Doc
ExtraHostDoc encoder.Doc
DeviceDoc encoder.Doc
DHCPOptionsDoc encoder.Doc
DeviceWireguardConfigDoc encoder.Doc
DeviceWireguardPeerDoc encoder.Doc
DeviceVIPConfigDoc encoder.Doc
VIPEquinixMetalConfigDoc encoder.Doc
VIPHCloudConfigDoc encoder.Doc
BondDoc encoder.Doc
STPDoc encoder.Doc
BridgeDoc encoder.Doc
VlanDoc encoder.Doc
RouteDoc encoder.Doc
RegistryMirrorConfigDoc encoder.Doc
RegistryConfigDoc encoder.Doc
RegistryAuthConfigDoc encoder.Doc
RegistryTLSConfigDoc encoder.Doc
SystemDiskEncryptionConfigDoc encoder.Doc
FeaturesConfigDoc encoder.Doc
KubernetesTalosAPIAccessConfigDoc encoder.Doc
VolumeMountConfigDoc encoder.Doc
ClusterInlineManifestDoc encoder.Doc
NetworkKubeSpanDoc encoder.Doc
NetworkDeviceSelectorDoc encoder.Doc
ClusterDiscoveryConfigDoc encoder.Doc
DiscoveryRegistriesConfigDoc encoder.Doc
RegistryKubernetesConfigDoc encoder.Doc
RegistryServiceConfigDoc encoder.Doc
UdevConfigDoc encoder.Doc
LoggingConfigDoc encoder.Doc
LoggingDestinationDoc encoder.Doc
KernelConfigDoc encoder.Doc
KernelModuleConfigDoc encoder.Doc
)
func init() {
ConfigDoc.Type = "Config"
ConfigDoc.Comments[encoder.LineComment] = "Config defines the v1alpha1 configuration file."
ConfigDoc.Description = "Config defines the v1alpha1 configuration file."
ConfigDoc.AddExample("", configExample)
ConfigDoc.Fields = make([]encoder.Doc, 5)
ConfigDoc.Fields[0].Name = "version"
ConfigDoc.Fields[0].Type = "string"
ConfigDoc.Fields[0].Note = ""
ConfigDoc.Fields[0].Description = "Indicates the schema used to decode the contents."
ConfigDoc.Fields[0].Comments[encoder.LineComment] = "Indicates the schema used to decode the contents."
ConfigDoc.Fields[0].Values = []string{
"v1alpha1",
}
ConfigDoc.Fields[1].Name = "debug"
ConfigDoc.Fields[1].Type = "bool"
ConfigDoc.Fields[1].Note = ""
ConfigDoc.Fields[1].Description = "Enable verbose logging to the console.\nAll system containers logs will flow into serial console.\n\n**Note:** To avoid breaking Talos bootstrap flow enable this option only if serial console can handle high message throughput."
ConfigDoc.Fields[1].Comments[encoder.LineComment] = "Enable verbose logging to the console."
ConfigDoc.Fields[1].Values = []string{
"true",
"yes",
"false",
"no",
}
ConfigDoc.Fields[2].Name = "persist"
ConfigDoc.Fields[2].Type = "bool"
ConfigDoc.Fields[2].Note = ""
ConfigDoc.Fields[2].Description = "Indicates whether to pull the machine config upon every boot."
ConfigDoc.Fields[2].Comments[encoder.LineComment] = "Indicates whether to pull the machine config upon every boot."
ConfigDoc.Fields[2].Values = []string{
"true",
"yes",
"false",
"no",
}
ConfigDoc.Fields[3].Name = "machine"
ConfigDoc.Fields[3].Type = "MachineConfig"
ConfigDoc.Fields[3].Note = ""
ConfigDoc.Fields[3].Description = "Provides machine specific configuration options."
ConfigDoc.Fields[3].Comments[encoder.LineComment] = "Provides machine specific configuration options."
ConfigDoc.Fields[4].Name = "cluster"
ConfigDoc.Fields[4].Type = "ClusterConfig"
ConfigDoc.Fields[4].Note = ""
ConfigDoc.Fields[4].Description = "Provides cluster specific configuration options."
ConfigDoc.Fields[4].Comments[encoder.LineComment] = "Provides cluster specific configuration options."
MachineConfigDoc.Type = "MachineConfig"
MachineConfigDoc.Comments[encoder.LineComment] = "MachineConfig represents the machine-specific config values."
MachineConfigDoc.Description = "MachineConfig represents the machine-specific config values."
MachineConfigDoc.AddExample("", machineConfigExample)
MachineConfigDoc.AppearsIn = []encoder.Appearance{
{
TypeName: "Config",
FieldName: "machine",
},
}
MachineConfigDoc.Fields = make([]encoder.Doc, 22)
MachineConfigDoc.Fields[0].Name = "type"
MachineConfigDoc.Fields[0].Type = "string"
MachineConfigDoc.Fields[0].Note = ""
MachineConfigDoc.Fields[0].Description = "Defines the role of the machine within the cluster.\n\n**Control Plane**\n\nControl Plane node type designates the node as a control plane member.\nThis means it will host etcd along with the Kubernetes controlplane components such as API Server, Controller Manager, Scheduler.\n\n**Worker**\n\nWorker node type designates the node as a worker node.\nThis means it will be an available compute node for scheduling workloads.\n\nThis node type was previously known as \"join\"; that value is still supported but deprecated."
MachineConfigDoc.Fields[0].Comments[encoder.LineComment] = "Defines the role of the machine within the cluster."
MachineConfigDoc.Fields[0].Values = []string{
"controlplane",
"worker",
}
MachineConfigDoc.Fields[1].Name = "token"
MachineConfigDoc.Fields[1].Type = "string"
MachineConfigDoc.Fields[1].Note = "Warning: It is important to ensure that this token is correct since a machine's certificate has a short TTL by default.\n"
MachineConfigDoc.Fields[1].Description = "The `token` is used by a machine to join the PKI of the cluster.\nUsing this token, a machine will create a certificate signing request (CSR), and request a certificate that will be used as its' identity."
MachineConfigDoc.Fields[1].Comments[encoder.LineComment] = "The `token` is used by a machine to join the PKI of the cluster."
MachineConfigDoc.Fields[1].AddExample("example token", "328hom.uqjzh6jnn2eie9oi")
MachineConfigDoc.Fields[2].Name = "ca"
MachineConfigDoc.Fields[2].Type = "PEMEncodedCertificateAndKey"
MachineConfigDoc.Fields[2].Note = ""
MachineConfigDoc.Fields[2].Description = "The root certificate authority of the PKI.\nIt is composed of a base64 encoded `crt` and `key`."
MachineConfigDoc.Fields[2].Comments[encoder.LineComment] = "The root certificate authority of the PKI."
MachineConfigDoc.Fields[2].AddExample("machine CA example", pemEncodedCertificateExample)
MachineConfigDoc.Fields[3].Name = "certSANs"
MachineConfigDoc.Fields[3].Type = "[]string"
MachineConfigDoc.Fields[3].Note = ""
MachineConfigDoc.Fields[3].Description = "Extra certificate subject alternative names for the machine's certificate.\nBy default, all non-loopback interface IPs are automatically added to the certificate's SANs."
MachineConfigDoc.Fields[3].Comments[encoder.LineComment] = "Extra certificate subject alternative names for the machine's certificate."
MachineConfigDoc.Fields[3].AddExample("Uncomment this to enable SANs.", []string{"10.0.0.10", "172.16.0.10", "192.168.0.10"})
MachineConfigDoc.Fields[4].Name = "controlPlane"
MachineConfigDoc.Fields[4].Type = "MachineControlPlaneConfig"
MachineConfigDoc.Fields[4].Note = ""
MachineConfigDoc.Fields[4].Description = "Provides machine specific control plane configuration options."
MachineConfigDoc.Fields[4].Comments[encoder.LineComment] = "Provides machine specific control plane configuration options."
MachineConfigDoc.Fields[4].AddExample("ControlPlane definition example.", machineControlplaneExample)
MachineConfigDoc.Fields[5].Name = "kubelet"
MachineConfigDoc.Fields[5].Type = "KubeletConfig"
MachineConfigDoc.Fields[5].Note = ""
MachineConfigDoc.Fields[5].Description = "Used to provide additional options to the kubelet."
MachineConfigDoc.Fields[5].Comments[encoder.LineComment] = "Used to provide additional options to the kubelet."
MachineConfigDoc.Fields[5].AddExample("Kubelet definition example.", machineKubeletExample)
MachineConfigDoc.Fields[6].Name = "pods"
MachineConfigDoc.Fields[6].Type = "[]Unstructured"
MachineConfigDoc.Fields[6].Note = ""
MachineConfigDoc.Fields[6].Description = "Used to provide static pod definitions to be run by the kubelet directly bypassing the kube-apiserver.\n\nStatic pods can be used to run components which should be started before the Kubernetes control plane is up.\nTalos doesn't validate the pod definition.\nUpdates to this field can be applied without a reboot.\n\nSee https://kubernetes.io/docs/tasks/configure-pod-container/static-pod/."
MachineConfigDoc.Fields[6].Comments[encoder.LineComment] = "Used to provide static pod definitions to be run by the kubelet directly bypassing the kube-apiserver."
MachineConfigDoc.Fields[6].AddExample("nginx static pod.", machinePodsExample)
MachineConfigDoc.Fields[7].Name = "network"
MachineConfigDoc.Fields[7].Type = "NetworkConfig"
MachineConfigDoc.Fields[7].Note = ""
MachineConfigDoc.Fields[7].Description = "Provides machine specific network configuration options."
MachineConfigDoc.Fields[7].Comments[encoder.LineComment] = "Provides machine specific network configuration options."
MachineConfigDoc.Fields[7].AddExample("Network definition example.", machineNetworkConfigExample)
MachineConfigDoc.Fields[8].Name = "disks"
MachineConfigDoc.Fields[8].Type = "[]MachineDisk"
MachineConfigDoc.Fields[8].Note = "Note: `size` is in units of bytes.\n"
MachineConfigDoc.Fields[8].Description = "Used to partition, format and mount additional disks.\nSince the rootfs is read only with the exception of `/var`, mounts are only valid if they are under `/var`.\nNote that the partitioning and formating is done only once, if and only if no existing partitions are found.\nIf `size:` is omitted, the partition is sized to occupy the full disk."
MachineConfigDoc.Fields[8].Comments[encoder.LineComment] = "Used to partition, format and mount additional disks."
MachineConfigDoc.Fields[8].AddExample("MachineDisks list example.", machineDisksExample)
MachineConfigDoc.Fields[9].Name = "install"
MachineConfigDoc.Fields[9].Type = "InstallConfig"
MachineConfigDoc.Fields[9].Note = ""
MachineConfigDoc.Fields[9].Description = "Used to provide instructions for installations."
MachineConfigDoc.Fields[9].Comments[encoder.LineComment] = "Used to provide instructions for installations."
MachineConfigDoc.Fields[9].AddExample("MachineInstall config usage example.", machineInstallExample)
MachineConfigDoc.Fields[10].Name = "files"
MachineConfigDoc.Fields[10].Type = "[]MachineFile"
MachineConfigDoc.Fields[10].Note = "Note: The specified `path` is relative to `/var`.\n"
MachineConfigDoc.Fields[10].Description = "Allows the addition of user specified files.\nThe value of `op` can be `create`, `overwrite`, or `append`.\nIn the case of `create`, `path` must not exist.\nIn the case of `overwrite`, and `append`, `path` must be a valid file.\nIf an `op` value of `append` is used, the existing file will be appended.\nNote that the file contents are not required to be base64 encoded."
MachineConfigDoc.Fields[10].Comments[encoder.LineComment] = "Allows the addition of user specified files."
MachineConfigDoc.Fields[10].AddExample("MachineFiles usage example.", machineFilesExample)
MachineConfigDoc.Fields[11].Name = "env"
MachineConfigDoc.Fields[11].Type = "Env"
MachineConfigDoc.Fields[11].Note = ""
MachineConfigDoc.Fields[11].Description = "The `env` field allows for the addition of environment variables.\nAll environment variables are set on PID 1 in addition to every service."
MachineConfigDoc.Fields[11].Comments[encoder.LineComment] = "The `env` field allows for the addition of environment variables."
MachineConfigDoc.Fields[11].AddExample("Environment variables definition examples.", machineEnvExamples[0])
MachineConfigDoc.Fields[11].AddExample("", machineEnvExamples[1])
MachineConfigDoc.Fields[11].AddExample("", machineEnvExamples[2])
MachineConfigDoc.Fields[11].Values = []string{
"`GRPC_GO_LOG_VERBOSITY_LEVEL`",
"`GRPC_GO_LOG_SEVERITY_LEVEL`",
"`http_proxy`",
"`https_proxy`",
"`no_proxy`",
}
MachineConfigDoc.Fields[12].Name = "time"
MachineConfigDoc.Fields[12].Type = "TimeConfig"
MachineConfigDoc.Fields[12].Note = ""
MachineConfigDoc.Fields[12].Description = "Used to configure the machine's time settings."
MachineConfigDoc.Fields[12].Comments[encoder.LineComment] = "Used to configure the machine's time settings."
MachineConfigDoc.Fields[12].AddExample("Example configuration for cloudflare ntp server.", machineTimeExample)
MachineConfigDoc.Fields[13].Name = "sysctls"
MachineConfigDoc.Fields[13].Type = "map[string]string"
MachineConfigDoc.Fields[13].Note = ""
MachineConfigDoc.Fields[13].Description = "Used to configure the machine's sysctls."
MachineConfigDoc.Fields[13].Comments[encoder.LineComment] = "Used to configure the machine's sysctls."
MachineConfigDoc.Fields[13].AddExample("MachineSysctls usage example.", machineSysctlsExample)
MachineConfigDoc.Fields[14].Name = "sysfs"
MachineConfigDoc.Fields[14].Type = "map[string]string"
MachineConfigDoc.Fields[14].Note = ""
MachineConfigDoc.Fields[14].Description = "Used to configure the machine's sysfs."
MachineConfigDoc.Fields[14].Comments[encoder.LineComment] = "Used to configure the machine's sysfs."
MachineConfigDoc.Fields[14].AddExample("MachineSysfs usage example.", machineSysfsExample)
MachineConfigDoc.Fields[15].Name = "registries"
MachineConfigDoc.Fields[15].Type = "RegistriesConfig"
MachineConfigDoc.Fields[15].Note = ""
MachineConfigDoc.Fields[15].Description = "Used to configure the machine's container image registry mirrors.\n\nAutomatically generates matching CRI configuration for registry mirrors.\n\nThe `mirrors` section allows to redirect requests for images to non-default registry,\nwhich might be local registry or caching mirror.\n\nThe `config` section provides a way to authenticate to the registry with TLS client\nidentity, provide registry CA, or authentication information.\nAuthentication information has same meaning with the corresponding field in `.docker/config.json`.\n\nSee also matching configuration for [CRI containerd plugin](https://github.com/containerd/cri/blob/master/docs/registry.md)."
MachineConfigDoc.Fields[15].Comments[encoder.LineComment] = "Used to configure the machine's container image registry mirrors."
MachineConfigDoc.Fields[15].AddExample("", machineConfigRegistriesExample)
MachineConfigDoc.Fields[16].Name = "systemDiskEncryption"
MachineConfigDoc.Fields[16].Type = "SystemDiskEncryptionConfig"
MachineConfigDoc.Fields[16].Note = ""
MachineConfigDoc.Fields[16].Description = "Machine system disk encryption configuration.\nDefines each system partition encryption parameters."
MachineConfigDoc.Fields[16].Comments[encoder.LineComment] = "Machine system disk encryption configuration."
MachineConfigDoc.Fields[16].AddExample("", machineSystemDiskEncryptionExample)
MachineConfigDoc.Fields[17].Name = "features"
MachineConfigDoc.Fields[17].Type = "FeaturesConfig"
MachineConfigDoc.Fields[17].Note = ""
MachineConfigDoc.Fields[17].Description = "Features describe individual Talos features that can be switched on or off."
MachineConfigDoc.Fields[17].Comments[encoder.LineComment] = "Features describe individual Talos features that can be switched on or off."
MachineConfigDoc.Fields[17].AddExample("", machineFeaturesExample)
MachineConfigDoc.Fields[18].Name = "udev"
MachineConfigDoc.Fields[18].Type = "UdevConfig"
MachineConfigDoc.Fields[18].Note = ""
MachineConfigDoc.Fields[18].Description = "Configures the udev system."
MachineConfigDoc.Fields[18].Comments[encoder.LineComment] = "Configures the udev system."
MachineConfigDoc.Fields[18].AddExample("", machineUdevExample)
MachineConfigDoc.Fields[19].Name = "logging"
MachineConfigDoc.Fields[19].Type = "LoggingConfig"
MachineConfigDoc.Fields[19].Note = ""
MachineConfigDoc.Fields[19].Description = "Configures the logging system."
MachineConfigDoc.Fields[19].Comments[encoder.LineComment] = "Configures the logging system."
MachineConfigDoc.Fields[19].AddExample("", machineLoggingExample)
MachineConfigDoc.Fields[20].Name = "kernel"
MachineConfigDoc.Fields[20].Type = "KernelConfig"
MachineConfigDoc.Fields[20].Note = ""
MachineConfigDoc.Fields[20].Description = "Configures the kernel."
MachineConfigDoc.Fields[20].Comments[encoder.LineComment] = "Configures the kernel."
MachineConfigDoc.Fields[20].AddExample("", machineKernelExample)
MachineConfigDoc.Fields[21].Name = "seccompProfiles"
MachineConfigDoc.Fields[21].Type = "[]MachineSeccompProfile"
MachineConfigDoc.Fields[21].Note = ""
MachineConfigDoc.Fields[21].Description = "Configures the seccomp profiles for the machine."
MachineConfigDoc.Fields[21].Comments[encoder.LineComment] = "Configures the seccomp profiles for the machine."
MachineConfigDoc.Fields[21].AddExample("", machineSeccompExample)
MachineSeccompProfileDoc.Type = "MachineSeccompProfile"
MachineSeccompProfileDoc.Comments[encoder.LineComment] = "MachineSeccompProfile defines seccomp profiles for the machine."
MachineSeccompProfileDoc.Description = "MachineSeccompProfile defines seccomp profiles for the machine."
MachineSeccompProfileDoc.AddExample("", machineSeccompExample)
MachineSeccompProfileDoc.AppearsIn = []encoder.Appearance{
{
TypeName: "MachineConfig",
FieldName: "seccompProfiles",
},
}
MachineSeccompProfileDoc.Fields = make([]encoder.Doc, 2)
MachineSeccompProfileDoc.Fields[0].Name = "name"
MachineSeccompProfileDoc.Fields[0].Type = "string"
MachineSeccompProfileDoc.Fields[0].Note = ""
MachineSeccompProfileDoc.Fields[0].Description = "The `name` field is used to provide the file name of the seccomp profile."
MachineSeccompProfileDoc.Fields[0].Comments[encoder.LineComment] = "The `name` field is used to provide the file name of the seccomp profile."
MachineSeccompProfileDoc.Fields[1].Name = "value"
MachineSeccompProfileDoc.Fields[1].Type = "Unstructured"
MachineSeccompProfileDoc.Fields[1].Note = ""
MachineSeccompProfileDoc.Fields[1].Description = "The `value` field is used to provide the seccomp profile."
MachineSeccompProfileDoc.Fields[1].Comments[encoder.LineComment] = "The `value` field is used to provide the seccomp profile."
ClusterConfigDoc.Type = "ClusterConfig"
ClusterConfigDoc.Comments[encoder.LineComment] = "ClusterConfig represents the cluster-wide config values."
ClusterConfigDoc.Description = "ClusterConfig represents the cluster-wide config values."
ClusterConfigDoc.AddExample("", clusterConfigExample)
ClusterConfigDoc.AppearsIn = []encoder.Appearance{
{
TypeName: "Config",
FieldName: "cluster",
},
}
ClusterConfigDoc.Fields = make([]encoder.Doc, 24)
ClusterConfigDoc.Fields[0].Name = "id"
ClusterConfigDoc.Fields[0].Type = "string"
ClusterConfigDoc.Fields[0].Note = ""
ClusterConfigDoc.Fields[0].Description = "Globally unique identifier for this cluster (base64 encoded random 32 bytes)."
ClusterConfigDoc.Fields[0].Comments[encoder.LineComment] = "Globally unique identifier for this cluster (base64 encoded random 32 bytes)."
ClusterConfigDoc.Fields[1].Name = "secret"
ClusterConfigDoc.Fields[1].Type = "string"
ClusterConfigDoc.Fields[1].Note = ""
ClusterConfigDoc.Fields[1].Description = "Shared secret of cluster (base64 encoded random 32 bytes).\nThis secret is shared among cluster members but should never be sent over the network."
ClusterConfigDoc.Fields[1].Comments[encoder.LineComment] = "Shared secret of cluster (base64 encoded random 32 bytes)."
ClusterConfigDoc.Fields[2].Name = "controlPlane"
ClusterConfigDoc.Fields[2].Type = "ControlPlaneConfig"
ClusterConfigDoc.Fields[2].Note = ""
ClusterConfigDoc.Fields[2].Description = "Provides control plane specific configuration options."
ClusterConfigDoc.Fields[2].Comments[encoder.LineComment] = "Provides control plane specific configuration options."
ClusterConfigDoc.Fields[2].AddExample("Setting controlplane endpoint address to 1.2.3.4 and port to 443 example.", clusterControlPlaneExample)
ClusterConfigDoc.Fields[3].Name = "clusterName"
ClusterConfigDoc.Fields[3].Type = "string"
ClusterConfigDoc.Fields[3].Note = ""
ClusterConfigDoc.Fields[3].Description = "Configures the cluster's name."
ClusterConfigDoc.Fields[3].Comments[encoder.LineComment] = "Configures the cluster's name."
ClusterConfigDoc.Fields[4].Name = "network"
ClusterConfigDoc.Fields[4].Type = "ClusterNetworkConfig"
ClusterConfigDoc.Fields[4].Note = ""
ClusterConfigDoc.Fields[4].Description = "Provides cluster specific network configuration options."
ClusterConfigDoc.Fields[4].Comments[encoder.LineComment] = "Provides cluster specific network configuration options."
ClusterConfigDoc.Fields[4].AddExample("Configuring with flannel CNI and setting up subnets.", clusterNetworkExample)
ClusterConfigDoc.Fields[5].Name = "token"
ClusterConfigDoc.Fields[5].Type = "string"
ClusterConfigDoc.Fields[5].Note = ""
ClusterConfigDoc.Fields[5].Description = "The [bootstrap token](https://kubernetes.io/docs/reference/access-authn-authz/bootstrap-tokens/) used to join the cluster."
ClusterConfigDoc.Fields[5].Comments[encoder.LineComment] = "The [bootstrap token](https://kubernetes.io/docs/reference/access-authn-authz/bootstrap-tokens/) used to join the cluster."
ClusterConfigDoc.Fields[5].AddExample("Bootstrap token example (do not use in production!).", "wlzjyw.bei2zfylhs2by0wd")
ClusterConfigDoc.Fields[6].Name = "aescbcEncryptionSecret"
ClusterConfigDoc.Fields[6].Type = "string"
ClusterConfigDoc.Fields[6].Note = ""
ClusterConfigDoc.Fields[6].Description = "The key used for the [encryption of secret data at rest](https://kubernetes.io/docs/tasks/administer-cluster/encrypt-data/)."
ClusterConfigDoc.Fields[6].Comments[encoder.LineComment] = "The key used for the [encryption of secret data at rest](https://kubernetes.io/docs/tasks/administer-cluster/encrypt-data/)."
ClusterConfigDoc.Fields[6].AddExample("Decryption secret example (do not use in production!).", "z01mye6j16bspJYtTB/5SFX8j7Ph4JXxM2Xuu4vsBPM=")
ClusterConfigDoc.Fields[7].Name = "ca"
ClusterConfigDoc.Fields[7].Type = "PEMEncodedCertificateAndKey"
ClusterConfigDoc.Fields[7].Note = ""
ClusterConfigDoc.Fields[7].Description = "The base64 encoded root certificate authority used by Kubernetes."
ClusterConfigDoc.Fields[7].Comments[encoder.LineComment] = "The base64 encoded root certificate authority used by Kubernetes."
ClusterConfigDoc.Fields[7].AddExample("ClusterCA example.", pemEncodedCertificateExample)
ClusterConfigDoc.Fields[8].Name = "aggregatorCA"
ClusterConfigDoc.Fields[8].Type = "PEMEncodedCertificateAndKey"
ClusterConfigDoc.Fields[8].Note = ""
ClusterConfigDoc.Fields[8].Description = "The base64 encoded aggregator certificate authority used by Kubernetes for front-proxy certificate generation.\n\nThis CA can be self-signed."
ClusterConfigDoc.Fields[8].Comments[encoder.LineComment] = "The base64 encoded aggregator certificate authority used by Kubernetes for front-proxy certificate generation."
ClusterConfigDoc.Fields[8].AddExample("AggregatorCA example.", pemEncodedCertificateExample)
ClusterConfigDoc.Fields[9].Name = "serviceAccount"
ClusterConfigDoc.Fields[9].Type = "PEMEncodedKey"
ClusterConfigDoc.Fields[9].Note = ""
ClusterConfigDoc.Fields[9].Description = "The base64 encoded private key for service account token generation."
ClusterConfigDoc.Fields[9].Comments[encoder.LineComment] = "The base64 encoded private key for service account token generation."
ClusterConfigDoc.Fields[9].AddExample("AggregatorCA example.", pemEncodedKeyExample)
ClusterConfigDoc.Fields[10].Name = "apiServer"
ClusterConfigDoc.Fields[10].Type = "APIServerConfig"
ClusterConfigDoc.Fields[10].Note = ""
ClusterConfigDoc.Fields[10].Description = "API server specific configuration options."
ClusterConfigDoc.Fields[10].Comments[encoder.LineComment] = "API server specific configuration options."
ClusterConfigDoc.Fields[10].AddExample("", clusterAPIServerExample)
ClusterConfigDoc.Fields[11].Name = "controllerManager"
ClusterConfigDoc.Fields[11].Type = "ControllerManagerConfig"
ClusterConfigDoc.Fields[11].Note = ""
ClusterConfigDoc.Fields[11].Description = "Controller manager server specific configuration options."
ClusterConfigDoc.Fields[11].Comments[encoder.LineComment] = "Controller manager server specific configuration options."
ClusterConfigDoc.Fields[11].AddExample("", clusterControllerManagerExample)
ClusterConfigDoc.Fields[12].Name = "proxy"
ClusterConfigDoc.Fields[12].Type = "ProxyConfig"
ClusterConfigDoc.Fields[12].Note = ""
ClusterConfigDoc.Fields[12].Description = "Kube-proxy server-specific configuration options"
ClusterConfigDoc.Fields[12].Comments[encoder.LineComment] = "Kube-proxy server-specific configuration options"
ClusterConfigDoc.Fields[12].AddExample("", clusterProxyExample)
ClusterConfigDoc.Fields[13].Name = "scheduler"
ClusterConfigDoc.Fields[13].Type = "SchedulerConfig"
ClusterConfigDoc.Fields[13].Note = ""
ClusterConfigDoc.Fields[13].Description = "Scheduler server specific configuration options."
ClusterConfigDoc.Fields[13].Comments[encoder.LineComment] = "Scheduler server specific configuration options."
ClusterConfigDoc.Fields[13].AddExample("", clusterSchedulerExample)
ClusterConfigDoc.Fields[14].Name = "discovery"
ClusterConfigDoc.Fields[14].Type = "ClusterDiscoveryConfig"
ClusterConfigDoc.Fields[14].Note = ""
ClusterConfigDoc.Fields[14].Description = "Configures cluster member discovery."
ClusterConfigDoc.Fields[14].Comments[encoder.LineComment] = "Configures cluster member discovery."
ClusterConfigDoc.Fields[14].AddExample("", clusterDiscoveryExample)
ClusterConfigDoc.Fields[15].Name = "etcd"
ClusterConfigDoc.Fields[15].Type = "EtcdConfig"
ClusterConfigDoc.Fields[15].Note = ""
ClusterConfigDoc.Fields[15].Description = "Etcd specific configuration options."
ClusterConfigDoc.Fields[15].Comments[encoder.LineComment] = "Etcd specific configuration options."
ClusterConfigDoc.Fields[15].AddExample("", clusterEtcdExample)
ClusterConfigDoc.Fields[16].Name = "coreDNS"
ClusterConfigDoc.Fields[16].Type = "CoreDNS"
ClusterConfigDoc.Fields[16].Note = ""
ClusterConfigDoc.Fields[16].Description = "Core DNS specific configuration options."
ClusterConfigDoc.Fields[16].Comments[encoder.LineComment] = "Core DNS specific configuration options."
ClusterConfigDoc.Fields[16].AddExample("", clusterCoreDNSExample)
ClusterConfigDoc.Fields[17].Name = "externalCloudProvider"
ClusterConfigDoc.Fields[17].Type = "ExternalCloudProviderConfig"
ClusterConfigDoc.Fields[17].Note = ""
ClusterConfigDoc.Fields[17].Description = "External cloud provider configuration."
ClusterConfigDoc.Fields[17].Comments[encoder.LineComment] = "External cloud provider configuration."
ClusterConfigDoc.Fields[17].AddExample("", clusterExternalCloudProviderConfigExample)
ClusterConfigDoc.Fields[18].Name = "extraManifests"
ClusterConfigDoc.Fields[18].Type = "[]string"
ClusterConfigDoc.Fields[18].Note = ""
ClusterConfigDoc.Fields[18].Description = "A list of urls that point to additional manifests.\nThese will get automatically deployed as part of the bootstrap."
ClusterConfigDoc.Fields[18].Comments[encoder.LineComment] = "A list of urls that point to additional manifests."
ClusterConfigDoc.Fields[18].AddExample("", []string{
"https://www.example.com/manifest1.yaml",
"https://www.example.com/manifest2.yaml",
})
ClusterConfigDoc.Fields[19].Name = "extraManifestHeaders"
ClusterConfigDoc.Fields[19].Type = "map[string]string"
ClusterConfigDoc.Fields[19].Note = ""
ClusterConfigDoc.Fields[19].Description = "A map of key value pairs that will be added while fetching the extraManifests."
ClusterConfigDoc.Fields[19].Comments[encoder.LineComment] = "A map of key value pairs that will be added while fetching the extraManifests."
ClusterConfigDoc.Fields[19].AddExample("", map[string]string{
"Token": "1234567",
"X-ExtraInfo": "info",
})
ClusterConfigDoc.Fields[20].Name = "inlineManifests"
ClusterConfigDoc.Fields[20].Type = "ClusterInlineManifests"
ClusterConfigDoc.Fields[20].Note = ""
ClusterConfigDoc.Fields[20].Description = "A list of inline Kubernetes manifests.\nThese will get automatically deployed as part of the bootstrap."
ClusterConfigDoc.Fields[20].Comments[encoder.LineComment] = "A list of inline Kubernetes manifests."
ClusterConfigDoc.Fields[20].AddExample("", clusterInlineManifestsExample)
ClusterConfigDoc.Fields[21].Name = "adminKubeconfig"
ClusterConfigDoc.Fields[21].Type = "AdminKubeconfigConfig"
ClusterConfigDoc.Fields[21].Note = ""
ClusterConfigDoc.Fields[21].Description = "Settings for admin kubeconfig generation.\nCertificate lifetime can be configured."
ClusterConfigDoc.Fields[21].Comments[encoder.LineComment] = "Settings for admin kubeconfig generation."
ClusterConfigDoc.Fields[21].AddExample("", clusterAdminKubeconfigExample)
ClusterConfigDoc.Fields[23].Name = "allowSchedulingOnControlPlanes"
ClusterConfigDoc.Fields[23].Type = "bool"
ClusterConfigDoc.Fields[23].Note = ""
ClusterConfigDoc.Fields[23].Description = "Allows running workload on control-plane nodes."
ClusterConfigDoc.Fields[23].Comments[encoder.LineComment] = "Allows running workload on control-plane nodes."
ClusterConfigDoc.Fields[23].Values = []string{
"true",
"yes",
"false",
"no",
}
ExtraMountDoc.Type = "ExtraMount"
ExtraMountDoc.Comments[encoder.LineComment] = "ExtraMount wraps OCI Mount specification."
ExtraMountDoc.Description = "ExtraMount wraps OCI Mount specification."
ExtraMountDoc.AddExample("", kubeletExtraMountsExample)
ExtraMountDoc.AppearsIn = []encoder.Appearance{
{
TypeName: "KubeletConfig",
FieldName: "extraMounts",
},
}
ExtraMountDoc.Fields = make([]encoder.Doc, 0)
MachineControlPlaneConfigDoc.Type = "MachineControlPlaneConfig"
MachineControlPlaneConfigDoc.Comments[encoder.LineComment] = "MachineControlPlaneConfig machine specific configuration options."
MachineControlPlaneConfigDoc.Description = "MachineControlPlaneConfig machine specific configuration options."
MachineControlPlaneConfigDoc.AddExample("ControlPlane definition example.", machineControlplaneExample)
MachineControlPlaneConfigDoc.AppearsIn = []encoder.Appearance{
{
TypeName: "MachineConfig",
FieldName: "controlPlane",
},
}
MachineControlPlaneConfigDoc.Fields = make([]encoder.Doc, 2)
MachineControlPlaneConfigDoc.Fields[0].Name = "controllerManager"
MachineControlPlaneConfigDoc.Fields[0].Type = "MachineControllerManagerConfig"
MachineControlPlaneConfigDoc.Fields[0].Note = ""
MachineControlPlaneConfigDoc.Fields[0].Description = "Controller manager machine specific configuration options."
MachineControlPlaneConfigDoc.Fields[0].Comments[encoder.LineComment] = "Controller manager machine specific configuration options."
MachineControlPlaneConfigDoc.Fields[1].Name = "scheduler"
MachineControlPlaneConfigDoc.Fields[1].Type = "MachineSchedulerConfig"
MachineControlPlaneConfigDoc.Fields[1].Note = ""
MachineControlPlaneConfigDoc.Fields[1].Description = "Scheduler machine specific configuration options."
MachineControlPlaneConfigDoc.Fields[1].Comments[encoder.LineComment] = "Scheduler machine specific configuration options."
MachineControllerManagerConfigDoc.Type = "MachineControllerManagerConfig"
MachineControllerManagerConfigDoc.Comments[encoder.LineComment] = "MachineControllerManagerConfig represents the machine specific ControllerManager config values."
MachineControllerManagerConfigDoc.Description = "MachineControllerManagerConfig represents the machine specific ControllerManager config values."
MachineControllerManagerConfigDoc.AppearsIn = []encoder.Appearance{
{
TypeName: "MachineControlPlaneConfig",
FieldName: "controllerManager",
},
}
MachineControllerManagerConfigDoc.Fields = make([]encoder.Doc, 1)
MachineControllerManagerConfigDoc.Fields[0].Name = "disabled"
MachineControllerManagerConfigDoc.Fields[0].Type = "bool"
MachineControllerManagerConfigDoc.Fields[0].Note = ""
MachineControllerManagerConfigDoc.Fields[0].Description = "Disable kube-controller-manager on the node."
MachineControllerManagerConfigDoc.Fields[0].Comments[encoder.LineComment] = "Disable kube-controller-manager on the node."
MachineSchedulerConfigDoc.Type = "MachineSchedulerConfig"
MachineSchedulerConfigDoc.Comments[encoder.LineComment] = "MachineSchedulerConfig represents the machine specific Scheduler config values."
MachineSchedulerConfigDoc.Description = "MachineSchedulerConfig represents the machine specific Scheduler config values."
MachineSchedulerConfigDoc.AppearsIn = []encoder.Appearance{
{
TypeName: "MachineControlPlaneConfig",
FieldName: "scheduler",
},
}
MachineSchedulerConfigDoc.Fields = make([]encoder.Doc, 1)
MachineSchedulerConfigDoc.Fields[0].Name = "disabled"
MachineSchedulerConfigDoc.Fields[0].Type = "bool"
MachineSchedulerConfigDoc.Fields[0].Note = ""
MachineSchedulerConfigDoc.Fields[0].Description = "Disable kube-scheduler on the node."
MachineSchedulerConfigDoc.Fields[0].Comments[encoder.LineComment] = "Disable kube-scheduler on the node."
KubeletConfigDoc.Type = "KubeletConfig"
KubeletConfigDoc.Comments[encoder.LineComment] = "KubeletConfig represents the kubelet config values."
KubeletConfigDoc.Description = "KubeletConfig represents the kubelet config values."
KubeletConfigDoc.AddExample("Kubelet definition example.", machineKubeletExample)
KubeletConfigDoc.AppearsIn = []encoder.Appearance{
{
TypeName: "MachineConfig",
FieldName: "kubelet",
},
}
KubeletConfigDoc.Fields = make([]encoder.Doc, 9)
KubeletConfigDoc.Fields[0].Name = "image"
KubeletConfigDoc.Fields[0].Type = "string"
KubeletConfigDoc.Fields[0].Note = ""
KubeletConfigDoc.Fields[0].Description = "The `image` field is an optional reference to an alternative kubelet image."
KubeletConfigDoc.Fields[0].Comments[encoder.LineComment] = "The `image` field is an optional reference to an alternative kubelet image."
KubeletConfigDoc.Fields[0].AddExample("", kubeletImageExample)
KubeletConfigDoc.Fields[1].Name = "clusterDNS"
KubeletConfigDoc.Fields[1].Type = "[]string"
KubeletConfigDoc.Fields[1].Note = ""
KubeletConfigDoc.Fields[1].Description = "The `ClusterDNS` field is an optional reference to an alternative kubelet clusterDNS ip list."
KubeletConfigDoc.Fields[1].Comments[encoder.LineComment] = "The `ClusterDNS` field is an optional reference to an alternative kubelet clusterDNS ip list."
KubeletConfigDoc.Fields[1].AddExample("", []string{"10.96.0.10", "169.254.2.53"})
KubeletConfigDoc.Fields[2].Name = "extraArgs"
KubeletConfigDoc.Fields[2].Type = "map[string]string"
KubeletConfigDoc.Fields[2].Note = ""
KubeletConfigDoc.Fields[2].Description = "The `extraArgs` field is used to provide additional flags to the kubelet."
KubeletConfigDoc.Fields[2].Comments[encoder.LineComment] = "The `extraArgs` field is used to provide additional flags to the kubelet."
KubeletConfigDoc.Fields[2].AddExample("", map[string]string{
"key": "value",
})
KubeletConfigDoc.Fields[3].Name = "extraMounts"
KubeletConfigDoc.Fields[3].Type = "[]ExtraMount"
KubeletConfigDoc.Fields[3].Note = ""
KubeletConfigDoc.Fields[3].Description = "The `extraMounts` field is used to add additional mounts to the kubelet container.\nNote that either `bind` or `rbind` are required in the `options`."
KubeletConfigDoc.Fields[3].Comments[encoder.LineComment] = "The `extraMounts` field is used to add additional mounts to the kubelet container."
KubeletConfigDoc.Fields[3].AddExample("", kubeletExtraMountsExample)
KubeletConfigDoc.Fields[4].Name = "extraConfig"
KubeletConfigDoc.Fields[4].Type = "Unstructured"
KubeletConfigDoc.Fields[4].Note = ""
KubeletConfigDoc.Fields[4].Description = "The `extraConfig` field is used to provide kubelet configuration overrides.\n\nSome fields are not allowed to be overridden: authentication and authorization, cgroups\nconfiguration, ports, etc."
KubeletConfigDoc.Fields[4].Comments[encoder.LineComment] = "The `extraConfig` field is used to provide kubelet configuration overrides."
KubeletConfigDoc.Fields[4].AddExample("", kubeletExtraConfigExample)
KubeletConfigDoc.Fields[5].Name = "defaultRuntimeSeccompProfileEnabled"
KubeletConfigDoc.Fields[5].Type = "bool"
KubeletConfigDoc.Fields[5].Note = ""
KubeletConfigDoc.Fields[5].Description = "Enable container runtime default Seccomp profile."
KubeletConfigDoc.Fields[5].Comments[encoder.LineComment] = "Enable container runtime default Seccomp profile."
KubeletConfigDoc.Fields[5].Values = []string{
"true",
"yes",
"false",
"no",
}
KubeletConfigDoc.Fields[6].Name = "registerWithFQDN"
KubeletConfigDoc.Fields[6].Type = "bool"
KubeletConfigDoc.Fields[6].Note = ""
KubeletConfigDoc.Fields[6].Description = "The `registerWithFQDN` field is used to force kubelet to use the node FQDN for registration.\nThis is required in clouds like AWS."
KubeletConfigDoc.Fields[6].Comments[encoder.LineComment] = "The `registerWithFQDN` field is used to force kubelet to use the node FQDN for registration."
KubeletConfigDoc.Fields[6].Values = []string{
"true",
"yes",
"false",
"no",
}
KubeletConfigDoc.Fields[7].Name = "nodeIP"
KubeletConfigDoc.Fields[7].Type = "KubeletNodeIPConfig"
KubeletConfigDoc.Fields[7].Note = ""
KubeletConfigDoc.Fields[7].Description = "The `nodeIP` field is used to configure `--node-ip` flag for the kubelet.\nThis is used when a node has multiple addresses to choose from."
KubeletConfigDoc.Fields[7].Comments[encoder.LineComment] = "The `nodeIP` field is used to configure `--node-ip` flag for the kubelet."
KubeletConfigDoc.Fields[7].AddExample("", kubeletNodeIPExample)
KubeletConfigDoc.Fields[8].Name = "skipNodeRegistration"
KubeletConfigDoc.Fields[8].Type = "bool"
KubeletConfigDoc.Fields[8].Note = ""
KubeletConfigDoc.Fields[8].Description = "The `skipNodeRegistration` is used to run the kubelet without registering with the apiserver.\nThis runs kubelet as standalone and only runs static pods."
KubeletConfigDoc.Fields[8].Comments[encoder.LineComment] = "The `skipNodeRegistration` is used to run the kubelet without registering with the apiserver."
KubeletConfigDoc.Fields[8].Values = []string{
"true",
"yes",
"false",
"no",
}
KubeletNodeIPConfigDoc.Type = "KubeletNodeIPConfig"
KubeletNodeIPConfigDoc.Comments[encoder.LineComment] = "KubeletNodeIPConfig represents the kubelet node IP configuration."
KubeletNodeIPConfigDoc.Description = "KubeletNodeIPConfig represents the kubelet node IP configuration."
KubeletNodeIPConfigDoc.AddExample("", kubeletNodeIPExample)
KubeletNodeIPConfigDoc.AppearsIn = []encoder.Appearance{
{
TypeName: "KubeletConfig",
FieldName: "nodeIP",
},
}
KubeletNodeIPConfigDoc.Fields = make([]encoder.Doc, 1)
KubeletNodeIPConfigDoc.Fields[0].Name = "validSubnets"
KubeletNodeIPConfigDoc.Fields[0].Type = "[]string"
KubeletNodeIPConfigDoc.Fields[0].Note = ""
KubeletNodeIPConfigDoc.Fields[0].Description = "The `validSubnets` field configures the networks to pick kubelet node IP from.\nFor dual stack configuration, there should be two subnets: one for IPv4, another for IPv6.\nIPs can be excluded from the list by using negative match with `!`, e.g `!10.0.0.0/8`.\nNegative subnet matches should be specified last to filter out IPs picked by positive matches.\nIf not specified, node IP is picked based on cluster podCIDRs: IPv4/IPv6 address or both."
KubeletNodeIPConfigDoc.Fields[0].Comments[encoder.LineComment] = "The `validSubnets` field configures the networks to pick kubelet node IP from."
NetworkConfigDoc.Type = "NetworkConfig"
NetworkConfigDoc.Comments[encoder.LineComment] = "NetworkConfig represents the machine's networking config values."
NetworkConfigDoc.Description = "NetworkConfig represents the machine's networking config values."
NetworkConfigDoc.AddExample("Network definition example.", machineNetworkConfigExample)
NetworkConfigDoc.AppearsIn = []encoder.Appearance{
{
TypeName: "MachineConfig",
FieldName: "network",
},
}
NetworkConfigDoc.Fields = make([]encoder.Doc, 6)
NetworkConfigDoc.Fields[0].Name = "hostname"
NetworkConfigDoc.Fields[0].Type = "string"
NetworkConfigDoc.Fields[0].Note = ""
NetworkConfigDoc.Fields[0].Description = "Used to statically set the hostname for the machine."
NetworkConfigDoc.Fields[0].Comments[encoder.LineComment] = "Used to statically set the hostname for the machine."
NetworkConfigDoc.Fields[1].Name = "interfaces"
NetworkConfigDoc.Fields[1].Type = "[]Device"
NetworkConfigDoc.Fields[1].Note = ""
NetworkConfigDoc.Fields[1].Description = "`interfaces` is used to define the network interface configuration.\nBy default all network interfaces will attempt a DHCP discovery.\nThis can be further tuned through this configuration parameter."
NetworkConfigDoc.Fields[1].Comments[encoder.LineComment] = "`interfaces` is used to define the network interface configuration."
NetworkConfigDoc.Fields[1].AddExample("", machineNetworkConfigExample.NetworkInterfaces)
NetworkConfigDoc.Fields[2].Name = "nameservers"
NetworkConfigDoc.Fields[2].Type = "[]string"
NetworkConfigDoc.Fields[2].Note = ""
NetworkConfigDoc.Fields[2].Description = "Used to statically set the nameservers for the machine.\nDefaults to `1.1.1.1` and `8.8.8.8`"
NetworkConfigDoc.Fields[2].Comments[encoder.LineComment] = "Used to statically set the nameservers for the machine."
NetworkConfigDoc.Fields[2].AddExample("", []string{"8.8.8.8", "1.1.1.1"})
NetworkConfigDoc.Fields[3].Name = "extraHostEntries"
NetworkConfigDoc.Fields[3].Type = "[]ExtraHost"
NetworkConfigDoc.Fields[3].Note = ""
NetworkConfigDoc.Fields[3].Description = "Allows for extra entries to be added to the `/etc/hosts` file"
NetworkConfigDoc.Fields[3].Comments[encoder.LineComment] = "Allows for extra entries to be added to the `/etc/hosts` file"
NetworkConfigDoc.Fields[3].AddExample("", networkConfigExtraHostsExample)
NetworkConfigDoc.Fields[4].Name = "kubespan"
NetworkConfigDoc.Fields[4].Type = "NetworkKubeSpan"
NetworkConfigDoc.Fields[4].Note = ""
NetworkConfigDoc.Fields[4].Description = "Configures KubeSpan feature."
NetworkConfigDoc.Fields[4].Comments[encoder.LineComment] = "Configures KubeSpan feature."
NetworkConfigDoc.Fields[4].AddExample("", networkKubeSpanExample)
NetworkConfigDoc.Fields[5].Name = "disableSearchDomain"
NetworkConfigDoc.Fields[5].Type = "bool"
NetworkConfigDoc.Fields[5].Note = ""
NetworkConfigDoc.Fields[5].Description = "Disable generating a default search domain in /etc/resolv.conf\nbased on the machine hostname.\nDefaults to `false`."
NetworkConfigDoc.Fields[5].Comments[encoder.LineComment] = "Disable generating a default search domain in /etc/resolv.conf"
NetworkConfigDoc.Fields[5].Values = []string{
"true",
"yes",
"false",
"no",
}
InstallConfigDoc.Type = "InstallConfig"
InstallConfigDoc.Comments[encoder.LineComment] = "InstallConfig represents the installation options for preparing a node."
InstallConfigDoc.Description = "InstallConfig represents the installation options for preparing a node."
InstallConfigDoc.AddExample("MachineInstall config usage example.", machineInstallExample)
InstallConfigDoc.AppearsIn = []encoder.Appearance{
{
TypeName: "MachineConfig",
FieldName: "install",
},
}
InstallConfigDoc.Fields = make([]encoder.Doc, 8)
InstallConfigDoc.Fields[0].Name = "disk"
InstallConfigDoc.Fields[0].Type = "string"
InstallConfigDoc.Fields[0].Note = ""
InstallConfigDoc.Fields[0].Description = "The disk used for installations."
InstallConfigDoc.Fields[0].Comments[encoder.LineComment] = "The disk used for installations."
InstallConfigDoc.Fields[0].AddExample("", "/dev/sda")
InstallConfigDoc.Fields[0].AddExample("", "/dev/nvme0")
InstallConfigDoc.Fields[1].Name = "diskSelector"
InstallConfigDoc.Fields[1].Type = "InstallDiskSelector"
InstallConfigDoc.Fields[1].Note = ""
InstallConfigDoc.Fields[1].Description = "Look up disk using disk attributes like model, size, serial and others.\nAlways has priority over `disk`."
InstallConfigDoc.Fields[1].Comments[encoder.LineComment] = "Look up disk using disk attributes like model, size, serial and others."
InstallConfigDoc.Fields[1].AddExample("", machineInstallDiskSelectorExample)
InstallConfigDoc.Fields[2].Name = "extraKernelArgs"
InstallConfigDoc.Fields[2].Type = "[]string"
InstallConfigDoc.Fields[2].Note = ""
InstallConfigDoc.Fields[2].Description = "Allows for supplying extra kernel args via the bootloader."
InstallConfigDoc.Fields[2].Comments[encoder.LineComment] = "Allows for supplying extra kernel args via the bootloader."
InstallConfigDoc.Fields[2].AddExample("", []string{"talos.platform=metal", "reboot=k"})
InstallConfigDoc.Fields[3].Name = "image"
InstallConfigDoc.Fields[3].Type = "string"
InstallConfigDoc.Fields[3].Note = ""
InstallConfigDoc.Fields[3].Description = "Allows for supplying the image used to perform the installation.\nImage reference for each Talos release can be found on\n[GitHub releases page](https://github.com/siderolabs/talos/releases)."
InstallConfigDoc.Fields[3].Comments[encoder.LineComment] = "Allows for supplying the image used to perform the installation."
InstallConfigDoc.Fields[3].AddExample("", "ghcr.io/siderolabs/installer:latest")
InstallConfigDoc.Fields[4].Name = "extensions"
InstallConfigDoc.Fields[4].Type = "[]InstallExtensionConfig"
InstallConfigDoc.Fields[4].Note = ""
InstallConfigDoc.Fields[4].Description = "Allows for supplying additional system extension images to install on top of base Talos image."
InstallConfigDoc.Fields[4].Comments[encoder.LineComment] = "Allows for supplying additional system extension images to install on top of base Talos image."
InstallConfigDoc.Fields[4].AddExample("", installExtensionsExample)
InstallConfigDoc.Fields[5].Name = "bootloader"
InstallConfigDoc.Fields[5].Type = "bool"
InstallConfigDoc.Fields[5].Note = ""
InstallConfigDoc.Fields[5].Description = "Indicates if a bootloader should be installed."
InstallConfigDoc.Fields[5].Comments[encoder.LineComment] = "Indicates if a bootloader should be installed."
InstallConfigDoc.Fields[5].Values = []string{
"true",
"yes",
"false",
"no",
}
InstallConfigDoc.Fields[6].Name = "wipe"
InstallConfigDoc.Fields[6].Type = "bool"
InstallConfigDoc.Fields[6].Note = ""
InstallConfigDoc.Fields[6].Description = "Indicates if the installation disk should be wiped at installation time.\nDefaults to `true`."
InstallConfigDoc.Fields[6].Comments[encoder.LineComment] = "Indicates if the installation disk should be wiped at installation time."
InstallConfigDoc.Fields[6].Values = []string{
"true",
"yes",
"false",
"no",
}
InstallConfigDoc.Fields[7].Name = "legacyBIOSSupport"
InstallConfigDoc.Fields[7].Type = "bool"
InstallConfigDoc.Fields[7].Note = ""
InstallConfigDoc.Fields[7].Description = "Indicates if MBR partition should be marked as bootable (active).\nShould be enabled only for the systems with legacy BIOS that doesn't support GPT partitioning scheme."
InstallConfigDoc.Fields[7].Comments[encoder.LineComment] = "Indicates if MBR partition should be marked as bootable (active)."
InstallDiskSelectorDoc.Type = "InstallDiskSelector"
InstallDiskSelectorDoc.Comments[encoder.LineComment] = "InstallDiskSelector represents a disk query parameters for the install disk lookup."
InstallDiskSelectorDoc.Description = "InstallDiskSelector represents a disk query parameters for the install disk lookup."
InstallDiskSelectorDoc.AddExample("", machineInstallDiskSelectorExample)
InstallDiskSelectorDoc.AppearsIn = []encoder.Appearance{
{
TypeName: "InstallConfig",
FieldName: "diskSelector",
},
}
InstallDiskSelectorDoc.Fields = make([]encoder.Doc, 9)
InstallDiskSelectorDoc.Fields[0].Name = "size"
InstallDiskSelectorDoc.Fields[0].Type = "InstallDiskSizeMatcher"
InstallDiskSelectorDoc.Fields[0].Note = ""
InstallDiskSelectorDoc.Fields[0].Description = "Disk size."
InstallDiskSelectorDoc.Fields[0].Comments[encoder.LineComment] = "Disk size."
InstallDiskSelectorDoc.Fields[0].AddExample("Select a disk which size is equal to 4GB.", machineInstallDiskSizeMatcherExamples[0])
InstallDiskSelectorDoc.Fields[0].AddExample("Select a disk which size is greater than 1TB.", machineInstallDiskSizeMatcherExamples[1])
InstallDiskSelectorDoc.Fields[0].AddExample("Select a disk which size is less or equal than 2TB.", machineInstallDiskSizeMatcherExamples[2])
InstallDiskSelectorDoc.Fields[1].Name = "name"
InstallDiskSelectorDoc.Fields[1].Type = "string"
InstallDiskSelectorDoc.Fields[1].Note = ""
InstallDiskSelectorDoc.Fields[1].Description = "Disk name `/sys/block/<dev>/device/name`."
InstallDiskSelectorDoc.Fields[1].Comments[encoder.LineComment] = "Disk name `/sys/block/<dev>/device/name`."
InstallDiskSelectorDoc.Fields[2].Name = "model"
InstallDiskSelectorDoc.Fields[2].Type = "string"
InstallDiskSelectorDoc.Fields[2].Note = ""
InstallDiskSelectorDoc.Fields[2].Description = "Disk model `/sys/block/<dev>/device/model`."
InstallDiskSelectorDoc.Fields[2].Comments[encoder.LineComment] = "Disk model `/sys/block/<dev>/device/model`."
InstallDiskSelectorDoc.Fields[3].Name = "serial"
InstallDiskSelectorDoc.Fields[3].Type = "string"
InstallDiskSelectorDoc.Fields[3].Note = ""
InstallDiskSelectorDoc.Fields[3].Description = "Disk serial number `/sys/block/<dev>/serial`."
InstallDiskSelectorDoc.Fields[3].Comments[encoder.LineComment] = "Disk serial number `/sys/block/<dev>/serial`."
InstallDiskSelectorDoc.Fields[4].Name = "modalias"
InstallDiskSelectorDoc.Fields[4].Type = "string"
InstallDiskSelectorDoc.Fields[4].Note = ""
InstallDiskSelectorDoc.Fields[4].Description = "Disk modalias `/sys/block/<dev>/device/modalias`."
InstallDiskSelectorDoc.Fields[4].Comments[encoder.LineComment] = "Disk modalias `/sys/block/<dev>/device/modalias`."
InstallDiskSelectorDoc.Fields[5].Name = "uuid"
InstallDiskSelectorDoc.Fields[5].Type = "string"
InstallDiskSelectorDoc.Fields[5].Note = ""
InstallDiskSelectorDoc.Fields[5].Description = "Disk UUID `/sys/block/<dev>/uuid`."
InstallDiskSelectorDoc.Fields[5].Comments[encoder.LineComment] = "Disk UUID `/sys/block/<dev>/uuid`."
InstallDiskSelectorDoc.Fields[6].Name = "wwid"
InstallDiskSelectorDoc.Fields[6].Type = "string"
InstallDiskSelectorDoc.Fields[6].Note = ""
InstallDiskSelectorDoc.Fields[6].Description = "Disk WWID `/sys/block/<dev>/wwid`."
InstallDiskSelectorDoc.Fields[6].Comments[encoder.LineComment] = "Disk WWID `/sys/block/<dev>/wwid`."
InstallDiskSelectorDoc.Fields[7].Name = "type"
InstallDiskSelectorDoc.Fields[7].Type = "InstallDiskType"
InstallDiskSelectorDoc.Fields[7].Note = ""
InstallDiskSelectorDoc.Fields[7].Description = "Disk Type."
InstallDiskSelectorDoc.Fields[7].Comments[encoder.LineComment] = "Disk Type."
InstallDiskSelectorDoc.Fields[7].Values = []string{
"ssd",
"hdd",
"nvme",
"sd",
}
InstallDiskSelectorDoc.Fields[8].Name = "busPath"
InstallDiskSelectorDoc.Fields[8].Type = "string"
InstallDiskSelectorDoc.Fields[8].Note = ""
InstallDiskSelectorDoc.Fields[8].Description = "Disk bus path."
InstallDiskSelectorDoc.Fields[8].Comments[encoder.LineComment] = "Disk bus path."
InstallDiskSelectorDoc.Fields[8].AddExample("", "/pci0000:00/0000:00:17.0/ata1/host0/target0:0:0/0:0:0:0")
InstallDiskSelectorDoc.Fields[8].AddExample("", "/pci0000:00/*")
InstallExtensionConfigDoc.Type = "InstallExtensionConfig"
InstallExtensionConfigDoc.Comments[encoder.LineComment] = "InstallExtensionConfig represents a configuration for a system extension."
InstallExtensionConfigDoc.Description = "InstallExtensionConfig represents a configuration for a system extension."
InstallExtensionConfigDoc.AddExample("", installExtensionsExample)
InstallExtensionConfigDoc.AppearsIn = []encoder.Appearance{
{
TypeName: "InstallConfig",
FieldName: "extensions",
},
}
InstallExtensionConfigDoc.Fields = make([]encoder.Doc, 1)
InstallExtensionConfigDoc.Fields[0].Name = "image"
InstallExtensionConfigDoc.Fields[0].Type = "string"
InstallExtensionConfigDoc.Fields[0].Note = ""
InstallExtensionConfigDoc.Fields[0].Description = "System extension image."
InstallExtensionConfigDoc.Fields[0].Comments[encoder.LineComment] = "System extension image."
TimeConfigDoc.Type = "TimeConfig"
TimeConfigDoc.Comments[encoder.LineComment] = "TimeConfig represents the options for configuring time on a machine."
TimeConfigDoc.Description = "TimeConfig represents the options for configuring time on a machine."
TimeConfigDoc.AddExample("Example configuration for cloudflare ntp server.", machineTimeExample)
TimeConfigDoc.AppearsIn = []encoder.Appearance{
{
TypeName: "MachineConfig",
FieldName: "time",
},
}
TimeConfigDoc.Fields = make([]encoder.Doc, 3)
TimeConfigDoc.Fields[0].Name = "disabled"
TimeConfigDoc.Fields[0].Type = "bool"
TimeConfigDoc.Fields[0].Note = ""
TimeConfigDoc.Fields[0].Description = "Indicates if the time service is disabled for the machine.\nDefaults to `false`."
TimeConfigDoc.Fields[0].Comments[encoder.LineComment] = "Indicates if the time service is disabled for the machine."
TimeConfigDoc.Fields[1].Name = "servers"
TimeConfigDoc.Fields[1].Type = "[]string"
TimeConfigDoc.Fields[1].Note = ""
TimeConfigDoc.Fields[1].Description = "Specifies time (NTP) servers to use for setting the system time.\nDefaults to `pool.ntp.org`"
TimeConfigDoc.Fields[1].Comments[encoder.LineComment] = "Specifies time (NTP) servers to use for setting the system time."
TimeConfigDoc.Fields[2].Name = "bootTimeout"
TimeConfigDoc.Fields[2].Type = "Duration"
TimeConfigDoc.Fields[2].Note = ""
TimeConfigDoc.Fields[2].Description = "Specifies the timeout when the node time is considered to be in sync unlocking the boot sequence.\nNTP sync will be still running in the background.\nDefaults to \"infinity\" (waiting forever for time sync)"
TimeConfigDoc.Fields[2].Comments[encoder.LineComment] = "Specifies the timeout when the node time is considered to be in sync unlocking the boot sequence."
RegistriesConfigDoc.Type = "RegistriesConfig"
RegistriesConfigDoc.Comments[encoder.LineComment] = "RegistriesConfig represents the image pull options."
RegistriesConfigDoc.Description = "RegistriesConfig represents the image pull options."
RegistriesConfigDoc.AddExample("", machineConfigRegistriesExample)
RegistriesConfigDoc.AppearsIn = []encoder.Appearance{
{
TypeName: "MachineConfig",
FieldName: "registries",
},
}
RegistriesConfigDoc.Fields = make([]encoder.Doc, 2)
RegistriesConfigDoc.Fields[0].Name = "mirrors"
RegistriesConfigDoc.Fields[0].Type = "map[string]RegistryMirrorConfig"
RegistriesConfigDoc.Fields[0].Note = ""
RegistriesConfigDoc.Fields[0].Description = "Specifies mirror configuration for each registry.\nThis setting allows to use local pull-through caching registires,\nair-gapped installations, etc.\n\nRegistry name is the first segment of image identifier, with 'docker.io'\nbeing default one."
RegistriesConfigDoc.Fields[0].Comments[encoder.LineComment] = "Specifies mirror configuration for each registry."
RegistriesConfigDoc.Fields[0].AddExample("", machineConfigRegistryMirrorsExample)
RegistriesConfigDoc.Fields[1].Name = "config"
RegistriesConfigDoc.Fields[1].Type = "map[string]RegistryConfig"
RegistriesConfigDoc.Fields[1].Note = ""
RegistriesConfigDoc.Fields[1].Description = "Specifies TLS & auth configuration for HTTPS image registries.\nMutual TLS can be enabled with 'clientIdentity' option.\n\nTLS configuration can be skipped if registry has trusted\nserver certificate."
RegistriesConfigDoc.Fields[1].Comments[encoder.LineComment] = "Specifies TLS & auth configuration for HTTPS image registries."
RegistriesConfigDoc.Fields[1].AddExample("", machineConfigRegistryConfigExample)
PodCheckpointerDoc.Type = "PodCheckpointer"
PodCheckpointerDoc.Comments[encoder.LineComment] = "PodCheckpointer represents the pod-checkpointer config values."
PodCheckpointerDoc.Description = "PodCheckpointer represents the pod-checkpointer config values."
PodCheckpointerDoc.Fields = make([]encoder.Doc, 1)
PodCheckpointerDoc.Fields[0].Name = "image"
PodCheckpointerDoc.Fields[0].Type = "string"
PodCheckpointerDoc.Fields[0].Note = ""
PodCheckpointerDoc.Fields[0].Description = "The `image` field is an override to the default pod-checkpointer image."
PodCheckpointerDoc.Fields[0].Comments[encoder.LineComment] = "The `image` field is an override to the default pod-checkpointer image."
CoreDNSDoc.Type = "CoreDNS"
CoreDNSDoc.Comments[encoder.LineComment] = "CoreDNS represents the CoreDNS config values."
CoreDNSDoc.Description = "CoreDNS represents the CoreDNS config values."
CoreDNSDoc.AddExample("", clusterCoreDNSExample)
CoreDNSDoc.AppearsIn = []encoder.Appearance{
{
TypeName: "ClusterConfig",
FieldName: "coreDNS",
},
}
CoreDNSDoc.Fields = make([]encoder.Doc, 2)
CoreDNSDoc.Fields[0].Name = "disabled"
CoreDNSDoc.Fields[0].Type = "bool"
CoreDNSDoc.Fields[0].Note = ""
CoreDNSDoc.Fields[0].Description = "Disable coredns deployment on cluster bootstrap."