-
Notifications
You must be signed in to change notification settings - Fork 605
Expand file tree
/
Copy path0000_10_config-operator_01_infrastructures-TechPreviewNoUpgrade.crd.yaml
More file actions
2770 lines (2754 loc) · 167 KB
/
0000_10_config-operator_01_infrastructures-TechPreviewNoUpgrade.crd.yaml
File metadata and controls
2770 lines (2754 loc) · 167 KB
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
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
api-approved.openshift.io: https://github.com/openshift/api/pull/470
api.openshift.io/merged-by-featuregates: "true"
include.release.openshift.io/ibm-cloud-managed: "true"
include.release.openshift.io/self-managed-high-availability: "true"
release.openshift.io/bootstrap-required: "true"
release.openshift.io/feature-set: TechPreviewNoUpgrade
name: infrastructures.config.openshift.io
spec:
group: config.openshift.io
names:
kind: Infrastructure
listKind: InfrastructureList
plural: infrastructures
singular: infrastructure
scope: Cluster
versions:
- name: v1
schema:
openAPIV3Schema:
description: |-
Infrastructure holds cluster-wide information about Infrastructure. The canonical name is `cluster`
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
properties:
apiVersion:
description: |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type: string
kind:
description: |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type: string
metadata:
type: object
spec:
description: spec holds user settable values for configuration
properties:
cloudConfig:
description: |-
cloudConfig is a reference to a ConfigMap containing the cloud provider configuration file.
This configuration file is used to configure the Kubernetes cloud provider integration
when using the built-in cloud provider integration or the external cloud controller manager.
The namespace for this config map is openshift-config.
cloudConfig should only be consumed by the kube_cloud_config controller.
The controller is responsible for using the user configuration in the spec
for various platforms and combining that with the user provided ConfigMap in this field
to create a stitched kube cloud config.
The controller generates a ConfigMap `kube-cloud-config` in `openshift-config-managed` namespace
with the kube cloud config is stored in `cloud.conf` key.
All the clients are expected to use the generated ConfigMap only.
properties:
key:
description: key allows pointing to a specific key/value inside
of the configmap. This is useful for logical file references.
type: string
name:
type: string
type: object
platformSpec:
description: |-
platformSpec holds desired information specific to the underlying
infrastructure provider.
properties:
alibabaCloud:
description: alibabaCloud contains settings specific to the Alibaba
Cloud infrastructure provider.
type: object
aws:
description: aws contains settings specific to the Amazon Web
Services infrastructure provider.
properties:
serviceEndpoints:
description: |-
serviceEndpoints list contains custom endpoints which will override default
service endpoint of AWS Services.
There must be only one ServiceEndpoint for a service.
items:
description: |-
AWSServiceEndpoint store the configuration of a custom url to
override existing defaults of AWS Services.
properties:
name:
description: |-
name is the name of the AWS service.
The list of all the service names can be found at https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html
This must be provided and cannot be empty.
pattern: ^[a-z0-9-]+$
type: string
url:
description: |-
url is fully qualified URI with scheme https, that overrides the default generated
endpoint for a client.
This must be provided and cannot be empty.
pattern: ^https://
type: string
type: object
type: array
x-kubernetes-list-type: atomic
type: object
azure:
description: azure contains settings specific to the Azure infrastructure
provider.
type: object
baremetal:
description: baremetal contains settings specific to the BareMetal
platform.
properties:
apiServerInternalIPs:
description: |-
apiServerInternalIPs are the IP addresses to contact the Kubernetes API
server that can be used by components inside the cluster, like kubelets
using the infrastructure rather than Kubernetes networking. These are the
IPs for a self-hosted load balancer in front of the API servers.
In dual stack clusters this list contains two IP addresses, one from IPv4
family and one from IPv6.
In single stack clusters a single IP address is expected.
When omitted, values from the status.apiServerInternalIPs will be used.
Once set, the list cannot be completely removed (but its second entry can).
items:
description: IP is an IP address (for example, "10.0.0.0"
or "fd00::").
maxLength: 39
minLength: 1
type: string
x-kubernetes-validations:
- message: value must be a valid IP address
rule: isIP(self)
maxItems: 2
type: array
x-kubernetes-list-type: atomic
x-kubernetes-validations:
- message: apiServerInternalIPs must contain at most one IPv4
address and at most one IPv6 address
rule: 'size(self) == 2 && isIP(self[0]) && isIP(self[1])
? ip(self[0]).family() != ip(self[1]).family() : true'
ingressIPs:
description: |-
ingressIPs are the external IPs which route to the default ingress
controller. The IPs are suitable targets of a wildcard DNS record used to
resolve default route host names.
In dual stack clusters this list contains two IP addresses, one from IPv4
family and one from IPv6.
In single stack clusters a single IP address is expected.
When omitted, values from the status.ingressIPs will be used.
Once set, the list cannot be completely removed (but its second entry can).
items:
description: IP is an IP address (for example, "10.0.0.0"
or "fd00::").
maxLength: 39
minLength: 1
type: string
x-kubernetes-validations:
- message: value must be a valid IP address
rule: isIP(self)
maxItems: 2
type: array
x-kubernetes-list-type: atomic
x-kubernetes-validations:
- message: ingressIPs must contain at most one IPv4 address
and at most one IPv6 address
rule: 'size(self) == 2 && isIP(self[0]) && isIP(self[1])
? ip(self[0]).family() != ip(self[1]).family() : true'
machineNetworks:
description: |-
machineNetworks are IP networks used to connect all the OpenShift cluster
nodes. Each network is provided in the CIDR format and should be IPv4 or IPv6,
for example "10.0.0.0/8" or "fd00::/8".
items:
description: CIDR is an IP address range in CIDR notation
(for example, "10.0.0.0/8" or "fd00::/8").
maxLength: 43
minLength: 1
type: string
x-kubernetes-validations:
- message: value must be a valid CIDR network address
rule: isCIDR(self)
maxItems: 32
type: array
x-kubernetes-list-type: atomic
x-kubernetes-validations:
- rule: self.all(x, self.exists_one(y, x == y))
type: object
x-kubernetes-validations:
- message: apiServerInternalIPs list is required once set
rule: '!has(oldSelf.apiServerInternalIPs) || has(self.apiServerInternalIPs)'
- message: ingressIPs list is required once set
rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)'
equinixMetal:
description: equinixMetal contains settings specific to the Equinix
Metal infrastructure provider.
type: object
external:
description: |-
ExternalPlatformType represents generic infrastructure provider.
Platform-specific components should be supplemented separately.
properties:
platformName:
default: Unknown
description: |-
platformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time.
This field is solely for informational and reporting purposes and is not expected to be used for decision-making.
type: string
x-kubernetes-validations:
- message: platform name cannot be changed once set
rule: oldSelf == 'Unknown' || self == oldSelf
type: object
gcp:
description: gcp contains settings specific to the Google Cloud
Platform infrastructure provider.
type: object
ibmcloud:
description: ibmcloud contains settings specific to the IBMCloud
infrastructure provider.
properties:
serviceEndpoints:
description: |-
serviceEndpoints is a list of custom endpoints which will override the default
service endpoints of an IBM service. These endpoints are used by components
within the cluster when trying to reach the IBM Cloud Services that have been
overridden. The CCCMO reads in the IBMCloudPlatformSpec and validates each
endpoint is resolvable. Once validated, the cloud config and IBMCloudPlatformStatus
are updated to reflect the same custom endpoints.
A maximum of 13 service endpoints overrides are supported.
items:
description: |-
IBMCloudServiceEndpoint stores the configuration of a custom url to
override existing defaults of IBM Cloud Services.
properties:
name:
description: |-
name is the name of the IBM Cloud service.
Possible values are: CIS, COS, COSConfig, DNSServices, GlobalCatalog, GlobalSearch, GlobalTagging, HyperProtect, IAM, KeyProtect, ResourceController, ResourceManager, or VPC.
For example, the IBM Cloud Private IAM service could be configured with the
service `name` of `IAM` and `url` of `https://private.iam.cloud.ibm.com`
Whereas the IBM Cloud Private VPC service for US South (Dallas) could be configured
with the service `name` of `VPC` and `url` of `https://us.south.private.iaas.cloud.ibm.com`
enum:
- CIS
- COS
- COSConfig
- DNSServices
- GlobalCatalog
- GlobalSearch
- GlobalTagging
- HyperProtect
- IAM
- KeyProtect
- ResourceController
- ResourceManager
- VPC
type: string
url:
description: |-
url is fully qualified URI with scheme https, that overrides the default generated
endpoint for a client.
This must be provided and cannot be empty. The path must follow the pattern
/v[0,9]+ or /api/v[0,9]+
maxLength: 300
type: string
x-kubernetes-validations:
- message: url must use https scheme
rule: url(self).getScheme() == "https"
- message: url path must match /v[0,9]+ or /api/v[0,9]+
rule: matches((url(self).getEscapedPath()), '^/(api/)?v[0-9]+/{0,1}$')
- message: url must be a valid absolute URL
rule: isURL(self)
required:
- name
- url
type: object
maxItems: 13
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
type: object
kubevirt:
description: kubevirt contains settings specific to the kubevirt
infrastructure provider.
type: object
nutanix:
description: nutanix contains settings specific to the Nutanix
infrastructure provider.
properties:
failureDomains:
description: |-
failureDomains configures failure domains information for the Nutanix platform.
When set, the failure domains defined here may be used to spread Machines across
prism element clusters to improve fault tolerance of the cluster.
items:
description: NutanixFailureDomain configures failure domain
information for the Nutanix platform.
properties:
cluster:
description: |-
cluster is to identify the cluster (the Prism Element under management of the Prism Central),
in which the Machine's VM will be created. The cluster identifier (uuid or name) can be obtained
from the Prism Central console or using the prism_central API.
properties:
name:
description: name is the resource name in the PC.
It cannot be empty if the type is Name.
type: string
type:
description: type is the identifier type to use
for this resource.
enum:
- UUID
- Name
type: string
uuid:
description: uuid is the UUID of the resource in
the PC. It cannot be empty if the type is UUID.
type: string
required:
- type
type: object
x-kubernetes-validations:
- message: uuid configuration is required when type
is UUID, and forbidden otherwise
rule: 'has(self.type) && self.type == ''UUID'' ? has(self.uuid)
: !has(self.uuid)'
- message: name configuration is required when type
is Name, and forbidden otherwise
rule: 'has(self.type) && self.type == ''Name'' ? has(self.name)
: !has(self.name)'
name:
description: |-
name defines the unique name of a failure domain.
Name is required and must be at most 64 characters in length.
It must consist of only lower case alphanumeric characters and hyphens (-).
It must start and end with an alphanumeric character.
This value is arbitrary and is used to identify the failure domain within the platform.
maxLength: 64
minLength: 1
pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?'
type: string
subnets:
description: |-
subnets holds a list of identifiers (one or more) of the cluster's network subnets
If the feature gate NutanixMultiSubnets is enabled, up to 32 subnets may be configured.
for the Machine's VM to connect to. The subnet identifiers (uuid or name) can be
obtained from the Prism Central console or using the prism_central API.
items:
description: NutanixResourceIdentifier holds the identity
of a Nutanix PC resource (cluster, image, subnet,
etc.)
properties:
name:
description: name is the resource name in the
PC. It cannot be empty if the type is Name.
type: string
type:
description: type is the identifier type to use
for this resource.
enum:
- UUID
- Name
type: string
uuid:
description: uuid is the UUID of the resource
in the PC. It cannot be empty if the type is
UUID.
type: string
required:
- type
type: object
x-kubernetes-validations:
- message: uuid configuration is required when type
is UUID, and forbidden otherwise
rule: 'has(self.type) && self.type == ''UUID'' ? has(self.uuid)
: !has(self.uuid)'
- message: name configuration is required when type
is Name, and forbidden otherwise
rule: 'has(self.type) && self.type == ''Name'' ? has(self.name)
: !has(self.name)'
maxItems: 32
minItems: 1
type: array
x-kubernetes-list-type: atomic
x-kubernetes-validations:
- message: each subnet must be unique
rule: self.all(x, self.exists_one(y, x == y))
required:
- cluster
- name
- subnets
type: object
maxItems: 32
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
prismCentral:
description: |-
prismCentral holds the endpoint address and port to access the Nutanix Prism Central.
When a cluster-wide proxy is installed, by default, this endpoint will be accessed via the proxy.
Should you wish for communication with this endpoint not to be proxied, please add the endpoint to the
proxy spec.noProxy list.
properties:
address:
description: address is the endpoint address (DNS name
or IP address) of the Nutanix Prism Central or Element
(cluster)
maxLength: 256
type: string
port:
description: port is the port number to access the Nutanix
Prism Central or Element (cluster)
format: int32
maximum: 65535
minimum: 1
type: integer
required:
- address
- port
type: object
prismElements:
description: |-
prismElements holds one or more endpoint address and port data to access the Nutanix
Prism Elements (clusters) of the Nutanix Prism Central. Currently we only support one
Prism Element (cluster) for an OpenShift cluster, where all the Nutanix resources (VMs, subnets, volumes, etc.)
used in the OpenShift cluster are located. In the future, we may support Nutanix resources (VMs, etc.)
spread over multiple Prism Elements (clusters) of the Prism Central.
items:
description: NutanixPrismElementEndpoint holds the name
and endpoint data for a Prism Element (cluster)
properties:
endpoint:
description: |-
endpoint holds the endpoint address and port data of the Prism Element (cluster).
When a cluster-wide proxy is installed, by default, this endpoint will be accessed via the proxy.
Should you wish for communication with this endpoint not to be proxied, please add the endpoint to the
proxy spec.noProxy list.
properties:
address:
description: address is the endpoint address (DNS
name or IP address) of the Nutanix Prism Central
or Element (cluster)
maxLength: 256
type: string
port:
description: port is the port number to access the
Nutanix Prism Central or Element (cluster)
format: int32
maximum: 65535
minimum: 1
type: integer
required:
- address
- port
type: object
name:
description: |-
name is the name of the Prism Element (cluster). This value will correspond with
the cluster field configured on other resources (eg Machines, PVCs, etc).
maxLength: 256
type: string
required:
- endpoint
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
required:
- prismCentral
- prismElements
type: object
openstack:
description: openstack contains settings specific to the OpenStack
infrastructure provider.
properties:
apiServerInternalIPs:
description: |-
apiServerInternalIPs are the IP addresses to contact the Kubernetes API
server that can be used by components inside the cluster, like kubelets
using the infrastructure rather than Kubernetes networking. These are the
IPs for a self-hosted load balancer in front of the API servers.
In dual stack clusters this list contains two IP addresses, one from IPv4
family and one from IPv6.
In single stack clusters a single IP address is expected.
When omitted, values from the status.apiServerInternalIPs will be used.
Once set, the list cannot be completely removed (but its second entry can).
items:
description: IP is an IP address (for example, "10.0.0.0"
or "fd00::").
maxLength: 39
minLength: 1
type: string
x-kubernetes-validations:
- message: value must be a valid IP address
rule: isIP(self)
maxItems: 2
type: array
x-kubernetes-list-type: atomic
x-kubernetes-validations:
- message: apiServerInternalIPs must contain at most one IPv4
address and at most one IPv6 address
rule: 'size(self) == 2 && isIP(self[0]) && isIP(self[1])
? ip(self[0]).family() != ip(self[1]).family() : true'
ingressIPs:
description: |-
ingressIPs are the external IPs which route to the default ingress
controller. The IPs are suitable targets of a wildcard DNS record used to
resolve default route host names.
In dual stack clusters this list contains two IP addresses, one from IPv4
family and one from IPv6.
In single stack clusters a single IP address is expected.
When omitted, values from the status.ingressIPs will be used.
Once set, the list cannot be completely removed (but its second entry can).
items:
description: IP is an IP address (for example, "10.0.0.0"
or "fd00::").
maxLength: 39
minLength: 1
type: string
x-kubernetes-validations:
- message: value must be a valid IP address
rule: isIP(self)
maxItems: 2
type: array
x-kubernetes-list-type: atomic
x-kubernetes-validations:
- message: ingressIPs must contain at most one IPv4 address
and at most one IPv6 address
rule: 'size(self) == 2 && isIP(self[0]) && isIP(self[1])
? ip(self[0]).family() != ip(self[1]).family() : true'
machineNetworks:
description: |-
machineNetworks are IP networks used to connect all the OpenShift cluster
nodes. Each network is provided in the CIDR format and should be IPv4 or IPv6,
for example "10.0.0.0/8" or "fd00::/8".
items:
description: CIDR is an IP address range in CIDR notation
(for example, "10.0.0.0/8" or "fd00::/8").
maxLength: 43
minLength: 1
type: string
x-kubernetes-validations:
- message: value must be a valid CIDR network address
rule: isCIDR(self)
maxItems: 32
type: array
x-kubernetes-list-type: atomic
x-kubernetes-validations:
- rule: self.all(x, self.exists_one(y, x == y))
type: object
x-kubernetes-validations:
- message: apiServerInternalIPs list is required once set
rule: '!has(oldSelf.apiServerInternalIPs) || has(self.apiServerInternalIPs)'
- message: ingressIPs list is required once set
rule: '!has(oldSelf.ingressIPs) || has(self.ingressIPs)'
ovirt:
description: ovirt contains settings specific to the oVirt infrastructure
provider.
type: object
powervs:
description: powervs contains settings specific to the IBM Power
Systems Virtual Servers infrastructure provider.
properties:
serviceEndpoints:
description: |-
serviceEndpoints is a list of custom endpoints which will override the default
service endpoints of a Power VS service.
items:
description: |-
PowervsServiceEndpoint stores the configuration of a custom url to
override existing defaults of PowerVS Services.
properties:
name:
description: |-
name is the name of the Power VS service.
Few of the services are
IAM - https://cloud.ibm.com/apidocs/iam-identity-token-api
ResourceController - https://cloud.ibm.com/apidocs/resource-controller/resource-controller
Power Cloud - https://cloud.ibm.com/apidocs/power-cloud
enum:
- CIS
- COS
- COSConfig
- DNSServices
- GlobalCatalog
- GlobalSearch
- GlobalTagging
- HyperProtect
- IAM
- KeyProtect
- Power
- ResourceController
- ResourceManager
- VPC
type: string
url:
description: |-
url is fully qualified URI with scheme https, that overrides the default generated
endpoint for a client.
This must be provided and cannot be empty.
format: uri
pattern: ^https://
type: string
required:
- name
- url
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
type: object
type:
description: |-
type is the underlying infrastructure provider for the cluster. This
value controls whether infrastructure automation such as service load
balancers, dynamic volume provisioning, machine creation and deletion, and
other integrations are enabled. If None, no infrastructure automation is
enabled. Allowed values are "AWS", "Azure", "BareMetal", "GCP", "Libvirt",
"OpenStack", "VSphere", "oVirt", "IBMCloud", "KubeVirt", "EquinixMetal",
"PowerVS", "AlibabaCloud", "Nutanix", "External", and "None". Individual
components may not support all platforms, and must handle unrecognized
platforms as None if they do not support that platform.
enum:
- ""
- AWS
- Azure
- BareMetal
- GCP
- Libvirt
- OpenStack
- None
- VSphere
- oVirt
- IBMCloud
- KubeVirt
- EquinixMetal
- PowerVS
- AlibabaCloud
- Nutanix
- External
type: string
vsphere:
description: vsphere contains settings specific to the VSphere
infrastructure provider.
properties:
apiServerInternalIPs:
description: |-
apiServerInternalIPs are the IP addresses to contact the Kubernetes API
server that can be used by components inside the cluster, like kubelets
using the infrastructure rather than Kubernetes networking. These are the
IPs for a self-hosted load balancer in front of the API servers.
In dual stack clusters this list contains two IP addresses, one from IPv4
family and one from IPv6.
In single stack clusters a single IP address is expected.
When omitted, values from the status.apiServerInternalIPs will be used.
Once set, the list cannot be completely removed (but its second entry can).
items:
description: IP is an IP address (for example, "10.0.0.0"
or "fd00::").
maxLength: 39
minLength: 1
type: string
x-kubernetes-validations:
- message: value must be a valid IP address
rule: isIP(self)
maxItems: 2
type: array
x-kubernetes-list-type: atomic
x-kubernetes-validations:
- message: apiServerInternalIPs must contain at most one IPv4
address and at most one IPv6 address
rule: 'size(self) == 2 && isIP(self[0]) && isIP(self[1])
? ip(self[0]).family() != ip(self[1]).family() : true'
failureDomains:
description: |-
failureDomains contains the definition of region, zone and the vCenter topology.
If this is omitted failure domains (regions and zones) will not be used.
items:
description: VSpherePlatformFailureDomainSpec holds the
region and zone failure domain and the vCenter topology
of that failure domain.
properties:
name:
description: |-
name defines the arbitrary but unique name
of a failure domain.
maxLength: 256
minLength: 1
type: string
region:
description: |-
region defines the name of a region tag that will
be attached to a vCenter datacenter. The tag
category in vCenter must be named openshift-region.
maxLength: 80
minLength: 1
type: string
regionAffinity:
description: |-
regionAffinity holds the type of region, Datacenter or ComputeCluster.
When set to Datacenter, this means the region is a vCenter Datacenter as defined in topology.
When set to ComputeCluster, this means the region is a vCenter Cluster as defined in topology.
properties:
type:
description: |-
type determines the vSphere object type for a region within this failure domain.
Available types are Datacenter and ComputeCluster.
When set to Datacenter, this means the vCenter Datacenter defined is the region.
When set to ComputeCluster, this means the vCenter cluster defined is the region.
enum:
- ComputeCluster
- Datacenter
type: string
required:
- type
type: object
server:
anyOf:
- format: ipv4
- format: ipv6
- format: hostname
description: server is the fully-qualified domain name
or the IP address of the vCenter server.
maxLength: 255
minLength: 1
type: string
topology:
description: topology describes a given failure domain
using vSphere constructs
properties:
computeCluster:
description: |-
computeCluster the absolute path of the vCenter cluster
in which virtual machine will be located.
The absolute path is of the form /<datacenter>/host/<cluster>.
The maximum length of the path is 2048 characters.
maxLength: 2048
pattern: ^/.*?/host/.*?
type: string
datacenter:
description: |-
datacenter is the name of vCenter datacenter in which virtual machines will be located.
The maximum length of the datacenter name is 80 characters.
maxLength: 80
type: string
datastore:
description: |-
datastore is the absolute path of the datastore in which the
virtual machine is located.
The absolute path is of the form /<datacenter>/datastore/<datastore>
The maximum length of the path is 2048 characters.
maxLength: 2048
pattern: ^/.*?/datastore/.*?
type: string
folder:
description: |-
folder is the absolute path of the folder where
virtual machines are located. The absolute path
is of the form /<datacenter>/vm/<folder>.
The maximum length of the path is 2048 characters.
maxLength: 2048
pattern: ^/.*?/vm/.*?
type: string
networks:
description: |-
networks is the list of port group network names within this failure domain.
If feature gate VSphereMultiNetworks is enabled, up to 10 network adapters may be defined.
10 is the maximum number of virtual network devices which may be attached to a VM as defined by:
https://configmax.esp.vmware.com/guest?vmwareproduct=vSphere&release=vSphere%208.0&categories=1-0
The available networks (port groups) can be listed using
`govc ls 'network/*'`
Networks should be in the form of an absolute path:
/<datacenter>/network/<portgroup>.
items:
type: string
maxItems: 10
minItems: 1
type: array
x-kubernetes-list-type: atomic
resourcePool:
description: |-
resourcePool is the absolute path of the resource pool where virtual machines will be
created. The absolute path is of the form /<datacenter>/host/<cluster>/Resources/<resourcepool>.
The maximum length of the path is 2048 characters.
maxLength: 2048
pattern: ^/.*?/host/.*?/Resources.*
type: string
template:
description: |-
template is the full inventory path of the virtual machine or template
that will be cloned when creating new machines in this failure domain.
The maximum length of the path is 2048 characters.
When omitted, the template will be calculated by the control plane
machineset operator based on the region and zone defined in
VSpherePlatformFailureDomainSpec.
For example, for zone=zonea, region=region1, and infrastructure name=test,
the template path would be calculated as /<datacenter>/vm/test-rhcos-region1-zonea.
maxLength: 2048
minLength: 1
pattern: ^/.*?/vm/.*?
type: string
required:
- computeCluster
- datacenter
- datastore
- networks
type: object
zone:
description: |-
zone defines the name of a zone tag that will
be attached to a vCenter cluster. The tag
category in vCenter must be named openshift-zone.
maxLength: 80
minLength: 1
type: string
zoneAffinity:
description: |-
zoneAffinity holds the type of the zone and the hostGroup which
vmGroup and the hostGroup names in vCenter corresponds to
a vm-host group of type Virtual Machine and Host respectively. Is also
contains the vmHostRule which is an affinity vm-host rule in vCenter.
properties:
hostGroup:
description: |-
hostGroup holds the vmGroup and the hostGroup names in vCenter
corresponds to a vm-host group of type Virtual Machine and Host respectively. Is also
contains the vmHostRule which is an affinity vm-host rule in vCenter.
properties:
hostGroup:
description: |-
hostGroup is the name of the vm-host group of type host within vCenter for this failure domain.
hostGroup is limited to 80 characters.
This field is required when the VSphereFailureDomain ZoneType is HostGroup
maxLength: 80
minLength: 1
type: string
vmGroup:
description: |-
vmGroup is the name of the vm-host group of type virtual machine within vCenter for this failure domain.
vmGroup is limited to 80 characters.
This field is required when the VSphereFailureDomain ZoneType is HostGroup
maxLength: 80
minLength: 1
type: string
vmHostRule:
description: |-
vmHostRule is the name of the affinity vm-host rule within vCenter for this failure domain.
vmHostRule is limited to 80 characters.
This field is required when the VSphereFailureDomain ZoneType is HostGroup
maxLength: 80
minLength: 1
type: string
required:
- hostGroup
- vmGroup
- vmHostRule
type: object
type:
description: |-
type determines the vSphere object type for a zone within this failure domain.
Available types are ComputeCluster and HostGroup.
When set to ComputeCluster, this means the vCenter cluster defined is the zone.
When set to HostGroup, hostGroup must be configured with hostGroup, vmGroup and vmHostRule and
this means the zone is defined by the grouping of those fields.
enum:
- HostGroup
- ComputeCluster
type: string
required:
- type
type: object
x-kubernetes-validations:
- message: hostGroup is required when type is HostGroup,
and forbidden otherwise
rule: 'has(self.type) && self.type == ''HostGroup''
? has(self.hostGroup) : !has(self.hostGroup)'
required:
- name
- region
- server
- topology
- zone
type: object
x-kubernetes-validations:
- message: when zoneAffinity type is HostGroup, regionAffinity
type must be ComputeCluster
rule: 'has(self.zoneAffinity) && self.zoneAffinity.type
== ''HostGroup'' ? has(self.regionAffinity) && self.regionAffinity.type
== ''ComputeCluster'' : true'
- message: when zoneAffinity type is ComputeCluster, regionAffinity
type must be Datacenter
rule: 'has(self.zoneAffinity) && self.zoneAffinity.type
== ''ComputeCluster'' ? has(self.regionAffinity) &&
self.regionAffinity.type == ''Datacenter'' : true'
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
ingressIPs:
description: |-
ingressIPs are the external IPs which route to the default ingress
controller. The IPs are suitable targets of a wildcard DNS record used to
resolve default route host names.
In dual stack clusters this list contains two IP addresses, one from IPv4
family and one from IPv6.
In single stack clusters a single IP address is expected.
When omitted, values from the status.ingressIPs will be used.
Once set, the list cannot be completely removed (but its second entry can).
items:
description: IP is an IP address (for example, "10.0.0.0"
or "fd00::").
maxLength: 39
minLength: 1
type: string
x-kubernetes-validations:
- message: value must be a valid IP address
rule: isIP(self)
maxItems: 2
type: array
x-kubernetes-list-type: atomic
x-kubernetes-validations:
- message: ingressIPs must contain at most one IPv4 address
and at most one IPv6 address
rule: 'size(self) == 2 && isIP(self[0]) && isIP(self[1])
? ip(self[0]).family() != ip(self[1]).family() : true'
machineNetworks:
description: |-
machineNetworks are IP networks used to connect all the OpenShift cluster
nodes. Each network is provided in the CIDR format and should be IPv4 or IPv6,
for example "10.0.0.0/8" or "fd00::/8".
items:
description: CIDR is an IP address range in CIDR notation
(for example, "10.0.0.0/8" or "fd00::/8").
maxLength: 43
minLength: 1
type: string
x-kubernetes-validations:
- message: value must be a valid CIDR network address
rule: isCIDR(self)
maxItems: 32
type: array
x-kubernetes-list-type: atomic
x-kubernetes-validations:
- rule: self.all(x, self.exists_one(y, x == y))
nodeNetworking:
description: |-
nodeNetworking contains the definition of internal and external network constraints for
assigning the node's networking.
If this field is omitted, networking defaults to the legacy
address selection behavior which is to only support a single address and
return the first one found.
properties:
external:
description: external represents the network configuration
of the node that is externally routable.
properties:
excludeNetworkSubnetCidr:
description: |-
excludeNetworkSubnetCidr IP addresses in subnet ranges will be excluded when selecting
the IP address from the VirtualMachine's VM for use in the status.addresses fields.
items:
format: cidr
type: string
type: array
x-kubernetes-list-type: atomic
network:
description: |-
network VirtualMachine's VM Network names that will be used to when searching
for status.addresses fields. Note that if internal.networkSubnetCIDR and
external.networkSubnetCIDR are not set, then the vNIC associated to this network must
only have a single IP address assigned to it.
The available networks (port groups) can be listed using
`govc ls 'network/*'`
type: string
networkSubnetCidr:
description: |-
networkSubnetCidr IP address on VirtualMachine's network interfaces included in the fields' CIDRs
that will be used in respective status.addresses fields.
items:
format: cidr
type: string
type: array
x-kubernetes-list-type: set
type: object
internal:
description: internal represents the network configuration
of the node that is routable only within the cluster.