/
schema.json
697 lines (697 loc) · 23.2 KB
/
schema.json
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
{
"$defs": {
"awsResourceTagValue": {
"$comment": "Restrictions based on https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions",
"maxLength": 256,
"minLength": 0,
"pattern": "^[ a-zA-Z0-9\\._:/=+-@]+$",
"title": "Tag value",
"type": "string"
},
"machinePool": {
"properties": {
"availabilityZones": {
"items": {
"title": "Availability zone",
"type": "string"
},
"title": "Availability zones",
"type": "array"
},
"customNodeLabels": {
"items": {
"title": "Label",
"type": "string"
},
"title": "Custom node labels",
"type": "array"
},
"customNodeTaints": {
"items": {
"properties": {
"effect": {
"enum": [
"NoSchedule",
"PreferNoSchedule",
"NoExecute"
],
"title": "Effect",
"type": "string"
},
"key": {
"title": "Key",
"type": "string"
},
"value": {
"title": "Value",
"type": "string"
}
},
"required": [
"effect",
"key",
"value"
],
"type": "object"
},
"title": "Custom node taints",
"type": "array"
},
"instanceType": {
"title": "EC2 instance type",
"type": "string"
},
"maxSize": {
"title": "Maximum number of nodes",
"type": "integer"
},
"minSize": {
"title": "Minimum number of nodes",
"type": "integer"
},
"rootVolumeSizeGB": {
"title": "Root volume size (GB)",
"type": "integer"
},
"subnetTags": {
"description": "Tags to filter which AWS subnets will be used for this node pool.",
"items": {
"additionalProperties": {
"$ref": "#/$defs/awsResourceTagValue"
},
"title": "Subnet tag",
"type": "object"
},
"title": "Subnet tags",
"type": "array"
}
},
"title": "Node pool",
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"baseDomain": {
"title": "Base DNS domain",
"description": "Description with a \"quoted\" word.",
"type": "string"
},
"cluster-shared": {
"title": "Library chart",
"type": "object"
},
"controlPlane": {
"properties": {
"apiMode": {
"default": "public",
"description": "Whether the Kubernetes API server load balancer should be reachable from the internet (public) or internal only (private).",
"enum": [
"public",
"private"
],
"title": "API mode",
"type": "string"
},
"containerdVolumeSizeGB": {
"default": 100,
"title": "Containerd volume size (GB)",
"type": "integer"
},
"etcdVolumeSizeGB": {
"default": 100,
"title": "Etcd volume size (GB)",
"type": "integer"
},
"instanceType": {
"default": "m5.xlarge",
"title": "EC2 instance type",
"type": "string"
},
"kubeletVolumeSizeGB": {
"default": 100,
"title": "Kubelet volume size (GB)",
"type": "integer"
},
"machineHealthCheck": {
"properties": {
"enabled": {
"default": true,
"title": "Enable",
"type": "boolean"
},
"maxUnhealthy": {
"default": "40%",
"examples": [
"40%"
],
"title": "Maximum unhealthy nodes",
"type": "string"
},
"nodeStartupTimeout": {
"default": "8m0s",
"description": "Determines how long a machine health check should wait for a node to join the cluster, before considering a machine unhealthy.",
"examples": [
"10m",
"100s"
],
"title": "Node startup timeout",
"type": "string"
},
"unhealthyNotReadyTimeout": {
"default": "10m0s",
"description": "If a node is not in condition 'Ready' after this timeout, it will be considered unhealthy.",
"examples": [
"300s"
],
"title": "Timeout for ready",
"type": "string"
},
"unhealthyUnknownTimeout": {
"default": "10m0s",
"description": "If a node is in 'Unknown' condition after this timeout, it will be considered unhealthy.",
"examples": [
"300s"
],
"title": "Timeout for unknown condition",
"type": "string"
}
},
"title": "Machine health check",
"type": "object"
},
"oidc": {
"properties": {
"caPem": {
"description": "Identity provider's CA certificate in PEM format.",
"title": "Certificate authority",
"type": "string"
},
"clientId": {
"title": "Client ID",
"type": "string"
},
"groupsClaim": {
"title": "Groups claim",
"type": "string"
},
"issuerUrl": {
"description": "Exact issuer URL that will be included in identity tokens.",
"title": "Issuer URL",
"type": "string"
},
"usernameClaim": {
"title": "Username claim",
"type": "string"
}
},
"title": "OIDC authentication",
"type": "object"
},
"rootVolumeSizeGB": {
"default": 120,
"title": "Root volume size (GB)",
"type": "integer"
},
"subnetTags": {
"description": "Tags to select AWS resources for the control plane by.",
"items": {
"additionalProperties": {
"$ref": "#/$defs/awsResourceTagValue"
},
"title": "Subnet tag",
"type": "object"
},
"title": "Subnet tags",
"type": "array"
}
},
"title": "Control plane",
"type": "object"
},
"defaultMachinePools": {
"default": {
"def00": {
"customNodeLabels": [
"label=default"
],
"instanceType": "m5.xlarge",
"minSize": 3
}
},
"patternProperties": {
"^[a-z0-9]{5,10}$": {
"$ref": "#/$defs/machinePool"
}
},
"title": "Default node pool",
"type": "object"
},
"global": {
"type": "object",
"title": "Global properties",
"properties": {
"connectivity": {
"properties": {
"availabilityZoneUsageLimit": {
"default": 3,
"description": "Maximum number of availability zones (AZ) that should be used in a region. If a region has more than this number of AZs then this number of AZs will be picked randomly when creating subnets.",
"title": "Availability zones",
"type": "integer"
},
"bastion": {
"properties": {
"enabled": {
"default": true,
"title": "Enable",
"type": "boolean"
},
"instanceType": {
"default": "t3.small",
"title": "EC2 instance type",
"type": "string"
},
"replicas": {
"default": 1,
"title": "Number of hosts",
"type": "integer"
},
"subnetTags": {
"description": "Tags to filter which AWS subnets will be used for the bastion hosts.",
"items": {
"additionalProperties": {
"$ref": "#/$defs/awsResourceTagValue"
},
"title": "Subnet tag",
"type": "object"
},
"title": "Subnet tags",
"type": "array"
}
},
"title": "Bastion host",
"type": "object"
},
"containerRegistries": {
"additionalProperties": {
"description": "Container registries and mirrors",
"items": {
"properties": {
"credentials": {
"properties": {
"auth": {
"description": "Base64-encoded string from the concatenation of the username, a colon, and the password.",
"title": "Auth",
"type": "string"
},
"identitytoken": {
"description": "Used to authenticate the user and obtain an access token for the registry.",
"title": "Identity token",
"type": "string"
},
"password": {
"description": "Used to authenticate for the registry with username/password.",
"title": "Password",
"type": "string"
},
"username": {
"description": "Used to authenticate for the registry with username/password.",
"title": "Username",
"type": "string"
}
},
"title": "Credentials",
"type": "object"
},
"endpoint": {
"description": "Endpoint for the container registry.",
"title": "Endpoint",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Registry",
"type": "object"
},
"title": "Registries",
"type": "array"
},
"description": "Endpoints and credentials configuration for container registries.",
"title": "Container registries",
"type": "object"
},
"dns": {
"properties": {
"additionalVpc": {
"description": "If DNS mode is 'private', the VPCs specified here will be assigned to the private hosted zone.",
"items": {
"examples": [
"vpc-x2aeasd1d"
],
"pattern": "^vpc-[0-0a-zA-Z]+$",
"title": "VPC identifier",
"type": "string"
},
"title": "Additional VPCs",
"type": "array"
},
"mode": {
"default": "public",
"description": "Whether the Route53 hosted zone of this cluster should be public or private.",
"enum": [
"public",
"private"
],
"title": "Mode",
"type": "string"
},
"resolverRulesOwnerAccount": {
"description": "ID of the AWS account that created the resolver rules to be associated with the workload cluster VPC.",
"oneOf": [
{
"pattern": "^\\d{12}$"
},
{
"const": ""
}
],
"title": "Resolver rules owner",
"type": "string"
}
},
"title": "DNS",
"type": "object"
},
"network": {
"properties": {
"podCidr": {
"default": "100.64.0.0/12",
"description": "IPv4 address range for pods, in CIDR notation.",
"title": "Pod subnet",
"type": "string"
},
"serviceCidr": {
"default": "172.31.0.0/16",
"description": "IPv4 address range for services, in CIDR notation.",
"title": "Service subnet",
"type": "string"
},
"vpcCidr": {
"default": "10.0.0.0/16",
"description": "IPv4 address range to assign to this cluster's VPC, in CIDR notation.",
"title": "VPC subnet",
"type": "string"
}
},
"title": "Network",
"type": "object"
},
"proxy": {
"description": "Whether/how outgoing traffic is routed through proxy servers.",
"properties": {
"enabled": {
"title": "Enable",
"type": "boolean"
},
"httpProxy": {
"description": "To be passed to the HTTP_PROXY environment variable in all hosts.",
"title": "HTTP proxy",
"type": "string"
},
"httpsProxy": {
"description": "To be passed to the HTTPS_PROXY environment variable in all hosts.",
"title": "HTTPS proxy",
"type": "string"
},
"noProxy": {
"description": "To be passed to the NO_PROXY environment variable in all hosts.",
"title": "No proxy",
"type": "string"
}
},
"title": "Proxy",
"type": "object"
},
"sshSsoPublicKey": {
"default": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIM4cvZ01fLmO9cJbWUj7sfF+NhECgy+Cl0bazSrZX7sU vault-ca@vault.operations.giantswarm.io",
"title": "SSH public key for single sign-on",
"type": "string"
},
"subnets": {
"default": [
{
"cidrBlocks": [
{
"availabilityZone": "a",
"cidr": "10.0.0.0/20"
},
{
"availabilityZone": "b",
"cidr": "10.0.16.0/20"
},
{
"availabilityZone": "c",
"cidr": "10.0.32.0/20"
}
],
"isPublic": true
},
{
"cidrBlocks": [
{
"availabilityZone": "a",
"cidr": "10.0.64.0/18"
},
{
"availabilityZone": "b",
"cidr": "10.0.128.0/18"
},
{
"availabilityZone": "c",
"cidr": "10.0.192.0/18"
}
],
"isPublic": false
}
],
"description": "Subnets are created and tagged based on this definition.",
"items": {
"properties": {
"cidrBlocks": {
"items": {
"properties": {
"availabilityZone": {
"examples": [
"a"
],
"title": "Availability zone",
"type": "string"
},
"cidr": {
"description": "IPv4 address range, in CIDR notation.",
"title": "Address range",
"type": "string"
},
"tags": {
"additionalProperties": {
"$ref": "#/$defs/awsResourceTagValue"
},
"description": "AWS resource tags to assign to this subnet.",
"title": "Tags",
"type": "object"
}
},
"type": "object"
},
"title": "Network",
"type": "array"
},
"isPublic": {
"title": "Public",
"type": "boolean"
},
"tags": {
"additionalProperties": {
"$ref": "#/$defs/awsResourceTagValue"
},
"description": "AWS resource tags to assign to this CIDR block.",
"title": "Tags",
"type": "object"
}
},
"title": "Subnet",
"type": "object"
},
"title": "Subnets",
"type": "array"
},
"topology": {
"description": "Networking architecture between management cluster and workload cluster.",
"properties": {
"mode": {
"default": "None",
"description": "Valid values: GiantSwarmManaged, UserManaged, None.",
"enum": [
"None",
"GiantSwarmManaged",
"UserManaged"
],
"title": "Mode",
"type": "string"
},
"prefixListId": {
"description": "ID of the managed prefix list to use when the topology mode is set to 'UserManaged'.",
"title": "Prefix list ID",
"type": "string"
},
"transitGatewayId": {
"description": "If the topology mode is set to 'UserManaged', this can be used to specify the transit gateway to use.",
"title": "Transit gateway ID",
"type": "string"
}
},
"title": "Topology",
"type": "object"
},
"vpcEndpointMode": {
"default": "GiantSwarmManaged",
"description": "Who is reponsible for creation and management of VPC endpoints.",
"enum": [
"GiantSwarmManaged",
"UserManaged"
],
"title": "VPC endpoint mode",
"type": "string"
},
"vpcMode": {
"default": "public",
"description": "Whether the cluser's VPC is created with public, internet facing resources (public subnets, NAT gateway) or not (private).",
"enum": [
"public",
"private"
],
"title": "VPC mode",
"type": "string"
}
},
"title": "Connectivity",
"type": "object"
},
"managementCluster": {
"description": "Name of the Cluster API cluster managing this workload cluster.",
"title": "Management cluster",
"type": "string"
},
"metadata": {
"properties": {
"description": {
"description": "User-friendly description of the cluster's purpose.",
"title": "Cluster description",
"type": "string"
},
"name": {
"description": "Unique identifier, cannot be changed after creation.",
"title": "Cluster name",
"type": "string"
},
"organization": {
"title": "Organization",
"type": "string"
}
},
"title": "Metadata",
"type": "object"
}
}
},
"internal": {
"description": "For Giant Swarm internal use only, not stable, or not supported by UIs.",
"properties": {
"hashSalt": {
"description": "If specified, this token is used as a salt to the hash suffix of some resource names. Can be used to force-recreate some resources.",
"title": "Hash salt",
"type": "string"
},
"kubernetesVersion": {
"default": "1.23.16",
"examples": [
"1.24.7"
],
"title": "Kubernetes version",
"type": "string"
}
},
"title": "Internal",
"type": "object"
},
"kubectlImage": {
"properties": {
"name": {
"default": "giantswarm/kubectl",
"title": "Repository",
"type": "string"
},
"registry": {
"default": "quay.io",
"title": "Registry",
"type": "string"
},
"tag": {
"default": "1.23.5",
"title": "Tag",
"type": "string"
}
},
"title": "Kubectl image",
"type": "object"
},
"nodePools": {
"patternProperties": {
"^[a-z0-9]{5,10}$": {
"$ref": "#/$defs/machinePool"
}
},
"title": "Node pools",
"type": "object"
},
"provider": {
"title": "Cluster API provider name",
"type": "string"
},
"providerSpecific": {
"properties": {
"ami": {
"description": "If specified, this image will be used to provision EC2 instances.",
"title": "Amazon machine image (AMI)",
"type": "string"
},
"awsClusterRoleIdentityName": {
"$comment": "See also https://cluster-api-aws.sigs.k8s.io/topics/multitenancy.html#awsclusterroleidentity",
"default": "default",
"description": "Name of an AWSClusterRoleIdentity object. This in turn refers to the IAM role used to create all AWS cloud resources when creating the cluster. The role can be in another AWS account in order to create all resources in that account. Note: This name does not refer directly to an IAM role name/ARN.",
"maxLength": 63,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_\\.]{1,63}$",
"title": "Cluster role identity name",
"type": "string"
},
"flatcarAwsAccount": {
"default": "075585003325",
"description": "AWS account ID owning the Flatcar Container Linux AMI.",
"title": "AWS account owning Flatcar image",
"type": "string"
},
"region": {
"title": "Region",
"type": "string"
}
},
"title": "AWS settings",
"type": "object"
}
},
"type": "object"
}